FileHideApp#

Qualified name: delphifmx.FileHideApp

class FileHideApp#

Bases: SysCommonAction

The standard action for hiding and showing (if hidden) a running macOS application. TFileHideApp hides all windows of the receiver application, and the next application in line is activated. If the windows of the receiver application are hidden, then TFileHideApp restores the hidden windows to the screen and makes the receiver active. The default ShortCut for TFileHideApp is CMD+H.

In the current version, TFileHideApp is implemented only for macOS.

Methods

`Create`	Instantiates and initializes a FireMonkey TCustomAction object.
`CustomTextChanged`	Introduces an interface for a function that is called when the CustomText property for the action changes.
`Execute`	Generates an OnExecute event.
`ExecuteTarget`	Introduces an interface for invoking an action on a target client component or control.
`HandlesTarget`	Introduces an interface for verifying that the type and state of a target component or control are appropriate for the action.
`Update`	Provides an opportunity to execute centralized code when an application is idle.

Attributes

`ActionComponent`	Indicates the client component that caused this action to execute.
`ActionList`	Holds the action list to which the action belongs.
`AutoCheck`	Controls whether the Checked property toggles when the action executes.
`Caption`	Represents the caption of the action.
`Category`	Group or category where the action belongs.
`Checked`	Indicates whether client controls and menu items appear checked.
`ClassName`	Returns the TObject.ClassName
`ComObject`	Specifies the interface reference implemented by the component.
`ComponentCount`	Indicates the number of components owned by the component.
`ComponentIndex`	Indicates the position of the component in its owner's Components property array.
`ComponentState`	Describes the current state of the component, indicating when a component needs to avoid certain actions.
`ComponentStyle`	Governs the behavior of the component.
`Components`	<Delphi indexed property Components of type TComponent at 1619D745CD0>
`CustomText`	CustomText is a user text.
`DesignInfo`	Contains information used by the Form designer.
`DisableIfNoHandler`	Indicates whether the action's clients should be disabled if no OnExecute event handler is found.
`Enabled`	Specifies the enabled state for the action.
`GroupIndex`	Indicates a group of actions in one action list.
`HelpContext`	Keeps the integer context ID that identifies the Help topic for the action.
`HelpKeyword`	Contains the keyword string that identifies the Help topic for the action.
`HelpType`	Keeps whether to use the HelpContext or HelpKeyword property to identify the Help topic.
`HideIfUnsupportedInterface`	Defines whether the UnSupported action can be visible and accessible.
`Hint`	Stores the Help hint text.
`ImageIndex`	Stores an index in a list of images.
`Index`	Specifies the index of the action in its action list.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`OnCanActionExec`	<Delphi property OnCanActionExec of type TSysCommonAction at 1619DBB56D0>
`OnExecute`	<Delphi property OnExecute of type TFileHideApp at 1619DBB6BF0>
`OnHint`	<Delphi property OnHint of type TSysCommonAction at 1619DBB5870>
`OnUpdate`	<Delphi property OnUpdate of type TSysCommonAction at 1619DBB57A0>
`Owner`	Indicates the component that is responsible for streaming and freeing this component.
`SecondaryShortCuts`	Stores shortcuts (in addition to ShortCut) for triggering the action.
`ShortCut`	Shortcut that triggers the action.
`ShortCutPressed`	Specifies that the action is fired by pressing a keyboard key, not by clicking with the mouse.
`StatusAction`	Stores the status for an input field in an action.
`Supported`	Defines whether the action can work on the current platform and CPU architecture.
`Tag`	Stores a NativeInt integral value as a part of a component.
`Target`	Defines the component for which the action is executed.
`Text`	Represents the caption of the action.
`UnsupportedArchitectures`	Defines the set of unsupported CPU architectures.
`UnsupportedPlatforms`	Defines the set of unsupported OS platforms.
`VCLComObject`	Represents information used internally by components that support COM.
`Visible`	Stores whether the action representation is visible.

ActionComponent#: Indicates the client component that caused this action to execute.

Create(AOwner: Component)#: Instantiates and initializes a FireMonkey TCustomAction object. FMX.StdActns.TFileHideApp.Create inherits from FMX.ActnList.TCustomAction.Create. All content below this line refers to FMX.ActnList.TCustomAction.Create. Instantiates and initializes a FireMonkey TCustomAction object. Applications do not need to call the constructor directly. Actions are created automatically when you add them to an action list component using New Action in the Action List editor at design time. If you want to create an action at run time, assign a TActionList component to its ActionList property after calling Create. AOwner is the component that is responsible for freeing the action. It becomes the value of the Owner property. Create calls an inherited System.Actions.TContainedAction.Create constructor and then initializes the Supported property with True .

CustomTextChanged()#: Introduces an interface for a function that is called when the CustomText property for the action changes. FMX.StdActns.TFileHideApp.CustomTextChanged inherits from FMX.ActnList.TCustomAction.CustomTextChanged. All content below this line refers to FMX.ActnList.TCustomAction.CustomTextChanged. Introduces an interface for a function that is called when the CustomText property for the action changes. As implemented in TCustomAction, CustomTextChanged does nothing. Descendant classes can override CustomTextChanged to provide business functionality. The announced purpose of this method is to update the Text property when the CustomText property is changed.

Execute()#: Generates an OnExecute event.

ExecuteTarget(Target: Object)#: Introduces an interface for invoking an action on a target client component or control. FMX.StdActns.TFileHideApp.ExecuteTarget inherits from System.Classes.TBasicAction.ExecuteTarget. All content below this line refers to System.Classes.TBasicAction.ExecuteTarget. Introduces an interface for invoking an action on a target client component or control. ExecuteTarget does nothing in TBasicAction. ExecuteTarget was introduced in TBasicAction so that descendants can override it to initiate the action on the target. For example, an edit action that performs copying might copy the contents of an edit control to the clipboard.

HandlesTarget(Target: Object) → Boolean#: Introduces an interface for verifying that the type and state of a target component or control are appropriate for the action. FMX.StdActns.TFileHideApp.HandlesTarget inherits from System.Classes.TBasicAction.HandlesTarget. All content below this line refers to System.Classes.TBasicAction.HandlesTarget. Introduces an interface for verifying that the type and state of a target component or control are appropriate for the action. HandlesTarget does nothing in TBasicAction. HandlesTarget was introduced in TBasicAction so that descendants can override it to check the type and state of a target. HandlesTarget can verify any information about a target that is relevant for the action. HandlesTarget returns True if the target meets the specified criteria, False otherwise.

OnExecute#: <Delphi property OnExecute of type TFileHideApp at 1619DBB6BF0>

ShortCut#: Shortcut that triggers the action. The value of Shortcut can be propagated to all client controls and client menu items linked to the action.

UnsupportedPlatforms#: Defines the set of unsupported OS platforms. The TPlatform type defines the pfWindows, pfMacOS, pfiOS, pfAndroid, and pfLinux constants that identify the Windows, Mac OS, Android, and other platforms. Use UnsupportedPlatforms to identify sets of unsupported OS platforms.

Update()#: Provides an opportunity to execute centralized code when an application is idle. FMX.StdActns.TFileHideApp.Update inherits from System.Classes.TBasicAction.Update. All content below this line refers to System.Classes.TBasicAction.Update. Provides an opportunity to execute centralized code when an application is idle. Update triggers the OnUpdate event handler. Update returns True if an event handler was found, False otherwise. When the application is idle, the OnUpdate event occurs for every action. This provides an opportunity for applications to execute centralized code for enabling and disabling, checking and unchecking, and so on.