diff --git a/components/lazcontrols/docs/listviewfilteredit.xml b/components/lazcontrols/docs/listviewfilteredit.xml index a9eccd35b3..050f80f330 100644 --- a/components/lazcontrols/docs/listviewfilteredit.xml +++ b/components/lazcontrols/docs/listviewfilteredit.xml @@ -370,8 +370,21 @@ Move the associated list view control to the last list item. Returns True if a Return or Enter key press was forwarded to the list view control. - - + +

+ReturnKeyHandled is an overridden Boolean function used +to the signal the OnKeyPress event handler in FilteredListView when a Return +(Enter) key down event is handled for the edit box on the control. No actions +are performed in the method if either FilteredListView or its OnKeyPress event +handler have not been assigned. +

+
+ + +TCustomControlFilterEdit.ReturnKeyHandled +TCustomControlFilterEdit.EditKeyDown +TWinControl.OnKeyPress + diff --git a/components/lazcontrols/docs/treefilteredit.xml b/components/lazcontrols/docs/treefilteredit.xml index acc3c66914..c14f67f7b8 100644 --- a/components/lazcontrols/docs/treefilteredit.xml +++ b/components/lazcontrols/docs/treefilteredit.xml @@ -529,13 +529,22 @@ event handler for the associated tree view.

-Implements the abstract virtual method introduced in the -TCustomControlFilterEdit ancestor. +ReturnKeyHandled is an overridden Boolean function which +implements the abstract virtual method introduced in the +TCustomControlFilterEdit ancestor. ReturnKeyHandled is used to forward a Return +(Enter) key to the FilteredTreeView for the control when it is handled in the +edit box for the control. No actions are performed in the method if either +FilteredTreeView or its OnKeypress event handler has not been assigned. +

+

+The return value is True if the key down event was forwarded to the +FilteredTreeView control for the class instance.

TCustomControlFilterEdit.EditKeyDown +TWinControl.OnKeyPress
@@ -555,6 +564,12 @@ It extends the inherited method to ensure that key strokes in the Edit for the control are applied (when needed) to its FilteredTreeview control.

+EditKeyDown calls the inherited method on entry to handle key down events +supported in the TCustomControlFilterEdit ancestor. The value in Key is set to +0 if it was handled in the inherited method, and no additional actions are +performed in the method. +

+

When FilteredTreeview has been assigned in the control, the following values in Key and Shift are handled:

@@ -575,13 +590,7 @@ Expands all of the tree nodes in the FilteredTreeview control.

-The value in Key is set to 0 if it was forward handled using methods in the -tree view control. -

-

-If Key has a value that is not handled in the method, or FilteredTreeview is -unassigned, the inherited method is called to handle the key combination for -the control. +The value in Key is set to 0 if it was handled in the method.

@@ -754,7 +763,7 @@ FilteredTreeview control.

Values in SelectionList are cleared and reloaded if the selected tree node is not the first node in the list; SelectionList will contain only the selected -tree node on exit. SelectionList is not changed if the selected node is +tree node on exit. SelectionList is not changed if the selected node is the first tree node in the selection list.