Clase wxHelpEvent
Se envía un evento de ayuda cuando el usuario ha solicitado ayuda contextual.
Jerarquía:
Esto puede deberse a que la aplicación solicite el modo de ayuda contextual a través de wxContextHelp o (en MS Windows) a que el sistema genere un mensaje WM_HELP cuando el usuario pulsa F1 o hace clic en el botón de consulta de un cuadro de diálogo.
Se envía un evento de ayuda a la ventana en la que el usuario ha hecho clic, y se propaga por la jerarquía de ventanas hasta que se procesa el evento o no hay más manejadores de eventos.
La aplicación debe llamar a wxEvent::GetId para comprobar la identidad de la ventana sobre la que se ha hecho clic y, a continuación, mostrar una ayuda adecuada o llamar a wxEvent::Skip() si no se reconoce el identificador.
Llamar a Skip es importante porque permite a wxWidgets generar más eventos para los ancestros de la ventana sobre la que se ha hecho clic. De otro modo sería imposible mostrar ayuda para las ventanas contenedoras, ya que el proceso se detendría después de la primera ventana encontrada.
Eventos que utilizan esta clase
Las siguientes macros de manejadores de eventos redirigen los eventos a manejadores de funciones miembro 'func' con prototipos como:
void handlerFuncName(wxHelpEvent& event)
Macros de eventos:
- EVT_HELP(id, func)
- Procesa un evento wxEVT_HELP.
- EVT_HELP_RANGE(id1, id2, func)
- Procesa un evento wxEVT_HELP para un rango de ids.
Tipos miembro
Origin()
enum Origin { Origin_Unknown , Origin_Keyboard , Origin_HelpButton }
Indica cómo se generó un wxHelpEvent.
- Origin_Unknown
- Origen de evento no reconocido.
- Origin_Keyboard
- Rvento generado por la pulsación de la tecla F1.
- Origen_HelpButton
- Eevento generado por wxContextHelp o desde el botón [?] de la barra de título (Windows).
Funciones miembro
wxHelpEvent()
wxHelpEvent::wxHelpEvent( wxEventType type = wxEVT_NULL, wxWindowID winid = 0, const wxPoint & pt = wxDefaultPosition, wxHelpEvent::Origin origin = Origin_Unknown )
Constructor.
GetOrigin()
wxHelpEvent::Origin wxHelpEvent::GetOrigin() const
Devuelve el origen del evento de ayuda que es uno de los valores de wxHelpEvent::Origin.
La aplicación puede manejar los eventos generados usando el teclado o el ratón de forma diferente, por ejemplo, usando wxGetMousePosition() para los eventos del ratón.
GetPosition()
const wxPoint& wxHelpEvent::GetPosition() const
Devuelve la posición del botón izquierdo del ratón, en coordenadas de pantalla.
Esto permite a la aplicación posicionar la ayuda adecuadamente.
SetOrigin()
void wxHelpEvent::SetOrigin(wxHelpEvent::Origin origin)
Establece el origen del evento de ayuda, sólo usado internamente por wxWidgets normalmente.
SetPosition()
void wxHelpEvent::SetPosition(const wxPoint & pt)
Establece la posición del ratón al hacer clic con el botón izquierdo, en coordenadas de pantalla.
Métodos y datos heredados
Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject, wxEvent y wxCommandEvent.