Class TAdHint

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TAdHint = class(TObject)

Description

TAdHint is used by the gui system to show a smal hint window when pointing on a specific GUI control. To change (e.g.) the color of the hints in the whole GUI environment, simply use TAdGUI.HintWnd for this purpose. This is also the place where you can replace the hint window with your own, extended TAdHint class.

Hierarchy

Overview

Methods

Public constructor Create(AParent:TAdDraw);
Public destructor Destroy; override;
Public procedure Show(MouseX, MouseY:integer; Text:string; Sender:TAdComponent); virtual;
Public procedure Hide; virtual;
Public procedure Draw; virtual;
Public procedure Move(TimeGap:double); virtual;

Properties

Public property ShowTime: single read FShowTime write FShowTime;
Public property WaitTime: single read FWaitTime write FWaitTime;
Public property Color: longint read FColor write FColor;
Public property Alpha: byte read FAlpha write SetAlpha;
Public property Parent: TAdDraw read FParent;
Public property Visible: boolean read FVisible write FVisible;
Public property FadeTime: single read FFadeTime write FFadeTime;
Public property BorderColor: longint read FBordercolor write FBorderColor;
Public property TextColor: longint read FTextColor write FTextColor;

Description

Methods

Public constructor Create(AParent:TAdDraw);

Creates an instance of TAdHint.

Public destructor Destroy; override;

Destroys the instance of TAdHint.

Public procedure Show(MouseX, MouseY:integer; Text:string; Sender:TAdComponent); virtual;

Shows the hint on a specific position. The hint window will automatically hide after "ShowTime" has expired. Normally this method is called by the underlying component.

Public procedure Hide; virtual;

Hides the hint before its "ShowTime" has expired.

Public procedure Draw; virtual;

Draws the hint, if it is visible.

Public procedure Move(TimeGap:double); virtual;

Moves the hint timers forward, so that it can hide.

Properties

Public property ShowTime: single read FShowTime write FShowTime;

The time in seconds the hint window should be shown after it had been activated.

Public property WaitTime: single read FWaitTime write FWaitTime;

The time the underlying component shall wait before showing the hint window.

Public property Color: longint read FColor write FColor;

The background color of the hint.

Public property Alpha: byte read FAlpha write SetAlpha;

The alpha value of the background color.

Public property Parent: TAdDraw read FParent;

The parent TAdDraw that was passed by creating the hint window.

Public property Visible: boolean read FVisible write FVisible;

Returns whether the hint window is currently visible.

Public property FadeTime: single read FFadeTime write FFadeTime;

Set this property to adjust the time the hint needs to fade in/out.

Public property BorderColor: longint read FBordercolor write FBorderColor;

The color of the hint window border.

Public property TextColor: longint read FTextColor write FTextColor;

The color of the hint text.

SourceForge.net Logo


Generated by PasDoc 0.11.0 on 2008-12-31 14:31:59