cshelp.h

Clase wxHelpProvider

wxHelpProvider es una clase abstracta utilizada por un programa que implementa la ayuda contextual para mostrar el texto de ayuda de la ventana dada.

Jerarquía:

El proveedor de ayuda actual debe ser establecido explícitamente por la aplicación mediante Set().

Funciones miembro

~wxHelpProvider()

virtual wxHelpProvider::~wxHelpProvider()

Destructor virtual para cualquier clase base.

AddHelp()

virtual void wxHelpProvider::AddHelp( wxWindow * window, const wxString & text )

Asocia el texto a la ventana indicada.

Observaciones

Aunque todos los proveedores de ayuda tienen estas funciones para permitir hacer funcionar wxWindow::SetHelpText(), no todos implementan las funciones.

AddHelp()

virtual void wxHelpProvider::AddHelp( wxWindowID id, const wxString & text )

Asocia el texto con el ID dado.

Este texto de ayuda se mostrará para todas las ventanas con ID id, a menos que tengan asociado un texto de ayuda más específico utilizando el otro prototipo AddHelp(). Puede utilizarse para establecer la misma cadena de ayuda para todos los botones Cancelar de la aplicación, por ejemplo.

Observaciones

Aunque todos los proveedores de ayuda tienen estas funciones para permitir hacer funcionar wxWindow::SetHelpText(), no todos implementan las funciones.

Get()

static wxHelpProvider* wxHelpProvider::Get()

Devuelve el puntero a la instancia del proveedor de ayuda.

A diferencia de otras clases, el proveedor de ayuda no se crea bajo demanda. Esto debe ser hecho explícitamente por la aplicación usando Set().

GetHelp()

virtual wxString wxHelpProvider::GetHelp(const wxWindow * window)

Obtiene el texto de ayuda asociado con la ventana window.

RemoveHelp()

virtual void wxHelpProvider::RemoveHelp(wxWindow * window)

Elimina la asociación entre el puntero de la ventana y el texto de ayuda.

Es llamado por el destructor de wxWindow. Sin esto, la tabla de cadenas de ayuda se llenará y cuando se reutilicen los punteros de ventana, se encontrará la cadena de ayuda incorrecta.

Set()

static wxHelpProvider* wxHelpProvider::Set(wxHelpProvider * helpProvider)

Establece el proveedor de ayuda actual para toda la aplicación.

Valor de retorno

El puntero al proveedor de ayuda anterior o NULL si no había ninguno.

ShowHelp()

virtual bool wxHelpProvider::ShowHelp(wxWindow * window)

Muestra la ayuda para la ventana dada.

Anular esta función si la ayuda no depende de la posición exacta dentro de la ventana, de lo contrario se deberá anular ShowHelpAtPoint(). Devuelve true si la ayuda fue mostrada, o false si no hay ayuda disponible para esta ventana.

ShowHelpAtPoint()

virtual bool wxHelpProvider::ShowHelpAtPoint( wxWindow * window, const wxPoint & point, wxHelpEvent::Origin origin )

Esta función puede ser sobreescrita para mostrar la ayuda de la ventana cuando debe depender de la posición dentro de la ventana, Por defecto este método reenvía a ShowHelp(), por lo que basta con implementar este último si la ayuda no depende de la posición.

Parámetros

window: Ventana para la que mostrar el texto de ayuda.
point: Coordenadas del ratón en el momento de la emisión del evento de ayuda.
origin: Origen del evento de ayuda, ver wxHelpEvent::Origin.

Valor de retorno

true si se mostró ayuda, o false si no había ayuda disponible para esta ventana.