Vcl.Controls.THintInfo

提供: RAD Studio API Documentation
移動先: 案内検索

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;
};

プロパティ

種類 可視性 ソース ユニット
record
struct
public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls Vcl.Controls

説明

THintInfo は、ヘルプ ウィンドウの外見と動作を定義するのに使用されます。


THintInfo 型は、TShowHintEvent 型の OnShowHint イベントのハンドラでヘルプ ウィンドウの外見と動作を定義するのに使用されます。

Vcl.Controls.THintInfo のフィールドの意味を以下の表で説明します。


フィールド 意味

HintControl

ヒントの処理が行われているコントロールの名前です。

HintWindowClass

ヒントウィンドウ コントロールのクラスです。デフォルトは THintWindow ですが、THintWindow から派生した任意のクラスを指定できます。カスタム ヒント ウィンドウを THintWindow の代わりに使用する場合は、このフィールドを使用します。

HintPos

ヒント ウィンドウの左上隅のデフォルト位置(画面座標)です。この値を変更することで、ウィンドウの表示位置を変更できます。

HintMaxWidth

ワード ラップが始まる前のヒント ウィンドウの最大幅です。デフォルトでは、この値は画面の幅(グローバル変数 Screen の Width プロパティ)です。

HintColor

ヒント ウィンドウの背景色です。

CursorRect

ヒント ウィンドウが表示されるためにユーザーのマウス ポインタが入っていなければならない矩形です。CursorRect のデフォルト値は、コントロールのクライアント矩形です。単一のコントロールをいくつかのヒント領域に分割できるように、この値を変更します。ユーザーがマウス ポインタをこの矩形の外に移動させると、ヒント ウィンドウは閉じます。

CursorPos

コントロール内のマウス ポインタの位置です。

ReshowTimeout

ヒント システムがヒント ステータスを再度質問するまでの待機時間です。デフォルトでは、このフィールドはゼロで、ヒント ステータスが変わらないことを示します。このフィールドをゼロでない値に設定すると、要求された時間(ミリ秒単位)が経過した後で、ヒントが、あたかもユーザーがマウス ポインタをヒント矩形の外にいったん移動させてから再び矩形内に戻したかのように動作します。これは、ヒント処理を一定時間遅らせるか、ヒントを定期的に更新できるようにするために使用できます。

HideTimeout

ヒントを表示する時間(ミリ秒数)です。デフォルトでは、これは、Application 変数の HintHidePause プロパティの値に設定されています。

HintStr

ヒント ウィンドウに表示される文字列です。これを使用すると、OnHint イベント ハンドラでヒントの内容を表示前に変更できます。デフォルトでは、このフィールドには、Application 変数の Hint プロパティの値を GetShortHint 関数に渡したときに返される値が格納されています。

HintData

ヒントウィンドウ コントロールに渡される追加データです。このフィールドは、HintWindowClass と共に使用します。


関連項目

コード例