Clase CToolTipCtrl

  • Artículo

En esta clase, se encapsula la funcionalidad de un "control de información sobre herramientas": una pequeña ventana emergente que se usa para mostrar una única línea de texto donde se describe el propósito de una de las herramientas de una aplicación.

Sintaxis

class CToolTipCtrl : public CWnd

Miembros

Constructores públicos

Nombre Descripción
CToolTipCtrl::CToolTipCtrl Construye un objeto CToolTipCtrl.

Métodos públicos

Nombre Descripción
CToolTipCtrl::Activate Esta función se usa para activar y desactivar un control de información sobre herramientas.
CToolTipCtrl::AddTool Esta función se usa para registrar una herramienta en el control de información sobre herramientas.
CToolTipCtrl::AdjustRect Esta función se usa para convertir el rectángulo de presentación de texto de un control de información sobre herramientas en su rectángulo de ventana y viceversa.
CToolTipCtrl::Create Esta función se usa para crear un control de información sobre herramientas y asociarlo con un objeto CToolTipCtrl.
CToolTipCtrl::CreateEx Esta función se usa para crear un control de información sobre herramientas con los estilos extendidos de Windows que se especifiquen y asociarlo con un objeto CToolTipCtrl.
CToolTipCtrl::DelTool Esta función se usa para quitar una herramienta del control de información sobre herramientas.
CToolTipCtrl::GetBubbleSize Esta función se usa para recuperar el tamaño de un control de información sobre herramientas.
CToolTipCtrl::GetCurrentTool Esta función se usa para recuperar información, como el tamaño, la posición y el texto de la ventana de información sobre herramientas donde se muestra el control de información sobre herramientas actual.
CToolTipCtrl::GetDelayTime Esta función se usa para recuperar las duraciones iniciales, emergentes y de muestra posterior que estén establecidas actualmente para un control de información sobre herramientas.
CToolTipCtrl::GetMargin Esta función se usa para recuperar los márgenes superior, izquierdo, inferior y derecho que estén establecidos para una ventana de información sobre herramientas.
CToolTipCtrl::GetMaxTipWidth Esta función se usa para recuperar el ancho máximo de una ventana de información sobre herramientas.
CToolTipCtrl::GetText Esta función se usa para recuperar el texto que se mantiene en un control de información sobre herramientas en relación con una herramienta.
CToolTipCtrl::GetTipBkColor Esta función se usa para recuperar el color de fondo de una ventana de información sobre herramientas.
CToolTipCtrl::GetTipTextColor Esta función se usa para recuperar el color del texto de una ventana de información sobre herramientas.
CToolTipCtrl::GetTitle Esta función se usa para recuperar el título del control de información sobre herramientas actual.
CToolTipCtrl::GetToolCount Esta función se usa para recuperar un recuento de las herramientas que se mantienen en un control de información sobre herramientas.
CToolTipCtrl::GetToolInfo Esta función se usa para recuperar la información que se mantiene en un control de información sobre herramientas en relación con una herramienta.
CToolTipCtrl::HitTest Esta función se usa para comprobar un punto y determinar si este se ubica dentro del rectángulo delimitador de la herramienta que se especifique. Si es así, se recuperará información sobre esa herramienta.
CToolTipCtrl::Pop Esta función se usa para quitar una ventana de información sobre herramientas que se está mostrando de la vista.
CToolTipCtrl::Popup Esta función se usa para hacer que el control de información sobre herramientas actual se muestre en las coordenadas del último mensaje del mouse.
CToolTipCtrl::RelayEvent Esta función se usa para pasar un mensaje del mouse a un control de información sobre herramientas para su procesamiento.
CToolTipCtrl::SetDelayTime Esta función se usa para establecer las duraciones iniciales, emergentes y de muestra posterior de un control de información sobre herramientas.
CToolTipCtrl::SetMargin Esta función se usa para establecer los márgenes superior, izquierdo, inferior y derecho de una ventana de información sobre herramientas.
CToolTipCtrl::SetMaxTipWidth Esta función se usa para establecer el ancho máximo de una ventana de información sobre herramientas.
CToolTipCtrl::SetTipBkColor Esta función se usa para establecer el color de fondo de una ventana de información sobre herramientas.
CToolTipCtrl::SetTipTextColor Esta función se usa para establecer el color del texto de una ventana de información sobre herramientas.
CToolTipCtrl::SetTitle Esta función se usa para agregar un icono y una cadena de título estándar a una información sobre herramientas.
CToolTipCtrl::SetToolInfo Esta función se usa para establecer la información que se mantiene en una información sobre herramientas en relación con una herramienta.
CToolTipCtrl::SetToolRect Esta función se usa para establecer un nuevo rectángulo delimitador para una herramienta.
CToolTipCtrl::SetWindowTheme Esta función se usa para establecer el estilo visual de una ventana de información sobre herramientas.
CToolTipCtrl::Update Esta función se usa para forzar que la herramienta actual vuelva a dibujarse.
CToolTipCtrl::UpdateTipText Esta función se usa para establecer el texto de información sobre herramientas de una herramienta.

