mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-10-02 19:59:39 +02:00
Docs: Updates for LCL, LazUtils and LazControls. Issue #38870, patch from Don Siders.
git-svn-id: trunk@65097 -
This commit is contained in:
parent
3368c71d4e
commit
8b2d0578a3
@ -27,14 +27,17 @@
|
||||
<element name="LazMethodList"/>
|
||||
|
||||
<element name="TCheckBoxThemedActionLink">
|
||||
<short/>
|
||||
<short>Provides a link between a themed check box control and its action</short>
|
||||
<descr>
|
||||
TCheckBoxThemedActionLink is a TWinControlActionLink descendant.
|
||||
<p>
|
||||
<var>TCheckBoxThemedActionLink</var> is a <var>TWinControlActionLink</var> descendant which maintains a link between a <var>TCustomCheckBoxThemed</var> class instance and its <var>Action</var>. It provides overridden methods that use TCustomCheckBoxThemed as the internal client for the link, and maintains the checked state for the client control when the Action is linked and executed.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TCustomAction">TCustomAction</link>
|
||||
<link id="#lcl.controls.TWinControlActionLink">TWinControlActionLink</link>
|
||||
<link id="#lcl.controls.TControlActionLink">TControlActionLink</link>
|
||||
</seealso>
|
||||
<notes><note>?</note></notes>
|
||||
</element>
|
||||
|
||||
<!-- protected members and methods -->
|
||||
|
@ -220,7 +220,6 @@
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<notes><note>Free for user data?</note></notes>
|
||||
</element>
|
||||
|
||||
<element name="TLvlGraphNode.Create">
|
||||
@ -2352,7 +2351,6 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<notes><note>?</note></notes>
|
||||
</element>
|
||||
|
||||
<element name="TLvlGraphControlFlag">
|
||||
@ -2451,11 +2449,73 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
|
||||
<p>
|
||||
<var>TCustomLvlGraphControl</var> is a <var>TCustomControl</var> descendant which impements the ancestor for <var>TLvlGraphControl</var>.
|
||||
</p>
|
||||
<p>
|
||||
It is used to render a level graph (also known as a edlayered graph). A level graph consists of nodes (or vertices) and edges with an equidistant spacing beteen related nodes.
|
||||
</p>
|
||||
<p>
|
||||
TCustomLvlGraphControl and TLvlGraphControl provide the following features:
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
Offers automatic topological sorting, with an option to put nodes left-most or right-most.
|
||||
</li>
|
||||
<li>
|
||||
Offers automatic topological sorting, with an option to put nodes left-most or right-most.
|
||||
</li>
|
||||
<li>
|
||||
Edges can be automatically combined.
|
||||
</li>
|
||||
<li>
|
||||
Long edges over multiple levels are combined into a single line with forks to related nodes.
|
||||
</li>
|
||||
<li>
|
||||
Provides a heuristic to minimize line crossings.
|
||||
</li>
|
||||
<li>
|
||||
Automatically prevents overlapping of display elements.
|
||||
</li>
|
||||
<li>
|
||||
Nodes can be displayed as rectangles, ellipses or icons stored in a TImageList.
|
||||
</li>
|
||||
<li>
|
||||
You can select nodes using the mouse.
|
||||
</li>
|
||||
<li>
|
||||
You can select multiple nodes at once.
|
||||
</li>
|
||||
<li>
|
||||
You can highlight nodes or edges under the mouse.
|
||||
</li>
|
||||
<li>
|
||||
The control displays back edges in special colours, which facilitates quick visual identification of cycles (e.g. unit circles).
|
||||
</li>
|
||||
<li>
|
||||
Edges can be drawn straight or as a curve (bezier).
|
||||
</li>
|
||||
<li>
|
||||
There is a header caption.
|
||||
</li>
|
||||
<li>
|
||||
Node captions can be shown to the left, to the right, above, or below nodes.
|
||||
</li>
|
||||
<li>
|
||||
All colors can be set via published properties.
|
||||
</li>
|
||||
<li>
|
||||
Events are provided to custom-draw and/or skip each part of the default drawing.
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
There is a simple example in:
|
||||
<file>($LazarusDir)/examples/levelgraph/lvlgraph_dependencies.lpi</file>.
|
||||
</p>
|
||||
<p>
|
||||
TLvlGraphControl is used to display unit dependencies in the Package Graph for the Lazarus IDE.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TLvlGraphControl"/>
|
||||
</seealso>
|
||||
<notes><note>Make this consistent with TLvlGraphicControl.</note></notes>
|
||||
</element>
|
||||
|
||||
<!-- private -->
|
||||
|
@ -597,16 +597,18 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
|
||||
<element name="TSpinEditExBase.FinalizeWnd">
|
||||
<element name="TSpinEditExBase.FinalizeWnd" link="#lcl.controls.TWinControl.FinalizeWnd">
|
||||
<short>Performs actions prior to freeing the handle for the control</short>
|
||||
<descr>
|
||||
<p>
|
||||
Ensures that the Value property is up-to-date before releasing the Handle for the control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<notes><note>?</note></notes>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
|
||||
<element name="TSpinEditExBase.Loaded">
|
||||
<short>
|
||||
Performs action needed when the component has been loaded from the LCL streaming mechanism
|
||||
@ -708,7 +710,6 @@
|
||||
<link id="#lcl.comctrls.TUpDown.MinRepeatInterval"/>
|
||||
<link id="DefMinRepeatValue"/>
|
||||
</seealso>
|
||||
<notes><note>?</note></notes>
|
||||
</element>
|
||||
|
||||
<!-- public methods and properties -->
|
||||
|
@ -10,7 +10,7 @@
|
||||
<short>Contains types and classes used to implement a list of file references</short>
|
||||
<descr>
|
||||
<p>
|
||||
Implements the TFileReference and TFileReferenceList classes. Provides a list of file references with counters and a search path for all files.
|
||||
Implements the <var>TFileReference</var> and <var>TFileReferenceList</var> classes. Provides a list of file references with reference counters and a search path for files in the list.
|
||||
</p>
|
||||
<p>
|
||||
Author: Mattias Gaertner
|
||||
@ -26,169 +26,221 @@
|
||||
<element name="LazTracer"/>
|
||||
|
||||
<element name="TFileReference">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Represents a reference-counted file stored in TFileReferenceList</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TFileReference</var> is a class used to represent a reference-counted file stored in the <var>TFileReferenceList</var> class. It provides <var>FileName</var> and <var>ReferenceCount</var> properties which are maintained by methods in TFileReferenceList.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TFileReferenceList"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- private -->
|
||||
<element name="TFileReference.fFilename"/>
|
||||
<element name="TFileReference.fReferenceCount"/>
|
||||
|
||||
<!-- public -->
|
||||
<element name="TFileReference.Filename">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Contains the name for the reference-counted file in the class instance</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>FileName</var> is a read-only String property with the name for the reference-counted file. The value in FileName is assigned in the <var>TFileReferenceList.AddFilename</var> method when the class instance is created.
|
||||
</p>
|
||||
<p>
|
||||
Use <var>ReferenceCount</var> to determine the number of times the file is referenced in the AVL Tree for the <var>TFileReferenceList</var> class where the item is stored.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TFileReference.ReferenceCount"/>
|
||||
<link id="TFileReferenceList.AddFilename"/>
|
||||
<link id="TFileReferenceList.RemoveFilename"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TFileReference.ReferenceCount">
|
||||
<short/>
|
||||
<short>Contains the number of references for the file</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TFileReference.FileName"/>
|
||||
<link id="TFileReferenceList.AddFilename"/>
|
||||
<link id="TFileReferenceList.RemoveFilename"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceFlag">
|
||||
<short/>
|
||||
<short>Represents flag values used for file references in TFileReferenceList</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TFileReferenceFlag.frfSearchPathValid">
|
||||
<short/>
|
||||
<short>
|
||||
Included when the search path for a file reference list is valid
|
||||
</short>
|
||||
</element>
|
||||
<element name="TFileReferenceFlag.frfChanged">
|
||||
<short/>
|
||||
<short>
|
||||
Included when the Timestamp or UpdateLock is changed for a file reference list
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceFlags">
|
||||
<short/>
|
||||
<short>Set type used to store flag values for TFileReferenceList</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TFileReferenceList"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList">
|
||||
<short/>
|
||||
<short>Implements a list used to maintain TFileReference instances</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- private -->
|
||||
<element name="TFileReferenceList.FOnChanged"/>
|
||||
<element name="TFileReferenceList.FTimeStamp"/>
|
||||
|
||||
<element name="TFileReferenceList.FTree">
|
||||
<short>Tree of TFileReference instances sorted by file name</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.FFlags"/>
|
||||
<element name="TFileReferenceList.FSearchPath"/>
|
||||
<element name="TFileReferenceList.FUpdateLock"/>
|
||||
|
||||
<element name="TFileReferenceList.UpdateSearchPath">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Reconstructs the delimited list of search path(s) for the files in the list
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.IncreaseTimeStamp">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Increments the value in the TimeStamp property</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.Invalidate">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Updates the TimeStamp and internal flags for the list, and signal OnChange when needed
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<!-- public -->
|
||||
<element name="TFileReferenceList.Create">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Constructor for the class instance</short>
|
||||
<descr>
|
||||
<p>
|
||||
Sets the default value for the <var>Timestamp</var> property (<var>LUInvalidChangeStamp64</var>).
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TFileReferenceList.TimeStamp"/>
|
||||
<link id="#lazutils.lazfilecache.LUInvalidChangeStamp64"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.Destroy">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Destructor for the class instance</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Destroy</var> is the overridden destructor for the class instance. It calls <var>Clear</var> to remove nodes in the internal AVL Tree for the class instance. Calls the inherited destructor prior to exiting from the method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.Clear">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Removes any tree nodes in the internal AVL tree</short>
|
||||
<descr>
|
||||
Also frees the <var>TFileReference</var> instance for the AVL tree nodes.
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.BeginUpdate">
|
||||
<short/>
|
||||
<short>Increments the UpdateLock for the class instance</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.EndUpdate">
|
||||
<short/>
|
||||
<short>Decrements the UpdateLock and signals OnChange when needed</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.AddFilename">
|
||||
<short/>
|
||||
<short>Adds a reference-counted file name to the list</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TFileReferenceList.AddFilename.Filename">
|
||||
<short/>
|
||||
<short>File name added to the list and the internal AVL tree</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.RemoveFilename">
|
||||
<short/>
|
||||
<short>Remove a reference for the specified file name</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TFileReferenceList.RemoveFilename.Filename">
|
||||
<short/>
|
||||
<short>
|
||||
File name de-referenced in the list and optionally removed from the internal AVL tree
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.GetFileReference">
|
||||
<short/>
|
||||
<short>Gets an existing TFileReference instance for the specified file name</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TFileReferenceList.GetFileReference.Result">
|
||||
<short/>
|
||||
<short>
|
||||
TFileReference instance for the specified file name, or Nil when not found
|
||||
</short>
|
||||
</element>
|
||||
<element name="TFileReferenceList.GetFileReference.Filename">
|
||||
<short/>
|
||||
<short>File name to locate in the list</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.CreateSearchPathFromAllFiles">
|
||||
<short/>
|
||||
<short>
|
||||
Gets a delimited list of search paths for the reference-counted files in the list
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TFileReferenceList.CreateSearchPathFromAllFiles.Result">
|
||||
<short/>
|
||||
<short>Delimited list of search paths for the reference-counted files</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.CreateFileList">
|
||||
<short/>
|
||||
<short>
|
||||
Creates and returns a TStringList instance with the file names in the list
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TFileReferenceList.CreateFileList.Result">
|
||||
<short/>
|
||||
<short>TStringList instance allocated in the method for the list of file names</short>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.TimeStamp">
|
||||
<short/>
|
||||
<short>Contains the timestamp value for the last change to the list</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.OnChanged">
|
||||
<short/>
|
||||
<short>Event handler signalled when items in the list have been changed</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TFileReferenceList.UpdateLock">
|
||||
<short/>
|
||||
<short>Contains the active update counter for the list</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
@ -61,18 +61,31 @@
|
||||
</element>
|
||||
|
||||
<element name="ComparePhysicalFilenames">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Compares file names after resolving symbolic links</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ComparePhysicalFilenames</var>, like <var>CompareFileNames</var>, is used to compare file name using the case-sensitivity enforced for file names on the platform.
|
||||
</p>
|
||||
<p>
|
||||
Calls <var>GetPhysicalFilename</var> to ensure that values in <var>Filename1</var> and <var>Filename2</var> are resolved to the actual file names on the local file system. This is significant for UNIX-like platforms where the file name arguments may be symbolic links on the file system.
|
||||
</p>
|
||||
<p>
|
||||
Calls CompareFileNames in <file>LazFileUtils</file> to perform the comparison and get the return value for the routine.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lazutils.LazFileUtils.CompareFileNames">CompareFileNames</link>
|
||||
<link id="#lazutils.LazFileUtils.GetPhysicalFilename">GetPhysicalFilename</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="ComparePhysicalFilenames.Result">
|
||||
<short/>
|
||||
<short>Relative sort order for the compared values</short>
|
||||
</element>
|
||||
<element name="ComparePhysicalFilenames.Filename1">
|
||||
<short/>
|
||||
<short>First file name resolved and used in the comparison</short>
|
||||
</element>
|
||||
<element name="ComparePhysicalFilenames.Filename2">
|
||||
<short/>
|
||||
<short>Second file name resolved and used in the comparison</short>
|
||||
</element>
|
||||
|
||||
<element name="CompareFilenames">
|
||||
@ -200,7 +213,6 @@
|
||||
<var>ProgramDirectoryWithBundle</var> is a <var>String</var> function used to get the path to current executable on the MacOS operating system. It calls ProgramDirectory to get the return value, and removes the bundle post-fix ('.app/Contents/MacOS') from the return value. The return value is not changed if it does not contain the bundle post-fix.
|
||||
</p>
|
||||
</descr>
|
||||
<notes><note>Routine name is misleading.</note></notes>
|
||||
<seealso>
|
||||
<link id="ProgramDirectory"/>
|
||||
</seealso>
|
||||
@ -353,7 +365,9 @@
|
||||
<element name="CreateAbsolutePath">
|
||||
<short>Deprecated</short>
|
||||
<descr>
|
||||
Deprecated. Use the function from the <file>LazFileUtils</file> unit.
|
||||
<p>
|
||||
Deprecated. Use the CreateAbsolutePath function from the <file>LazFileUtils</file> unit.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="@lazutils.lazfileutils.CreateAbsolutePath">CreateAbsolutePath</link>
|
||||
@ -431,8 +445,7 @@
|
||||
<short>Do not search in BasePath, search only in SearchPath</short>
|
||||
</element>
|
||||
<element name="TSearchFileInPathFlag.sffSearchLoUpCase">
|
||||
<short/>
|
||||
<notes><note>I can guess the intent... but I cannot find an example of usage.</note></notes>
|
||||
<short>Performs a case-insensitive search for file or directory names</short>
|
||||
</element>
|
||||
<element name="TSearchFileInPathFlag.sffFile">
|
||||
<short>Must be a file, and not a directory</short>
|
||||
@ -757,7 +770,7 @@
|
||||
<short>Contains file information for the current entry in the iterator</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>FileInfo</var> is a read-only <var>TSearchRec</var> property with the file information for the current entry in the iterator. FileInfo is used in the IsDirectory method to determine the faDirectory file attribute exists in the file information. Values in the Path, FileName, and FileInfo properties are updated in descendent classes which perform the search operation.
|
||||
<var>FileInfo</var> is a read-only <var>TSearchRec</var> property with the file information for the current entry in the iterator. FileInfo is used in the IsDirectory method to determine the faDirectory file attribute exists in the file information. Values in the <var>Path</var>, <var>FileName</var>, and FileInfo properties are updated in descendent classes which perform the search operation.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -786,7 +799,7 @@
|
||||
<short>Contains the path to the current file or directory in the iterator</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Path</var> is a read-only <var>String</var> property which contains the fully-qualified path to the current file or directory in the <var>FileInfo</var> properties. Values in the Path, FileName, and FileInfo properties are updated in descendent classes which perform the search operation.
|
||||
<var>Path</var> is a read-only <var>String</var> property which contains the fully-qualified path to the current file or directory in the <var>FileInfo</var> property. Values in the Path, <var>FileName</var>, and FileInfo properties are updated in descendent classes which perform the search operation.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
|
@ -97,9 +97,6 @@
|
||||
<var>AlignToInt</var> is a <var>Pointer</var> function used to adjust the pointer in <var>p</var> to the size needed for an <var>Integer</var> data type. <var>AlignToInt</var> is influenced by the <b>FPC_REQUIRES_PROPER_ALIGNMENT</b> compiler define; when it is defined, the <var>Align</var> routine is called to adjust the pointer size to the boundaries required for an <var>Integer</var> data type. When it is not defined, the pointer in <var>p</var> is used as the return value.
|
||||
</p>
|
||||
</descr>
|
||||
<notes>
|
||||
<note>Not currently used in any other units.</note>
|
||||
</notes>
|
||||
<seealso>
|
||||
<link id="AlignToPtr"/>
|
||||
</seealso>
|
||||
|
@ -265,14 +265,12 @@
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<notes><note>? [unusable by definition]</note></notes>
|
||||
</element>
|
||||
|
||||
<element name="TRawImageDescription.ByteOrder">
|
||||
<short>The LSB/MSB-first byte order of color data</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<errors>[Not yet implemented]</errors>
|
||||
</element>
|
||||
|
||||
<element name="TRawImageDescription.LineOrder">
|
||||
|
@ -214,11 +214,6 @@
|
||||
The return value is <b>True</b> when the HTML content is successfully added by calling <var>AddOutput</var>. The return value is <b>False</b> when the maximum number of lines specified in the <var>Render</var> method is exceeded.
|
||||
</p>
|
||||
</descr>
|
||||
<notes>
|
||||
<note>
|
||||
Does not appear to recognize HTML5 empty attributes (with no attribute value assignment).
|
||||
</note>
|
||||
</notes>
|
||||
</element>
|
||||
<element name="THTML2TextRenderer.HtmlTag.Result">
|
||||
<short>
|
||||
|
@ -873,43 +873,46 @@
|
||||
</element>
|
||||
|
||||
<element name="TXMLConfig.IsLegacyList">
|
||||
<short></short>
|
||||
<short>
|
||||
Indicates if the specified list was written using the format from a previous LazUtils version
|
||||
</short>
|
||||
<descr>
|
||||
Not used in the current implementation.
|
||||
<p>
|
||||
In a previous LazUtils version, a Count value was written to indicate the number of items in the list. The return value is True if an entry named "Count" is found in APath with a value other than -1.
|
||||
</p>
|
||||
</descr>
|
||||
<notes>
|
||||
<note>???</note>
|
||||
</notes>
|
||||
<seealso></seealso>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TXMLConfig.IsLegacyList.Result">
|
||||
<short></short>
|
||||
<short>True when the path includes a Count value</short>
|
||||
</element>
|
||||
<element name="TXMLConfig.IsLegacyList.APath">
|
||||
<short></short>
|
||||
<short>Path the values examined in the method</short>
|
||||
</element>
|
||||
|
||||
<element name="TXMLConfig.GetListItemCount">
|
||||
<short></short>
|
||||
<short>Gets the numer of values with the specified name found in the given path</short>
|
||||
<descr>
|
||||
Not used in the current implementation.
|
||||
<p>
|
||||
<var>GetListItemCount</var> is an <var>Integer</var> function used to get the number of values with the name in <var>AItemName</var> found on the path in <var>APath</var>.
|
||||
</p>
|
||||
<p>
|
||||
<var>ALegacyList</var> indicates whether the list includes a "Count" value from a previous LazUtils version. When ALegacyList is <b>True</b>, the "Count" value is used (or 0 as the default). When set to <b>False</b>, a list of XML nodes is retrieved from APath with the name in AItemName. The length of the resulting list node list is used as the return value, or 0 when no XML nodes are found with the specified name.
|
||||
</p>
|
||||
</descr>
|
||||
<notes>
|
||||
<note>???</note>
|
||||
</notes>
|
||||
<seealso></seealso>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TXMLConfig.GetListItemCount.Result">
|
||||
<short></short>
|
||||
<short>Number of items in the list identified by APath</short>
|
||||
</element>
|
||||
<element name="TXMLConfig.GetListItemCount.APath">
|
||||
<short></short>
|
||||
<short>Path the XML nodes for the list</short>
|
||||
</element>
|
||||
<element name="TXMLConfig.GetListItemCount.AItemName">
|
||||
<short></short>
|
||||
<short>Name for the list items in APath</short>
|
||||
</element>
|
||||
<element name="TXMLConfig.GetListItemCount.ALegacyList">
|
||||
<short></short>
|
||||
<short>True when the Count value from an older LazUtils version is used</short>
|
||||
</element>
|
||||
|
||||
<element name="TXMLConfig.GetListItemXPath">
|
||||
@ -918,7 +921,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
GetListItemXPath is a String class function used to get the path specifier used to access a list item at the specified position in the Document. The return value contains the path specifier constructed for the list item. For example:
|
||||
<var>GetListItemXPath</var> is a <var>String</var> class function used to get the path specifier used to access a list item at the specified position in the Document. The return value contains the path specifier constructed for the list item. For example:
|
||||
</p>
|
||||
<code>
|
||||
'item0'
|
||||
@ -926,10 +929,7 @@
|
||||
'item[0]'
|
||||
</code>
|
||||
</descr>
|
||||
<notes>
|
||||
<note>???</note>
|
||||
</notes>
|
||||
<seealso></seealso>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TXMLConfig.GetListItemXPath.Result">
|
||||
<short>Path specifier for the list item at the specified position</short>
|
||||
@ -950,29 +950,33 @@
|
||||
</element>
|
||||
|
||||
<element name="TXMLConfig.SetListItemCount">
|
||||
<short></short>
|
||||
<short>Sets the value for the Count element in a legacy version of the class</short>
|
||||
<descr>
|
||||
Not used in the current implementation.
|
||||
<p>
|
||||
<var>SetListItemCount</var> is a method used to store a Count element with the number of list items in APath. No actions are performed in the method when ALegacyList is set to <b>False</b>; the Count tag is not written or maintained in newer versions of the class.
|
||||
</p>
|
||||
<p>
|
||||
SetListItemCount adds or updates the Count element to use the value in ACount. SetListItemCount deletes the Count element if its value is 0 (zero).
|
||||
</p>
|
||||
</descr>
|
||||
<notes>
|
||||
<note>???</note>
|
||||
</notes>
|
||||
<seealso></seealso>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TXMLConfig.SetListItemCount.APath">
|
||||
<short></short>
|
||||
<short>Path to the XML node where the list is stored</short>
|
||||
</element>
|
||||
<element name="TXMLConfig.SetListItemCount.ACount">
|
||||
<short></short>
|
||||
<short>Value for the Count element written in the method</short>
|
||||
</element>
|
||||
<element name="TXMLConfig.SetListItemCount.ALegacyList">
|
||||
<short></short>
|
||||
<short>True the Count element from an older LazUtils version is used</short>
|
||||
</element>
|
||||
|
||||
<element name="TXMLConfig.Modified">
|
||||
<short>Indicates if the XML content in the class has been modified</short>
|
||||
<descr>
|
||||
<var>Modified</var> is a <var>Boolean</var> property used to indicate if the XML content in <var>Document</var> has been altered since it was loaded or created. The value in <var>Modified</var> is updated in methods like <var>CreateClean</var>, <var>Flush</var>, <var>SetValue</var>, <var>DeletePath</var>, <var>DeleteValue</var>, and <var>InternalCleanNode</var>.
|
||||
<p>
|
||||
<var>Modified</var> is a <var>Boolean</var> property used to indicate if the XML content in <var>Document</var> has been altered since it was loaded or created. The value in <var>Modified</var> is updated in methods like <var>CreateClean</var>, <var>Flush</var>, <var>SetValue</var>, <var>DeletePath</var>, <var>DeleteValue</var>, and <var>InternalCleanNode</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TXMLConfig.CreateClean"/>
|
||||
|
@ -318,10 +318,10 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="ConvertLineEndings.Result">
|
||||
<short/>
|
||||
<short>Value after converting the line endings</short>
|
||||
</element>
|
||||
<element name="ConvertLineEndings.s">
|
||||
<short/>
|
||||
<short>Value with line endings to convert in the routine</short>
|
||||
</element>
|
||||
|
||||
<element name="TabsToSpaces">
|
||||
@ -390,18 +390,20 @@
|
||||
<element name="SimpleSyntaxToRegExpr">
|
||||
<short>Creates a regular expression from a filter expression used in IDE dialogs</short>
|
||||
<descr>
|
||||
<p>
|
||||
Ensures that characters in <var>Src</var> are converted to the notation needed for regular expressions, including '.', ',', ';', '*', '+', '?', and '\'. The return value is enclosed in a regex single line expression ('^(...)$').
|
||||
</p>
|
||||
<p>
|
||||
Used in the implementation of the Clean Directory and Change Encoding dialogs in the Lazarus IDE.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<notes><note>?</note></notes>
|
||||
</element>
|
||||
<element name="SimpleSyntaxToRegExpr.Result">
|
||||
<short/>
|
||||
<short>Regular expression for the value in Src</short>
|
||||
</element>
|
||||
<element name="SimpleSyntaxToRegExpr.Src">
|
||||
<short/>
|
||||
<short>Filter expression converted to a regular expression in the routine</short>
|
||||
</element>
|
||||
|
||||
<element name="BinaryStrToText">
|
||||
@ -690,7 +692,6 @@
|
||||
</element>
|
||||
<element name="StringListToString.IgnoreEmptyLines">
|
||||
<short>Indicates if empty lines are excluded from the result</short>
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="StringToStringList">
|
||||
|
@ -181,7 +181,6 @@
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
<notes><note>?</note></notes>
|
||||
</element>
|
||||
<element name="MergeSortWithLen.List">
|
||||
<short></short>
|
||||
|
@ -26,13 +26,13 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
TLookupStringList is a TStringList descendant that implements an unsorted StringList with a fast lookup feature. Internally it uses a map container to store the strings which are used in the Contains, IndexOf and Find methods. The map container does not reserve too much memory because the strings are reference counted and not copied.
|
||||
<var>TLookupStringList</var> is a <var>TStringList</var> descendant that implements an unsorted string list with a fast lookup feature. Internally it uses a map container to store the strings which are used in the <var>Contains</var>, <var>IndexOf</var> and <var>Find</var> methods. The map container does not reserve too much memory because the strings are reference counted and not copied.
|
||||
</p>
|
||||
<p>
|
||||
All Duplicates property values are fully supported, including dupIgnore and dupError, unlike in unsorted TStringList class.
|
||||
All values for the Duplicates property are fully supported, including dupIgnore and dupError (unlike in unsorted TStringList class).
|
||||
</p>
|
||||
<p>
|
||||
This class is useful only when you must preserve the order in list, but also need to do fast lookups to see if a string exists, or must prevent duplicates.
|
||||
This class is useful when you must preserve the order in list, but also need to do fast lookups to see if a string exists, or must prevent duplicates.
|
||||
</p>
|
||||
<p>
|
||||
Authors: Juha Manninen / Antônio Galvão
|
||||
@ -51,7 +51,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
InsertItem is an overridden method which ensures that the internal String map and the Duplicates property are used when an item value is inserted. When Sorted contains False, the value in Duplicates determines the actions taken.
|
||||
<var>InsertItem</var> is an overridden method which ensures that the internal <var>String</var> map and the <var>Duplicates</var> property are used when an item value is inserted. When <var>Sorted</var> contains <b>False</b>, the value in Duplicates determines the actions taken.
|
||||
</p>
|
||||
<dl>
|
||||
<dt>dupAccept</dt>
|
||||
@ -68,12 +68,12 @@
|
||||
</dd>
|
||||
</dl>
|
||||
<p>
|
||||
InsertItem calls the inherited method, and adds the value in S to the internal string map.
|
||||
InsertItem calls the inherited method, and adds the value in <var>S</var> to the internal string map.
|
||||
</p>
|
||||
</descr>
|
||||
<errors>
|
||||
<p>
|
||||
Raises an Exception when adding a duplicated value and Duplicates contains dupError. Raised with the message 'TLookupStringList.InsertItem: Duplicates are not allowed.'
|
||||
Raises an <var>Exception</var> when adding a duplicated value and Duplicates contains <var>dupError</var>. Raised with the message 'TLookupStringList.InsertItem: Duplicates are not allowed.'
|
||||
</p>
|
||||
</errors>
|
||||
<seealso></seealso>
|
||||
@ -94,7 +94,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Create is the constructor for the class instance, and calls the inherited constructor. Create allocates the internal TStringMap instance used in the class.
|
||||
<var>Create</var> is the constructor for the class instance, and calls the inherited constructor. Create allocates the internal <var>TStringMap</var> instance used in the class.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -107,7 +107,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Destroy is the destructor for the class instance. Destroy frees the internal TStringMap instance allocated in the constructor, and calls the inherited Destroy method.
|
||||
<var>Destroy</var> is the destructor for the class instance. Destroy frees the internal <var>TStringMap</var> instance allocated in the constructor, and calls the inherited Destroy method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -120,7 +120,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Assign is an overridden method which implements the object persistence mechanism in the class. Assign ensures that property values in Source are stored in the current class instance. Assign calls the inherited method. When Source is a TLookupStringList class instance, the values in its internal string map are also stored in the current class instance.
|
||||
<var>Assign</var> is an overridden method which implements the object persistence mechanism in the class. Assign ensures that property values in <var>Source</var> are stored in the current class instance. Assign calls the inherited method. When Source is a <var>TLookupStringList</var> class instance, the values in its internal string map are also stored in the current class instance.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -137,7 +137,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Clear is an overridden method used to clear the content stored in Strings, Objects, and the internal string map. Clear calls the inherited method, and calls the TStringMap.Clear method in the internal string map.
|
||||
<var>Clear</var> is an overridden method used to clear the content stored in <var>Strings</var>, <var>Objects</var>, and the internal string map. Clear calls the inherited method, and calls the <var>TStringMap.Clear</var> method in the internal string map.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -150,7 +150,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Delete is an overridden method which ensures that the internal string map is maintained when deleting the value stored at the specified position. The corresponding value in Strings is used to check for duplicates using IndexOf. When a duplicate exists, and Duplicates are not allowed, the value is also removed from the internal string map. Delete calls the inherited method to delete the values in Strings and Objects at the position in Index.
|
||||
<var>Delete</var> is an overridden method which ensures that the internal string map is maintained when deleting the value stored at the specified position. The corresponding value in <var>Strings</var> is used to check for duplicates using <var>IndexOf</var>. When a duplicate exists, and <var>Duplicates</var> are not allowed, the value is also removed from the internal string map. Delete calls the inherited method to delete the values in Strings and Objects at the position in <var>Index</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -167,10 +167,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Add is an overridden Integer function used to enforce handling of Duplicates when adding the specified value to Strings. Add checks the values in Sorted and Duplicates to see if duplicates are allowed in the unsorted String list.
|
||||
<var>Add</var> is an overridden <var>Integer</var> function used to enforce handling of <var>Duplicates</var> when adding the specified value to <var>Strings</var>. Add checks the values in <var>Sorted</var> and Duplicates to see if duplicates are allowed in the unsorted string list.
|
||||
</p>
|
||||
<p>
|
||||
The return value is -1 if the value in S already exists in the string map, and no actions are performed in the method. Otherwise, the inherited Add method is called to store the value in S. The return value is the position in Strings where the new value was stored.
|
||||
The return value is <b>-1</b> if the value in <var>S</var> already exists in the string map, and no actions are performed in the method. Otherwise, the inherited Add method is called to store the value in S. The return value is the position in Strings where the new value was stored.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -193,10 +193,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
AddObject is an overridden Integer function used to add the specified values to the Strings and Objects in the list. AddObject calls the Add method to add the value in S to Strings.
|
||||
<var>AddObject</var> is an overridden <var>Integer</var> function used to add the specified values to the <var>Strings</var> and <var>Objects</var> in the list. AddObject calls the <var>Add</var> method to add the value in <var>S</var> to Strings.
|
||||
</p>
|
||||
<p>
|
||||
The return value contains the ordinal position in Strings where the value was stored, or -1 when duplicate values are not allowed. If the return value is not -1, the Objects property is updated to include the value in AObject at the specified position.
|
||||
The return value contains the ordinal position in Strings where the value was stored, or <b>-1</b> when duplicate values are not allowed. If the return value is not <b>-1</b>, the Objects property is updated to include the value in <var>AObject</var> at the specified position.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -223,10 +223,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Contains is a Boolean function used to determine if the specified value already exists in the internal string map for the string list. The return value is True when S is already stored in the TStringMap for the class.
|
||||
<var>Contains</var> is a <var>Boolean</var> function used to determine if the specified value already exists in the internal string map for the string list. The return value is <b>True</b> when <var>S</var> is already stored in the <var>TStringMap</var> for the class.
|
||||
</p>
|
||||
<p>
|
||||
Contains is called from the Add, InsertItem, and IndexOf methods.
|
||||
Contains is called from the <var>Add</var>, <var>InsertItem</var>, and <var>IndexOf</var> methods.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -247,7 +247,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Find is an overridden Boolean function used to locate the specified value in the Strings property. The value in Index contains the position in Strings where value was located using the IndexOf method. Index contains -1 if the value in S is not stored in Strings. The return value if True when Index contains a value other than -1.
|
||||
<var>Find</var> is an overridden <var>Boolean</var> function used to locate the specified value in the <var>Strings</var> property. The value in <var>Index</var> contains the position in Strings where value was located using the <var>IndexOf</var> method. Index contains <b>-1</b> if the value in <var>S</var> is not stored in Strings. The return value if <b>True</b> when Index contains a value other than <b>-1</b>.
|
||||
</p>
|
||||
<p>
|
||||
Please note: Find does <b>NOT</b> call the inherited method.
|
||||
@ -275,10 +275,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
IndexOf is an overridden Integer function used to get the position in Strings where the specified value is stored. IndexOf uses the internal String map to determine if the value in S is stored in the string list. If S already exists, the inherited method is called.
|
||||
<var>IndexOf</var> is an overridden <var>Integer</var> function used to get the position in <var>Strings</var> where the specified value is stored. IndexOf uses the internal <var>String</var> map to determine if the value in <var>S</var> is stored in the string list. If S already exists, the inherited method is called.
|
||||
</p>
|
||||
<p>
|
||||
The return value contains the ordinal position for the specified value, or -1 when S does not exist in the string map.
|
||||
The return value contains the ordinal position for the specified value, or <b>-1</b> when S does not exist in the string map.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -300,7 +300,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Removes duplicate strings (with case sensitivity) from AStrings. Deduplicate creates a TLookupStringList instance that is used to remove the duplicate values in AStrings. When AStrings owns and contains objects, the function will return False.
|
||||
Removes duplicate strings (with case sensitivity) from <var>AStrings</var>. Deduplicate creates a <var>TLookupStringList</var> instance that is used to remove the duplicate values in AStrings. When AStrings owns and contains objects, the function will return <b>False</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
|
@ -22,9 +22,11 @@
|
||||
<element name="SysUtils"/>
|
||||
|
||||
<element name="T2Pointer">
|
||||
<short></short>
|
||||
<short>Record type with pointers to members in the association</short>
|
||||
<descr>
|
||||
T2Pointer is a record type used to maintain an association between the pointers to the members in the record.
|
||||
<p>
|
||||
<var>T2Pointer</var> is a record type used to maintain an association between the pointers to the members in the record.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -44,7 +46,9 @@
|
||||
<element name="P2Pointer">
|
||||
<short>Pointer to the T2Pointer record type</short>
|
||||
<descr>
|
||||
Used to implement the list of item and object associations in TObjectArray.
|
||||
<p>
|
||||
Used to implement the list of item / object associations in <var>TObjectArray</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TObjectArray.Items"/>
|
||||
@ -54,7 +58,7 @@
|
||||
|
||||
<element name="TObjectArray">
|
||||
<short>
|
||||
Implement an array of items with their associated objects
|
||||
Implements an array of items with their associated objects
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
@ -539,7 +543,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Pack</var> is a procedure used to remove all associations where the Item class instance is unassigned (contains <b>Nil</b>). Pack iterates over the allocated storage in <var>List</var> to determine if the <var>T2Pointer.Item</var> member is unassigned. When an an unassigned item is found, subsequent associations are moved into the storage position(s) for any unused items. Pack updates the value in the <var>Count</var> property to reflect the new number of associations in List.
|
||||
<var>Pack</var> is a procedure used to remove all associations where the Item class instance is unassigned (contains <b>Nil</b>). Pack iterates over the allocated storage in <var>List</var> to determine if the <var>T2Pointer.Item</var> member is unassigned. When an an unassigned item is found, subsequent associations are moved to fill the storage position(s) for any unused items. Pack updates the value in the <var>Count</var> property to reflect the new number of associations in List.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -637,7 +641,7 @@
|
||||
<p>
|
||||
<var>List</var> is a read-only <var>P2Pointer</var> property which provides access to the list which implements the storage for the class instance. It is organized as pointers to a sequence of T2Pointer records. To access the record, and its Item and Object properties, use a subscript in the range 0..Count-1. For example:
|
||||
</p>
|
||||
<code>
|
||||
<code>
|
||||
// type TMyObjStrsArr = specialize TObjectArray<TMyObject, TStrings>;
|
||||
// var aObjArr: TMyObjStrsArr;
|
||||
// var lFound: Boolean;
|
||||
@ -649,7 +653,7 @@ begin
|
||||
if lFound then break;
|
||||
end;
|
||||
Exit(lFound);
|
||||
</code>
|
||||
</code>
|
||||
<p>
|
||||
Content in the record can be accessed using the indexed Items and Objects properties as well.
|
||||
</p>
|
||||
|
@ -437,14 +437,14 @@
|
||||
Since the property value is a Pointer, it must be dereferenced to access the member values for a given hash item. For example:
|
||||
</p>
|
||||
<code>
|
||||
// var AKey: Cardinal;
|
||||
// var AHashValue: String;
|
||||
// var AData: TObject;
|
||||
// var AHashes: TStringHashList;
|
||||
// var AKey: Cardinal;
|
||||
// var AHashValue: String;
|
||||
// var AData: TObject;
|
||||
// var AHashes: TStringHashList;
|
||||
|
||||
AKey := AHashes.List[2]^.Key;
|
||||
AHashValue := AHashes.List[2]^.HashValue;
|
||||
AData := AHashes.List[2]^.Data;
|
||||
AKey := AHashes.List[2]^.Key;
|
||||
AHashValue := AHashes.List[2]^.HashValue;
|
||||
AData := AHashes.List[2]^.Data;
|
||||
</code>
|
||||
</descr>
|
||||
<seealso>
|
||||
|
@ -601,16 +601,16 @@
|
||||
<short>Finishes an update process for the component</short>
|
||||
<descr>
|
||||
<p>
|
||||
EndUpdate is a method used to finish an active update process for the component.
|
||||
<var>EndUpdate</var> is a method used to finish an active update process for the component.
|
||||
</p>
|
||||
<p>
|
||||
For each call to BeginUpdate, there needs to be a corresponding call to EndUpdate. The methods are used as a pair to consolidate <var>OnChanging</var> and <var>OnChange</var> event notifcations.
|
||||
For each call to <var>BeginUpdate</var>, there needs to be a corresponding call to EndUpdate. The methods are used as a pair to consolidate <var>OnChanging</var> and <var>OnChange</var> event notifcations.
|
||||
</p>
|
||||
<p>
|
||||
EndUpdate decrements the internal update counter incremented by calling BeginUpdate. When the update counter is a postive non-zero value, the Changed method is note called and the OnChange event handler is not signalled.
|
||||
EndUpdate decrements the internal update counter incremented by calling BeginUpdate. When the update counter is a postive non-zero value, the <var>Changed</var> method is not called and the <var>OnChange</var> event handler is not signalled.
|
||||
</p>
|
||||
<p>
|
||||
An Exception is raised if the internal update counter is <= 0 when the method is called. When the counter value reaches 0, the Changed method is called to signal the OnChange event handler (when assigned).
|
||||
An <var>Exception</var> is raised if the internal update counter is <= 0 when the method is called. When the counter value reaches 0, the Changed method is called to signal the OnChange event handler (when assigned).
|
||||
</p>
|
||||
<p>
|
||||
Use BeginUpdate to start an update process by incrementing the value for the internal counter.
|
||||
@ -654,7 +654,7 @@
|
||||
<short>Appends the specified text to the values in Strings</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls AddObject to append the value in S. Nil is used for the object parameter.
|
||||
Calls <var>AddObject</var> to append the value in <var>S</var>. <b>Nil</b> is used as the value for the object parameter.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -672,16 +672,16 @@
|
||||
<short>Adds a String and Object pair to the string list</short>
|
||||
<descr>
|
||||
<p>
|
||||
Adds a LineEnding if they value in Text does not already end with one of the end-of-line characters.
|
||||
Adds a <var>LineEnding</var> if the value in <var>Text</var> does not already end with one of the end-of-line characters.
|
||||
</p>
|
||||
<p>
|
||||
Calls BuildArrays when an object instance has been assigned to AObject.
|
||||
Calls <var>BuildArrays</var> when an object instance has been assigned to <var>AObject</var>.
|
||||
</p>
|
||||
<p>
|
||||
Recalculates the number of lines in the internal line ranges array. If the number of lines is larger than the current capacity for the array, the capacity is doubled. The memory for the line range array is re-allocated to the new capacity, and the unused portion is zero-filled.
|
||||
</p>
|
||||
<p>
|
||||
The value in AObject is stored in the TTextLineRange instance for the new line. The start and end position, and the text are also stored in the line range information.
|
||||
The value in AObject is stored in the <var>TTextLineRange</var> instance for the new line. The start and end positions, and the text are stored in the line range information.
|
||||
</p>
|
||||
<p>
|
||||
The internal line count is incremented prior to exiting from the method.
|
||||
@ -702,7 +702,9 @@
|
||||
<element name="TTextStrings.AddStrings" link="#rtl.classes.TStrings.AddStrings">
|
||||
<short/>
|
||||
<descr>
|
||||
No actions are performed in the method when TheString does not have any lines of text.
|
||||
<p>
|
||||
No actions are performed in the method when <var>TheString</var> does not have any lines of text.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TStrings.AddStrings">TStrings.AddStrings</link>
|
||||
@ -716,7 +718,7 @@
|
||||
<short>Loads the content in the string list from the specified file name</short>
|
||||
<descr>
|
||||
<p>
|
||||
Creates a temporary TFileStream instance for the FileName argument. The file handle is opened for reading, and shared write access is denied. The inherited LoadFromStream method is called to load the values in the string list from the file stream.
|
||||
Creates a temporary <var>TFileStream</var> instance for the <var>FileName</var> argument. The file handle is opened for reading, and shared write access is denied. The inherited <var>LoadFromStream</var> method is called to load the values in the string list from the file stream.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -732,7 +734,7 @@
|
||||
<short>Saves the content in the string list to the specified file name</short>
|
||||
<descr>
|
||||
<p>
|
||||
Creates a temporary TFileStream instance for the FileName argument. The file is created if it does not already exist. The inherited SaveToStream method is called to store the content in the string list to the file stream.
|
||||
Creates a temporary <var>TFileStream</var> instance for the <var>FileName</var> argument. The file is created if it does not already exist. The inherited <var>SaveToStream</var> method is called to store content in the string list to the file stream.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -763,10 +765,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
OnChange is a TNotifyEvent property with the event handler signalled when values in the Strings and/or Objects properties have been changed.
|
||||
<var>OnChange</var> is a <var>TNotifyEvent</var> property with the event handler signalled when values in the <var>Strings</var> and/or <var>Objects</var> properties have been changed.
|
||||
</p>
|
||||
<p>
|
||||
OnChange is signalled from the Changed method, and occurs after the property value(s) are stored in the component.
|
||||
OnChange is signalled from the <var>Changed</var> method, and occurs after the property value(s) are stored in the component.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -781,10 +783,10 @@
|
||||
<short>Event handler signalled before properties are updated in the component</short>
|
||||
<descr>
|
||||
<p>
|
||||
OnChanging is a TNotifyEvent property with the event handler signalled before the <var>Strings</var> or <var>Objects</var> properties are updated in the component.
|
||||
<var>OnChanging</var> is a <var>TNotifyEvent</var> property with the event handler signalled before the <var>Strings</var> or <var>Objects</var> properties are updated in the component.
|
||||
</p>
|
||||
<p>
|
||||
OnChanging is signalled from the Changing method when an update process in not already active.
|
||||
OnChanging is signalled from the <var>Changing</var> method when an update process in not already active.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
|
@ -9345,28 +9345,30 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomGrid.OffsetToColRow">
|
||||
<short>Moves to a column or row located at the specified offset ???</short>
|
||||
<short>Moves to a column or row located at the specified offset</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<notes><note>?</note></notes>
|
||||
<version>
|
||||
Index and Rest arguments were changed to output parameters in LCL version 2.1 (revision 65087).
|
||||
</version>
|
||||
</element>
|
||||
<element name="TCustomGrid.OffsetToColRow.Result">
|
||||
<short/>
|
||||
<short>True if a column and row number was identified for the specified offset</short>
|
||||
</element>
|
||||
<element name="TCustomGrid.OffsetToColRow.IsCol">
|
||||
<short/>
|
||||
<short>True if the offset is for a column, False for a row</short>
|
||||
</element>
|
||||
<element name="TCustomGrid.OffsetToColRow.Fisical">
|
||||
<short/>
|
||||
<short>True for a physical offset, False for a logical offset</short>
|
||||
</element>
|
||||
<element name="TCustomGrid.OffsetToColRow.Offset">
|
||||
<short/>
|
||||
<short>Offset in pixels for the column or row</short>
|
||||
</element>
|
||||
<element name="TCustomGrid.OffsetToColRow.Index">
|
||||
<short/>
|
||||
<short>Index position for the column or row in the specified offset</short>
|
||||
</element>
|
||||
<element name="TCustomGrid.OffsetToColRow.Rest">
|
||||
<short/>
|
||||
<short>Remaining pixels stating at the value in Index</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomGrid.Paint">
|
||||
@ -12055,6 +12057,9 @@
|
||||
<short>Converts mouse coordinates to the grid coordinates for a cell in the grid</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<version>
|
||||
ACol and ARow arguments were changed to output parameters in LCL version 2.1 (revision 65087).
|
||||
</version>
|
||||
</element>
|
||||
<element name="TCustomGrid.MouseToCell.Result">
|
||||
<short>TPoint instance with the grid coordinates for the cell</short>
|
||||
|
@ -48,7 +48,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TLazCanvasImageFormat.clfOther">
|
||||
<short></short>
|
||||
<short>Images use a format other than those in this enumeration</short>
|
||||
</element>
|
||||
<element name="TLazCanvasImageFormat.clfRGB16_R5G6B5">
|
||||
<short>Images use 16-bit RGB colors</short>
|
||||
@ -74,7 +74,7 @@
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TFPSharpInterpolation">
|
||||
<short></short>
|
||||
<short>Implements a very sharp and square interpolation</short>
|
||||
<descr>
|
||||
<p>
|
||||
TFPSharpInterpolation implements a very sharp and square interpolation for stretching, similar to StretchBlt from the Windows API.
|
||||
@ -305,13 +305,13 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TLazCanvas.SetColor.x">
|
||||
<short></short>
|
||||
<short>Horizontal pixel coordinate</short>
|
||||
</element>
|
||||
<element name="TLazCanvas.SetColor.y">
|
||||
<short></short>
|
||||
<short>Vertical pixel coordinate</short>
|
||||
</element>
|
||||
<element name="TLazCanvas.SetColor.AValue">
|
||||
<short></short>
|
||||
<short>Color for the pixel</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: protected -->
|
||||
@ -354,7 +354,7 @@
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TLazCanvas.DoRectangleFill">
|
||||
<short></short>
|
||||
<short>Adjusts the FCL image rectangle to be LCL compatible</short>
|
||||
<descr>
|
||||
<p>
|
||||
Adjusts the fcl-image coordinate system to be compatible with coordinates used in <var>TCanvas</var>.
|
||||
@ -363,7 +363,7 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLazCanvas.DoRectangleFill.Bounds">
|
||||
<short></short>
|
||||
<short>Rectangle bounds adjusted in the method</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
@ -377,7 +377,7 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TLazCanvas.DoPolygonFill.points">
|
||||
<short></short>
|
||||
<short>Array with the TPoint instances for the polygon corners</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
|
@ -1031,10 +1031,10 @@
|
||||
<var>PopulateWithRoot</var> calls the internal <var>GetFilesInDir</var> helper to get a list of file system items for the path which match the <var>Mask</var> and <var>ObjectTypes</var> specified for the control. Each of the files in the list are passed to <var>DoAddItem</var> / <var>OnAddItem</var> to determine if they can be added to the <var>Items</var> in the control.
|
||||
</p>
|
||||
<p>
|
||||
A <var>TListItem</var> instance is added to Items to represent the files or directories. The <var>Data</var> property in the list item is used to store a pointer to the file size. Values are added to SubItems with the string representation for the file size, and the file extension.
|
||||
A <var>TListItem</var> instance is added to Items to represent the files or directories. The <var>Data</var> property in the list item is used to store a pointer to the file size. Values are added to <var>SubItems</var> with the string representation for the file size, and the file extension.
|
||||
</p>
|
||||
<p>
|
||||
When <var>UseBuiltInIcons</var> is set to <b>True</b>, the <var>GetBuiltInImageIndex</var> method is called to get the <var>ImageIndex</var> for the built-in icon used for the list item. The value in <var>ViewStyle</var> determines the image size requested. When ViewStyle is <var>vsIcon</var>, LargeImages is checked for the index value. Otherwise, <var>SmalImages</var> is checked.
|
||||
When <var>UseBuiltInIcons</var> is set to <b>True</b>, the <var>GetBuiltInImageIndex</var> method is called to get the <var>ImageIndex</var> for the built-in icon for a list item. This action is performed using the path to the current file name when LargeImages and/or SmallImages have not been assigned. The value in <var>ViewStyle</var> determines the image size requested. When ViewStyle is <var>vsIcon</var>, LargeImages is checked (when assigned). Otherwise, <var>SmalImages</var> is checked (when assigned). If an imagelist exists in either LargeImages or SmallImages, the existing ImageIndex in the list item is used.
|
||||
</p>
|
||||
<p>
|
||||
The <var>OnFileAdded</var> event handler is signalled (when assigned) for each new entry added to Items.
|
||||
@ -1369,10 +1369,6 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomShellListView.Items" link="#lcl.comctrls.TCustomListView.Items"/>
|
||||
<element name="TCustomShellListView.SmallImages" link="#lcl.comctrls.TCustomListView.SmallImages"/>
|
||||
<element name="TCustomShellListView.SmallImagesWidth" link="#lcl.comctrls.TCustomListView.SmallImagesWidth"/>
|
||||
<element name="TCustomShellListView.LargeImages" link="#lcl.comctrls.TCustomListView.LargeImages"/>
|
||||
<element name="TCustomShellListView.LargeImagesWidth" link="#lcl.comctrls.TCustomListView.LargeImagesWidth"/>
|
||||
|
||||
<element name="TShellListView">
|
||||
<short>
|
||||
|
Loading…
Reference in New Issue
Block a user