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

Docs: Documentation updates for LCL and LazUtils. Issue #38242, patch from Don Siders.

Browse Source 
git-svn-id: trunk@64264 -
This commit is contained in:
juha 2020-12-22 09:07:46 +00:00
parent 9c3791702a
commit 43f81d24b9
6 changed files with 617 additions and 360 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/xml/lazutils/avglvltree.xml
View File

@ -526,6 +526,18 @@
<short></short>
</element>
<element name="TPointerToPointerTree.FindByValue">
<short>Finds a Key by its Value using a slow linear search.</short>
<descr/>
<seealso/>
</element>
<element name="TPointerToPointerTree.FindByValue.Result">
<short>Pointer to the Key or Nil</short>
</element>
<element name="TPointerToPointerTree.FindByValue.AValue">
<short/>
</element>
<element name="TPointerToPointerTree.Count">
<short>
<var>Count</var> - the number of items

443
docs/xml/lazutils/lazclasses.xml
View File

@ -1,225 +1,274 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<package name="lazutils">
<!--
====================================================================
LazClasses
====================================================================
-->
<module name="LazClasses">
<short>Contains classes and routines used to implement free notifications</short>
<descr></descr>
<!--
====================================================================
LazClasses
====================================================================
-->
<!-- unresolved external references -->
<element name="SysUtils"/>
<element name="Classes"/>
<element name="LazMethodList"/>
<module name="LazClasses">
<short></short>
<descr>
</descr>
<element name="TFreeNotifyingObject">
<short>Base class used to implement objects which perform free notifications</short>
<descr/>
<seealso/>
</element>
<!-- class Visibility: default -->
<element name="TFreeNotifyingObject">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TFreeNotifyingObject.FFreeNotificationList">
<short>List of notification methods called when the object is freed</short>
</element>
<!-- variable Visibility: private -->
<element name="TFreeNotifyingObject.FFreeNotificationList">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TFreeNotifyingObject.Destroy">
<short>Destructor for the class instance</short>
<descr/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TFreeNotifyingObject.Create">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TFreeNotifyingObject.AddFreeNotification">
<short>Adds the specified method to the notification list in the class instance</short>
<descr/>
<seealso/>
</element>
<element name="TFreeNotifyingObject.AddFreeNotification.ANotification">
<short>The notification event handler added to the internal list</short>
</element>
<!-- destructor Visibility: public -->
<element name="TFreeNotifyingObject.Destroy">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TFreeNotifyingObject.RemoveFreeNotification">
<short>Removes the specified method from the internal list</short>
<descr/>
<seealso/>
</element>
<element name="TFreeNotifyingObject.RemoveFreeNotification.ANotification">
<short>The notification event handler removed form the internal list</short>
</element>
<!-- procedure Visibility: public -->
<element name="TFreeNotifyingObject.AddFreeeNotification">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject">
<short>Implements a thread-safe reference-counted class which performs free notifications</short>
<descr>
<p>
Used in the implementation of logging classes and the debugger interface in Lazarus. Also used in the implementation of classes for TSynEdit.
</p>
</descr>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TFreeNotifyingObject.AddFreeeNotification.ANotification">
<short></short>
</element>
<element name="TRefCountedObject.FRefCount">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TFreeNotifyingObject.RemoveFreeeNotification">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.FIncDecRefCount">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TFreeNotifyingObject.RemoveFreeeNotification.ANotification">
<short></short>
</element>
<element name="TRefCountedObject.FDebugNext">
<short/>
</element>
<!-- class Visibility: default -->
<element name="TRefCountedObject">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.FDebugPrev">
<short/>
</element>
<!-- variable Visibility: private -->
<element name="TRefCountedObject.FRefCount">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.FDebugList">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TRefCountedObject.DoFree">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.FCritSect">
<short/>
</element>
<!-- property Visibility: protected -->
<element name="TRefCountedObject.RefCount">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.FInDestroy">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TRefCountedObject.Create">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.DbgAddName">
<short/>
<descr/>
<seealso/>
</element>
<element name="TRefCountedObject.DbgAddName.DebugIdAdr">
<short/>
</element>
<element name="TRefCountedObject.DbgAddName.DebugIdTxt">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TRefCountedObject.Destroy">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.DbgRemoveName">
<short/>
<descr/>
<seealso/>
</element>
<element name="TRefCountedObject.DbgRemoveName.DebugIdAdr">
<short/>
</element>
<element name="TRefCountedObject.DbgRemoveName.DebugIdTxt">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TRefCountedObject.AddReference">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.DoFree">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TRefCountedObject.ReleaseReference">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.DoReferenceAdded">
<short/>
<descr/>
<seealso/>
</element>
<!-- class Visibility: default -->
<element name="TRefCntObjList">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.DoReferenceReleased">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TRefCntObjList.Notify">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.RefCount">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TRefCntObjList.Notify.Ptr">
<short></short>
</element>
<element name="TRefCountedObject.Create">
<short/>
<descr/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TRefCntObjList.Notify.Action">
<short></short>
</element>
<element name="TRefCountedObject.Destroy">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="ReleaseRefAndNil">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TRefCountedObject.AddReference">
<short/>
<descr>
<p>
AddReference and ReleaseReference can be used in threads. However a thread can only call the
methods, if either:
</p>
<ul>
<li>The thread already holds a refernce (and no other thread will release that reference).</li>
<li>The thread created the reference, and no other thread has access to the object (yet).</li>
<li>
The thread is in a critical section, preventing other threads from decreasing the reference
count.
</li>
</ul>
</descr>
<seealso/>
</element>
<element name="TRefCountedObject.AddReference.DebugIdAdr">
<short/>
</element>
<element name="TRefCountedObject.AddReference.DebugIdTxt">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ReleaseRefAndNil.ARefCountedObject">
<short></short>
</element>
<element name="TRefCountedObject.ReleaseReference">
<short/>
<descr>
<p>
AddReference and ReleaseReference can be used in threads. However a thread can only call the
methods, if either:
</p>
<ul>
<li>The thread already holds a refernce (and no other thread will release that reference).</li>
<li>The thread created the reference, and no other thread has access to the object (yet).</li>
<li>
The thread is in a critical section, preventing other threads from decreasing the reference
count.
</li>
</ul>
</descr>
<seealso/>
</element>
<element name="TRefCountedObject.ReleaseReference.DebugIdAdr">
<short/>
</element>
<element name="TRefCountedObject.ReleaseReference.DebugIdTxt">
<short/>
</element>
</module> <!-- LazClasses -->
<element name="TRefCountedObject.DbgRenameReference">
<short/>
<descr/>
<seealso/>
</element>
<element name="TRefCountedObject.DbgRenameReference.DebugIdAdr">
<short/>
</element>
<element name="TRefCountedObject.DbgRenameReference.DebugIdTxt">
<short/>
</element>
<element name="TRefCountedObject.DbgRenameReference.OldDebugIdAdr">
<short/>
</element>
<element name="TRefCountedObject.DbgRenameReference.OldDebugIdTxt">
<short/>
</element>
</package>
<element name="TRefCntObjList">
<short>Implements a list used to store TRefCountedObject instances</short>
<descr>
<p>
Provides a <var>Notify</var> method which executes the notification methods for each reference-counted object in the list.
</p>
</descr>
<seealso/>
</element>
<element name="TRefCntObjList.Notify">
<short/>
<descr/>
<seealso/>
</element>
<element name="TRefCntObjList.Notify.Ptr">
<short/>
</element>
<element name="TRefCntObjList.Notify.Action">
<short/>
</element>
<element name="ReleaseRefAndNil">
<short/>
<descr/>
<seealso/>
</element>
<element name="ReleaseRefAndNil.ARefCountedObject">
<short/>
</element>
<element name="ReleaseRefAndNil.DebugIdAdr">
<short/>
</element>
<element name="ReleaseRefAndNil.DebugIdTxt">
<short/>
</element>
<element name="NilThenReleaseRef">
<short/>
<descr/>
<seealso/>
</element>
<element name="NilThenReleaseRef.ARefCountedObject">
<short/>
</element>
<element name="NilThenReleaseRef.DebugIdAdr">
<short/>
</element>
<element name="NilThenReleaseRef.DebugIdTxt">
<short/>
</element>
</module>
<!-- LazClasses -->
</package>
</fpdoc-descriptions>

