cshelp.h

Clase wxContextHelp

Esta clase cambia el cursor por una consulta y pone la aplicación en "modo de ayuda contextual".

Jerarquía:

Cuando el usuario hace clic con el botón izquierdo del ratón en una ventana dentro de la ventana especificada, se envía un evento wxEVT_HELP a ese control, y la aplicación puede responder a él mostrando algo de ayuda.

Por ejemplo:

wxContextHelp contextHelp(myWindow);

Hay un par de maneras de invocar este comportamiento implícitamente:

  • Utilizar el estilo wxDIALOG_EX_CONTEXTHELP para un diálogo (solo Windows). Esto pondrá un signo de interrogación en la barra de título, y Windows pondrá la aplicación en modo de ayuda contextual automáticamente, con programación adicional.
  • Crear un wxContextHelpButton, cuyo comportamiento predefinido es crear un objeto de ayuda contextual. Normalmente se escribirá la aplicación de forma que este botón solo se añada a un diálogo para plataformas no Windows (utilizar wxDIALOG_EX_CONTEXTHELP en Windows).

Hay que tener en cuenta que en macOS, el cursor no cambia cuando se está en modo de ayuda contextual.

Funciones miembro

wxContextHelp()

wxContextHelp::wxContextHelp( wxWindow * window = NULL, bool doNow = true )

Construye un objeto de ayuda contextual, llamando a BeginContextHelp() si doNow es true (por defecto).

Si window es NULL, se utiliza la ventana superior.

~wxContextHelp()

virtual wxContextHelp::~wxContextHelp()

Destruye el objeto de ayuda contextual.

BeginContextHelp()

bool wxContextHelp::BeginContextHelp(wxWindow * window)

Pone la aplicación en modo de ayuda sensible al contexto.

window es la ventana que se utilizará para capturar eventos; si es NULL, se utilizará la ventana superior.

Devuelve true si la aplicación se ha puesto con éxito en modo de ayuda sensible al contexto. Esta función solo devuelve cuando el bucle de eventos ha finalizado.

EndContextHelp()

bool wxContextHelp::EndContextHelp()

Finaliza el modo de ayuda contextual.

Normalmente no es llamado por la aplicación.

Métodos y datos heredados

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