radiobox.h

Clase wxRadioBox

Una casilla de radio se utiliza para seleccionar una de varias opciones mutuamente excluyentes.

Jerarquía:

Jerarquía de la clase wxRadioBox

Se muestra como una columna vertical o una fila horizontal de botones etiquetados.

Estilos

Esta clase admite los siguientes estilos:

wxRA_SPECIFY_ROWS
El parámetro de dimensión mayor se refiere al número máximo de filas.
wxRA_SPECIFY_COLS
El parámetro de dimensión mayor se refiere al número máximo de columnas.

Eventos emitidos por esta clase

Las siguientes macros manejadoras de eventos redirigen los eventos a manejadores de funciones miembro 'func' con prototipos como:

void handlerFuncName(wxCommandEvent& event)

Macros para eventos emitidos por esta clase:

EVT_RADIOBOX(id, func)
Procesa un evento wxEVT_RADIOBOX, cuando un radiobutton es pulsado.

Funciones miembro

wxRadioBox()

wxRadioBox::wxRadioBox()

Constructor por defecto.

wxRadioBox()

wxRadioBox::wxRadioBox( wxWindow * parent, wxWindowID id, const wxString & label, const wxPoint & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, int n = 0, const wxString choices[] = nullptr, int majorDimension = 0, long style = wxRA_SPECIFY_COLS, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxRadioBoxNameStr )

Constructor, crea y muestra un radiobox.

Parámetros
parent
Ventana padre. No debe ser nullptr.
id
Identificador de ventana. El valor wxID_ANY indica un valor por defecto.
label
Etiqueta para la caja estática que rodea los botones de radio.
pos
Posición de la ventana. Si se especifica wxDefaultPosition se elige una posición por defecto.
size
Tamaño de la ventana. Si se especifica wxDefaultSize se elige un tamaño por defecto.
n
Número de opciones con las que se inicializa el radiobox.
choices
Un array de opciones con las que inicializar el radiobox.
majorDimension
Especifica el número máximo de filas (si el estilo contiene wxRA_SPECIFY_ROWS) o columnas (si el estilo contiene wxRA_SPECIFY_COLS) para un radiobox bidimensional. El valor por defecto 0 significa utilizar el número de elementos, es decir, n.
style
Estilo de ventana. Véase wxRadioBox.
validator
Validador de la ventana.
name
Nombre de la ventana.

Nota wxPerl: No soportado por wxPerl.

wxRadioBox()

wxRadioBox::wxRadioBox( wxWindow * parent, wxWindowID id, const wxString & label, const wxPoint & pos, const wxSize & size, const wxArrayString & choices, int majorDimension = 0, long style = wxRA_SPECIFY_COLS, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxRadioBoxNameStr )

Constructor, crea y muestra un radiobox.

Parámetros
parent
Ventana padre. No debe ser nullptr.
id
Identificador de la ventana. El valor wxID_ANY indica un valor por defecto.label Etiqueta para la caja estática que rodea los botones de radio.
pos
Posición de la ventana. Si se especifica wxDefaultPosition se elige una posición por defecto.
size
Tamaño de la ventana. Si se especifica wxDefaultSize se elige un tamaño por defecto.
choices
Un array de opciones con las que inicializar el radiobox.
majorDimension
Especifica el número máximo de filas (si el estilo contiene wxRA_SPECIFY_ROWS) o columnas (si el estilo contiene wxRA_SPECIFY_COLS) para un radiobox bidimensional. El valor por defecto de 0 significa utilizar el número de elementos, es decir, el número de elementos en las opciones.
style
Estilo de la ventana. Ver wxRadioBox.
validator
Ventana validator.
name
Nombre de la ventana.

Nota wxPerl: Utilizar una referencia array para el parámetro choices.

~wxRadioBox()

virtual wxRadioBox::~wxRadioBox()

Destructor, destruye el elemento radiobox.

Create()

bool wxRadioBox::Create( wxWindow * parent, wxWindowID id, const wxString & label, const wxPoint & pos, const wxSize & size, const wxArrayString & choices, int majorDimension = 0, long style = wxRA_SPECIFY_COLS, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxRadioBoxNameStr )

Crea el radiobox para la construcción en dos pasos.

Create()

bool wxRadioBox::Create( wxWindow * parent, wxWindowID id, const wxString & label, const wxPoint & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, int n = 0, const wxString choices[] = nullptr, int majorDimension = 0, long style = wxRA_SPECIFY_COLS, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxRadioBoxNameStr )

Crea el radiobox para la construcción en dos pasos.

Enable()

virtual bool wxRadioBox::Enable( unsigned int n, bool enable = true )

Activa o desactiva un botón individual en el radiobox.

Parámetros
enable
true para activar, false para desactivar.
n
El botón de base cero a activar o desactivar.
FindString()

virtual int wxRadioBox::FindString( const wxString & string, bool bCase = false ) const