Comentarios

Una "herramienta" es una ventana, como una ventana secundaria o un control, o bien un área rectangular que se define en la aplicación, concretamente dentro del área cliente de una ventana. Los objetos de información sobre herramientas están ocultos la mayor parte del tiempo: estos solo aparecen cuando el usuario coloca el cursor sobre una herramienta y lo deja allí durante, aproximadamente, medio segundo. Cuando esto sucede, la información sobre herramientas aparece cerca del cursor. Después, cuando el usuario hace clic en un botón del mouse o mueve el cursor fuera de la herramienta, esta desaparece.

En la clase CToolTipCtrl, se proporciona la funcionalidad que permite controlar el tiempo inicial y la duración de la información sobre herramientas, los anchos de margen que rodean al texto de la información sobre herramientas, el ancho de la propia ventana de información sobre herramientas y, por último, el color del fondo y el texto de la información sobre herramientas. Es posible proporcionar información sobre más de una herramienta mediante un único control de información sobre herramientas.

En la clase CToolTipCtrl, se proporciona la funcionalidad del control de información sobre herramientas común de Windows. Este control (y, por tanto, la clase CToolTipCtrl) solo está disponible para los programas que se ejecutan en Windows 95/98 y Windows NT 3.51, así como en las versiones posteriores de estos.

Para obtener más información sobre cómo habilitar los elementos de información sobre herramientas, consulte Informaciones sobre herramientas en Windows que no derivan de CFrameWnd.

Para obtener más información sobre el uso de la clase CToolTipCtrl, consulte Controles y Uso de CToolTipCtrl.

Jerarquía de herencia

CObject

CCmdTarget

CWnd

CToolTipCtrl

Requisitos

Encabezadoafxcmn.h:

CToolTipCtrl::Activate

Llame a esta función para activar o desactivar un control de información sobre herramientas.

void Activate(BOOL bActivate);

Parámetros

bActivate
El valor de este parámetro se usa para especificar si el control de información sobre herramientas se va a activar o desactivar.

Comentarios

Si el valor del parámetro bActivate es TRUE, el control se activará; si es FALSE, se desactivará.

Si un control de información sobre herramientas está activo, la información sobre herramientas aparecerá cuando el cursor se coloque sobre una herramienta que se haya registrado con ese control. Por otro lado, cuando está inactivo, la información sobre herramientas no aparecerá aunque el cursor se coloque sobre la herramienta.

Ejemplo

Vea el ejemplo de CPropertySheet::GetTabControl.

CToolTipCtrl::AddTool

Esta función se usa para registrar una herramienta en el control de información sobre herramientas.

BOOL AddTool(
    CWnd* pWnd,
    UINT nIDText,
    LPCRECT lpRectTool = NULL,
    UINT_PTR nIDTool = 0);

BOOL AddTool(
    CWnd* pWnd,
    LPCTSTR lpszText = LPSTR_TEXTCALLBACK,
    LPCRECT lpRectTool = NULL,
    UINT_PTR nIDTool = 0);

Parámetros

