Clase wxIcon
Un icono es un pequeño mapa de bits rectangular que suele utilizarse para indicar una aplicación minimizada.
Jerarquía:
Se diferencia de un wxBitmap en que siempre tiene asociada una máscara para dibujar de forma transparente. En algunas plataformas, los iconos y los mapas de bits se implementan de forma idéntica, ya que no hay una distinción real entre un wxBitmap con una máscara y un icono; y no hay un formato de icono específico en algunas plataformas (las aplicaciones basadas en X normalmente estandarizan en XPMs para pequeños mapas de bits e iconos). Sin embargo, algunas plataformas (como Windows) hacen la distinción, por lo que se proporciona una clase separada.
Observaciones
Suele ser conveniente asociar un icono pertinente a un marco. Los iconos también pueden utilizarse para otros fines, por ejemplo con wxTreeCtrl y wxListCtrl. Los iconos tienen formatos diferentes en las distintas plataformas, por lo que normalmente se crearán iconos distintos para los distintos entornos. Se contemplan métodos específicos de cada plataforma para crear una estructura wxIcon, y esta es una ocasión en la que probablemente se requerirá compilación condicional. Hay que tener en cuenta que debe crearse un nuevo icono cada vez que se vaya a utilizar para una nueva ventana. En Windows, el icono no se volverá a cargar si ya se ha utilizado. Un icono asignado a un marco se borrará cuando se borre el marco. Para más información, consulte Mapas de bits e iconos.
Funciones miembro
wxIcon()
wxIcon::wxIcon()
Constructor por defecto.
Construye un objeto icono sin datos; una asignación u otra función miembro como LoadFile() debe ser llamada posteriormente.
wxIcon()
wxIcon::wxIcon(const wxIcon & icon)
Constructor copia.
wxIcon()
wxIcon::wxIcon( const char bits[], int width, int height )
Crea un icono a partir de una matriz de bits.
Solo debe utilizar esta función para mapas de bits monocromos (profundidad 1) en programas portables: en este caso, el parámetro bits debe contener una imagen XBM.
Para otras profundidades de bits, el comportamiento depende de la plataforma: en Windows, los datos se pasan sin cambios a la API CreateBitmap() subyacente. En otras plataformas, solo pueden crearse mapas de bits monocromos con este constructor y debe utilizarse wxImage para crear mapas de bits en color a partir de datos estáticos.
Parámetros
- bits
- Especifica una matriz de valores de píxel.
- width
- La anchura de la imagen.
- height
- La altura de la imagen.
Nota: En wxPerl utilizar Wx::Icon->newBits(bits, width, height, depth = -1);
wxIcon()
wxIcon::wxIcon(const char *const * bits)
Crea un mapa de bits a partir de datos XPM.
Para utilizar este constructor, primero se debe incluir un archivo XPM. Por ejemplo, suponiendo que el archivo mybitmap.xpm contiene una matriz XPM de punteros de caracteres llamada mybitmap:
#include "mybitmap.xpm" ... wxIcon *icon = new wxIcon(mybitmap);
Existe una macro, wxICON, que crea un icono utilizando un XPM en la plataforma adecuada, o un recurso de icono en Windows.
wxIcon icon(wxICON(sample));
// Equivalent to:
#if defined(__WXGTK__) || defined(__WXMOTIF__)
wxIcon icon(sample_xpm);
#endif
#if defined(__WXMSW__)
wxIcon icon("sample");
#endif
Nota: En wxPerl use Wx::Icon->newFromXPM(data).
wxIcon()
wxIcon::wxIcon( const wxString & name, wxBitmapType type = wxICON_DEFAULT_TYPE, int desiredWidth = -1, int desiredHeight = -1 )
Carga un icono desde un archivo o recurso.
Parámetros
- name
- Puede referirse a un nombre de recurso o a un nombre de archivo en MS Windows y X. Su significado viene determinado por el parámetro type.
- type
- Puede ser uno de los valores de wxBitmapType e indica qué tipo de bitmap debe cargarse. Véase la nota en la descripción detallada de la clase. Hay que tener en cuenta que la constante wxICON_DEFAULT_TYPE tiene un valor diferente en los distintos ports de wxWidgets. Ver la cabecera icon.h para el valor que toma para un puerto específico.
- desiredWidth
- Especifica la anchura deseada del icono. Este parámetro solo tiene efecto en Windows, donde los recursos de iconos pueden contener varios iconos de diferentes tamaños.
- desiredHeight
- Especifica la altura deseada del icono. Este parámetro solo tiene efecto en Windows, donde los recursos de iconos pueden contener varios iconos de diferentes tamaños.
wxIcon()
wxIcon::wxIcon(const wxIconLocation & loc)
Carga un icono desde la ubicación especificada.
~wxIcon()
virtual wxIcon::~wxIcon()
Destructor.
Ver Destrucción de Objetos para más información.
Si la aplicación omite borrar el icono explícitamente, el icono será destruido automáticamente por wxWidgets cuando la aplicación salga.
Advertencia
No se debe borrar un icono que esté seleccionado en un contexto de dispositivo de memoria.
ConvertToDisabled()
wxIcon wxIcon::ConvertToDisabled(unsigned char brightness = 255) const
Devuelve la versión desactivada (atenuada) del icono.
Este método solo está disponible en wxIcon bajo wxMSW, otros ports solo lo tienen en wxBitmap. Aunque siempre se puede utilizar wxImage::ConvertToDisabled() y crear el icono desde wxImage manualmente.
Disponibilidad: solo disponible para el port wxMSW.
CopyFromBitmap()
void wxIcon::CopyFromBitmap(const wxBitmap & bmp)
Copia un mapa de bits bmp en este icono.
En MS Windows, el mapa de bits debe tener configurado el color de máscara.
CreateFromHICON()
bool wxIcon::CreateFromHICON(WXHICON icon)
Adjunta un manejador de icono de Windows.
Este método específico de wxMSW permite asignar a wxIcon un HICON nativo de Windows (que debe ser de tipo WXHICON opaque handle). Hay que tener en cuenta que esto significa que el HICON será destruido por wxIcon cuando se destruya.
Valor de retorno
true si tiene éxito.
Disponibilidad: solo disponible para el port wxMSW.
GetDepth()
int wxIcon::GetDepth() const
Obtiene la profundidad de color del icono.
Un valor de 1 indica un icono monocromo.
GetHeight()
int wxIcon::GetHeight() const
Obtiene la altura del icono en píxeles físicos.
GetLogicalHeight()
double wxIcon::GetLogicalHeight() const
Obtiene la altura del icono en píxeles lógicos.
Véase wxBitmap::GetLogicalHeight().
GetLogicalSize()
wxSize wxIcon::GetLogicalSize() const
Obtiene el tamaño del icono en píxeles lógicos.
Véase wxBitmap::GetLogicalSize().
GetLogicalWidth()
double wxIcon::GetLogicalWidth() const
Obtiene la anchura del icono en píxeles lógicos.
Véase wxBitmap::GetLogicalWidth().
GetScaleFactor()
double wxIcon::GetScaleFactor() const
Obtiene el factor de escala de este icono.
Véase wxBitmap::GetScaleFactor().
GetSize()
wxSize wxIcon::GetSize() const
Obtiene el tamaño del icono en píxeles físicos.
GetWidth()
int wxIcon::GetWidth() const
Obtiene la anchura del icono en píxeles físicos.
IsOk()
virtual bool wxIcon::IsOk() const
Devuelve true si los datos del icono están presentes.
LoadFile()
bool wxIcon::LoadFile( const wxString & name, wxBitmapType type = wxICON_DEFAULT_TYPE, int desiredWidth = -1, int desiredHeight = -1 )
Carga un icono desde un archivo o recurso.
Parámetros
- name
- Un nombre de archivo o de recurso de Windows. El significado de name viene determinado por el parámetro type.
- type
- Uno de los valores de wxBitmapType; véase la nota en la descripción detallada de la clase. Hay que tener en cuenta que la constante wxICON_DEFAULT_TYPE tiene un valor diferente en los distintos ports de wxWidgets. Consultar la cabecera icon.h para conocer el valor que toma para un puerto específico.
- desiredWidth
- Especifica la anchura deseada del icono. Este parámetro solo tiene efecto en Windows, donde los recursos de iconos pueden contener varios iconos de diferentes tamaños.
- desiredHeight
- Especifica la altura deseada del icono. Este parámetro solo tiene efecto en Windows, donde los recursos de iconos pueden contener varios iconos de distintos tamaños.
Valor de retorno
true si la operación se ha realizado correctamente, false en caso contrario.
SetDepth()
void wxIcon::SetDepth(int depth)
Obsoleto
Esta función está obsoleta desde la versión 3.1.2, las dimensiones y la profundidad solo pueden establecerse en el momento de la construcción. Establece el miembro de profundidad (no afecta a los datos del icono).
Parámetros
- depth
- Profundidad del icono.
SetHeight()
void wxIcon::SetHeight(int height)
Obsoleto
Esta función está obsoleta desde la versión 3.1.2, las dimensiones y la profundidad sólo pueden establecerse en el momento de la construcción. Establece el miembro de altura (no afecta a los datos del icono).
Parámetros
- height
- Altura del icono en píxeles.
SetWidth()
void wxIcon::SetWidth(int width)
Obsoleto
Esta función está obsoleta desde la versión 3.1.2, las dimensiones y la profundidad sólo pueden establecerse en el momento de la construcción. Establece el miembro de anchura (no afecta a los datos del icono).
Parámetros
- width
- Anchura del icono en píxeles.
Operadores
operator=
wxIcon& wxIcon::operator=(const wxIcon & icon)()
Operador de asignación, utilizando Reference Counting.
Parámetros
- icon
- Icono a asignar.
Métodos y datos heredados
Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject y wxGDIObject.