173
docs/xml/lcl/comctrls.xml
View File

@ -1066,14 +1066,18 @@
</element>
<element name="TCustomPage">
<short>
<var>TCustomPage</var>: The base type for <var>Page</var>
</short>
<short>The base class for TTabSheet</short>
<descr>
<var>TCustomPage</var>: The base type for the tabbed pages found in notebooks.
<p>
<var>TCustomPage</var> is a <var>TWinControl</var> descendant which implements the base class for the tabbed pages found in notebooks. TCustomPage provides properties used to maintain the order and visibility of the page, and event handlers signalled when the page is hidden or displayed.
</p>
</descr>
<seealso>
<link id="#lcl.ExtCtrls.Multi-PageControls">Multi-PageControls</link>
<link id="TTabSheet"/>
<link id="TPageControl"/>
<link id="TCustomTabControl.Page"/>
<link id="TCustomTabControl.ActivePageComponent"/>
</seealso>
</element>
@ -1135,8 +1139,15 @@
<short>
Contains flag values that represent the status or state for the handle in the custom page control
</short>
<descr/>
<seealso/>
<descr>
<p>
Values in <var>Flags</var> are normally added or removed when changes are performed in a control which uses the page control class instance. See <var>TPageFlag</var> for more information about enumeration values and their meanings.
</p>
</descr>
<seealso>
<link id="TPageFlags"/>
<link id="TPageFlag"/>
</seealso>
</element>
<element name="TCustomPage.CMHitTest" link="#LCL.Controls.TControl.CMHitTest">
@ -1148,7 +1159,7 @@
<short/>
</element>
<element name="TCustomPage.CMVisibleChanged">
<element name="TCustomPage.CMVisibleChanged" link="#lcl.controls.TWinControl.CMVisibleChanged">
<short/>
<descr/>
<seealso/>
@ -1158,23 +1169,25 @@
</element>
<element name="TCustomPage.GetPageIndex">
<short>
<var>GetPageIndex</var> - returns the index of the current page</short>
<short>Gets the value for the PageIndex property</short>
<descr/>
<seealso/>
<seealso>
<link id="TCustomPage.PageIndex"/>
</seealso>
</element>
<element name="TCustomPage.GetPageIndex.Result">
<short/>
<short>Value for the property</short>
</element>
<element name="TCustomPage.SetPageIndex">
<short>
<var>SetPageIndex</var> - specifies an index for the current page</short>
<short>Sets the value for the PageIndex property</short>
<descr/>
<seealso/>
<seealso>
<link id="TCustomPage.PageIndex"/>
</seealso>
</element>
<element name="TCustomPage.SetPageIndex.AValue">
<short/>
<short>New value for the property</short>
</element>
<element name="TCustomPage.GetTabVisible">
@ -1193,7 +1206,9 @@
Provides support for TCustomTabControl as parent when handling dialog accelerator keys
</short>
<descr>
Calls the inherited DoalogChar method when Parent is not derived from TCustomTabControl.
<p>
Calls the inherited DialogChar method when Parent is not derived from TCustomTabControl.
</p>
</descr>
<seealso/>
</element>
@ -1219,9 +1234,7 @@
</element>
<element name="TCustomPage.DestroyHandle" link="#LCL.Controls.TWinControl.DestroyHandle">
<short>
Removes values in the Flags property when the handle for the control is freed
</short>
<short>Updates the Flags property when the handle for the control is freed</short>
<descr/>
<seealso/>
</element>
@ -1236,24 +1249,30 @@
</element>
<element name="TCustomPage.Create">
<short>
<var>Create</var> - constructor for <var>TCustomPage</var>: calls inherited <var>Create</var> then initializes style, visibility, alignment and caption</short>
<descr/>
<short>Constructor for the class instance</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for <var>TCustomPage</var>.
</p>
<p>
Create calls the inherited constructor on entry and sets the default value for the style, visibility, alignment and caption in the class instance.
</p>
</descr>
<seealso>
<link id="#lcl.Controls.TControl.Create">TControl.Create</link>
<link id="#lcl.controls.TWinControl.Create"/>
</seealso>
</element>
<element name="TCustomPage.Create.TheOwner">
<short>Owner of the class instance</short>
</element>
<element name="TCustomPage.CanTab" link="#LCL.Controls.TControl.CanTab"/>
<element name="TCustomPage.CanTab" link="#lcl.controls.TWinControl.CanTab"/>
<element name="TCustomPage.CanTab.Result"/>
<element name="TCustomPage.IsControlVisible" link="#lcl.Controls.TControl.IsControlVisible"/>
<element name="TCustomPage.IsControlVisible.Result"/>
<element name="TCustomPage.HandleObjectShouldBeVisible" link="#LCL.Controls.TControl.HandleObjectShouldBeVisible">
<element name="TCustomPage.HandleObjectShouldBeVisible" link="#lcl.controls.TControl.HandleObjectShouldBeVisible">
<short/>
<descr/>
<seealso/>
@ -1294,14 +1313,19 @@
</element>
<element name="TCustomPage.PageIndex">
<short>
<var>PageIndex </var>- integer index value for this page in the notebook</short>
<short>Ordinal position for the page in the parent control</short>
<descr>
<p>
<var>PageIndex</var> is an Integer property which contains the ordinal position for the page control in a <var>Parent</var> control. Setting a new value for the property causes the Parent control to call its <var>MoveTab</var> method to reorder the pages on the control. This action is performed when Parent is descended from <var>TCustomTabControl</var>.
</p>
</descr>
<seealso>
<link id="TCustomTabControl"/>
</seealso>
</element>
<element name="TCustomPage.TabVisible">
<short>
Indicates if the tab in the Parent control should be visible
</short>
<short>Indicates if the tab in the Parent control should be visible</short>
<descr>
<p>
<var>TabVisible</var> indicates if the Tab in the <var>Parent</var> control is visible.
@ -2176,7 +2200,17 @@
<element name="TCustomTabControl.ShowCurrentPage">
<short>Ensures that the current page has its Visible property set to True</short>
<descr/>
<descr>
<p>
<var>ShowCurrentPage</var> checks the value in <var>PageIndex</var> to determine if a valid page index has been specified. No actions are performed in the method when PageIndex is less than <b>0</b> or greater than <b>PageCount - 1</b>.
</p>
<p>
ShowCurrentPage gets the <var>TCustomPage</var> instance in <var>Page</var> at the position in <var>PageIndex</var>, and sets its <var>Visible</var> property to <b>True</b>. If the Page is Enabled, it <var>SetFocus</var> method is called.
</p>
<p>
ShowCurrentPage sets the Visible property in the previously selected Page to <b>False</b>.
</p>
</descr>
<seealso/>
</element>
@ -2695,8 +2729,18 @@
</element>
<element name="TCustomTabControl.TabToPageIndex">
<short/>
<descr/>
<short>Gets the real page index for the specified tab</short>
<descr>
<p>
<var>TabToPageIndex</var> is an <var>Integer</var> function used to get the page index for the tab at the specified position. The tab index value in <var>AIndex</var> does not include any non-visible tabs. TabToPageIndex adjusts the index value to include any <var>TCustomPage</var> instances in <var>Page</var> with its <var>TabVisible</var> property set to <b>False</b>.
</p>
<p>
The return value contains the value specified in AIndex after adding any non-visible pages proper to the requested position.
</p>
<p>
No actions are performed in the method at design-time; all pages are visible on the designer surface.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomTabControl.TabToPageIndex.Result">
@ -2848,7 +2892,7 @@
</element>
<element name="TCustomTabControl.Pages">
<short>The contents of the <var>Pages</var> in the Notebook (as Strings)</short>
<short>The list of page names in the control</short>
<descr/>
<seealso/>
</element>
@ -17923,28 +17967,8 @@
</short>
<descr>
<p>
<var>TTreeViewState</var> - enumerated type containing the permissible values for state of a <var>TTreeView</var>
<var>TTreeViewState</var> is an enumerated type containing the permissible state values for <var>TTreeView</var>.
</p>
<pre>tvsScrollbarChanged,
tvsMaxRightNeedsUpdate,
tvsTopsNeedsUpdate,
tvsMaxLvlNeedsUpdate,
tvsTopItemNeedsUpdate,
tvsBottomItemNeedsUpdate,
tvsCanvasChanged,
tvsDragged,
tvsIsEditing,
tvsStateChanging,
tvsManualNotify,
tvsUpdating,
tvsPainting,
tvsMouseCapture,
tvsWaitForDragging,
tvsDblClicked,
tvsTripleClicked,
tvsQuadClicked,
tvsSelectionChanged
</pre>
</descr>
<seealso/>
</element>
@ -18119,19 +18143,22 @@
<p>
A series of defaults used to set the options of a TreeView object when first placed on a form. This set consists of the following items:
</p>
<pre>
tvoShowRoot,
tvoShowLines,
tvoShowButtons,
tvoHideSelection,
tvoToolTips,
tvoKeepCollapsedNodes,
tvoAutoItemHeight
</pre>
<ul>
<li>tvoShowRoot</li>
<li>tvoShowLines</li>
<li>tvoShowButtons</li>
<li>tvoHideSelection</li>
<li>tvoToolTips</li>
<li>tvoKeepCollapsedNodes</li>
<li>tvoAutoItemHeight</li>
</ul>
<p>
For the meaning of these options, see the documentation of <var>TTreeView</var>.
</p>
</descr>
<seealso>
<link id="TTreeView"/>
</seealso>
</element>
<element name="DefaultMultiSelectStyle">
@ -18192,25 +18219,19 @@
<element name="TCustomTreeView">
<short>
<var>TCustomTreeView</var> - ancestor class for <var>TTreeView</var>
Ancestor class for <var>TTreeView</var>
</short>
<descr>
<p>
<var>TCustomTreeView</var> - ancestor class for <var>TTreeView</var>,
which displays a collection of items in a hierarchical tree form.
This class defines many properties which are inherited by children classes,
including loading the data from files or streams, saving to files or streams,
updating, sorting alphabetically, editing, making visible or invisible, expanding
or collapsing the tree display, and many more.
<var>TCustomTreeView</var> - ancestor class for <var>TTreeView</var>, which displays a collection of items in a hierarchical tree form. This class defines many properties which are inherited by descendent classes, including loading the data from files or streams, saving to files or streams, updating, sorting alphabetically, editing, making visible or invisible, expanding or collapsing the tree display, and many more.
</p>
<p>
Please note that Accessibility support in TCustomTreeView might make this control
slower if there is a very large number of items, for example, 10.000+ items.
If the performance impact is unacceptable it is possible to turn accessibility
off for tree view items by setting TCustomTreeView.AccessibilityOn to false.
The default value is true.
Please note that Accessibility support in TCustomTreeView might make this control slower if there are a very large number of items, for example: 10,000+ items. If the performance impact is unacceptable, it is possible to turn accessibility off for tree view items by setting the <var>AccessibilityOn</var> property to <b>False</b>. The default value is <b>True</b>.
</p>
</descr>
<seealso>
<link id="TTreeView"/>
</seealso>
</element>
<element name="TCustomTreeView.FAccessibilityOn"/>

