[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] |
[Properties (by Name)] [Methods (by Name)] [Events (by Name)]
TCustomForm - the base type for TForm
Source position: forms.pp line 375
type TCustomForm = class(TScrollingWinControl) |
||
protected |
||
|
FFormBorderStyle - local variable to hold style of border |
|
FActionLists: TList; |
|
FActionLists - local variable holding lists of actions asociated with the Form |
procedure CMShowingChanged(); message; |
|
CMShowingChanged - system message method for showing if the form has changed |
procedure Activate; dynamic; |
|
Activate - method for rendering the Form active |
procedure ActiveChanged; dynamic; |
|
ActiveChanged - method for a form that is active and changed |
procedure BeginFormUpdate; |
|
BeginFormUpdate - start updating the Form |
procedure CreateParams(); override; |
|
CreateParams - create parameters for this windowed class |
procedure CreateWnd; override; |
|
Creates the Window |
procedure Deactivate; dynamic; |
|
Deactivate - method for rendering the Form inactive |
procedure DoClose(); dynamic; |
|
DoClose - close the Form using the specified CloseAction |
procedure DoCreate; virtual; |
|
DoCreate - perform the Create action |
procedure DoDestroy; virtual; |
|
DoDestroy- perform the Destroy action |
procedure DoHide; dynamic; |
|
DoHide - method for hiding a previously visible object |
procedure DoShow; dynamic; |
|
DoShow - method to redender visible a previously hidden form |
procedure EndFormUpdate; |
|
EndFormUpdate - finish updating the Form |
procedure GetChildren(); override; |
|
|
procedure Loaded; override; |
|
|
procedure ChildHandlesCreated; override; |
|
ChildHandlesCreated - method for use when handles have been created for descendants |
procedure Notification(); override; |
|
|
procedure PaintWindow(); override; |
|
Paint handler plug-in |
procedure RequestAlign; override; |
|
Smart calling Parent.AlignControls |
procedure SetZOrder(); override; |
|
SetZOrder - set the Z order for the Form; if Topmost is True, Form is on top of all other objects |
procedure SetParent(); override; |
|
Find who the parents are and store the information |
procedure UpdateShowing; override; |
|
UpdateShowing - method to update the Visible property |
procedure SetVisible(); override; |
|
Procedure to set Visible flag and ensure the control can be seen |
procedure DoFirstShow; virtual; |
|
DoFirstShow - perform the first Show action since creation of the Form |
procedure UpdateWindowState; |
|
UpdateWindowState - update the state of the Window displaying the Form |
procedure VisibleChanging; override; |
|
VisibleChanging - method for dealing with a Form whose Visible property is changing |
procedure WndProc(); override; |
|
WndProc - message handler for the procedure of this window |
function VisibleIsStored; |
|
VisibleIsStored - True if the Visible property has been stored |
procedure DoSendBoundsToInterface; override; |
|
DoSendBoundsToInterface - sends information about the control's bounds to the interface |
procedure DoAutoSize; override; |
|
DoAutoSize - method for actually performing the AutoSize |
procedure SetAutoSize(); override; |
|
Set the boolean variable that determines whether autosize can function |
procedure DoDock(); override; |
|
Perform the docking manoeuvre to the new dock site at the position specified by ARect |
function GetFloating; override; |
|
Find out (true or false) whether the control is floating (as opposed to fixed) |
function GetDefaultDockCaption; override; |
|
GetDefaultDockCaption - returns the default caption to be used for docking |
procedure CMActionExecute(); message; |
|
CMActionExecute - system message method for executing action |
procedure CMActionUpdate(); message; |
|
CMActionUpdate - system message method for updating action |
function DoExecuteAction(); |
|
Asks every visible control to Execute the specified action ExeAction. |
function DoUpdateAction(); |
|
DoUpdateAction - asks all visible controls to update the specified action |
procedure UpdateActions; virtual; |
|
UpdateActions - method for updating actions |
public |
||
constructor Create(); override; |
|
|
constructor CreateNew(); virtual; |
|
CreateNew - constructor for creating a completely new form |
procedure BeforeDestruction; override; |
|
BeforeDestruction - method to be applied before Form is destroyed (usually involves clean-up) |
function BigIconHandle; |
|
BigIconHandle - returns system Handle for large Icon |
function SmallIconHandle; |
|
SmallIconHandle - returns system Handle for small Icon |
procedure DestroyWnd; override; |
|
DestroyWnd - destroy the window for this control |
destructor Destroy; override; |
|
|
procedure Close; |
|
Close the form and release its resources |
function CloseQuery; virtual; |
|
Is the associated query to be closed? |
procedure Release; |
|
Set free the resources of the form |
procedure Hide; |
|
Hide this control |
procedure Show; |
|
Makes the control visible. |
procedure ShowOnTop; |
|
Shows this form as the top (nearest) item of any stack of windows or images. |
procedure EnsureVisible(); |
|
Ensure that this form is always visible, if necessary moving it to the top (front) of the stack of images |
function FormIsUpdating; override; |
|
True if the form is being updated |
function GetControlClassDefaultSize; override; |
|
Find the default size for this class of controls (by reference to parents) |
function NeedParentForAutoSize; override; |
|
True - need to know parent's properties to do autosize. False - can autosize independently |
function WantChildKey(); virtual; |
|
WantChildKey - returns True if the specified child control requires a key (Message) |
procedure DefocusControl(); |
|
DefocusControl - withdraws focus from the specified control, removing it if required |
procedure SetFocus; override; |
|
SetFocus - give the current control the focus |
function SetFocusedControl(); virtual; |
|
SetFocusedControl - method for giving focus to specified control; returns True if successful |
procedure FocusControl(); |
|
FocusControl - method for giving focus to specified control |
function ShowModal; virtual; |
|
Show this form as modal - ie control cannot be resumed by another form until the current form is closed |
procedure SetRestoredBounds(); |
|
SetRestoredBounds - set the bounds defining the position of the restored control |
function GetRolesForControl(); |
|
GetRolesForControl - returns a set of roles (default, cancel) for the Form |
procedure RemoveAllHandlersOfObject(); override; |
|
RemoveAllHandlersOfObject - method for removing all of an object's handlers: part of a clean-up procedure |
procedure AddHandlerFirstShow(); |
|
AddHandlerFirstShow - perform the action for adding a handler at the time of first showing |
procedure RemoveHandlerFirstShow(); |
|
RemoveHandlerFirstShow - perform the action for removing the handler on the first showing |
procedure AddHandlerClose(); |
|
AddHandlerClose - adds a handler for closing Form |
procedure RemoveHandlerClose(); |
|
RemoveHandlerClose - removes handler for closing form |
procedure AddHandlerCreate(); |
|
AddHandlerCreate - performs the OnCreateHandler event |
procedure RemoveHandlerCreate(); |
|
RemoveHandlerCreate - removes the handler for the Create event |
function IsShortcut(); virtual; |
|
IsShortcut - if True, the specified Key and Message are active as a shortcut |
function ColorIsStored; override; |
|
Returns True if Colour is stored |
procedure IntfDropFiles(); |
|
IntfDropFiles - Invokes OnDropFilesEvent of the form. This function is called by the interface. |
procedure IntfHelp(); |
|
IntfHelp - Show help for control or menu item. This function is called by the interface. |
function GetFormImage; |
|
GetFormImage - gets a Bitmap image for the Form |
procedure Dock(); override; |
|
Dock - Procedure governing Docking of Control |
property Active: Boolean; [r] |
|
Is true when the form has the focus |
property ActiveControl: TWinControl; [rw] |
|
Specifies the active control on the form |
property ActiveDefaultControl: TControl; [rw] |
|
Specifies the active default control on the Form |
property AllowDropFiles: Boolean; [rw] |
|
Specifies if files are allowed to be dropped on this form. |
property BorderIcons: TBorderIcons; [rw] |
|
Specifies which icons appear on the top of the form |
property BorderStyle: TFormBorderStyle; [rw] |
|
The border style for this Form |
property CancelControl: TControl; [rw] |
|
The control associated with the cancel action |
property Caption; [s] |
|
Caption - the text-string appearing on the Control, usually used to identify its function |
property Color; |
|
Determine the colour for the current control |
property DefaultControl: TControl; [rw] |
|
The control associated with the default action for this form |
property Designer: TIDesigner; [rw] |
|
|
property FormState: TFormState; [r] |
|
Determines the state of the form |
property FormStyle: TFormStyle; [rw] |
|
Determinates the style of the form |
property HelpFile: String; [rws] |
|
Specifies the help file that is used by the form |
|
The Icon associated with this Form (which may appear in menus, directories, ListBoxes etc) |
|
property KeyPreview: Boolean; [rws] |
|
KeyPreview - if True, Key Preview is possible |
|
Specifies a MainMenu for this form |
|
property ModalResult: TModalResult; [rw] |
|
Specifies the return value of an modal form |
property OnActivate: TNotifyEvent; [rw] |
|
Event handler for activation (opening) of the form |
property OnClose: TCloseEvent; [rws] |
|
Event handler for closing the form |
property OnCloseQuery: TCloseQueryEvent; [rws] |
|
Event handler for closing the query associated with the form |
property OnCreate: TNotifyEvent; [rw] |
|
Event handler for creating the form |
property OnDeactivate: TNotifyEvent; [rw] |
|
Event handler for deactivating the form |
property OnDestroy: TNotifyEvent; [rw] |
|
Event handler when the form is being destroyed |
property OnDropFiles: TDropFilesEvent; [rw] |
|
The event invoked when file is dropped on this form. |
property OnHelp: THelpEvent; [rw] |
|
Event handler when Help is required |
property OnHide: TNotifyEvent; [rw] |
|
Event handler if form is being hidden |
property OnResize; [s] |
|
Event Handler for resize of control |
property OnShortcut: TShortCutEvent; [rw] |
|
Event handler if shortcut key is pressed |
property OnShow: TNotifyEvent; [rw] |
|
Event handler if form is to be shown |
property OnWindowStateChange: TNotifyEvent; [rw] |
|
Event handler for a change in the window state |
property ParentFont; |
|
ParentFont - should the control use the same font as the parent? Default is true |
property PixelsPerInch: LongInt; [rws] |
|
The scaling of the form in absolute terms |
|
The position of the form on the screen |
|
property RestoredLeft: Integer; [r] |
|
The position of the left edge of the form when it is restored (ie changes from minimised or maximised) |
property RestoredTop: Integer; [r] |
|
The position of the top edge of the form when it is restored (ie changes from minimised or maximised) |
property RestoredWidth: Integer; [r] |
|
The width of the form when it is restored (ie changes from minimised or maximised) |
property RestoredHeight: Integer; [r] |
|
The height of the form when it is restored (ie changes from minimised or maximised) |
property ShowInTaskBar: TShowInTaskbar; [rw] |
|
Should the form be shown in the system Task Bar? |
property Visible; [s] |
|
Visible - can the control be seen? |
property WindowState: TWindowState; [rw] |
|
Represents how the form appears on the screen |
end; |
|
TCustomForm - the base type for TForm |
|
| | ||
|
TScrollingWinControl - a class of Window Contrl that has one or more scroll bars |
|
| | ||
|
TCustomControl - a base class for many window controls |
|
| | ||
|
TWinControl - the base class for all windowed controls |
|
| | ||
|
TControl - the main ancestor class for visual controls. |
|
| | ||
TLCLComponent |
||
? | ||
TObject |