pWnd
El valor de este parámetro se corresponde con un puntero que apunta a la ventana donde se muestra la herramienta.

nIDText
El valor de este parámetro se corresponde con el id. del recurso de cadena donde se almacena el texto sobre la herramienta.

lpRectTool
El valor de este parámetro se corresponde con un puntero que apunta a una estructura RECT, donde se incluyen las coordenadas del rectángulo delimitador de la herramienta. Estas coordenadas son relativas a la esquina superior izquierda del área cliente de la ventana que se identifica mediante el parámetro pWnd.

nIDTool
El valor de este parámetro se corresponde con el id. de la herramienta.

lpszText
El valor de este parámetro se corresponde con un puntero que apunta al texto sobre la herramienta. Si en este parámetro se incluye el valor LPSTR_TEXTCALLBACK, los mensajes de notificación TTN_NEEDTEXT irán al elemento primario de la ventana a la que se apunta desde el parámetro pWnd.

Valor devuelto

Si es correcta, su valor es distinto de cero. En caso contrario, es cero.

Comentarios

Los parámetros lpRectTool y nIDTool deben ser válidos; alternativamente, si el valor del parámetro lpRectTool es NULL, el valor de nIDTool deberá ser 0.

Es posible asociar un control de información sobre herramientas con más de una herramienta. Llame a esta función para registrar una herramienta en el control de información sobre herramientas, de modo que la información que se almacene en la información sobre herramientas se muestre cuando el cursor se coloque sobre la herramienta.

Nota:

No es posible usar la función AddTool para establecer una información sobre herramientas en un control estático.

Ejemplo

Vea el ejemplo de CPropertySheet::GetTabControl.

CToolTipCtrl::AdjustRect

Esta función se usa para convertir el rectángulo de presentación de texto de un control de información sobre herramientas en su rectángulo de ventana y viceversa.

BOOL AdjustRect(
    LPRECT lprc,
    BOOL bLarger = TRUE);

Parámetros

lprc
El valor de este parámetro se corresponde con un puntero que apunta a una estructura RECT, donde se almacena un rectángulo de ventana de información sobre herramientas o un rectángulo de presentación de texto.

bLarger
Si el valor de este parámetro es TRUE, el parámetro lprc se usará para especificar un rectángulo de presentación de texto y se obtendrá el rectángulo de ventana correspondiente. Si el valor de este parámetro es FALSE, el parámetro lprc se usará para especificar un rectángulo de ventana y se obtendrá el rectángulo de presentación de texto correspondiente.

Valor devuelto

El valor devuelto será distinto de cero si el rectángulo se ajusta correctamente; de lo contrario, será 0.

Comentarios

Esta función miembro se usa para calcular el rectángulo de presentación de texto de un control de información sobre herramientas a partir de su rectángulo de ventana o, alternativamente, para calcular el rectángulo de la ventana de información sobre herramientas que se necesita para mostrar el rectángulo de presentación de texto que se especifique.

En esta función miembro, se implementa el comportamiento del mensaje TTM_ADJUSTRECT de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::Create

Esta función se usa para crear un control de información sobre herramientas y asociarlo con un objeto CToolTipCtrl.

virtual BOOL Create(CWnd* pParentWnd, DWORD dwStyle = 0);

Parámetros

pParentWnd
El valor de este parámetro se usa para especificar la ventana primaria del control de información sobre herramientas, que suele ser un elemento CDialog. Este valor no debe ser NULL.

dwStyle
El valor de este parámetro se usa para especificar el estilo del control de información sobre herramientas. Consulte la sección Comentarios para obtener más información.

Valor devuelto

El valor devuelto será distinto de cero si el objeto CToolTipCtrl se crea correctamente; en caso contrario, será 0.

Comentarios

El proceso de construcción de un elemento CToolTipCtrl se divide en dos pasos. En primer lugar, debe llamar al constructor para hacer que se construya el objeto CToolTipCtrl. Después, debe llamar a la función Create para hacer que el control de información sobre herramientas se cree y se asocie con el objeto CToolTipCtrl.