46
docs/xml/lcl/controls.xml
View File

@ -11029,6 +11029,12 @@
<short/>
<notes><note>?</note></notes>
</element>
<element name="TWinControlFlag.wcfDesignerDeleting">
<short>Only used for TCustomPairSplitter / TPairSplitter</short>
</element>
<element name="TWinControlFlag.wcfSpecialSubContro">
<short>Only used for TCustomPairSplitter / TPairSplitter</short>
</element>
<element link="#lcl.controls.TWinControlFlag" name="TWinControlFlags">
<short>Set of TWinControlFlag enumeration values</short>
@ -11310,7 +11316,6 @@
<element link="#lcl.controls.TWinControl.Showing" name="TWinControl.FShowing"/>
<element link="#lcl.controls.TWinControl.DockSite" name="TWinControl.FDockSite"/>
<element link="#lcl.controls.TWinControl.UseDockManager" name="TWinControl.FUseDockManager"/>
<element name="TWinControl.FDesignerDeleting"/>
<element name="TWinControl.AlignControl">
<short>Aligns the control and its child controls</short>
@ -11393,6 +11398,17 @@
<short/>
</element>
<element name="TWinControl.GetIsSpecialSubControl">
<short>Gets the value for the IsSpecialSubControl property</short>
<descr/>
<seealso>
<link id="TWinControl.IsSpecialSubControl"/>
</seealso>
</element>
<element name="TWinControl.GetIsSpecialSubControl.Result">
<short>Value for the property</short>
</element>
<element link="#lcl.controls.TWinControl.TabOrder" name="TWinControl.GetTabOrder"/>
<element name="TWinControl.GetTabOrder.Result">
<short/>
@ -11412,6 +11428,17 @@
<short/>
</element>
<element name="TWinControl.SetDesignerDeleting">
<short>Sets the value for the DesignerDeleting property</short>
<descr/>
<seealso>
<link id="TWinControl.DesignerDeleting"/>
</seealso>
</element>
<element name="TWinControl.SetDesignerDeleting.AValue">
<short>New value for the property</short>
</element>
<element link="#lcl.controls.TWinControl.DockSite" name="TWinControl.SetDockSite"/>
<element name="TWinControl.SetDockSite.NewDockSite">
<short/>
@ -13812,7 +13839,22 @@
<element name="TWinControl.DesignerDeleting">
<short/>
<descr/>
<descr>
<p>
<var>DesignerDeleting</var> is a <var>Boolean</var> property.
</p>
</descr>
<seealso/>
</element>
<element name="TWinControl.IsSpecialSubControl">
<short/>
<descr>
<p>
<var>IsSpecialSubControl</var> is a read-only <var>Boolean</var> property.
Used in <var>TCustomPairSplitter</var> only.
</p>
</descr>
<seealso/>
</element>

