paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-06 21:18:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazControls. Updates topics in TListViewFilterEdit and TTreeFilterEdit for changes in 3692c658 and 764415b6.

Browse Source 
* TListViewFilterEdit.ReturnKeyHandled
* TTreeFilterEdit.ReturnKeyHandled
* TTreeFilterEdit.EditKeyDown
This commit is contained in:
dsiders 2023-11-21 00:11:35 +00:00
parent f8d06c652d
commit 83f6726288
2 changed files with 34 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
components/lazcontrols/docs/listviewfilteredit.xml
View File

@ -370,8 +370,21 @@ Move the associated list view control to the last list item.
Returns <b>True</b> if a Return or Enter key press was forwarded to the list
view control.
</short>
<descr/>
<seealso/>
<descr>
<p>
<var>ReturnKeyHandled</var> is an overridden <var>Boolean</var> 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.
</p>
</descr>
<seealso>
<link id="TListViewFilterEdit.FilteredListview"/>
<link id="#lcl.editbtn.TCustomControlFilterEdit.ReturnKeyHandled">TCustomControlFilterEdit.ReturnKeyHandled</link>
<link id="#lcl.editbtn.TCustomControlFilterEdit.EditKeyDown">TCustomControlFilterEdit.EditKeyDown</link>
<link id="#lcl.controls.TWinControl.OnKeyPress">TWinControl.OnKeyPress</link>
</seealso>
</element>
<element name="TListViewFilterEdit.ReturnKeyHandled.Result">
<short>

29
components/lazcontrols/docs/treefilteredit.xml
View File

@ -529,13 +529,22 @@ event handler for the associated tree view.
</short>
<descr>
<p>
Implements the abstract virtual method introduced in the
TCustomControlFilterEdit ancestor.
<var>ReturnKeyHandled</var> is an overridden <var>Boolean</var> 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.
</p>
<p>
The return value is <b>True</b> if the key down event was forwarded to the
FilteredTreeView control for the class instance.
</p>
</descr>
<seealso>
<link id="TTreeFilterEdit.FilteredTreeview"/>
<link id="#lcl.editbtn.TCustomControlFilterEdit.EditKeyDown">TCustomControlFilterEdit.EditKeyDown</link>
<link id="#lcl.controls.TWinControl.OnKeyPress">TWinControl.OnKeyPress</link>
</seealso>
</element>
<element name="TTreeFilterEdit.ReturnKeyHandled.Result">
@ -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.
</p>
<p>
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.
</p>
<p>
When FilteredTreeview has been assigned in the control, the following values
in Key and Shift are handled:
</p>
@ -575,13 +590,7 @@ Expands all of the tree nodes in the FilteredTreeview control.
</dd>
</dl>
<p>
The value in Key is set to 0 if it was forward handled using methods in the
tree view control.
</p>
<p>
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.
</p>
</descr>
<version>
@ -754,7 +763,7 @@ FilteredTreeview control.
<p>
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 <b>is</b>
tree node on exit. SelectionList is not changed if the selected node <b>is</b>
the first tree node in the selection list.
</p>
<p>