El valor del parámetro dwStyle puede establecerse con cualquier combinación de Estilos de ventana. Además, los controles de información sobre herramientas tienen dos estilos específicos de la clase: TTS_ALWAYSTIP y TTS_NOPREFIX.

Estilo Significado
TTS_ALWAYSTIP Este estilo se usa para especificar que la información sobre herramientas deberá aparecer cuando el cursor se coloque sobre una herramienta, independientemente de que la ventana de propietario del control de información sobre herramientas esté activa o inactiva. Si no usa este estilo, el control de información sobre herramientas aparecerá cuando la ventana propietaria de la herramienta esté activa, pero no cuando esté inactiva.
TTS_NOPREFIX Al usar este estilo, se impide que se quite el carácter Y comercial (&) de una cadena desde el sistema. Si el estilo TTS_NOPREFIX no se usa en un control de información sobre herramientas, se quitarán automáticamente los caracteres Y comercial desde el sistema. Esto permitirá que, en una aplicación, se use la misma cadena como elemento de menú y como texto en un control de información sobre herramientas.

Los controles de información sobre herramientas tienen los estilos de ventana WS_POPUP y WS_EX_TOOLWINDOW, independientemente de si se especifican durante el proceso de creación del control.

Para crear un control de información sobre herramientas con estilos de ventana extendidos, llame a la función CToolTipCtrl::CreateEx en lugar de a Create.

Ejemplo

Vea el ejemplo de CPropertySheet::GetTabControl.

CToolTipCtrl::CreateEx

Esta función puede usarse para crear un control (una ventana secundaria) y asociarlo con el objeto CToolTipCtrl.

virtual BOOL CreateEx(
    CWnd* pParentWnd,
    DWORD dwStyle = 0,
    DWORD dwStyleEx = 0);

Parámetros

pParentWnd
Un puntero a la ventana que constituye el elemento primario del control.

dwStyle
El valor de este parámetro se usa para especificar el estilo del control de información sobre herramientas. Para obtener más información, consulte la sección Comentarios de la función Create.

dwStyleEx
El valor de este parámetro se usa para especificar el estilo extendido del control que se va a crear. Para obtener una lista de estilos extendidos de Windows, consulte el parámetro dwExStyle de la función CreateWindowEx en Windows SDK.

Valor devuelto

Distinto de cero si se realiza correctamente; de lo contrario, 0.

Comentarios

Usa la función CreateEx, en lugar de Create, para aplicar estilos extendidos de Windows. Estos se especifican en el prefacio de estilo extendido WS_EX_ de Windows.

CToolTipCtrl::CToolTipCtrl

Construye un objeto CToolTipCtrl.

CToolTipCtrl();

Comentarios

Debe llamar a Create después de que se construya el objeto.

Ejemplo

// Declare a CToolTipCtrl object.
CToolTipCtrl m_ToolTipCtrl;

CToolTipCtrl::DelTool

Esta función se usa para quitar la herramienta que se especifica mediante los parámetros pWnd y nIDTool de la colección de herramientas que se admiten en un control de información sobre herramientas.

void DelTool(
    CWnd* pWnd,
    UINT_PTR nIDTool = 0);

Parámetros

pWnd
El valor de este parámetro se corresponde con un puntero que apunta a la ventana donde se muestra la herramienta.

nIDTool
El valor de este parámetro se corresponde con el id. de la herramienta.

CToolTipCtrl::GetBubbleSize

Esta función se usa para recuperar el tamaño de un control de información sobre herramientas.

CSize GetBubbleSize(LPTOOLINFO lpToolInfo) const;

Parámetros

lpToolInfo
El valor de este parámetro se corresponde con un puntero que apunta a la estructura TOOLINFO de la información sobre herramientas.

Valor devuelto

El valor que se devuelve se corresponde con el tamaño de la información sobre herramientas.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_GETBUBBLESIZE de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::GetCurrentTool

Esta función se usa para recuperar información, como el tamaño, la posición y el texto de la ventana de información sobre herramientas que se muestra en el control de información sobre herramientas actual.

BOOL GetCurrentTool(LPTOOLINFO lpToolInfo) const;

