Clase wxCommandEvent
Esta clase de evento contiene información sobre eventos de comando, que se originan en una variedad de controles simples.
Jerarquía:
Hay que tener en cuenta que wxCommandEvent y las clases de eventos derivadas de wxCommandEvent por defecto y a diferencia de otras clases derivadas de wxEvent se propagan hacia arriba desde la ventana de origen (la ventana que emite el evento) hasta el primer padre que procesa el evento.
Controles más complejos, como wxTreeCtrl, tienen clases de eventos de comando separadas.
Eventos que utilizan 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 de eventos:
- EVT_COMMAND(id, event, func)
- Procesa un comando, proporcionando el identificador de la ventana, el identificador del evento del comando y la función miembro.
- EVT_COMMAND_RANGE(id1, id2, event, func)
- Procesa un comando para un rango de identificadores de ventana, suministrando los identificadores de ventana mínimo y máximo, el identificador de evento de comando y la función miembro.
- EVT_BUTTON(id, func)
- Procesa un comando wxEVT_BUTTON, generado por un control wxButton.
- EVT_CHECKBOX(id, func)
- Procesa un comando wxEVT_CHECKBOX, generado por un control wxCheckBox.
- EVT_CHOICE(id, func)
- Procesa un comando wxEVT_CHOICE, generado por un control wxChoice.
- EVT_COMBOBOX(id, func)
- Procesa un comando wxEVT_COMBOBOX, generado por un control wxComboBox.
- EVT_LISTBOX(id, func)
- Procesa un comando wxEVT_LISTBOX, que es generado por un control wxListBox.
- EVT_LISTBOX_DCLICK(id, func)
- Procesa un comando wxEVT_LISTBOX_DCLICK, generado por un control wxListBox.
- EVT_CHECKLISTBOX(id, func)
- Procesa un comando wxEVT_CHECKLISTBOX, generado por un control wxCheckListBox.
- EVT_MENU(id, func)
- Procesa un comando wxEVT_MENU, generado por un elemento de menú.
- EVT_MENU_RANGE(id1, id2, func)
- Procesa un comando wxEVT_MENU, que es generado por un rango de elementos de menú.
- EVT_CONTEXT_MENU(func)
- Procesa el evento generado cuando el usuario ha solicitado que aparezca un menú emergente pulsando una tecla especial del teclado (en Windows) o haciendo clic con el botón derecho del ratón.
- EVT_RADIOBOX(id, func)
- Procesa un comando wxEVT_RADIOBOX, generado por un control wxRadioBox.
- EVT_RADIOBUTTON(id, func)
- Procesa un comando wxEVT_RADIOBUTTON, generado por un control wxRadioButton.
- EVT_SCROLLBAR(id, func)
- Procesa un comando wxEVT_SCROLLBAR, que es generado por un control wxScrollBar. Esto se proporciona sólo por compatibilidad; en su lugar deben utilizarse macros de eventos de barra de desplazamiento más específicas (véase wxScrollEvent).
- EVT_SLIDER(id, func)
- Procesa un comando wxEVT_SLIDER, generado por un control wxSlider.
- EVT_TEXT(id, func):
- Procesa un comando wxEVT_TEXT, generado por un control wxTextCtrl.
- EVT_TEXT_ENTER(id, func)
- Procesa un comando wxEVT_TEXT_ENTER, que es generado por un control wxTextCtrl. Tenga en cuenta que debe utilizar la bandera wxTE_PROCESS_ENTER al crear el control si desea que genere este tipo de eventos.
- EVT_TEXT_MAXLEN(id, func)
- Procesa un comando wxEVT_TEXT_MAXLEN, que es generado por un control wxTextCtrl cuando el usuario intenta introducir en él más caracteres que el límite previamente establecido con SetMaxLength().
- EVT_TOGGLEBUTTON(id, func)
- Procesa un evento wxEVT_TOGGLEBUTTON.
- EVT_TOOL(id, func)
- Procesa un evento wxEVT_TOOL (sinónimo de wxEVT_MENU). Pasa el id de la herramienta.
- EVT_TOOL_RANGE(id1, id2, func)
- Procesa un evento wxEVT_TOOL para un rango de identificadores. Pasa los ids de las herramientas.
- EVT_TOOL_RCLICKED(id, func)
- Procesa un evento wxEVT_TOOL_RCLICKED. Pasa el id de la herramienta. (No disponible en wxOSX.)
- EVT_TOOL_RCLICKED_RANGE(id1, id2, func)
- Procesa un evento wxEVT_TOOL_RCLICKED para un rango de ids. Pasa los ids de las herramientas. (No disponible en wxOSX.)
- EVT_TOOL_ENTER(id, func)
- Procesa un evento wxEVT_TOOL_ENTER. Pasa el id de la propia barra de herramientas. El valor de wxCommandEvent::GetSelection() es el id de la herramienta, o -1 si el cursor del ratón se ha movido fuera de una herramienta. (No disponible en wxOSX.)
- EVT_COMMAND_LEFT_CLICK(id, func)
- Procesa un comando wxEVT_COMMAND_LEFT_CLICK, generado por un control (sólo wxMSW).
- EVT_COMMAND_LEFT_DCLICK(id, func)
- Procesa un comando wxEVT_COMMAND_LEFT_DCLICK, generado por un control (sólo wxMSW).
- EVT_COMMAND_RIGHT_CLICK(id, func)
- Procesa un comando wxEVT_COMMAND_RIGHT_CLICK, generado por un control (sólo wxMSW).
- EVT_COMMAND_SET_FOCUS(id, func)
- Procesa un comando wxEVT_COMMAND_SET_FOCUS, generado por un control (sólo wxMSW).
- EVT_COMMAND_KILL_FOCUS(id, func)
- Procesa un comando wxEVT_COMMAND_KILL_FOCUS, generado por un control (sólo wxMSW).
- EVT_COMMAND_ENTER(id, func)
- Procesa un comando wxEVT_COMMAND_ENTER, generado por un control.
Funciones miembro
wxCommandEvent()
wxCommandEvent::wxCommandEvent( wxEventType commandEventType = wxEVT_NULL, int id = 0 )
Constructor.
GetClientData()
void* wxCommandEvent::GetClientData() const
Devuelve el puntero de datos del cliente para un evento de listbox o de selección (no válido para una deselección).
GetClientObject()
wxClientData* wxCommandEvent::GetClientObject() const
Devuelve el puntero de objeto del cliente para un evento de listbox o de selección (no válido para una deselección).
GetExtraLong()
long wxCommandEvent::GetExtraLong() const
Devuelve información extra que depende del tipo de objeto del evento.
Si el evento proviene de la selección de un listbox, es un booleano que determina si el evento fue una selección (true) o una deselección (false). Una deselección de un listbox solo se produce en los cuadros de selección múltiple, y en este caso los valores de índice y cadena son indeterminados y el listbox debe ser examinado por la aplicación.
GetInt()
int wxCommandEvent::GetInt() const
Devuelve el identificador entero correspondiente a una selección de listbox, choice o radiobox (solo si el evento fue una selección, no una deselección), o un valor booleano que representa el valor de una casilla de verificación.
Para un elemento de menú, este método devuelve -1 si el elemento no es seleccionable o un valor booleano (verdadero o falso) para los elementos seleccionables que indica el nuevo estado del elemento.
GetSelection()
int wxCommandEvent::GetSelection() const
Devuelve el índice del elemento para un evento de selección de lista o elección (no válido para una deselección).
GetString()
wxString wxCommandEvent::GetString() const
Devuelve la cadena del elemento para un evento de selección de lista o elección.
Si se han deseleccionado uno o varios elementos, devuelve el índice del primer elemento deseleccionado. Si algunos elementos han sido seleccionados y otros deseleccionados al mismo tiempo, devuelve el índice del primer elemento seleccionado.
IsChecked()
bool wxCommandEvent::IsChecked() const
Este método se puede utilizar con eventos de casilla de verificación y de menú: para las casillas de verificación, el método devuelve true para un evento de selección y false para uno de deselección.
Para los eventos de menú, este método indica si el elemento de menú acaba de ser marcado o desmarcado (y por tanto solo tiene sentido para elementos de menú marcables).
hay que tener en cuenta que este método no se puede utilizar actualmente con wxCheckListBox.
IsSelection()
bool wxCommandEvent::IsSelection() const
Para un evento listbox o similar, devuelve true si es una selección, false si es una deselección.
Si algunos elementos han sido seleccionados y otros deseleccionados al mismo tiempo, devolverá true.
SetClientData()
void wxCommandEvent::SetClientData(void * clientData)
Establece los datos del cliente para este evento.
SetClientObject()
void wxCommandEvent::SetClientObject(wxClientData * clientObject)
Establece el objeto cliente para este evento.
El objeto cliente no es propiedad del objeto evento y el objeto evento no borrará el objeto cliente en su destructor.
El objeto cliente debe pertenecer y ser eliminado por otro objeto (por ejemplo, un control) que tenga un tiempo de vida más largo que el objeto evento.
SetExtraLong()
void wxCommandEvent::SetExtraLong(long extraLong)
Establece el miembro m_extraLong.
SetInt()
void wxCommandEvent::SetInt(int intCommand)
Establece el miembro m_commandInt.
SetString()
void wxCommandEvent::SetString(const wxString & string)
Establece el miembro m_commandString.
Métodos y datos heredados
Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject y wxEvent.