Class TAdWindowFramework

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TAdWindowFramework = class(TAdPersistent)

Description

An abstract class which represents a window or the drawing surface. TAdWindowFramework is passed to the plugin dll, which uses the data given by the frame work to produce its own device context or uses an already existing one.

Hierarchy

Overview

Methods

Public constructor Create; virtual;
Public destructor Destroy; override;
Public function BindTo(AObj:Pointer):boolean; virtual; abstract;
Public function InitDisplay(AProps:TAdDisplayProperties):boolean; virtual; abstract;
Public procedure Run; virtual; abstract;
Public procedure Terminate; virtual; abstract;
Public function IdentStr:ShortString;

Properties

Public property Title: string read FTitle write SetTitle;
Public property Events: TAdEventHandler read FEvents;
Public property ClientWidth: integer read GetClientWidth;
Public property ClientHeight: integer read GetClientHeight;
Public property CursorVisible: Boolean read FCursorVisible write SetCursorVisible;

Description

Methods

Public constructor Create; virtual;

Creates an instance of TAdWindowFramework.

Public destructor Destroy; override;

Destroys the instance of TAdWindowFramework.

Public function BindTo(AObj:Pointer):boolean; virtual; abstract;

The window framework will try to "bind" itsself to the object (which in most cases is a component) given by the "AObj"-Parameter. For Windowframeworks which create a window theirselfes, "AObj" must be Nil. "BindTo" will return True when the binding is valid.

See also
InitDisplay
Inits the display surface on the object passed by BindTo.
Public function InitDisplay(AProps:TAdDisplayProperties):boolean; virtual; abstract;

Inits the display surface on the object passed by BindTo. If the window-framework does not create the window itself, the properties given in "AProps" may be ignored.

See also
BindTo
The window framework will try to "bind" itsself to the object (which in most cases is a component) given by the "AObj"-Parameter.
Public procedure Run; virtual; abstract;

If the windowframework creates the window itself, "Run" causes the window system to perform its event loop. "Run" will be left wenn the main window is closed or "Terminate" is called.

Public procedure Terminate; virtual; abstract;

The main event loop will be left and the application will close

Public function IdentStr:ShortString;

Returns an identification string which consists of the inheritance hierarchy of the class.

Properties

Public property Title: string read FTitle write SetTitle;

Property which is used to set the window title. Has no effect on a window framework which doesn't create a window by itself.

Public property Events: TAdEventHandler read FEvents;

Contains a list of events the window may receive.

See also
TAdEventHandler
A simple class which contains all events that may be caught by a TAdWindowFramework.
Public property ClientWidth: integer read GetClientWidth;

Returns the width of the client area of the window.

Public property ClientHeight: integer read GetClientHeight;

Retrurns the height of the client area of the window

Public property CursorVisible: Boolean read FCursorVisible write SetCursorVisible;

Use this property to show or hide the mouse cursor.

SourceForge.net Logo


Generated by PasDoc 0.11.0 on 2008-12-31 14:32:00