Parámetros

lpToolInfo
[out] El valor de este parámetro se corresponde con un puntero que apunta a una estructura TOOLINFO, donde se obtiene información sobre la ventana de información sobre herramientas actual.

Valor devuelto

El valor devuelto será TRUE si la información se recupera correctamente; de lo contrario, será FALSE.

Comentarios

Al usar este método, se envía el mensaje TTM_GETCURRENTTOOL, que se describe en Windows SDK.

Ejemplo

Al ejecutar el siguiente ejemplo de código, se recupera información sobre la ventana de información sobre herramientas actual.

{
    //Get information about the current tooltip. 
    TOOLINFO tInfo = {0};
    tInfo.cbSize = sizeof(TOOLINFO);
    CToolBarCtrl& m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
    CToolTipCtrl* m_toolTip = m_toolBarCtrl.GetToolTips();
    BOOL bRet = m_toolTip->GetCurrentTool( &tInfo );
}

CToolTipCtrl::GetDelayTime

Esta función se usa para recuperar las duraciones iniciales, emergentes y de muestra posterior que estén establecidas actualmente para un control de información sobre herramientas.

int GetDelayTime(DWORD dwDuration) const;

Parámetros

dwDuration
El valor de este parámetro se corresponde con una marca que se usa para especificar qué valor de duración se recuperará. Este parámetro puede establecerse con uno de los siguientes valores:

  • TTDT_AUTOPOP: este valor se usa para recuperar el período de tiempo durante el que la ventana de información sobre herramientas permanecerá visible si el puntero está estacionado dentro del rectángulo delimitador de una herramienta.

  • TTDT_INITIAL: este valor se usa para recuperar el período de tiempo durante el que el puntero deberá permanecer estacionario dentro del rectángulo delimitador de una herramienta antes de que aparezca la ventana de información sobre herramientas.

  • TTDT_RESHOW: este valor se usa para recuperar el período de tiempo que debe transcurrir para que las ventanas de información sobre herramientas posteriores aparezcan a medida que el puntero pasa de una herramienta a otra.

Valor devuelto

El valor devuelto se corresponde con el tiempo de retraso que se especifica, en milisegundos.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_GETDELAYTIME de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::GetMargin

Esta función se usa para recuperar los márgenes superior, izquierdo, inferior y derecho que estén establecidos para una ventana de información sobre herramientas.

void GetMargin(LPRECT lprc) const;

Parámetros

lprc
El valor de este parámetro se corresponde con la dirección de una estructura RECT, donde se recibirá la información de margen. Los miembros de la estructura RECT no se usan para definir un rectángulo delimitador. En el caso de este mensaje, los miembros de la estructura se interpretan de la siguiente manera:

Miembro Representación
top Este miembro se corresponde con la distancia, en píxeles, entre el borde superior y el extremo superior del texto de la información sobre herramientas.
left Este miembro se corresponde con la distancia, en píxeles, entre el borde izquierdo y el extremo izquierdo del texto de la información sobre herramientas.
bottom Este miembro se corresponde con la distancia, en píxeles, entre el borde inferior y el extremo inferior del texto de la información sobre herramientas.
right Este miembro se corresponde con la distancia, en píxeles, entre el borde derecho y el extremo derecho del texto de la información sobre herramientas.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_GETMARGIN de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::GetMaxTipWidth

Esta función se usa para recuperar el ancho máximo de una ventana de información sobre herramientas.

int GetMaxTipWidth() const;

Valor devuelto

El valor devuelto se corresponde con el ancho máximo de una ventana de información sobre herramientas.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_GETMAXTIPWIDTH de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::GetText

Esta función se usa para recuperar el texto que se mantiene en un control de información sobre herramientas en relación con una herramienta.

void GetText(
    CString& str,
    CWnd* pWnd,
    UINT_PTR nIDTool = 0) const;

Parámetros

str
El valor de este parámetro se corresponde con una referencia a un objeto CString, donde se recibe el texto sobre la herramienta.

pWnd
El valor de este parámetro se corresponde con un puntero que apunta a la ventana donde se muestra la herramienta.

