listctrl.h

Clase wxListItem

Esta clase almacena información sobre un elemento o columna de wxListCtrl.

Jerarquía:

Jerarquía de la clase wxListItem

wxListItem es una clase que contiene información sobre:

  • Posición del elemento basada en cero; véase SetId() y GetId().
  • Índice de columna basado en cero; véase SetColumn() y GetColumn().
  • La etiqueta (o cabecera de las columnas); véase SetText() y GetText().
  • El índice basado en cero en una lista de imágenes; véase GetImage() y SetImage().
  • Datos definidos por la aplicación; véase SetData() y GetData().
  • Sólo para columnas: la anchura de la columna; véase SetWidth() y GetWidth().
  • Sólo para columnas: el formato de la columna; uno de wxLIST_FORMAT_LEFT, wxLIST_FORMAT_RIGHT, wxLIST_FORMAT_CENTRE. Véase SetAlign() y GetAlign().
  • El estado del elemento; véase SetState() y GetState(). Se trata de una lista de bits de los siguientes indicadores:
    • wxLIST_STATE_FOCUSED: El elemento tiene el foco.
    • wxLIST_STATE_SELECTED: El elemento está seleccionado.
    • wxLIST_STATE_DONTCARE: Sin banderas especiales (el valor de esta constante es 0).
    • wxLIST_STATE_DROPHILITED: El elemento está resaltado para recibir un evento de caída. Sólo Win32.
    • wxLIST_STATE_CUT: El ítem está en estado de corte. Sólo Win32.
  • Una máscara que indica qué indicadores de estado son válidos; se trata de una lista de bits de los indicadores indicados anteriormente para el estado del elemento. Véase SetStateMask() y GetStateMask().
  • Una máscara que indica qué campos de esta clase son válidos; véase SetMask() y GetMask(). Es una lista de bits de las siguientes banderas:
    • wxLIST_MASK_STATE: El campo de estado es válido.
    • wxLIST_MASK_TEXT: El campo label es válido.
    • wxLIST_MASK_IMAGE: El campo imagen es válido.
    • wxLIST_MASK_DATA: El campo de datos definido por la aplicación es válido.
    • wxLIST_MASK_WIDTH: El campo ancho de columna es válido.
    • wxLIST_MASK_FORMAT: El campo de formato de columna es válido.

El objeto wxListItem también puede contener información de color y fuente específica del elemento: para ello es necesario llamar a una de las funciones SetTextColour(), SetBackgroundColour() o SetFont() pasándole el color/fuente a utilizar. Si no se especifica el color o la fuente, se utilizará el color o la fuente por defecto del control de lista.

Funciones miembro

wxListItem()

wxListItem::wxListItem()

Constructor.

Clear()

void wxListItem::Clear()

Restablece el estado predeterminado del elemento.

GetAlign()

wxListColumnFormat wxListItem::GetAlign()const

Devuelve la alineación de este elemento.

Puede ser wxLIST_FORMAT_LEFT, wxLIST_FORMAT_RIGHT o wxLIST_FORMAT_CENTRE.

GetBackgroundColour()

wxColour wxListItem::GetBackgroundColour() const

Devuelve el color de fondo de este elemento.

GetColumn()

int wxListItem::GetColumn() const

Devuelve la columna de base cero; sólo tiene sentido en modo informe.

GetData()

wxUIntPtr< wxListItem::GetData() const

Devuelve los datos del cliente asociados al control.

Hay que tener en cuenta que los datos del cliente se asocian al ítem y no a los subítems.

GetFont()

wxFont wxListItem::GetFont() const

Devuelve la fuente utilizada para mostrar el elemento.

GetId()

long wxListItem::GetId() const

Devuelve la posición del elemento basada en cero.

GetImage()

int wxListItem::GetImage() const

Devuelve el índice de base cero de la imagen asociada al elemento en la lista de imágenes.

GetMask()

long wxListItem::GetMask() const

Devuelve una máscara de bits que indica qué campos de la estructura son válidos.

Puede ser cualquier combinación de los siguientes valores:

  • wxLIST_MASK_STATE: GetState es válido.
  • wxLIST_MASK_TEXT: GetText es válido.
  • wxLIST_MASK_IMAGE: GetImage es válido.
  • wxLIST_MASK_DATA: GetData es válido.
  • wxLIST_MASK_WIDTH: GetWidth es válido.
  • wxLIST_MASK_FORMAT: GetFormat es válido.
GetState()

long wxListItem::GetState() const

Devuelve un campo de bits que representa el estado del elemento.

Puede ser cualquier combinación de:

  • wxLIST_STATE_DONTCARE: Sin banderas especiales (el valor de esta constante es 0).
  • wxLIST_STATE_DROPHILITED: El elemento está resaltado para recibir un evento de drop. Sólo Win32.
  • wxLIST_STATE_FOCUSED: El ítem tiene el foco.
  • wxLIST_STATE_SELECTED: El ítem está seleccionado.
  • wxLIST_STATE_CUT: El ítem está en estado cortado. Sólo Win32.
GetText()

const wxString& wxListItem::GetText() const

Devuelve el texto de la etiqueta/cabecera.

GetTextColour()

wxColour wxListItem::GetTextColour() const

Devuelve el color del texto.

GetWidth()

int wxListItem::GetWidth() const

Sólo tiene sentido para cabeceras de columna en modo informe.

Devuelve el ancho de la columna.

SetAlign()

void wxListItem::SetAlign(wxListColumnFormat align)

Establece la alineación del elemento.

SetBackgroundColour()

void wxListItem::SetBackgroundColour(const wxColour & colBack)

Establece el color de fondo del elemento.

SetColumn()

void wxListItem::SetColumn(int col)

Establece la columna de base cero.

Sólo tiene sentido en el modo de informe.

SetData()

void wxListItem::SetData(long data)

Establece los datos del cliente para el artículo.

Hay que tener en cuenta que los datos del cliente se asocian al ítem y no a los subítems.

SetData()

void wxListItem::SetData(void * data)

Establece los datos del cliente para el artículo.

Hay que tener en cuenta que los datos del cliente se asocian al ítem y no a los subítems.

SetFont()

void wxListItem::SetFont(const wxFont & font)

Establece la fuente para el ítem.

SetId()

void wxListItem::SetId(long id)

Establece la posición basada en cero del ítem.

SetImage()

void wxListItem::SetImage(int image)

Establece el índice basado en cero de la imagen dentro de la lista de imágenes asociada con el ítem.

SetMask()

void wxListItem::SetMask(long mask)

Establece la máscara de campos válidos.

SetState()

void wxListItem::SetState(long state)

Establece las banderas de estado del elemento (hay que tener en cuenta que las banderas de estado válidas están influenciadas por el valor de la máscara de estado, ver wxListItem::SetStateMask).

Ver GetState() para los valores válidos de las banderas.

SetStateMask()

void wxListItem::SetStateMask(long stateMask)

Establece la máscara de bits que se utiliza para determinar cuáles de las banderas de estado se van a establecer.

SetText()

void wxListItem::SetText(const wxString & text)

Establece la etiqueta para el ítem.

SetTextColour()

void wxListItem::SetTextColour(const wxColour & colText)

Establece el color del texto para el ítem.

SetWidth()

void wxListItem::SetWidth(int width)

Sólo tiene sentido para las cabeceras de columna en modo informe.

Establece el ancho de la columna.

Métodos y datos heredados

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