Vcl.Controls.THintInfo

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

  THintInfo = record
    HintControl: TControl;
    HintWindowClass: THintWindowClass;
    HintPos: TPoint;
    HintMaxWidth: Integer;
    HintColor: TColor;
    CursorRect: TRect;
    CursorPos: TPoint;
    ReshowTimeout: Integer;
    HideTimeout: Integer;
    HintStr: string;
    HintData: TCustomData;
  end;

C++

struct DECLSPEC_DRECORD THintInfo
{
public:
    TControl* HintControl;
    THintWindowClass HintWindowClass;
    System::Types::TPoint HintPos;
    int HintMaxWidth;
    System::Uitypes::TColor HintColor;
    System::Types::TRect CursorRect;
    System::Types::TPoint CursorPos;
    int ReshowTimeout;
    int HideTimeout;
    System::UnicodeString HintStr;
    void *HintData;
};

Propriétés

Type Visibilité  Source Unité  Parent
record
struct
public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls Vcl.Controls

Description

THintInfo est utilisé pour définir l'apparence et le comportement d'une fenêtre d'aide.

Le type THintInfo est utilisé pour définir l'apparence et le comportement d'une fenêtre d'aide dans un gestionnaire d'événement OnShowHint de type TShowHintEvent.

Le tableau suivant donne la description des champs de Vcl.Controls.THintInfo :


Champ Signification

HintControl

Le nom du contrôle pour lequel la fenêtre de conseil s'affiche.

HintWindowClass

La classe du contrôle fenêtre de conseil. La classe par défaut est THintWindow, mais vous pouvez spécifier n'importe quelle classe dérivée de THintWindow. Utilisez ce champ si vous voulez substituer une fenêtre de conseil personnalisée à THintWindow.

HintPos

La position par défaut des coordonnées écran du coin supérieur gauche de la fenêtre de conseil. Modifiez l'emplacement de l'affichage de la fenêtre en changeant cette valeur.

HintMaxWidth

La largeur maximale de la fenêtre de conseil avant que le passage à la ligne automatique commence. Par défaut, la valeur représente la largeur de l'écran (la propriété Width de la variable globale Screen).

HintColor

La couleur du fond de la fenêtre de conseil.

CursorRect

Le rectangle dans lequel doit se trouver le pointeur de la souris pour que la fenêtre de conseil apparaisse. Par défaut, c'est le rectangle client du contrôle. Changez cette valeur quand vous voulez diviser un même contrôle en plusieurs régions de conseils. Quand l'utilisateur déplace le pointeur de la souris à l'extérieur du rectangle, la fenêtre de conseil disparaît.

CursorPos

L'emplacement du pointeur de la souris à l'intérieur du contrôle.

ReshowTimeout

Temps que doit attendre le système de conseil avant de demander à nouveau l'état du conseil. Par défaut, ce champ vaut zéro, ce qui indique que l'état du conseil ne change pas. Si vous donnez une valeur différente de zéro, le conseil agira, après le nombre de millisecondes demandé, comme si l'utilisateur déplaçait la souris à l'extérieur du rectangle puis y revenait. Cela permet d'interrompre l'affichage du conseil pendant un certain temps ou de mettre à jour périodiquement le conseil.

HideTimeout

Le nombre de millisecondes d'affichage du conseil. Par défaut, il s'agit de la valeur de la propriété HintHidePause de la variable Application.

HintStr

La chaîne à afficher dans la fenêtre de conseil. Cela permet à un gestionnaire de l'événement OnHint de modifier le contenu d'un conseil avant qu'il ne soit affiché. Par défaut, il contient la valeur renvoyée par la fonction GetShortHint quand elle transmet la valeur de la propriété Hint de la variable Application.

HintData

D'autres données à transmettre au contrôle fenêtre de conseil. Utilisez ce champ en conjonction avec HintWindowClass.


Voir aussi

Exemples de code