232
docs/xml/lcl/filectrl.xml
View File

@ -7,9 +7,19 @@
====================================================================
-->
<module name="FileCtrl">
<short>Implements a list box used to select files on the local file system</short>
<short>Implements list box and combo-box controls used to select files on the local file system</short>
<descr/>
<!-- unresolved external references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="StdCtrls"/>
<element name="FileUtil"/>
<element name="LazFileUtils"/>
<element name="Masks"/>
<element name="Graphics"/>
<element name="ShellCtrls"/>
<element name="TFileAttr">
<short>Enumerated type with file and directory attributes used in TFileListBox</short>
<descr>
@ -44,22 +54,22 @@
</element>
<element name="TFileAttr.ftHidden">
<short>
File is hidden. For UNIX-like environments, the means that the file name starts with a '.' (Dot) character.
File is hidden. For UNIX-like environments, this means that the file name starts with a <b>'.'</b> (<b>Period</b>) character.
</short>
</element>
<element name="TFileAttr.ftSystem">
<short>
File is a sytem file. For UNIX-like environements, this means it is a character, block, or FIFO file.
File is a sytem file. For UNIX-like environements, this means that it is a character, block, or FIFO file.
</short>
</element>
<element name="TFileAttr.ftVolumeID">
<short>
Drive Volume label used on the Windows FAT (not FAT32) file system. Not used on UNIX-like file systems.
Drive Volume label used on the Windows FAT (not FAT32) file system. Volume labels are not used on UNIX-like file systems.
</short>
</element>
<element name="TFileAttr.ftDirectory">
<short>
FIle is a directory.
FIle is a directory entry.
</short>
</element>
<element name="TFileAttr.ftArchive">
@ -74,7 +84,7 @@
</element>
<element name="TFileType">
<short>Set used to store file attributes</short>
<short>Set type used to store file attributes</short>
<descr>
<p>
<var>TFileType</var> is a set type used to store zero (0) or more enumeration values from <var>TFileAttr</var>. TFileType is the type used to implement the <var>FileType</var> property in <var>TFileListBox</var>.
@ -93,25 +103,28 @@
<var>TCustomFileListBox</var> is a TCustomListBox descendant which implements the base type for <var>TFileListBox</var>. TCustomFileListBox extends the ancestor with properties, methods, and events used to select a file or directory on the local file system in a list box control.
</p>
<p>
Use the Drive and Directory properties to specify the location on the local file sytem displayed in the list box. Please note: Drive is not used on UNIX-like file systems.
Use the <var>Drive</var> and <var>Directory</var> properties to specify the location on the local file sytem displayed in the list box. Please note that Drive is not used on UNIX-like file systems.
</p>
<p>
Use FileType to specify the files and/or directories which can be displayed in the control.
Use <var>FileType</var> to specify the files and/or directories which can be displayed in the control.
</p>
<p>
Use Mask to specify a file mask (with optional wildcards) used to select the files displayed in the control. Please note: Wild cards may be implemented differently for some file systems. For example: '*' is the "all files" mask on UNIX-like file systems instead of "*.*".
Use <var>Mask</var> to specify a file mask (with optional wildcards) used to select the files displayed in the control. Please note that wild cards may be implemented differently for some file systems. For example: <b>'*'</b> is the "all files" mask on UNIX-like file systems instead of <b>"*.*"</b>.
</p>
<p>
Use the Sorted property to control the order of files and directories displayed in the control.
Use the <var>Sorted</var> property to control the order of files and directories displayed in the control.
</p>
<p>
Use the FileName property to get the current file selection in the control.
Use <var>Items</var> to access the file and/or directory names matching the FileType and Mask in the current Directory for the control. Directory names are enclosed in square brackets (<b>[]</b>).
</p>
<p>
Assign an object procedure to the OnChange event handler to perform actions needed when a new item has been selected in the control.
Use <var>FileName</var> or <var>ItemIndex</var> to get or set the current selection in the control.
</p>
<p>
Do not create instances of TCustomFileListBox. Use the TFileListBox descendant which sets the visibility of properties used in the class instance.
Assign an object procedure to the <var>OnChange</var> event handler to perform actions needed when a new item has been selected in the control.
</p>
<p>
Do not create instances of <var>TCustomFileListBox</var>. Use the <var>TFileListBox</var> descendant which sets the visibility of properties used in the class instance.
</p>
</descr>
<seealso>
@ -137,7 +150,7 @@
</element>
<element name="TCustomFileListBox.MaskIsStored.Result">
<short>
True when a value other than the all directory entries mask has been assigned to the property
True when a value other than the all directory entries mask (<b>'*'</b>) has been assigned to the property
</short>
</element>
@ -244,7 +257,7 @@
<var>IndexOfFile</var> is an Integer function used to get the ordinal position for the specified file name in the list of file names in the control. <var>AFilename</var> contains the file name to locate in the method.
</p>
<p>
IndexOfFile handles drive and volume entries that may be stored in <var>Items</var> by ignoring the square brackets ('<b>[]</b>') used to surround values with the corresponding file attributes. The <var>CompareFileNames</var> routine from <file>LazFileUtils</file> is used to perform file name comparisions.
IndexOfFile handles drive and volume entries that may be stored in <var>Items</var> by ignoring the square brackets (<b>[]</b>) used to surround values with the corresponding file attributes. The <var>CompareFileNames</var> routine from <file>LazFileUtils</file> is used to perform file name comparisions.
</p>
<p>
The return value is <b>-1</b> when AFilename is not stored in the Items property.
@ -282,22 +295,45 @@
<short>Shift, Alt, or Ctrl modifier for the virtual key</short>
</element>
<element name="TCustomFileListBox.SetItemIndex">
<short>Sets the value for the ItemIndex property</short>
<descr>
<p>
<var>SetItemIndex</var> is an overridden method in <var>TCustomFileListBox</var>. Calls the inherited method on entry. Calls <var>UpdateSelectedFileName</var> to set the new value for the <var>FileName</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomListBox.SetItemIndex"/>
<link id="#lcl.stdctrls.TCustomListBox.ItemIndex"/>
<link id="TCustomFileListBox.FileName"/>
</seealso>
</element>
<element name="TCustomFileListBox.SetItemIndex.AIndex">
<short>New value for the property</short>
</element>
<element name="TCustomFileListBox.Create">
<short>Constructor for the class instance</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create sets the default values for properties in the class instance, including:
</p>
<ul>
<li>Mask</li>
<li>FileType</li>
<li>Drive</li>
<li>Directory</li>
<li>MultiSelect</li>
<li>Sorted</li>
</ul>
<dl>
<dt>Mask</dt>
<dd>Set to the AllDirectoryEntriesMask ('*')</dd>
<dt>FileType</dt>
<dd>Set to [ftNormal]</dd>
<dt>Directory</dt>
<dd>Set to the value from GetCurrentDirUTF8</dd>
<dt>Drive</dt>
<dd>Contains the value form ExtractFileDrive, or an empty string</dd>
<dt>MultiSelect</dt>
<dd>Set to False</dd>
<dt>Sorted</dt>
<dd>Set to True after files have been loaded in UpdateFileList</dd>
</dl>
<p>
Create calls the <var>UpdateFileList</var> method to load the file and directory names for the current directory into the Items property.
Create calls the <var>UpdateFileList</var> method to load the file and directory names for the current directory into the <var>Items</var> property.
</p>
</descr>
<seealso>
@ -357,7 +393,10 @@
UpdateFileList calls <var>Clear</var> to remove any existing values in the <var>Items</var> property.
</p>
<p>
Values in <var>FileType</var> are used to construct the corresponding file attributes needed for use with <var>TSearchRec</var>. The <var>FindFirstUTF8</var> and <var>FindNextUTF8</var> routines from <file>LazFileUtils</file> are used to find matching file or directory names in the <var>Directory</var> for the control. Each value returned for the TSearchRec is compared to the <var>Mask</var> and <var>FileType</var> defined in the control. Acceptable values are added to the <var>Items</var> property. Please note: Directory names are surrounded by <b>square brackets</b> (<b>'[]'</b>) when added to the Items property.
Values in <var>FileType</var> are used to construct file attributes needed for use with <var>TSearchRec</var>. The <var>FindFirstUTF8</var> and <var>FindNextUTF8</var> routines from <file>LazFileUtils</file> are used to find matching file or directory names in the <var>Directory</var> for the control. Each value returned for the TSearchRec is compared to the <var>Mask</var> and <var>FileType</var> defined in the control. Acceptable values are added to the <var>Items</var> property.
</p>
<p>
Please note that Directory names (included when FileType contains ftDirectory) are surrounded by <b>square brackets</b> (<b>'[]'</b>) when added to the Items property.
</p>
<p>
The private <var>UpdateSelectedFileName</var> method is called to include path information in <var>FileName</var> for the selected item in the control.
@ -381,6 +420,9 @@
<p>
Use Directory to specify the path on the local file system to the entries displayed in the control.
</p>
<remark>
Setting a new value in Drive does not automatically alter the value in Directory. Always assign an explicit value to Directory when setting the value in Drive. In addition, setting a value in Directory which includes a drive designator like 'd:\config\' does not update the value in Drive. The only time Drive is automatically sync'd to the value in Directory is in the Create constructor.
</remark>
</descr>
<seealso>
<list id="TCustomFileListBox.Create"/>
@ -394,16 +436,26 @@
<short>The <var>Directory</var> or Folder in which the file is located</short>
<descr>
<p>
<var>Directory</var> is a <var>String</var> property which contains the path on the local file system to the files or and/or directories displayed in the list box control. The initial value for Directory is assigned in the constructor and uses the current directory for the application.
<var>Directory</var> is a <var>String</var> property which contains the path on the local file system to the files or and/or directories displayed in the list box control. The initial value for Directory is assigned in the constructor and defaults to the current directory for the application.
</p>
<p>
The value in Directory is prepended to the value used in <var>Filename</var> in the private <var>UpdateSelectedFileName</var> method.
The value in Directory is prepended to the value in <var>Filename</var> when the <var>UpdateSelectedFileName</var> method is called from methods like: <var>Click</var>, <var>KeyUp</var>, <var>SetItemIndex</var>, <var>SetFileName</var>.
</p>
<p>
Changing the value in Directory causes the <var>UpdateFileList</var> method to be called to reload the file and or directory names stored in the <var>Items</var> property.
</p>
<remark>
Changing the value in Directory does not automatically update the value in Drive. If Directory includes a drive designator like 'D:\config\', it is not proogated to the Drive property. In addition, setting a value in Drive does not update the value in Director. The only time Drive and Directory are automatically sync'd is in the Create constructor.
</remark>
</descr>
<seealso/>
<seealso>
<link id="TCustomFileListBox.FileName"/>
<link id="TCustomFileListBox.ItemIndex"/>
<link id="TCustomFileListBox.UpdateFileList"/>
<link id="TCustomFileListBox.Click"/>
<link id="TCustomFileListBox.KeyUp"/>
<link id="TCustomFileListBox.SetItemIndex"/>
</seealso>
</element>
<element name="TCustomFileListBox.FileName">
@ -453,16 +505,16 @@
<short>Contains the mask for files selected for the control</short>
<descr>
<p>
<var>Mask</var> should be filled with one or more file masks separated by semi-colons. For example: "*.pdf;*.svg" will show all files with the extensions pdf and svg. The default value for the property is "*" which is the generic mask meaning any file. Do not use the Windows specific mask "*.*" to attempt to show all files, which is the behavior from Delphi. In the LCL version of the control "*.*" will require the file name to have an extension.
<var>Mask</var> should be filled with one or more file masks separated by semi-colons. For example: <b>'*.pdf;*.svg'</b> will show all files with the extensions pdf and svg. The default value for the property is "*" which is the generic mask meaning any file or directory. Do not use the Windows specific mask <b>'*.*'</b> to attempt to show all files, which is the behavior from Delphi. In the LCL version of the control '*.*' will require the file name to have an extension.
</p>
<p>
Allowed wildcards include "*" which means zero or more characters, and "?" which means exactly 1 character of any kind. Other characters represent themselves with one important detail: The file matching algorithm is <b>not</b> case sensitive. So if you set "*.PDF" in the mask, then "PostScript.pdf" will also be shown, even on Linux which is a case sensitive file system.
Allowed wildcards include <b>'*.*'</b> which means zero or more characters, and <b>'?'</b> which means exactly 1 character with any value. Other characters represent themselves with one important detail: The file matching algorithm is <b>not</b> case sensitive. So if you set '*.PDF' in the mask, then 'PostScript.pdf' will also be shown, even on Linux which is a case sensitive file system.
</p>
<p>
This property has exactly the same rules and behavior as the <var>Mask</var> property in <var>TFilterComboBox</var>.
</p>
<p>
Changing the value in Mask causes the <var>UpdateFileList</var> method to be called to reload the file information in the Items property.
Changing the value in Mask causes the <var>UpdateFileList</var> method to be called to reload the file information for the current Directory in the Items property.
</p>
</descr>
<seealso>
@ -509,13 +561,13 @@
<var>TFileListBox</var> is a <var>TCustomFileListBox</var> descendant which implements a file selection list box control. It is used to select a file or directory on the local file system. TFileListBox sets the visibility for properties introduced in an ancestor class, and does not contains any new properties, methods, or events.
</p>
<p>
Use the Drive and Directory properties to specify the location on the local file sytem displayed in the list box. Please note: Drive is not used on UNIX-like file systems.
Use the Drive and Directory properties to specify the location on the local file sytem displayed in the list box. Please note that Drive is not used on UNIX-like file systems.
</p>
<p>
Use FileType to specify the files and/or directories which can be displayed in the control.
</p>
<p>
Use Mask to specify a file mask (with optional wildcards) used to select the files displayed in the control. Please note: Wild cards may be implemented differently for some file systems. For example: '*' is the "all files" mask on UNIX-like file systems instead of "*.*".
Use Mask to specify a file mask (with optional wildcards) used to select the files displayed in the control. Please note that wild cards may be implemented differently for some file systems. For example: <b>'*'</b> is the "all files" mask on UNIX-like file systems instead of <b>'*.*'</b>.
</p>
<p>
Use the Sorted property to control the order of files and directories displayed in the control.
@ -592,7 +644,7 @@
Use the <var>Filter</var> property to define the filter names and expressions available in the drop-down for the combo-box. Only the filter name is displayed in the combo-box.
</p>
<p>
Use <var>AutoComplete</var> to enable or disable case-insensitive automatic text completion in the edit area for the combo-box. When set to <b>True</b>, the Filter which starts the the typed value is located and selected in the control. Please note: AutoComplete works when the text area is empty, or the entire contents of the editable are are selected.
Use <var>AutoComplete</var> to enable or disable case-insensitive automatic text completion in the edit area for the combo-box. When set to <b>True</b>, the Filter which starts the the typed value is located and selected in the control. Please note that AutoComplete works when the text area is empty, or when the entire contents of the editable are are selected.
</p>
<p>
Use <var>ItemIndex</var> to get the ordinal position in Filter for the selected filter. Use the <var>OnSelect</var> event handler to perform actions needed when a new value is selected in the combo-box.
@ -601,7 +653,7 @@
TCustomFilterComboBox includes a <var>ShellListView</var> property with the <var>TShellListView</var> instance used to display the list of files matching the seleted filter. ShellListView is updated (when assigned) in the <var>Select</var> method to use the value in <var>Mask</var> in the list view control. Set the <var>Root</var> property in ShellListView to control the directory displayed in the control.
</p>
<p>
TCustomFilterComboBox sets the visibility for properties defined in an ancestor class, and does not introduce any new properties, methods, or events. Please note: Some properties are not published for the control, so do they do not appear in the Object Inspector at design-time. For example: Mask.
TCustomFilterComboBox sets the visibility for properties defined in an ancestor class, and does not introduce any new properties, methods, or events. Please note that some properties are not published for the control, so do they do not appear in the Object Inspector at design-time. For example: Mask.
</p>
</descr>
<seealso>
@ -618,7 +670,7 @@
<short>Sets the value for the Filter property</short>
<descr/>
<seealso>
<link id="TCustomFilterComboBox.Filter"/>
<link id="TFilterComboBox.Filter"/>
</seealso>
</element>
<element name="TCustomFilterComboBox.SetFilter.AValue">
@ -694,6 +746,33 @@
<element name="TCustomFilterComboBox.ConvertFilterToStrings">
<short>Parses the file filter(s) in AFilter and stores them in AStrings</short>
<descr>
<p>
<var>ConvertFilterToStrings</var> is a class procedure used to parse the LCL filter string in <var>AFilter</var>, and store the individual filters in <var>AStrings</var>.
</p>
<p>
AFilter contains a value like: 'Text files (*.txt *.pas)|*.txt;*.pas|Binaries (*.exe)|*.exe'.
</p>
<p>
Values in <var>AClearStrings</var>, <var>AAddDescription</var>, and <var>AAddFilter</var> control the values stored in the AStrings.
</p>
<p>
AClearStrings indicates whether existing values in AStrings are cleared before adding values found in the method.
</p>
<p>
AAddDescription insicates if the descriptive text for file filter(s) are added to the string list.
</p>
<p>
AAddFilter indicates if the file mask portion of the filter is added to the string list.
</p>
<p>
When AAddDescription = <b>True</b> and AAddFilter = <b>False</b>, the following values would be stored in AStrings:
</p>
<pre>
Text files (*.txt *.pas)
Binaries (*.exe)</pre>
<p>
Adapted from the converter initially created for QtWSDialogs.pas
</p>
</descr>
<seealso>
</seealso>
@ -717,6 +796,18 @@
<element name="TCustomFilterComboBox.Mask">
<short>File mask for the selected filter in the control</short>
<descr>
<p>
<var>Mask</var> is a read-only <var>String</var> property with the file mask for the selected <var>Filter</var> in the control.
</p>
<p>
When reading the value for Mask, a temporary TStringList instance is used to convert the values in Filter into individual file masks by calling the <var>ConvertFilterToStrings</var> method. The value in <var>ItemIndex</var> determines the value returned for the property.
</p>
<p>
The property value is an empty string (<b>''</b>) if Filter is unassigned, or ItemIndex contains <b>-1</b>.
</p>
<p>
Mask can be used to provide the file mask for the selected filter to related controls.
</p>
</descr>
<seealso>
<link id="TFilterComboBox.Filter"/>
@ -729,12 +820,16 @@
<short>Connects the control to a TShellListView instance</short>
<descr>
<p>
The files shown in the TShellListView will be limited to the Filter selected in the control.
<var>ShellListView</var> is a <var>TShellListView</var> property which contains an optional list view control connected to the combo-box control. The files shown in the TShellListView will be limited to the <var>Mask</var> (or selected Filter) in the control.
</p>
<p>
When a shell list view control is assigned to the property, the value in Mask is copied into the Mask property for the list view control. The list view is added to the free notification list for the combo-box. ShellListView is updated (when assigned) in the <var>Select</var> method to use the current value in the Mask property.
</p>
</descr>
<seealso>
<link id="TCustomFilterComboBox.Mask"/>
<link id="TCustomFilterComboBox.Select"/>
<link id="#lcl.shellctrls.TShellListView"/>
</seealso>
</element>
@ -745,7 +840,7 @@
<var>TFilterComboBox</var> is a <var>TCustomFilterComboBox</var> descendant which implements a combo-box used to select files which match a selection filter. Use the <var>Filter</var> property to define the filter names and expressions available in the drop-down for the combo-box. Only the filter name is displayed in the combo-box.
</p>
<p>
Use <var>AutoComplete</var> to enable or disable case-insensitive automatic text completion in the edit area for the combo-box. When set to <b>True</b>, the Filter which starts the the typed value is located and selected in the control. Please note: AutoComplete works when the text area is empty, or the entire contents of the editable are are selected.
Use <var>AutoComplete</var> to enable or disable case-insensitive automatic text completion in the edit area for the combo-box. When set to <b>True</b>, the Filter which starts the the typed value is located and selected in the control. Please note that AutoComplete works when the text area is empty, or the entire contents of the editable are are selected.
</p>
<p>
Use <var>ItemIndex</var> to get the ordinal position in Filter for the selected filter. Use the <var>OnSelect</var> event handler to perform actions needed when a new value is selected in the combo-box.
@ -754,7 +849,7 @@
TFilterComboBox includes a <var>ShellListView</var> property with the <var>TShellListView</var> instance used to display the list of files matching the seleted filter. ShellListView is updated (when assigned) in the <var>Select</var> method to use the value in <var>Mask</var> in the list view control. Set the <var>Root</var> property in ShellListView to control the directory displayed in the control.
</p>
<p>
TFilterComboBox sets the visibility for properties defined in an ancestor class, and does not introduce any new properties, methods, or events. Please note: Some properties are not published for the control, so do they do not appear in the Object Inspector at design-time. For example: Mask.
TFilterComboBox sets the visibility for properties defined in an ancestor class, and does not introduce any new properties, methods, or events. Please note that Some properties are not published for the control, so do they do not appear in the Object Inspector at design-time. For example: Mask.
</p>
</descr>
<seealso>
@ -767,7 +862,15 @@
<element name="TFilterComboBox.Anchors" link="#LCL.Controls.TControl.Anchors"/>
<element name="TFilterComboBox.AutoComplete" link="#LCL.StdCtrls.TCustomComboBox.AutoComplete"/>
<element name="TFilterComboBox.AutoDropDown" link="#LCL.StdCtrls.TCustomComboBox.AutoDropDown"/>
<element name="TFilterComboBox.AutoSize" link="#LCL.Controls.TControl.AutoSize"/>
<element name="TFilterComboBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
<descr>
<p>
Please note that some themes (or styles) in Windows may use a fixed height for the combo-box.
</p>
</descr>
</element>
<element name="TFilterComboBox.BidiMode" link="#LCL.Controls.TControl.BidiMode"/>
<element name="TFilterComboBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing"/>
<element name="TFilterComboBox.Color" link="#LCL.Controls.TControl.Color"/>
@ -776,7 +879,26 @@
<element name="TFilterComboBox.DragKind" link="#LCL.Controls.TControl.DragKind"/>
<element name="TFilterComboBox.DragMode" link="#LCL.Controls.TControl.DragMode"/>
<element name="TFilterComboBox.Enabled" link="#LCL.Controls.TControl.Enabled"/>
<element name="TFilterComboBox.Filter" link="#LCL.StdCtrls.TCustomComboBox.Filter"/>
<element name="TFilterComboBox.Filter">
<short>Contains oneor more file filters used in the combo-box</short>
<descr>
<p>
<var>Filter</var> is a <var>String</var> property which is published in <var>TFilterComboBox</var>. Filter contains the file filter(s) which are used in the <var>Items</var> property. Each filter value in the string contains a textual description and mask. For example:
</p>
<code>'Text files (*.txt *.pas)|*.txt;*.pas|Binaries (*.exe)|*.exe'.</code>
<p>
Setting a new value for the property causes <var>ConvertFilterToStrings</var> to be called to parse and store the filter descriptions in the Items property. Existing values in Items are cleared before storing the new filter values. The value in <var>ItemIndex</var> is set to <b>0</b> to select the initial filter in Items.
</p>
</descr>
<seealso>
<link id="TCustomFilterComboBox.Items"/>
<link id="TCustomFilterComboBox.ConvertFilterToStrings"/>
<link id="#lcl.stdctrls.TCustomComboBox.SetFilter"/>
<link id="#lcl.stdctrls.TCustomComboBox.ItemIndex"/>
</seealso>
</element>
<element name="TFilterComboBox.Font" link="#LCL.Controls.TControl.Font"/>
<element name="TFilterComboBox.ItemIndex" link="#LCL.StdCtrls.TCustomComboBox.ItemIndex"/>
<element name="TFilterComboBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBidiMode"/>
@ -811,28 +933,34 @@
<element name="TFilterComboBox.OnSelect" link="#lcl.stdctrls.TCustomComboBox.OnSelect"/>
<element name="TFilterComboBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="MiniMizeName">
<element name="MinimizeName">
<short>Returns a shortened version of a file name, so that it fits within the given MaxWidth</short>
<descr>
<p>
This function will return a shortened version of FileName, so that it fits within the given MaxWidth. It uses the Font currently assigned to the Canvas argument.
This function will return a shortened version of <var>FileName</var>, so that it fits within the width given in <var>MaxWidth</var>. It uses the Font currently assigned to the <var>Canvas</var> argument.
</p>
<p>
For example: C:\Documents and Settings\User\Application Data\Microsoft\Word\custom.dic would be shortened to a value like: C:\...\Word\custom.dic.
For example: 'C:\Documents and Settings\User\Application Data\Microsoft\Word\custom.dic' would be shortened to a value like: 'C:\...\Word\custom.dic'.
</p>
<p>
No actions are performed in the routine when path information is not included in FileName. Normalizes all path delimiters in the file name to the first path delimiter found in the argument.
</p>
<p>
When FileName is longer than the value in MaxWidth, directory names are dropped and replaced with one <b>'...'</b> value until the shortened file name fits within the specified width.
</p>
</descr>
</element>
<element name="MiniMizeName.Result">
<short/>
<element name="MinimizeName.Result">
<short>File name shortened to the maximum length when needed</short>
</element>
<element name="MiniMizeName.FileName">
<short/>
<element name="MinimizeName.FileName">
<short>File name examined and shortened in the routine</short>
</element>
<element name="MiniMizeName.Canvas">
<short/>
<element name="MinimizeName.Canvas">
<short>Canvas with the font used to measure the file name</short>
</element>
<element name="MiniMizeName.MaxWidth">
<short/>
<element name="MinimizeName.MaxWidth">
<short>Maximum width (in pixels) for the file name on the canvas</short>
</element>
<element name="Register">

