iconbndl.h

Clase wxIconBundle

Esta clase contiene múltiples copias de un icono en diferentes tamaños.

Jerarquía:

Se utiliza normalmente en wxDialog::SetIcons y wxTopLevelWindow::SetIcons.

Tipos miembro

anónimo

proto

enum  	{
  FALLBACK_NONE = 0 ,
  FALLBACK_SYSTEM = 1 ,
  FALLBACK_NEAREST_LARGER = 2
}

Los elementos de este enum determinan lo que ocurre si GetIcon() no encuentra el icono exactamente del tamaño solicitado.

Valores
FALLBACK_NONE
Devuelve un icono no válido si no se encuentra el tamaño exacto.
FALLBACK_SISTEMA

Devuelve el icono del tamaño del icono del sistema si no se encuentra el tamaño exacto.

Puede combinarse con otros elementos enum no-NONE para determinar qué ocurre si tampoco se encuentra el tamaño del icono del sistema.

FALLBACK_NEAREST_LARGER
Devuelve el icono de mayor tamaño más cercano o, si no hay ningún icono de mayor tamaño en el paquete, el icono de menor tamaño más cercano.

Funciones miembro

wxIconBundle()

wxIconBundle::wxIconBundle()

Constructor por defecto.

wxIconBundle()

wxIconBundle::wxIconBundle( const wxString & file, wxBitmapType type = wxBITMAP_TYPE_ANY )

Inicializa el bundle con los iconos encontrados en el fichero.

wxIconBundle()

wxIconBundle::wxIconBundle( wxInputStream & stream, wxBitmapType type = wxBITMAP_TYPE_ANY )

Inicializa el paquete con los iconos encontrados en el flujo.

Hay que tener en cuenta que el flujo debe poder buscarse, al menos si contiene más de un icono. El puntero del flujo se posiciona después del último icono leído del flujo cuando esta función devuelve.

wxIconBundle()

wxIconBundle::wxIconBundle(const wxIcon & icon)

Inicializa el paquete con un único icono.

wxIconBundle()

wxIconBundle::wxIconBundle( const wxString & resourceName, WXHINSTANCE module )

Inicializa el bundle con todos los tamaños de un icono de grupo con resourceName almacenado como un recurso de MS Windows en module.

Cuando module es 0, se utiliza la instancia actual.

Disponibilidad: sólo disponible para el port wxMSW.

wxIconBundle()

wxIconBundle::wxIconBundle(const wxIconBundle & ic)

Constructor de copia.

~wxIconBundle()

virtual wxIconBundle::~wxIconBundle()

Destructor.

AddIcon()

void wxIconBundle::AddIcon(const wxIcon & icon)

Añade el icono a la colección; si la colección ya contiene un icono con la misma anchura y altura, se sustituye por el nuevo.

AddIcon()

void wxIconBundle::AddIcon( const wxString & file, wxBitmapType type = wxBITMAP_TYPE_ANY )

Añade todos los iconos contenidos en el archivo al paquete; si la colección ya contiene iconos con la misma anchura y altura, se sustituyen por los nuevos.

AddIcon()

void wxIconBundle::AddIcon( const wxString & resourceName, WXHINSTANCE module )

Carga todos los tamaños de un icono de grupo con resourceName almacenado como un recurso de MS Windows en module.

Cuando module es 0, se utiliza la instancia actual.

Disponibilidad: sólo disponible para el puerto wxMSW.

AddIcon()

void wxIconBundle::AddIcon( wxInputStream & stream, wxBitmapType type = wxBITMAP_TYPE_ANY )

Añade al paquete todos los iconos contenidos en el flujo; si la colección ya contiene iconos con la misma anchura y altura, se sustituyen por los nuevos.

Hay que tener en cuenta que, al igual que en el constructor que carga el paquete de iconos desde el flujo, el flujo debe poder buscarse, al menos si se va a cargar más de un icono desde él.

GetIcon()

wxIcon wxIconBundle::GetIcon( const wxSize & size, int flags = FALLBACK_SYSTEM ) const

Devuelve el icono con el tamaño dado.

Si el tamaño es wxDefaultSize, se interpreta como el tamaño estándar del icono del sistema, es decir, el tamaño devuelto por wxSystemSettings::GetMetric() para wxSYS_ICON_X y wxSYS_ICON_Y.

Si el paquete contiene un icono con exactamente el tamaño solicitado, siempre se devuelve. En caso contrario, el comportamiento depende de las banderas. Si sólo se da wxIconBundle::FALLBACK_NONE, la función devuelve un icono inválido. Si se da wxIconBundle::FALLBACK_SYSTEM, intenta encontrar el icono de tamaño estándar del sistema, independientemente del tamaño pasado como parámetro. En caso contrario, o si tampoco se encuentra el icono de tamaño de sistema, pero se especifica la bandera wxIconBundle::FALLBACK_NEAREST_LARGER, la función devuelve el icono más pequeño del tamaño mayor que el solicitado o, si esto falla también, sólo el icono más cercano al tamaño especificado.

El parámetro flags sólo está disponible desde wxWidgets 2.9.4.

GetIcon()

wxIcon wxIconBundle::GetIcon( wxCoord size = wxDefaultCoord, int flags = FALLBACK_SYSTEM ) const

Lo mismo que:

GetIcon( wxSize( size, size ) ) 
GetIconByIndex()

wxIcon wxIconBundle::GetIconByIndex(size_t n) const

Devuelve el icono en el índice (debe ser < GetIconCount())

GetIconCount()

size_t wxIconBundle::GetIconCount() const

Devuelve el número de iconos disponibles.

GetIconOfExactSize()

wxIcon wxIconBundle::GetIconOfExactSize(const wxSize & size) const

Devuelve el icono con exactamente el tamaño dado o wxNullIcon si este tamaño no está disponible.

IsEmpty()

bool wxIconBundle::IsEmpty() const

Devuelve true si el paquete no contiene ningún icono, false en caso contrario (en cuyo caso una llamada a GetIcon() con el parámetro por defecto debería devolver un icono válido).

Operadores miembro

operator=()

wxIconBundle& wxIconBundle::operator=(const wxIconBundle & ic)

Operador de asignación, utilizando el cómputo de referencias.

Métodos y datos heredados

Esta clase hereda los métodos y datos miembro públicos y protegidos de wxGDIObject y wxObject.