diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 3335238628..dd99f244d3 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -12877,6 +12877,16 @@ application. Handler provides the Handle for the main form. + + +Handler signalled to execute an action. + + + + +Handler signalled to update an action. + + A queued asynchronous callback request node. @@ -14553,57 +14563,111 @@ to ensure that its resources are freed as needed. -Signals the OnActionExecute handler (when assigned). +Signals an OnActionExecute handler (when assigned).

ExecuteAction is an overridden Boolean function used to -signal the OnActionExecute (when assigned) using -ExeAction as the action executed in the event handler. It sets the -default value for the Handled argument to the event handler to -False. The argument can be updated in the event handler, and is used -as the return value for the method. +signal an OnActionExecute event handler assigned to the control. +ExecuteAction reimplements the method defined in the ancestor (TComponent) +and does not call the inherited method.

-ExecuteAction re-implements the method defined in the ancestor, and does -not call the inherited method. +ExecuteAction signals a TActionEvent event handler using the action instance +in ExeAction as an argument. The Handled argument in the event is +used as the return value for the method, and is set to True if the +action was successfully executed in an event handler. +

+

+In LCL version 2.4 or higher, multiple handler routines can be assigned which +use the ahtActionExecute event type. This situation can occur when +TApplicationProperties tries to assign an OnActionExecute handler to the +TApplication instance and it already has a user-specified handler. It can also +happen when the AddOnActionExecuteHandler method is called directly to add a +handler routine for the application event type. +

+

+If OnActionExecute handler is not assigned, or returns False, the other +handlers in the internal list are signalled to determine whether they can +execute the action. Each handler routine is signalled until one of them +changes the Handled argument in the event type to True. If none of the +routines can execute the action, the return value is False.

+ +Modified in in LCL version 2.4 to provide support for multiple OnActionExecute +event handlers in the application. + + + + +TActionEvent TComponent.ExecuteAction -True when the Action was handled in the event handler. + +True when the Action was handled in one of the event handlers for the +type. + -The Action to execute in the event handler. + +The Action to execute in the event handler. + -Signals the OnActionUpdate handler (when assigned). + +Signals an OnActionUpdate handler (when assigned). +

UpdateAction is an overridden Boolean function used to -signal the OnActionUpdate event handler (when assigned) to update -the settings for the action in TheAction. It sets the default -value for the Handled argument to the event handler to -False. The argument can be updated in the event handler, and is used -as the return value for the method. -

-

-UpdateAction re-implements the method defined in the ancestor, and does +signal an OnActionUpdate event handler (when assigned) to update +the settings in the action instance in TheAction. UpdateAction +reimplements the method defined in the ancestor (TComponent), and does not call the inherited method.

+

+UpdateAction signals a TActionEvent event handler using the action instance +in TheAction as an argument. The Handled argument in the event is +used as the return value for the method, and is set to True if the +action was successfully updated in an event handler. +

+

+In LCL version 2.4 or higher, multiple handler routines can be assigned which +use the ahtActionUpdate event type. This situation can occur when +TApplicationProperties tries to assign an OnActionUpdate handler to the +TApplication instance and it already has a user-specified handler. It can also +happen when the AddOnActionUpdateHandler method is called directly to add a +handler routine for the application event type. +

+

+If OnActionUpdate handler is not assigned, or returns False, the other +handlers in the internal list are signalled to determine whether they can +update the action. Each handler routine is signalled until one of them +changes the Handled argument in the event type to True. If none of the +routines can update the action, the return value is False. +

 + +Modified in in LCL version 2.4 to provide support for multiple OnActionUpdate +event handlers in the application. + -TComponent.UpdateAction + + + +TActionEvent +TComponent.UpdateAction True if the action was updated in the event handler. -The action updated in the event handler. +The action updated in an event handler. @@ -16031,6 +16095,86 @@ Handler routine removed in the method. + + +Adds the specified routine to the list of ahtActionExecute handlers for the +application. + + + +Added in LCL version 2.4. + + + + + +Handler routine added or inserted in the list of handlers for the type. + + + + +True if the handler routine is inserted as the first entry in the +handler list. False if the routine is appended to the end of the list. + + + + + +Removes the specified routine from the list of ahtActionExecute handlers for +the application. + + + +Added in LCL version 2.4. + + + + + +Handler routine located and removed in the method. + + + + + +Adds the specified routine to the list of ahtActionUpdate handlers for the +application. + + + +Added in LCL version 2.4. + + + + + +Handler routine added or inserted in the list of handlers for the type. + + + + +True if the handler routine is inserted as the first entry in the +handler list. False if the routine is appended to the end of the list. + + + + + +Removes the specified routine from the list of ahtActionUpdate handlers for +the application. + + + +Added in LCL version 2.4. + + + + + +Handler routine located and removed in the method. + + + Removes all handlers implemented for the specified object. @@ -17756,6 +17900,9 @@ similar to the TApplicationEvents class in Delphi. + + + Sets the value for the ExceptionDialog property. @@ -18095,6 +18242,40 @@ similar to the TApplicationEvents class in Delphi. New value for the property. + + +Sets the value for the OnActionExecute property. + + + + + + + + + + +New value for the OnActionExecute property. + + + + + +Sets the value for the OnActionUpdate property. + + + + + + + + + + +New value for the OnActionUpdate property. + + + Constructor for the class instance. @@ -18224,6 +18405,8 @@ singleton to be updated. + + The abstract base class for visual Form designers.