System.Actions.EnumRegisteredActionsProc

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

EnumRegisteredActionsProc: procedure(Proc: TEnumActionProc;
Info: Pointer;
const FrameworkType: string) = nil;

C++

extern DELPHI_PACKAGE void __fastcall (*EnumRegisteredActionsProc)(TEnumActionProc Proc, void * Info, const System::UnicodeString FrameworkType);

Properties

Type Visibility Source Unit Parent
variable public
System.Actions.pas
System.Actions.hpp
System.Actions System.Actions

Description

The global procedural variable that stores a procedure that iterates through the list of registered actions, passing them to the specified callback function.

The EnumRegisteredActionsProc procedural variable should store a procedure that iterates the list of registered actions, passing them to the user-defined Proc callback function. The IDE should assign the proper procedure to the EnumRegisteredActionsProc variable.

The EnumRegisteredActionsProc procedural variable has the following parameters:

Parameter Description
Proc

Specifies the user-defined callback function.

Belongs to the TEnumActionProc method pointer type having the following declaration:

TEnumActionProc = procedure(const Category: string;
   ActionClass: TBasicActionClass;
   Info: TEnumActionProcInfo) of object;
Here:
  • Category is the category of the action. For TContainedAction descendants, this is the Category property. For ancestor classes you can pass in an empty string.
  • ActionClass is the retrieved action object.
  • The Info parameter of the callback function is the same as the Info parameter passed to the main EnumRegisteredActions function. It allows the user to pass custom information to the callback function.
Info

Allows the user to pass custom information to the callback function.

FrameworkType Defines the GUI application framework where you want to use the action. Its value must be either "VCL" (default) or "FMX" (FireMonkey). You cannot use VCL actions in FireMonkey applications, or vice versa.

The default value is nil (Delphi) or NULL (C++).

See Also