nIDTool
El valor de este parámetro se corresponde con el id. de la herramienta.

Comentarios

Los parámetros pWnd y nIDTool se usan para identificar la herramienta. Si esa herramienta se ha registrado previamente en el control de información sobre herramientas mediante una llamada a la función CToolTipCtrl::AddTool, el texto sobre la herramienta se asignará al objeto al que se hace referencia en el parámetro str.

CToolTipCtrl::GetTipBkColor

Esta función se usa para recuperar el color de fondo de una ventana de información sobre herramientas.

COLORREF GetTipBkColor() const;

Valor devuelto

Valor COLORREF que representa el color de fondo.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_GETTIPBKCOLOR de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::GetTipTextColor

Esta función se usa para recuperar el color del texto de una ventana de información sobre herramientas.

COLORREF GetTipTextColor() const;

Valor devuelto

El valor devuelto será un valor COLORREF que se usa para representar el color del texto.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_GETTIPTEXTCOLOR de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::GetTitle

Esta función se usa para recuperar el título del control de información sobre herramientas actual.

void GetTitle(PTTGETTITLE pttgt) const;

Parámetros

pttgt
[out] El valor de este parámetro se corresponde con un puntero que apunta a una estructura TTGETTITLE, donde se almacena la información sobre el control de información sobre herramientas. Cuando este método se devuelva, se apuntará al texto del título desde el miembro pszTitle de la estructura TTGETTITLE.

Comentarios

Al usar este método, se envía el mensaje TTM_GETTITLE, que se describe en Windows SDK.

CToolTipCtrl::GetToolCount

Esta función se usa para recuperar un recuento de las herramientas que se registran en un control de información sobre herramientas.

int GetToolCount() const;

Valor devuelto

El valor devuelto se corresponderá con un recuento de las herramientas que se registraron en un control de información sobre herramientas.

CToolTipCtrl::GetToolInfo

Esta función se usa para recuperar la información que se mantiene en un control de información sobre herramientas en relación con una herramienta.

BOOL GetToolInfo(
    CToolInfo& ToolInfo,
    CWnd* pWnd,
    UINT_PTR nIDTool = 0) const;

Parámetros

ToolInfo
El valor de este parámetro se corresponde con una referencia a un objeto TOOLINFO, donde se recibe el texto sobre la herramienta.

pWnd
El valor de este parámetro se corresponde con un puntero que apunta a la ventana donde se muestra la herramienta.

nIDTool
El valor de este parámetro se corresponde con el id. de la herramienta.

Valor devuelto

Si es correcta, su valor es distinto de cero. En caso contrario, es cero.

Comentarios

Los miembros hwnd y uId de la estructura TOOLINFO, a los que se hace referencia mediante el valor del parámetro CToolInfo, se usan para identificar a la herramienta. Si esa herramienta se ha registrado en el control de información sobre herramientas mediante una llamada anterior a la función AddTool, la estructura TOOLINFO se rellenará con información sobre la herramienta.

CToolTipCtrl::HitTest

Esta función se usa para comprobar un punto y determinar si este se ubica dentro del rectángulo delimitador de la herramienta que se especifique. Si es así, también se recupera información sobre esa herramienta.

BOOL HitTest(
    CWnd* pWnd,
    CPoint pt,
    LPTOOLINFO lpToolInfo) const;

Parámetros

pWnd
El valor de este parámetro se corresponde con un puntero que apunta a la ventana donde se muestra la herramienta.

pt
El valor de este parámetro se corresponde con un puntero que apunta a un objeto CPoint, donde se almacenan las coordenadas del punto que se va a probar.

lpToolInfo
El valor de este parámetro se corresponde con un puntero que apunta a una estructura TOOLINFO, donde se almacena la información sobre la herramienta.

Valor devuelto

El valor devuelto será distinto de cero si el punto que se especifica mediante la información de prueba de posicionamiento se ubica dentro del rectángulo delimitador de la herramienta; de lo contrario, será 0.

Comentarios

