imaglist.h

Clase wxImageList

Un wxImageList contiene una lista de imágenes, que se almacenan en una forma no especificada.

Jerarquía:

Jerarquía de la clase wxImageList

Las imágenes pueden utilizar el canal alfa o máscaras para el dibujo transparente, y se pueden hacer de una variedad de fuentes, incluyendo mapas de bits e iconos.

wxImageList se utiliza principalmente en conjunción con las clases wxTreeCtrl y wxclass/wxListCtrl.

No se recomienda el uso de esta clase en el nuevo código, ya que no permite mostrar mapas de bits dependientes de DPI. Por favor, utilizar wxWithImages::SetImages() en lugar de wxWithImages::SetImageList().

Funciones miembro

wxImageList()

wxImageList::wxImageList()

Constructor por defecto.

Hay que tener en cuenta que el objeto creado utilizando el constructor por defecto no es válido y llamar a cualquier método que no sea Create() en él dará lugar a un fallo de aserción.

wxImageList()

wxImageList::wxImageList( int width, int height, bool mask = true, int initialCount = 1 )

Constructor que especifica el tamaño de la imagen, si se deben crear máscaras de imagen y el tamaño inicial de la lista.

Hay que tener en cuenta que el tamaño se especifica en píxeles físicos y debe corresponder al tamaño de los mapas de bits, en píxeles, que se añadirán a esta lista.

Parámetros
width
Anchura de las imágenes de la lista.
height
Altura de las imágenes de la lista.
mask
Si es true, todas las imágenes tendrán máscaras, creándose la máscara a partir de los píxeles de color gris claro si no se especifica lo contrario, es decir, si la imagen no tiene ni canal alfa ni máscara y no se especifica explícitamente ninguna máscara al añadirla. Hay que tener en cuenta que si una imagen tiene canal alfa o máscara, siempre se utilizará, tanto si este parámetro es verdadero como falso.
initialCount
El tamaño inicial de la lista.
Add()

int wxImageList::Add( const wxBitmap & bitmap, const wxBitmap & mask = wxNullBitmap )

Añade una nueva imagen o imágenes utilizando un mapa de bits y un mapa de bits de máscara opcional.

El tamaño físico del mapa de bits debe ser el mismo que el especificado al construir wxImageList. Si la anchura del mapa de bits es mayor que la anchura de la lista de imágenes, el mapa de bits se divide en imágenes más pequeñas de la anchura requerida, lo que permite añadir varias imágenes a partir de un único mapa de bits.

Parámetros
bitmap
Mapa de bits que representa las áreas opacas de la imagen.
mask
Mapa de bits de máscara monocromática, que representa las áreas transparentes de la imagen.
Valor de retorno

El nuevo índice de la imagen basado en cero.

Add()

int wxImageList::Add( const wxBitmap & bitmap, const wxColour & maskColour )

Añade una nueva imagen o imágenes utilizando un mapa de bits y un color de máscara.

El tamaño físico del mapa de bits debe ser el mismo que el especificado al construir wxImageList. Si la anchura del mapa de bits es mayor que la anchura de la lista de imágenes, el mapa de bits se divide en imágenes más pequeñas de la anchura requerida, lo que permite añadir varias imágenes a partir de un único mapa de bits.

Parámetros
bitmap
Mapa de bits que representa las áreas opacas de la imagen.
maskColour
Color que indica qué partes de la imagen son transparentes.
Valor de retorno

El nuevo índice de la imagen basado en cero.

Add()

int wxImageList::Add(const wxIcon & icon)

Añade una nueva imagen utilizando un icono.

El tamaño físico del icono debe ser el mismo que el especificado al construir wxImageList.

Parámetros
icon
Icono a utilizar como imagen.
Valor de retorno

El nuevo índice de la imagen basado en cero.

Disponibilidad

Sólo disponible para los ports wxMSW, wxOSX/Cocoa.

Create()

bool wxImageList::Create( int width, int height, bool mask = true, int initialCount = 1 )

Inicializa la lista.

Ver wxImageList() para más detalles.

Esta función puede ser llamada sólo una vez después de crear el objeto usando su constructor por defecto o después de llamar a Destroy().