Busca un botón que coincida con la cadena dada, devolviendo la posición si se encuentra, o wxNOT_FOUND si no se encuentra.

Parámetros
string
La cadena a buscar.
bCase
¿Debe la búsqueda distinguir entre mayúsculas y minúsculas?

Reimplementado de wxItemContainerImmutable.

GetColumnCount()

unsigned int wxRadioBox::GetColumnCount() const

Devuelve el número de columnas del radiobox.

GetCount()

virtual unsigned int wxRadioBox::GetCount() const

Devuelve el número de elementos del control.

GetItemFromPoint()

virtual int wxRadioBox::GetItemFromPoint(const wxPoint & pt) const

Devuelve un elemento de la caja de radio bajo el punto, un índice de elemento basado en cero, o wxNOT_FOUND si no hay ningún elemento bajo el punto.

Parámetros
pt
Punto en coordenadas del cliente.
GetItemHelpText()

wxString wxRadioBox::GetItemHelpText(unsigned int item) const

Devuelve el texto de ayuda asociado al elemento especificado si existe o wxEmptyString.

Parámetros
item
El índice de item basado en cero.
GetItemToolTip()

wxToolTip* wxRadioBox::GetItemToolTip(unsigned int item) const

Devuelve el tooltip asociado al elemento especificado si existe o NULL.

GetRowCount()

unsigned int wxRadioBox::GetRowCount() const

Devuelve el número de filas del radiobox.

GetSelection()

virtual int wxRadioBox::GetSelection() const

Devuelve el índice del elemento seleccionado.

Como los cuadros de radio siempre tienen un elemento seleccionado, el valor de retorno nunca es wxNOT_FOUND para esta clase.

Implementa wxItemContainerImmutable.

GetString()

virtual wxString wxRadioBox::GetString(unsigned int n) const

Devuelve la etiqueta del elemento con el índice dado.

El índice debe ser válido, es decir, menor que el valor devuelto por GetCount(), de lo contrario se lanza un assert. Esta función no puede invocarse si el control está vacío.

Parámetros
n
El índice basado en cero.
Devuelve

La etiqueta del elemento.

IsItemEnabled()

virtual bool wxRadioBox::IsItemEnabled(unsigned int n) const

Devuelve true si el elemento está habilitado o false si fue deshabilitado usando Enable(n, false).

Esta función actualmente solo está implementada en wxMSW, wxGTK, wxQT y wxUniversal y siempre devuelve true en los otros ports.

Parámetros
n
La posición del botón en base cero.
IsItemShown()

virtual bool wxRadioBox::IsItemShown(unsigned int n) const

Devuelve true si el elemento se muestra actualmente o false si se ocultó usando Show(n, false).

Hay que tener en cuenta que esta función devuelve true para un elemento que no ha sido ocultado aunque no se muestre todo el radiobox.

Esta función actualmente solo está implementada en wxMSW, wxGTK, wxQT y wxUniversal y siempre devuelve true en los otros ports.

Parámetros
n
La posición del botón en base cero.
SetItemHelpText()

void wxRadioBox::SetItemHelpText( unsigned int item, const wxString & helptext )

Establece el texto de ayuda de un elemento.

Una cadena vacía borra cualquier texto de ayuda existente.

Parámetros
item
El índice de item basado en cero.
helptext
El texto de ayuda a establecer para el item.
SetItemToolTip()

void wxRadioBox::SetItemToolTip( unsigned int item, const wxString & text )

Establece el texto de la información sobre herramientas para el elemento especificado en el grupo de radio.

Esta función actualmente solo está implementada en wxMSW y wxGTK2 y no hace nada en los otros ports.

Parámetros
item
Índice del ítem para el que se mostrará el tooltip.
text
Texto del tooltip para el ítem, el tooltip se elimina si está vacío.
SetSelection()

virtual void wxRadioBox::SetSelection(int n)

Establece la selección en el elemento dado.

Hay que tener en cuenta que un cuadro de radio siempre tiene selección, por lo que n debe ser válido aquí y pasar wxNOT_FOUND no está permitido.

Implementa wxItemContainerImmutable.

SetString()

virtual void wxRadioBox::SetString( unsigned int n, const wxString & string )

Establece la etiqueta para el elemento dado.

Parámetros
n
El índice del ítem en base cero.
string
La etiqueta a establecer.

Implementa wxItemContainerImmutable.

Show()

virtual bool wxRadioBox::Show( unsigned int item, bool show = true )

Muestra u oculta botones individuales.

Parámetros
show
true para mostrar, false para ocultar.
item
La posición en base cero del botón a mostrar u ocultar.
Devuelve

true si el elemento se ha mostrado u ocultado o false si no se ha hecho nada porque ya estaba en el estado solicitado.

Métodos y datos heredados

Esta clase hereda los métodos y datos miembro públicos y protegidos de wxControl, wxWindow, wxEvtHandler, wxObject wxItemContainerImmutable.