Si al usar esta función se devuelve un valor distinto de cero, significará que la estructura a la que se apunta desde el parámetro lpToolInfo se habrá rellenado con información sobre la herramienta en cuyo rectángulo se encontraba el punto en cuestión.

La estructura TTHITTESTINFO se define de la siguiente manera:

typedef struct _TT_HITTESTINFO { // tthti
    HWND hwnd;   // handle of tool or window with tool
    POINT pt;    // client coordinates of point to test
    TOOLINFO ti; // receives information about the tool
} TTHITTESTINFO, FAR * LPHITTESTINFO;

  • hwnd

    Este miembro se usa para especificar el manipulador de la herramienta.

  • pt

    Este miembro se usa para especificar las coordenadas de un punto si este se ubica en el rectángulo delimitador de la herramienta.

  • ti

    Este miembro se usa para obtener información sobre la herramienta. Para obtener más información sobre la estructura TOOLINFO, consulte CToolTipCtrl::GetToolInfo.

CToolTipCtrl::Pop

Esta función se usa para quitar una ventana de información sobre herramientas que se está mostrando de la vista.

void Pop();

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_POP de Win32, tal y como se describe en Windows SDK.

Esta función se usa para hacer que el control de información sobre herramientas actual se muestre en las coordenadas del último mensaje del mouse.

void Popup();

Comentarios

Al usar este método, se envía el mensaje TTM_POPUP, que se describe en Windows SDK.

Ejemplo

En el siguiente ejemplo de código, se muestra una ventana de información sobre herramientas.

{
   // Display the most recent tooltip.
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   CToolTipCtrl *m_toolTip = m_toolBarCtrl.GetToolTips();
   m_toolTip->Popup();
}

CToolTipCtrl::RelayEvent

Esta función se usa para pasar un mensaje del mouse a un control de información sobre herramientas para su procesamiento.

void RelayEvent(LPMSG lpMsg);

Parámetros

lpMsg
El valor de este parámetro se corresponde con un puntero que apunta a una estructura MSG, donde se almacena el mensaje que se va a retransmitir.

Comentarios

En los controles de información sobre herramientas solo se procesan los siguientes mensajes que se reciben mediante la función RelayEvent:

WM_LBUTTONDOWN WM_MOUSEMOVE
WM_LBUTTONUP WM_RBUTTONDOWN
WM_MBUTTONDOWN WM_RBUTTONUP
WM_MBUTTONUP

Ejemplo

Vea el ejemplo de CPropertySheet::GetTabControl.

CToolTipCtrl::SetDelayTime

Esta función se usa para establecer el tiempo de retraso de un control de información sobre herramientas.

void SetDelayTime(UINT nDelay);

void SetDelayTime(
    DWORD dwDuration,
    int iTime);

Parámetros

nDelay
El valor de este parámetro se usa para especificar el nuevo tiempo de retraso, que se mide en milisegundos.

dwDuration
El valor de este parámetro se corresponde con una marca que se usa para especificar qué valor de duración se recuperará. Para obtener una descripción de los valores válidos, consulte CToolTipCtrl::GetDelayTime.

iTime
El valor devuelto se corresponde con el tiempo de retraso que se especifica, en milisegundos.

Comentarios

El tiempo de retraso es el período de tiempo que el cursor debe permanecer sobre una herramienta antes de que aparezca la ventana de información sobre herramientas. El tiempo de retraso predeterminado es de 500 milisegundos.

CToolTipCtrl::SetMargin

Esta función se usa para establecer los márgenes superior, izquierdo, inferior y derecho de una ventana de información sobre herramientas.

void SetMargin(LPRECT lprc);

Parámetros

lprc
El valor de este parámetro se corresponde con la dirección de una estructura RECT, donde se almacena la información de margen que se va a establecer. Los miembros de la estructura RECT no se usan para definir un rectángulo delimitador. Para obtener una descripción de la información de margen, consulte CToolTipCtrl::GetMargin.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_SETMARGIN de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::SetMaxTipWidth

Esta función se usa para establecer el ancho máximo de una ventana de información sobre herramientas.

int SetMaxTipWidth(int iWidth);

Parámetros