71
docs/xml/lcl/pairsplitter.xml
View File

@ -40,14 +40,12 @@
</short>
<descr>
<p>
<var>TPairSplitterSide</var> is a TWinControl descendant that implements the child controls used in the TPairSplitter component. TPairSplitterSide behaves like a TPanel component with a reference to the TPairSplitter that owns the control. TPairSplitterSide provides a custom Paint method and WMPaint message handling. TPairSplitterSide alters the visibility of inherited properties to match their intended usage.
<var>TPairSplitterSide</var> is a <var>TWinControl</var> descendant that represents the child controls used in the TPairSplitter component. TPairSplitterSide behaves like a TPanel component with a reference to the TPairSplitter that owns the control. TPairSplitterSide provides a custom Paint method and WMPaint message handling. TPairSplitterSide alters the visibility of inherited properties to match their intended usage.
</p>
</descr>
<seealso/>
</element>
<element name="TPairSplitterSide.fCreatedBySplitter"/>
<!-- function Visibility: private -->
<element name="TPairSplitterSide.GetSplitter">
<short>Gets the value for the Splitter property</short>
@ -59,22 +57,28 @@
<element name="TPairSplitterSide.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<!-- procedure Visibility: protected -->
<element name="TPairSplitterSide.SetParent">
<short>
Sets the value for the Parent property
</short>
<descr>
<p>
<var>SetParent</var> is an overridden procedure used to set the value in the Parent property. SetParent ensures that the control is removed from its existing parent prior to setting the new property value. The control is added to the new parent when AParent is not <var>Nil</var>.
<var>SetParent</var> is an overridden procedure used to set the value in the <var>Parent</var> property. SetParent is the re-implemented write access specifier for the Parent property.
</p>
<p>
SetParent is the reimplemented write access specifier for the Parent property.
SetParent ensures that the control is removed from the Sides property in the existing Parent prior to setting the new value for the property. SetParent calls the inherited method to handle the Bounds and AutoSizing for the control.
</p>
<p>
If the new Parent is not <b>Nil</b>, the <var>AddSide</var> method in the TPairSplitter instance is called to add the current control.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.Parent"/>
<link id="#lcl.controls.TControl.SetParent"/>
<link id="#lcl.controls.TControl.CheckNewParent"/>
<link id="TPairSplitter.AddSide"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TPairSplitterSide.SetParent.AParent">
<short>New value for the Parent property</short>
</element>
@ -102,19 +106,15 @@
<element name="TPairSplitterSide.Align" link="#lcl.Controls.TControl.Align"/>
<element name="TPairSplitterSide.Anchors" link="#lcl.Controls.TControl.Anchors"/>
<!-- constructor Visibility: public -->
<element name="TPairSplitterSide.Create">
<short>
Constructor for the class instance
</short>
<short>Constructor for the class instance</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance, and calls the inherited constructor using TheOwner as the owner of the control. Create updates the ControlStyle property to include the value csAcceptsControls.
<var>Create</var> is the constructor for the class instance, and calls the inherited constructor using TheOwner as the owner of the control. Create updates values in the ControlStyle property and the internal window control flags used in the control.
</p>
</descr>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPairSplitterSide.Create.TheOwner">
<short>Owner of the control</short>
</element>
@ -139,7 +139,7 @@
</short>
<descr>
<p>
<var>Splitter</var> is a read-only TCustomPairSplitter property which represents the component for the control. The value in Splitter is the same as the Parent for the control, or <var>Nil</var> when Parent has not been assigned.
<var>Splitter</var> is a read-only <var>TCustomPairSplitter</var> property which represents the component for the control. The value in Splitter is the same as the Parent for the control, or <var>Nil</var> when Parent has not been assigned.
</p>
</descr>
<seealso/>
@ -192,15 +192,18 @@
<short>Splitter is oriented to size adjacent children vertically</short>
</element>
<!-- object Visibility: default -->
<element name="TCustomPairSplitter" link="#lcl.Controls.TWinControl">
<element name="TCustomPairSplitter">
<short>
Defines the base class for the TPairSplitter component
</short>
<descr>
Defines the base class for the <var>TPairSplitter</var> component. TPairSplitter is a component with two TPairSplitterSide children. Both child components can contain other components. The children are separated by a splitter which can be dragged by the user to resize the adjacent children.
<p>
Defines the base class for the <var>TPairSplitter</var> component. TPairSplitter is a component with two TPairSplitterSide children. Both child components can contain other components. The children are separated by a splitter which can be dragged by the user to resize the adjacent child controls.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.Controls.TWinControl"/>
</seealso>
</element>
<!-- variable Visibility: private -->
@ -291,17 +294,17 @@
<short>Owner of the component</short>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomPairSplitter.Destroy">
<short>
Destructor for the class instance
</short>
<short>Destructor for the class instance</short>
<descr>
<p>
<var>Destroy</var> is the destructor for the class instance. Destroy frees resources allocated in the Sides property, and calls the inherited destructor.
<var>Destroy</var> is the destructor for the class instance. Destroy ensures that the class instances in Sides are not created (or re-created), and calls the inherited destructor.
</p>
</descr>
<seealso/>
<seealso>
<link id="TCustomPairSplitter.Sides"/>
<link id="TPairSplitterSide"/>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -328,14 +331,13 @@
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomPairSplitter.CreateSides">
<short>
Creates missing controls in the Sides property
</short>
<descr>
<p>
<var>CreateSides</var> is a procedure used to create missing controls in the Sides property. CreateSides ensures that both TPairSplitterSide values used in the component have been created (and parented).
<var>CreateSides</var> is a procedure used to create missing values in the Sides property. CreateSides ensures that both TPairSplitterSide instances used in the component have been created (and parented).
</p>
<p>
No actions are performed in the method when component streaming has not been completed, or when the component is freed.
@ -366,7 +368,7 @@
</short>
<descr>
<p>
<var>ChildClassAllowed</var> is an overridden Boolean function used to determine if the specified class is inherited from a specific ancestor class. ChildClassAllowed calls the ChildClass.InheritsFrom method. The return value is True when it is derived from the TPairSplitterSide or TSplitter classes.
<var>ChildClassAllowed</var> is an overridden <var>Boolean</var> function used to determine if the specified class is inherited from a specific ancestor class. ChildClassAllowed calls the ChildClass.InheritsFrom method. The return value is True when it is derived from the TPairSplitterSide or TSplitter classes.
</p>
</descr>
<seealso/>
@ -389,7 +391,7 @@
</short>
<descr>
<p>
<var>Sides</var> is a read-only indexed TPairSplitterSide property which provides access to the adjacent children resized using the Splitter in the component. Sides always has 2 elements in the array (in the range 0..1). If Index contains an invalid value, an exception is raised.
<var>Sides</var> is a read-only indexed <var>TPairSplitterSide</var> property which provides access to the adjacent children resized using the Splitter in the component. Sides always has 2 elements in the array (in the range 0..1). If Index contains an invalid value, an exception is raised.
</p>
<p>
Each controls in Sides behaves like a TPanel component with a reference to the TPairSplitter that owns the control. They provide a custom Paint method and WMPaint message handling. Some of their properties have altered visibility; for example, Align and Anchors are private, Top and Left are public.
@ -414,7 +416,7 @@
</short>
<descr>
<p>
<var>SplitterType</var> is a TPairSplitterType property which specifies the orientation for the splitter in the component. The values in TPairSplitterType dictate the splitter orientation relative to the adjacent children in Sides. Writing a new value in the SplitterType property causes the value in the Cursor property to be changed to match the selected orientation. For example:
<var>SplitterType</var> is a <var>TPairSplitterType</var> property which specifies the orientation for the splitter in the component. The values in TPairSplitterType dictate the splitter orientation relative to the adjacent children in Sides. Writing a new value in the SplitterType property causes the value in the Cursor property to be changed to match the selected orientation. For example:
</p>
<dl>
<dt>pstHorizontal</dt>
@ -437,7 +439,7 @@
</short>
<descr>
<p>
<var>Position</var> is an Integer property that indicates the position for the splitter relative to its orientation. Reading the value in splitter causes the UpdatePosition to be called to recalculate the current position for the Splitter. Position can be set at design-time, or changed at run-time by dragging the grab bar for the splitter. The value in Position affects the sizing of the adjacent child controls in Sides.
<var>Position</var> is an <var>Integer</var> property that indicates the position for the splitter relative to its orientation. Reading the value in splitter causes the UpdatePosition to be called to recalculate the current position for the Splitter. Position can be set at design-time, or changed at run-time by dragging the grab bar for the splitter. The value in Position affects the sizing of the adjacent child controls in Sides.
</p>
<p>
When SplitterType contains <var>pstHorizontal</var>, the value in Position is used as the Width for the child control in Sides[0]. The remaining Width in the component (less the 5 pixels used for the Splitter) is set as the Width for the child control in Sides[1].
@ -455,7 +457,9 @@
Implements the TPairSplitter component
</short>
<descr>
Implements the TPairSplitter component. TPairSplitter is a component with two TPairSplitterSide children. Both child components can contain other components. The children are separated by a splitter which can be dragged by the user to resize the adjacent children.
<p>
Implements the <var>TPairSplitter</var> component. TPairSplitter is a component with two <var>TPairSplitterSide</var> children. Both child components can contain other components. The children are separated by a splitter which can be dragged by the user to resize the adjacent children.
</p>
</descr>
<seealso/>
</element>
@ -487,8 +491,9 @@
<!-- procedure Visibility: default -->
<element name="Register">
<short></short>
<short>Registers components for use in the Lazarus IDE</short>
</element>
</module>
<!-- PairSplitter -->
</package>