[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 management and configuration for a GUI application.

Declaration

Source position: forms.pp line 1314

type TApplication = class(TCustomApplication) end;

protected

  function GetConsoleApplication; override;

  

Here: returns False, because this is a GUI application.

  procedure NotifyIdleHandler();

  

Notifies all Idle handlers.

  procedure NotifyIdleEndHandler;

  

Notifies all Idle End handlers, when a new message arrived.

  procedure NotifyActivateHandler;

  

Notifies all Activation handlers.

  procedure NotifyDeactivateHandler;

  

Notifies all Deactivation handlers.

  procedure NotifyCustomForms();

  

Notifies all CustomForms of Msg arrived.

  function IsHintMsg();

  

Nop, exists for Delphi compatibility only.

  function DoOnHelp(); virtual;

  

OnHelp message handler. Tries OnHelp handlers of the active form, Application OnHelp and application Help handlers.

  procedure DoOnMouseMove; virtual;

  

OnMouseMove message handler, updates the Hint.

  procedure ShowHintWindow();

  

Shows or hides the Hint window.

  procedure OnHintTimer();

  

Event handler for timing the duration of hints.

  procedure SetTitle(); override;

  procedure StartHintTimer();

  

Starts the timer for display of a hint message.

  procedure UpdateVisible;

  

Asks the widgetset to update the TaskBar entries.

  procedure DoIdleActions;

  

Updates all Actions, hides splash screens.

  procedure MenuPopupHandler();

  

Hides the Hint window.

  procedure ProcessAsyncCallQueue;

  

Calls all methods queued by QueueAsyncCall.

  procedure FreeComponent();

  procedure ReleaseComponents;

  

Destroys all components marked for release.

  procedure DoBeforeFinalization;

  

Destroys all components.

  function GetParams(); override;

  

Returns the indexed commandline argument.

public

  constructor Create(); override;

  destructor Destroy; override;

  procedure ActivateHint();

  

  function GetControlAtMouse;

  

Finds the control under the mouse.

  procedure ControlDestroyed();

  

Clears all references to the destroyed control.

  function BigIconHandle;

  

The Handle of the large application Icon.

  function SmallIconHandle;

  

The Handle of the small application Icon.

  procedure BringToFront;

  

Asks the widgetset to bring the application's form(s) to the front

  procedure CreateForm();

  

Creates a Form or component, owned by Application.

  procedure UpdateMainForm();

  

When MainForm is Nil, this form becomes the application MainForm.

  procedure QueueAsyncCall();

  

Inserts an asynchronous call into the queue.

  procedure RemoveAsyncCalls();

  

Removes all calls added via QueueAsyncCall.

  procedure ReleaseComponent();

  

Safe destruction of a component, can be requested by the component itself.

  function ExecuteAction(); override;

  

Invokes the OnActionExecute handler.

  function UpdateAction(); override;

  

Invokes the OnActionUpdate handler.

  procedure HandleException(); override;

  

HandleException method for handling an exception; attempts to maintain program execution if possible, otherwise exits gracefully

  procedure HandleMessage;

  

Handles all messages, then enters Idle state.

  function HelpCommand();

  

Show help

  function HelpContext();

  

Show context sensitive help.

  function HelpKeyword();

  

Show help for a keyword.

  procedure ShowHelpForObject();

  

When Sender is a TControl, invoke its ShowHelp method.

  procedure RemoveStayOnTop();

  

Remove StayOnTop from all forms. Builds a form list for use in RestoreStayOnTop.

  procedure RestoreStayOnTop();

  

Restores StayOnTop for all forms changed by RemoveStayOnTop.

  function IsWaiting;

  

True if the application is awaiting an event

  procedure CancelHint;

  

Called when the Hint time has expired, to stop showing the Hint.

  procedure HideHint;

  

Hides the Hint window.

  procedure HintMouseMessage();

  

Called when the the mouse is over a control with a Hint

  procedure Initialize; override;

  

Initializes the widgetset (and more).

  function MessageBox();

  

Display an message dialog with several response buttons.

  procedure Minimize;

  

Asks the widgetset to minimize the application.

  procedure ModalStarted;

  

Called when a form is shown modally.

  procedure ModalFinished;

  

Called when a modal form is closed.

  procedure Restore;

  

Restores the previously minimized application.

  procedure Notification(); override;

  

Invokes the notification handlers.

  procedure ProcessMessages;

  

Call this method during lengthy operations, to keep the GUI responsive.

  procedure Idle();

  

Invoked when the application enters the idle state.

  procedure Run;

  

MainForm is loaded and control is passed to the event loop.

  procedure ShowException(); override;

  

Shows the exception message and asks the user to abort or continue.

  procedure Terminate; override;

  

The application is terminated and the component engine is shutdown.

  procedure DisableIdleHandler;

  

Blocks Idle handling. Can be called moreoften, every call must be followed by EnableIdleHandler.

  procedure EnableIdleHandler;

  

Resume Idle handling.

  procedure NotifyUserInputHandler();

  

Notifies all user input handlers

  procedure NotifyKeyDownBeforeHandler();

  

Notifies all ahtKeyDownBefore handlers.

  procedure NotifyKeyDownHandler();

  

Notifies all ahtKeyDownAfter handlers, eventually reacts on F1 (Help).

  procedure ControlKeyDown();

  

Handles KeyDown events in a Control, e.g. handles navigation keys.

  procedure ControlKeyUp();

  

Handles KeyUp events in a Control, e.g. handles Enter and Esc keys.

  procedure AddOnIdleHandler();

  

Adds an application Idle handler.

  procedure RemoveOnIdleHandler();

  

Removes an application Idle handler.

  procedure AddOnIdleEndHandler();

  

Adds an application IdleEnd handler.

  procedure RemoveOnIdleEndHandler();

  

Removes an application IdleEnd handler.

  procedure AddOnUserInputHandler();

  

Adds an application user input handler.

  procedure RemoveOnUserInputHandler();

  

Removes an application user input handler.

  procedure AddOnKeyDownBeforeHandler();

  

Adds an application key down before interface handler.

  procedure RemoveOnKeyDownBeforeHandler();

  

Removes an application key down before interface handler.

  procedure AddOnKeyDownHandler();

  

Adds an application key down after interface handler.

  procedure RemoveOnKeyDownHandler();

  

Removes an application key down after interface handler.

  procedure AddOnActivateHandler();

  

Adds an application activation handler.

  procedure RemoveOnActivateHandler();

  

Removes an application activation handler.

  procedure AddOnDeactivateHandler();

  

Adds an application deactivation handler.

  procedure RemoveOnDeactivateHandler();

  

Removes an application deactivation handler.

  procedure AddOnExceptionHandler();

  

Adds an application exception handler.

  procedure RemoveOnExceptionHandler();

  

Removes an application exception handler.

  procedure AddOnEndSessionHandler();

  

Adds an application logoff handler.

  procedure RemoveOnEndSessionHandler();

  

Removes an application logoff handler.

  procedure AddOnQueryEndSessionHandler();

  

Adds an application logoff query handler.

  procedure RemoveOnQueryEndSessionHandler();

  

Removes an application logoff query handler.

  procedure AddOnMinimizeHandler();

  

Adds an application minimizing handler.

  procedure RemoveOnMinimizeHandler();

  

Removes an application minimizing handler.

  procedure AddOnModalBeginHandler();

  

Adds an application becoming modal handler.

  procedure RemoveOnModalBeginHandler();

  

Removes an application becoming modal handler.

  procedure AddOnModalEndHandler();

  

Adds an application exiting modal state handler.

  procedure RemoveOnModalEndHandler();

  

Removes an application exiting modal state handler.

  procedure AddOnRestoreHandler();

  

Adds an application exiting minimized state handler.

  procedure RemoveOnRestoreHandler();

  

Removes an application exiting minimized state handler.

  procedure AddOnDropFilesHandler();

  

Adds an application dropped files handler.

  procedure RemoveOnDropFilesHandler();

  

Removes an application dropped files handler.

  procedure AddOnHelpHandler();

  

Adds an application Help handler.

  procedure RemoveOnHelpHandler();

  

Removes an application Help handler.

  procedure AddOnHintHandler();

  

Adds an application Hint handler.

  procedure RemoveOnHintHandler();

  

Removes an application Hint handler.

  procedure AddOnShowHintHandler();

  

Adds an application Hint show handler.

  procedure RemoveOnShowHintHandler();

  

Removes an application Hint show handler.

  procedure AddOnGetMainFormHandleHandler();

  

Adds an application MainForm Handle handler.

  procedure RemoveOnGetMainFormHandleHandler();

  

Removes an application MainForm Handle handler.

  procedure RemoveAllHandlersOfObject(); virtual;

  

Removes all handlers implemented in the given object.

  procedure DoBeforeMouseMessage();

  

Things to be done before a mouse message is processed.

  function IsShortcut();

  

Asks all shortcut handlers to handle the key.

  procedure IntfQueryEndSession();

  

Called by the interface to confirm the end of a session.

  procedure IntfEndSession;

  

Called by the interface when the session ends.

  procedure IntfAppActivate();

  

Called by the interface on application activation

  procedure IntfAppDeactivate();

  

Called by the interface on application deactivation

  procedure IntfAppMinimize;

  

Called by the interface when the application is minimized.

  procedure IntfAppRestore;

  

Called by the interface when the application is restored.

  procedure IntfDropFiles();

  

Called by the interface when files have been dropped.

  procedure IntfSettingsChange;

  procedure IntfThemeOptionChange();

  

Called by the interface when a theme option has changed.

  function IsRightToLeft;

  function IsRTLLang();

  

Checks the given language name for right-to-left reading.

  function Direction();

  

Checks the given language name for right-to-left reading.

  procedure DoArrowKey();

  

Uses arrow keys for navigation, if enabled.

  procedure DoTabKey();

  

Uses the Tab key for navigation, if enabled.

  procedure DoEscapeKey();

  

Interprets Esc as Cancel action, if applicable.

  procedure DoReturnKey();

  

Interprets Enter as the default action, if applicable.

  property Active: Boolean; [r]

  

True if the application has the focus.

  property ApplicationType: TApplicationType; [rw]

  

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

  property BidiMode: TBiDiMode; [rw]

  

The bidirectional mode to use.

  property CaptureExceptions: Boolean; [rw]

  

Enables exception handling by Application.

  property ExtendedKeysSupport: Boolean; [rw]

  property ExceptionDialog: TApplicationExceptionDlg; [rw]

  property FindGlobalComponentEnabled: Boolean; [rw]

  

Enables searching for global components by name.

  property Flags: TApplicationFlags; [rw]

  

Application state flags.

  property Hint: string; [rw]

  

The current Hint text.

  property HintColor: TColor; [rw]

  

The color of Hint windows.

  property HintHidePause: Integer; [rw]

  

How long a Hint stays visible, after an mouse move.

  property HintHidePausePerChar: Integer; [rw]

  

How much a keystroke extends the time a Hint stays visible (added to HintHidePause).

  property HintPause: Integer; [rw]

  

The delay before a Hint is shown.

  property HintShortCuts: Boolean; [rw]

  

Enables the display of keyboard shortcuts (e.g. on menu entries).

  property HintShortPause: Integer; [rw]

  

The pause before a different Hint is displayed.

  property Icon: TIcon; [rw]

  

The icon associated with this application.

  property LayoutAdjustmentPolicy: TLayoutAdjustmentPolicy; [rw]

  property Navigation: TApplicationNavigationOptions; [rw]

  

Allows to switch between controls by pressing keys.

  property MainForm: TForm; [r]

  

The application terminates when this form is closed.

  property MainFormHandle: HWND; [r]

  

The Handle of the MainForm

  property MainFormOnTaskBar: Boolean; [rw] platform ;

  

  property ModalLevel: Integer; [r]

  

The number of modal forms shown.

  property MoveFormFocusToChildren: Boolean; [rw]

  property MouseControl: TControl; [r]

  

The control currently under the mouse.

  property TaskBarBehavior: TTaskBarBehavior; [rw]

  

How forms are represented in the TaskBar.

  property UpdateFormatSettings: Boolean; [rw] platform ;

  property OnActionExecute: TActionEvent; [rw]

  

Default handler for unhandled Actions

  property OnActionUpdate: TActionEvent; [rw]

  

Default handler for unhandled Action updates

  property OnActivate: TNotifyEvent; [rw]

  

Event handler for activation of the application.

  property OnDeactivate: TNotifyEvent; [rw]

  

Event handler for deactivation of the application.

  property OnGetMainFormHandle: TGetHandleEvent; [rw]

  

  property OnIdle: TIdleEvent; [rw]

  

Event handler for application entering Idle state.

  property OnIdleEnd: TNotifyEvent; [rw]

  

Event handler for application leaving Idle state.

  property OnEndSession: TNotifyEvent; [rw]

  

Event handler for ending a session of the application

  property OnQueryEndSession: TQueryEndSessionEvent; [rw]

  

This event handler can deny to end the session.

  property OnMinimize: TNotifyEvent; [rw]

  

Event handler for application minimized.

  property OnMessageDialogFinished: TModalDialogFinished; [rw]

  property OnModalBegin: TNotifyEvent; [rw]

  

Event handler for a modal form opened (application entering modal mode).

  property OnModalEnd: TNotifyEvent; [rw]

  

Event handler for all modal forms closed (application exiting modal mode).

  property OnRestore: TNotifyEvent; [rw]

  

Event handler for application restored (from minimized/maximized state).

  property OnDropFiles: TDropFilesEvent; [rw]

  

The default handler for dropped files

  property OnHelp: THelpEvent; [rw]

  

Event handler when help is requested.

  property OnHint: TNotifyEvent; [rw]

  

Event handler when a hint is requested.

  property OnShortcut: TShortCutEvent; [rw]

  

This event handler can interpret keystrokes as shortcuts, before the normal target handles the key.

  property OnShowHint: TShowHintEvent; [rw]

  

Event handler for showing an Hint.

  property OnUserInput: TOnUserInputEvent; [rw]

  

  property OnDestroy: TNotifyEvent; [rw]

  

  property OnCircularException: TExceptionEvent; [rw]

  

Handler invoked when there is an exception circle before killing the app with Halt

  property ShowButtonGlyphs: TApplicationShowGlyphs; [rw]

  

Allows to override the platform default for glyphs on buttons.

  property ShowMenuGlyphs: TApplicationShowGlyphs; [rw]

  

Sets the default policy for showing or hiding glyph images in menus

  property ShowHint: Boolean; [rw]

  

Enables Hint display

  property ShowMainForm: Boolean; [rw]

  

Allows to show or hide the main form, on application start. Default TRUE.

  property Title: string; [rw]

  property Scaled: Boolean; [rw]

Inheritance

TApplication

  

Application management and configuration for a GUI application.

|

TCustomApplication

?

TObject

Description

Provides a message loop, hooks for application event handlers, and more.

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

Other project types have a different Application class

See also

TScreen

  

Provides information about the display and related objects.

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