iWidth
El valor de este parámetro se corresponde con la anchura máxima de la ventana de información sobre herramientas que se va a establecer.

Valor devuelto

El valor devuelto se corresponde con la anchura máxima anterior de la información sobre herramientas.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_SETMAXTIPWIDTH de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::SetTipBkColor

Esta función se usa para establecer el color de fondo de una ventana de información sobre herramientas.

void SetTipBkColor(COLORREF clr);

Parámetros

clr
Nuevo color de fondo.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_SETTIPBKCOLOR de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::SetTipTextColor

Esta función se usa para establecer el color del texto de una ventana de información sobre herramientas.

void SetTipTextColor(COLORREF clr);

Parámetros

clr
El valor de este parámetro se corresponde con el nuevo color del texto.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_SETTIPTEXTCOLOR de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::SetTitle

Esta función se usa para agregar un icono y una cadena de título estándar a una información sobre herramientas.

BOOL SetTitle(
    UINT uIcon,
    LPCTSTR lpstrTitle);

Parámetros

uIcon
Consulte icon en TTM_SETTITLE de Windows SDK.

lpstrTitle
El valor de este parámetro se corresponde con un puntero que apunta a la cadena de título.

Valor devuelto

Si es correcta, su valor es distinto de cero. En caso contrario, es cero.

Comentarios

En esta función miembro, se implementa el comportamiento del mensaje TTM_SETTITLE de Win32, tal y como se describe en Windows SDK.

CToolTipCtrl::SetToolInfo

Esta función se usa para establecer la información que se mantiene en una información sobre herramientas en relación con una herramienta.

void SetToolInfo(LPTOOLINFO lpToolInfo);

Parámetros

lpToolInfo
El valor de este parámetro se corresponde con un puntero que apunta a una estructura TOOLINFO, donde se especifica la información que se va a establecer.

CToolTipCtrl::SetToolRect

Esta función se usa para establecer un nuevo rectángulo delimitador para una herramienta.

void SetToolRect(
    CWnd* pWnd,
    UINT_PTR nIDTool,
    LPCRECT lpRect);

Parámetros

pWnd
El valor de este parámetro se corresponde con un puntero que apunta a la ventana donde se muestra la herramienta.

nIDTool
El valor de este parámetro se corresponde con el id. de la herramienta.

lpRect
El valor de este parámetro se corresponde con un puntero que apunta a una estructura RECT, donde se especifica el nuevo rectángulo delimitador.

CToolTipCtrl::SetWindowTheme

Esta función se usa para establecer el estilo visual de una ventana de información sobre herramientas.

HRESULT SetWindowTheme(LPCWSTR pszSubAppName);

Parámetros

pszSubAppName
El valor de este parámetro se corresponde con un puntero que apunta a una cadena Unicode, donde se almacena el estilo visual que se va a establecer.

Valor devuelto

En esta función, no se usa el valor devuelto.

Comentarios

Esta función miembro se usa para emular la funcionalidad del mensaje TTM_SETWINDOWTHEME, tal como se describe en Windows SDK.

CToolTipCtrl::Update

Esta función se usa para forzar que la herramienta actual vuelva a dibujarse.

void Update();

CToolTipCtrl::UpdateTipText

Esta función se usa para actualizar el texto de la información sobre herramientas de este control.

void UpdateTipText(
    LPCTSTR lpszText,
    CWnd* pWnd,
    UINT_PTR nIDTool = 0);

void UpdateTipText(
    UINT nIDText,
    CWnd* pWnd,
    UINT_PTR nIDTool = 0);

Parámetros

lpszText
El valor de este parámetro se corresponde con un puntero que apunta al texto sobre la herramienta.

pWnd
El valor de este parámetro se corresponde con un puntero que apunta a la ventana donde se muestra la herramienta.

nIDTool
El valor de este parámetro se corresponde con el id. de la herramienta.

nIDText
El valor de este parámetro se corresponde con el id. del recurso de cadena donde se almacena el texto sobre la herramienta.

Consulte también

CWnd (clase)
Gráfico de jerarquías
CToolBar (clase)