[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'Forms' (#lcl)

TApplication

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Application - the whole current program, described as an object

Declaration

Source position: forms.pp line 957

type TApplication = class(TCustomApplication)

protected

  function GetConsoleApplication; override;

  

  procedure NotifyIdleHandler();

  

  procedure NotifyIdleEndHandler;

  

  procedure NotifyActivateHandler;

  

  procedure NotifyDeactivateHandler;

  

  function IsHintMsg();

  

  procedure DoOnMouseMove; virtual;

  

  procedure ShowHintWindow();

  

  procedure OnHintTimer();

  

  procedure SetTitle(); override;

  

  procedure StartHintTimer();

  

  procedure UpdateVisible;

  

  procedure DoIdleActions;

  

  procedure MenuPopupHandler();

  

  procedure ProcessAsyncCallQueue;

  

  procedure FreeComponent();

  

  procedure DoBeforeFinalization;

  

  function GetParams(); override;

public

  constructor Create(); override;

  

Create an instance of TApplication

  destructor Destroy; override;

  

Destroy this instance of TApplication and free its resources

  procedure ControlDestroyed();

  

Method for dealing with a control that has been destroyed

  procedure BringToFront;

  

Use the selected widget set's method to bring the application's form(s) to the front

  procedure CreateForm();

  

Create Form or any other kind of component

  procedure UpdateMainForm();

  

  procedure QueueAsyncCall();

  

Insert a given asynchronous call into the queue

  procedure ReleaseComponent();

  

  function ExecuteAction(); override;

  

The method to be used to execute the action associated with the Application

  function UpdateAction(); override;

  

  procedure HandleException(); override;

  

Exception handler - methods to be followed in response to exceptions

  procedure HandleMessage;

  

Process all events according to the method defined for the widget set

  function HelpContext();

  

  function HelpKeyword();

  

  procedure ShowHelpForObject();

  

  procedure HideAllFormsWithStayOnTop;

  

  function IsWaiting;

  

  procedure CancelHint;

  

Cancels a request for a hint, if there is no hint timer or no hint to display

  procedure HideHint;

  

Don't display the hint

  procedure HintMouseMessage();

  

  property Icon: TIcon; [rw]

  

The icon to be associated with this application

  procedure Initialize; override;

  

Initialize any forms associated with the application

  function MessageBox();

  

Message Box: a useful function to display a message.

  procedure Minimize;

  

Minimise the form using the widget set's method

  procedure Restore;

  

Restore the application's form to the size it was before minimisation or maximisation

  procedure Notification(); override;

  

  procedure ProcessMessages;

  

  procedure Idle();

  

  procedure Run;

  

The method to be used to make the application execute.

  procedure ShowException(); override;

  

Show any exception that has occurred

  procedure Terminate; override;

  

Procedure to end the application

  procedure DisableIdleHandler;

  

  procedure EnableIdleHandler;

  

  procedure NotifyUserInputHandler();

  

  procedure NotifyKeyDownBeforeHandler();

  

  procedure NotifyKeyDownHandler();

  

  procedure ControlKeyDown();

  

  procedure ControlKeyUp();

  

  procedure AddOnIdleHandler();

  

  procedure RemoveOnIdleHandler();

  

  procedure AddOnIdleEndHandler();

  

  procedure RemoveOnIdleEndHandler();

  

  procedure AddOnUserInputHandler();

  

  procedure RemoveOnUserInputHandler();

  

  procedure AddOnKeyDownBeforeHandler();

  

  procedure RemoveOnKeyDownBeforeHandler();

  

  procedure AddOnKeyDownHandler();

  

  procedure RemoveOnKeyDownHandler();

  

  procedure AddOnActivateHandler();

  

  procedure RemoveOnActivateHandler();

  

  procedure AddOnDeactivateHandler();

  

  procedure RemoveOnDeactivateHandler();

  

  procedure AddOnExceptionHandler();

  

  procedure RemoveOnExceptionHandler();

  

  procedure AddOnEndSessionHandler();

  

  procedure RemoveOnEndSessionHandler();

  

  procedure AddOnQueryEndSessionHandler();

  

  procedure RemoveOnQueryEndSessionHandler();

  

  procedure AddOnMinimizeHandler();

  

  procedure RemoveOnMinimizeHandler();

  

  procedure AddOnRestoreHandler();

  

  procedure RemoveOnRestoreHandler();

  

  procedure AddOnDropFilesHandler();

  

  procedure RemoveOnDropFilesHandler();

  

  procedure AddOnHelpHandler();

  

  procedure RemoveOnHelpHandler();

  

  procedure AddOnHintHandler();

  

  procedure RemoveOnHintHandler();

  

  procedure AddOnShowHintHandler();

  

  procedure RemoveOnShowHintHandler();

  

  procedure RemoveAllHandlersOfObject(); virtual;

  

  procedure DoBeforeMouseMessage();

  

  function IsShortcut();

  

  procedure IntfQueryEndSession();

  

  procedure IntfEndSession;

  

  procedure IntfAppMinimize;

  

  procedure IntfAppRestore;

  

  procedure IntfDropFiles();

  

  procedure DoEscapeKey();

  

  procedure DoReturnKey();

  

  procedure DoTabKey();

  

  property Active: Boolean; [r]

  

  property CaptureExceptions: Boolean; [rw]

  

If exceptions have occurred, find out what they are, ready for processing

  property FindGlobalComponentEnabled: Boolean; [rw]

  

  property Flags: TApplicationFlags; [rw]

  

  property Hint: String; [rw]

  

The hint associated with the main application

  property HintColor: TColor; [rw]

  

The colour used to display the hint

  property HintHidePause: Integer; [rw]

  

The delay period after mouse entry before the hint becomes visible

  property HintHidePausePerChar: Integer; [rw]

  

  property HintPause: Integer; [rw]

  

The length of time for which the hint is displayed

  property HintShortCuts: Boolean; [rw]

  

  property HintShortPause: Integer; [rw]

  

  property Navigation: TApplicationNavigationOptions; [rw]

  

Determine how the form is to be navigated

  property MainForm: TForm; [r]

  

The Main Form used by the application for process control and for data input/output

  property OnActionExecute: TActionEvent; [rw]

  

Event handler for executing the form's main action

  property OnActionUpdate: TActionEvent; [rw]

  

  property OnActivate: TNotifyEvent; [rw]

  

Event handler for activation of the application

  property OnDeactivate: TNotifyEvent; [rw]

  

Event handler for deactivation of the application

  property OnIdle: TIdleEvent; [rw]

  

  property OnIdleEnd: TNotifyEvent; [rw]

  

  property OnEndSession: TNotifyEvent; [rw]

  

Event handler for ending a session of the application

  property OnQueryEndSession: TQueryEndSessionEvent; [rw]

  

  property OnMinimize: TNotifyEvent; [rw]

  

Event handler for minimising the application's form

  property OnRestore: TNotifyEvent; [rw]

  

Event handler for restoring the application's form from minimised or maximised condition

  property OnDropFiles: TDropFilesEvent; [rw]

  

The event invoked when file is dropped on one of the application forms.

  property OnHelp: THelpEvent; [rw]

  

Event handler when help is required

  property OnHint: TNotifyEvent; [rw]

  

Event handler when a hint is required

  property OnShortcut: TShortCutEvent; [rw]

  

Event handler when a shortcut key is pressed

  property OnShowHint: TShowHintEvent; [rw]

  

Event handler for showing a hint

  property OnUserInput: TOnUserInputEvent; [rw]

  

Event handler when user input is required or is occurring

  property OnDestroy: TNotifyEvent; [rw]

  

Event handler for destruction of the application

  property ShowHint: Boolean; [rw]

  

Is a hint required to be shown?

  property ShowMainForm: Boolean; [rw]

  

Is the main form for the application to be shown? Default TRUE

  property Title: String; [rw]

  

The Title to be displayed in the top border of the Main Window of the application

  property ApplicationType: TApplicationType; [rw]

  

The type of the application (ie the sort of device for which it is intended)

end;

Inheritance

TApplication

  

Application - the whole current program, described as an object

|

TCustomApplication

|

TObject

Description

Application - the whole current program, described as an object.

Includes the useful function MessageBox, a simple dialog intended for displaying error messages internally, but available as an alternative to the various Message Dialogs

The latest version of this document can be found at lazarus-ccr.sourceforge.net.