Destroy()

void wxImageList::Destroy()

Destruye la lista actual.

Esta función restablece el objeto a su estado inicial y hace más que RemoveAll() en la versión nativa wxMSW.

Después de llamarla, Create() puede ser llamada de nuevo para recrear la lista de imágenes, por ejemplo, usando un tamaño diferente.

Draw()

virtual bool wxImageList::Draw( int index, wxDC & dc, int x, int y, int flags = wxIMAGELIST_DRAW_NORMAL, bool solidBackground = false )

Dibuja una imagen especificada en un contexto de dispositivo.

Parámetros
index
Índice de imagen, empezando por cero.
dc
Contexto de dispositivo sobre el que dibujar.
x
Posición X en el contexto de dispositivo.
y
Posición Y en el contexto de dispositivo.
flags
Cómo dibujar la imagen. Una lista de bits de una selección de los siguientes:
  • wxIMAGELIST_DRAW_NORMAL: Dibuja la imagen normalmente.
  • wxIMAGELIST_DRAW_TRANSPARENT: Dibuja la imagen con transparencia.
  • wxIMAGELIST_DRAW_SELECTED: Dibuja la imagen en estado seleccionado.
  • wxIMAGELIST_DRAW_FOCUSED: Dibuja la imagen en estado enfocado.
solidBackground
Para optimizar - el dibujo puede ser más rápido si se le dice a la función que el fondo es sólido.
GetBitmap()

wxBitmap wxImageList::GetBitmap(int index) const

Devuelve el mapa de bits correspondiente al índice dado.

GetIcon()

wxIcon wxImageList::GetIcon(int index) const

Devuelve el icono correspondiente al índice dado.

GetImageCount()

virtual int wxImageList::GetImageCount() const

Devuelve el número de imágenes de la lista.

GetSize()

virtual wxSize wxImageList::GetSize() const

Recupera el tamaño de la lista de imágenes tal y como se pasó a Create().

Valor de retorno

El tamaño de la lista de imágenes, que puede ser cero si la lista de imágenes aún no se ha inicializado.

GetSize()

virtual bool wxImageList::GetSize( int index, int & width, int & height ) const

Recupera el tamaño de las imágenes de la lista.

Actualmente, el parámetro index se ignora, ya que todas las imágenes de la lista tienen el mismo tamaño.

Parámetros
index
Actualmente sin usar, debería ser 0.
width
Recibe la anchura de las imágenes de la lista en píxeles.
height
Recibe la altura de las imágenes de la lista en píxeles.
Valor de retornox/h6>

true si la función ha tenido éxito, false si ha fallado (por ejemplo, si la lista de imágenes aún no se ha inicializado).

Remove()

bool wxImageList::Remove(int index)

Elimina la imagen en la posición dada.

RemoveAll()

bool wxImageList::RemoveAll()

Elimina todas las imágenes de la lista.

Replace()

bool wxImageList::Replace( int index, const wxBitmap & bitmap, const wxBitmap & mask = wxNullBitmap )

Sustituye la imagen existente por la nueva imagen.

Parámetros
index
El índice del mapa de bits que se va a reemplazar.
bitmap
Mapa de bits que representa las áreas opacas de la imagen.
mask
Mapa de bits de máscara monocromática, que representa las áreas transparentes de la imagen.
Valor de retorno

true si la sustitución se ha realizado correctamente, false en caso contrario.

Observaciones

El bitmap o icono original no se ve afectado por la operación Replace(), y puede ser eliminado posteriormente.

Replace()

bool wxImageList::Replace( int index, const wxIcon & icon )

Sustituye la imagen existente por la nueva imagen.

Parámetros
index
Índice del mapa de bits que se va a sustituir.
icon
Icono que se va a utilizar como imagen.
Valor de retorno

true si el reemplazo fue exitoso, false en caso contrario.

Observaciones

El mapa de bits o icono original no se ve afectado por la operación Replace(), y puede eliminarse posteriormente.

Disponibilidad

Sólo disponible para los ports wxMSW, wxOSX/Cocoa.

Métodos y datos heredados

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