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

Docs: Updated documentation for LazUtils and LCL. Issue #35079, patch from Don Siders.

Browse Source 
git-svn-id: trunk@60422 -
This commit is contained in:
juha 2019-02-14 15:06:13 +00:00
parent 1cade139bf
commit e2a4c97011
5 changed files with 1121 additions and 562 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitattributes vendored
View File

@ -6004,6 +6004,7 @@ docs/xml/lazutils/extendedstrings.xml svneol=native#text/plain
docs/xml/lazutils/fileutil.xml svneol=native#text/plain
docs/xml/lazutils/fpcadds.xml svneol=LF#text/xml eol=lf
docs/xml/lazutils/fpmake.xml svneol=native#text/plain
docs/xml/lazutils/html2textrender.xml svneol=native#text/plain
docs/xml/lazutils/laz2_dom.xml svneol=native#text/plain
docs/xml/lazutils/laz2_xmlcfg.xml svneol=native#text/plain
docs/xml/lazutils/laz2_xmlread.xml svneol=native#text/plain
@ -6064,6 +6065,7 @@ docs/xml/lazutils/ttprofile.xml svneol=native#text/plain
docs/xml/lazutils/ttraster.xml svneol=native#text/plain
docs/xml/lazutils/tttables.xml svneol=native#text/plain
docs/xml/lazutils/tttypes.xml svneol=native#text/plain
docs/xml/lazutils/uitypes.xml svneol=native#text/plain
docs/xml/lazutils/utf8process.xml svneol=native#text/plain
docs/xml/lcl/actnlist.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/alllclunits.xml svneol=LF#text/xml eol=lf

367
docs/xml/lazutils/extendedstrings.xml
View File

@ -2,70 +2,78 @@
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
ExtendedStrings
====================================================================
-->
====================================================================
ExtendedStrings
====================================================================
-->
<module name="ExtendedStrings">
<short>Defines <var>TExtendedStrings</var> which is a normal <var>TStringList</var>, except that the Objects can hold any type of records</short>
<descr/>
<short>
Defines <var>TExtendedStrings</var> which is a normal <var>TStringList</var>, except that the Objects property can hold any type of records
</short>
<descr></descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<element name="Classes"/>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<element name="SysUtils"/>
<!-- enumeration type Visibility: default -->
<element name="TExtStringsOption">
<short/>
<descr/>
<seealso/>
<short>
Defines actions needed when creating or freeing records in TExtendedStringList
</short>
<descr>
<p>
<var>TExtStringsOption</var> is an enumeration type with values that define actions needed when creating or freeing records in TExtendedStringList. Values from TExtStringsOption are stored in the <var>TExtStringsOptions</var> type.
</p>
</descr>
<seealso></seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoClearRecordsOnCreate">
<short/>
<short>Memory allocated to a new record is cleared (filled with #0)</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoFreeObjectsOnDelete">
<short/>
<short>Objects call their free method before they are deleted</short>
</element>
<!-- set type Visibility: default -->
<element name="TExtStringsOptions">
<short/>
<descr/>
<seealso/>
<short>
Stores TExtStringsOption values
</short>
<descr>
<var>TExtStringsOptions</var> is a set type used to store <var>TExtStringsOption</var> values. TExtStringsOptions is the type used for the <var>TExtendedStringList.Options</var> property.
</descr>
<seealso></seealso>
</element>
<!-- object Visibility: default -->
<element name="TExtendedStringList">
<short/>
<descr/>
<errors/>
<seealso/>
<element name="TExtendedStringList" link="#rtl.Classes.TStringList">
<short>
Implements a string list that allows Records in its Objects property
</short>
<descr>
<p>
<var>TExtendedStringList</var> is a TStringList descendant that provides support for using Records in the class. The Records property allows access to records stored in the class. TExtendedStringList provides overridden methods to maintain values in the Objects property. New properties and methods are included to control actions needed when adding or freeing Records stored in the Objects property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- variable Visibility: private -->
<element name="TExtendedStringList.FOptions">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TExtendedStringList.FRecordSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TExtendedStringList.GetRecords">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetRecords.Result">
@ -75,23 +83,19 @@
<element name="TExtendedStringList.GetRecords.Index">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetOptions">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetOptions.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetRecords">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecords.Index">
@ -101,23 +105,19 @@
<element name="TExtendedStringList.SetRecords.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetRecordSize">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecordSize.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.DoResizeRecord">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.Index">
@ -131,162 +131,297 @@
<element name="TExtendedStringList.DoResizeRecord.NewSize">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TExtendedStringList.ResizeRecord">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Changes the memory allocation size for the specified record
</short>
<descr>
<p>
<var>ResizeRecord</var> is a procedure used to change the memory allocation size for the specified record. ResizeRecord calls ReAllocMem to change the allocated memory size to the value in NewSize. ResizeRecord is called when the value in the RecordSize property is changed.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.ARecord">
<short/>
<short>Pointer to the record</short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.Index">
<short/>
<short>Ordinal position for the specified record</short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.OldSize">
<short/>
<short>Previous memory allocation size</short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.NewSize">
<short/>
<short>New memory allocation size</short>
</element>
<!-- function Visibility: protected -->
<element name="TExtendedStringList.GetObject">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Reimplements the read access specifier for Objects
</short>
<descr>
<p>
<var>GetObject</var> is an overridden TObject function which reimplements the read access specifier for the Objects property. GetObject calls the inherited method to retrieve the value at the position in Index. GetObject ensures that the return value is cast to a TObject instance when assigned, or <var>Nil</var> when unassigned.
</p>
<p>
GetObject and PutObject are called directly (as opposed to using the Objects property) in methods which maintain values in Records.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetObject.Result">
<short/>
<short>TObject stored at the specified position</short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.GetObject.Index">
<short/>
<short>Ordinal position for the requested value</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TExtendedStringList.PutObject">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Reimplements the write access specifier for Objects
</short>
<descr>
<p>
<var>PutObject</var> is an overridden procedure which reimplements the write access specifier for the Objects property. PutObject uses a pointer to the value in Records stored at the position in Index. If a record has not been stored at the position, CreateRecord is called to allocate and initialize the memory for the record. The value in AnObject is stored in Records at the position in Index.
</p>
<p>
GetObject and PutObject are called directly (as opposed to using the Objects property) in methods which maintain values in Records.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.Index">
<short/>
<short>Ordinal position for value</short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.AnObject">
<short/>
<short>Object to store at the specified position</short>
</element>
<!-- constructor Visibility: public -->
<element name="TExtendedStringList.Create">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Constructor for the class instance
</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance. Create calls the inherited constructor, and sets the default values in the following properties:
</p>
<dl>
<dt>Options</dt>
<dd>Set to <var>[ esoClearRecordsOnCreate ]</var></dd>
<dt>RecordSize</dt>
<dd>Set to the value in the <var>InitialRecordSize</var> argument</dd>
</dl>
<p>
Use RecordSize to change the memory allocation size for Records in the class.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Create.InitialRecordSize">
<short/>
<short>Memory size allocated for records</short>
</element>
<!-- destructor Visibility: public -->
<element name="TExtendedStringList.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Destructor for the class instance
</short>
<descr>
<p>
<var>Destroy</var> is the destructor for the class instance. Destroy calls FreeAllRecords to release memory allocated for entries in the Records property. Destroy calls the inherited destructor.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Clear">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Removes items stored in the string list
</short>
<descr>
<p>
<var>Clear</var> is an overridden procedure used to remove items stored in the string list. Clear calls FreeAllRecords to release memory allocated for items in the Records property. Clear calls the inherited Clear method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Delete">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Deletes the item at the specified position
</short>
<descr>
<p>
<var>Delete</var> is an overridden procedure used to delete the item at the specified position in the string list. Delete ensures that memory allocated in Records is freed by calling FreeRecord using the position in Index. Delete calls the inherited Delete method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Delete.Index">
<short/>
<short>Ordinal position for the item</short>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.CreateRecord">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Allocates memory for a new record
</short>
<descr>
<p>
<var>CreateRecord</var> is a procedure used to allocate (and optionally initialize) memory for a new value in the Records property. CreateRecord calls GetMem to allocate the memory size specified in the RecordSize property. When Options includes the value <var>esoClearRecordsOnCreate</var>, the allocated memory is filled with the character value <var>#0</var>. CreateRecord calls the inherited PutObject method to store the new record.
</p>
<p>
CreateRecord is called when reading a value in the Records property, and when writing a value to the Objects property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.CreateRecord.Index">
<short/>
<short>Ordinal position for the record</short>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeRecord">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Frees memory allocated for the specified record
</short>
<descr>
<p>
<var>FreeRecord</var> is a procedure used to free memory allocated for the record at the specified position. FreeRecord calls the inherited GetObject method to get the value stored in the Objects property. If a record has been allocated, and Options contains the value esoFreeObjectsOnDelete, the object instance in Objects is freed. FreeRecord calls FreeMem to release memory allocated for the record, and calls the inherited PutObject method to store the <var>Nil</var>'d object reference.
</p>
<p>
FreeRecord is called when writing a new value in the Records property, and in methods like FreeAllRecords and Delete.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.FreeRecord.Index">
<short/>
<short>Ordinal position for the record</short>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeAllRecords">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Frees memory allocated for Records in the class
</short>
<descr>
<p>
<var>FreeAllRecords</var> is a procedure used to free memory allocated for the Records in the class. FreeAllRecords iterates over the items in the string list, and calls the FreeRecord method to free memory allocated for each item.
</p>
<p>
FreeAllRecords is called in the Clear method, and in the destructor for the class.
</p>
</descr>
<errors></errors>
<seealso></seealso>
</element>
<!-- function Visibility: public -->
<element name="TExtendedStringList.RecordAllocated">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Determines if memory has been allocated for the specified record
</short>
<descr>
<p>
<var>RecordAllocated</var> is a Boolean function which determines if memory has been allocated for the record at the specified position. The return value is True if the item at the Index position in Objects contains a value other than <var>Nil</var>.
</p>
<p>
RecordAllocated is called when reading a value for the Records property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Result">
<short/>
<short>True if memory has been allocated for the record</short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Index">
<short/>
<short>Ordinal position for the record</short>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Records">
<short/>
<descr/>
<seealso/>
<short>
Provides indexed access to records in the string list
</short>
<descr>
<p>
<var>Records</var> an indexed Pointer property that provides access to records stored in the string list. Index is the ordinal position in the list for the desired record.
</p>
<p>
Reading a value in Records causes a record to be created using CreateRecord if one has not already been allocated. The record pointer is retrieved by calling the inherited GetObject method.
</p>
<p>
Writing a new value in Records causes a previous record value to be freed by calling FreeRecord. The inherited PutObject method is called to store the value in AValue as a TObject reference in the Objects property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Records.Index">
<short/>
<short>Ordinal position for the record</short>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.RecordSize">
<short/>
<descr/>
<seealso/>
<short>
Memory allocation size for Records in the class
</short>
<descr>
<p>
<var>RecordSize</var> is an Integer property that specifies the memory allocation size for Records in the class. The initial value for the property is set to the argument passed in the constructor. Setting a new value for the property causes the allocated memory size for any existing Records to be changed to the new value.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Options">
<short/>
<descr/>
<seealso/>
<short>
Contains record options enabled in the class
</short>
<descr>
<p>
<var>Options</var> is a TExtStringsOptions property that contains the record options enabled for the class. Options can contains values from the TExtStringsOption enumeration, including:
</p>
<dl>
<dt><var>esoClearRecordsOnCreate</var></dt>
<dd>
Memory allocated to a new record is cleared (filled with <var>#0</var>)
</dd>
<dt><var>esoFreeObjectsOnDelete</var></dt>
<dd>
Objects call their free method before they are deleted
</dd>
</dl>
<p>
The default value for the property is <var>[ esoClearRecordsOnCreate ]</var> as set in the constructor for the class.
</p>
</descr>
<seealso></seealso>
</element>
</module>
<!-- ExtendedStrings -->
</package>
</fpdoc-descriptions>

241
docs/xml/lazutils/html2textrender.xml Normal file
View File

@ -0,0 +1,241 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
html2textrender
====================================================================
-->
<module name="html2textrender">
<short>
Contains an HTML-to-Text renderer
</short>
<descr>
<p>
html2textrender.pas contains an HTML-to-Text renderer. It converts HTML into plain text by stripping tags and their attributes.
</p>
</descr>
<!-- unresolved externals -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="LConvEncoding"/>
<element name="THTML2TextRenderer">
<short></short>
<descr>
<p>
THTML2TextRenderer is an HTML-to-Text renderer. It converts HTML into plain text by stripping tags and their attributes. Converted text includes configurable indentation for HTML tags that affect the indentation level. The following HTML tags include special processing in the renderer:
</p>
<ul>
<li>HTML</li>
<li>BODY</li>
<li>P</li>
<li>BR</li>
<li>HR</li>
<li>OL</li>
<li>UL</li>
<li>LI</li>
<li>DIV CLASS="TITLE" (forces title mark output)</li>
</ul>
<p>
The following Named character entities are converted to their plain text equivalent:
</p>
<dl>
<dt>&amp;nbsp;</dt>
<dd>' '</dd>
<dt>&amp;lt;</dt>
<dd>'&lt;'</dd>
<dt>&amp;gt;</dt>
<dd>'&gt;;'</dd>
<dt>&amp;amp;</dt>
<dd>'&amp;'</dd>
</dl>
<p>
Other named character entities or numeric character entities are included verbatim in the plain text output.
</p>
<p>
A UTF-8 Byte Order Mark in the HTML is ignored.
</p>
</descr>
<seealso></seealso>
</element>
<!-- Visibility: private -->
<element name="THTML2TextRenderer.fHTML">
<short></short>
</element>
<element name="THTML2TextRenderer.fOutput">
<short></short>
</element>
<element name="THTML2TextRenderer.fMaxLines">
<short></short>
</element>
<element name="THTML2TextRenderer.fLineEndMark">
<short>End of line marker, by default standard LineEnding</short>
</element>
<element name="THTML2TextRenderer.fTitleMartk">
<short>Markup used at the start/end of title text</short>
</element>
<element name="THTML2TextRenderer.fHorzLine">
<short>Markup used for an HR Tag</short>
</element>
<element name="THTML2TextRenderer.fLinkBegin">
<short>Markup used at the start of an Anchor Tag</short>
</element>
<element name="THTML2TextRenderer.fLineEnd`">
<short>Markup used at the end of an Anchor Tag</short>
</element>
<element name="THTML2TextRenderer.fListItemMark">
<short>Markup used for a list item tag</short>
</element>
<element name="THTML2TextRenderer.fMoreMark">
<short>Text added when there are too many lines</short>
</element>
<element name="THTML2TextRenderer.fInHeader">
<short></short>
</element>
<element name="THTML2TextRenderer.fInDivTitle">
<short></short>
</element>
<element name="THTML2TextRenderer.fPendingSpace">
<short></short>
</element>
<element name="THTML2TextRenderer.fPendingNewLineCnt">
<short></short>
</element>
<element name="THTML2TextRenderer.fIndentStep">
<short>Increment (in spaces) for each nested HTML level</short>
</element>
<element name="THTML2TextRenderer.fIndent">
<short></short>
</element>
<element name="THTML2TextRenderer.fLineCnt">
<short></short>
</element>
<element name="THTML2TextRenderer.fHtmlLen">
<short></short>
</element>
<element name="THTML2TextRenderer.p">
<short></short>
</element>
<element name="THTML2TextRenderer.AddNewLine">
<short>Sets a pending line break to be added later</short>
</element>
<element name="THTML2TextRenderer.AddOneNewLine">
<short>Sets a maximum of one pending line break to be added later</short>
</element>
<element name="THTML2TextRenderer.AddOutput">
<short>Appends text to the plaint-text output for the renderer</short>
</element>
<element name="THTML2TextRenderer.AddOutput.aText">
<short></short>
</element>
<element name="THTML2TextRenderer.AddOutput.Result">
<short></short>
</element>
<element name="THTML2TextRenderer.HtmlTag">
<short>Handles an HTML tag and its attributes values</short>
</element>
<element name="THTML2TextRenderer.HtmlTag.Result">
<short></short>
</element>
<element name="THTML2TextRenderer.HtmlEntity">
<short>Handles an HTML character entity</short>
</element>
<element name="THTML2TextRenderer.HtmlEntity.Result">
<short></short>
</element>
<element name="THTML2TextRenderer.Reset">
<short>Rest the state and output for the renderer</short>
</element>
<!-- Visibility: public -->
<element name="THTML2TextRenderer.Create">
<short>Creates the class instance</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.Create.aHTML">
<short></short>
</element>
<element name="THTML2TextRenderer.Create.Stream">
<short></short>
</element>
<element name="THTML2TextRenderer.Destroy">
<short>Frees the class instance</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.Render">
<short>
Parses the HTML and renders to plain text
</short>
<descr>
<p>
Parses the HTML and renders to plain text. Output is limited to aMaxLines lines. Note: AddOutput, HtmlTag and HtmlEntity return False if MaxLines was exceeded.
</p>
</descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.Render.aMaxLines">
<short></short>
</element>
<element name="THTML2TextRenderer.Render.Result">
<short></short>
</element>
<element name="THTML2TextRenderer.LineEndMark">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.TitleMark">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.HorzLineMark">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.LinkBeginMark">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.LinkEndMark">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.ListItemMark">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.MoreMark">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="THTML2TextRenderer.IndentStep">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
</module>
<!-- html2textrender -->
</package>
</fpdoc-descriptions>

262
docs/xml/lazutils/uitypes.xml Normal file
View File

@ -0,0 +1,262 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
UITypes
====================================================================
-->
<module name="UITypes">
<short>
Contains types and constants used in modal dialogs
</short>
<descr/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="TMsgDlgType">
<short>
Defines the type of dialog implemented in a message box
</short>
<descr>
<p>
TMsgDlgType is an enumeration type that defines the type of dialog implemented in a message box. Values in the enumeration determine the caption, icon, string literals, and buttons displayed in various dialog types.
</p>
<p>
TMsgDlgType is used in several routines, such as: MessageDlg, MessageDlgPos, MessageDlgPosHelp, CreateMessageDialog, QuestionDlg, and LazMessageDlg.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TMsgDlgType.mtWarning">
<short>
Warning message box with an Exclamation mark icon
</short>
</element>
<element name="TMsgDlgType.mtError">
<short>
Error message box with Stop sign icon
</short>
</element>
<element name="TMsgDlgType.mtInformation">
<short>
Information message box with an Info icon
</short>
</element>
<element name="TMsgDlgType.mtConfirmation">
<short>
Confirmation message box with a Question mark icon
</short>
</element>
<element name="TMsgDlgType.mtCustom">
<short>
Custom message box; No icon is displayed, and the caption contains the value in ApplicationName
</short>
</element>
<element name="TMsgDlgBtn">
<short>
Defines the buttons that can be displayed in a message box
</short>
<descr>
<p>
TMsgDlgBtn is an enumeration type with values that define the buttons that can be displayed in a message dialog. TMsgDlgBtn values also determine the modal result returned from the dialog when the corresponding button is clicked.
</p>
<p>
Values in the enumeration are used in various routines, such as: MessageDlg, MessageDlgPos, MessageDlgPosHelp, CreateMessageDialog, QuestionDlg, and LazMessageDlg.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TMsgDlgBtn.mbYes">
<short>
Displays a 'Yes' button
</short>
</element>
<element name="TMsgDlgBtn.mbNo">
<short>
Displays a 'No' button
</short>
</element>
<element name="TMsgDlgBtn.mbOK">
<short>
Displays an 'OK' button
</short>
</element>
<element name="TMsgDlgBtn.mbCancel">
<short>
Displays a 'Cancel' button
</short>
</element>
<element name="TMsgDlgBtn.mbAbort">
<short>
Displays an 'Abort' button
</short>
</element>
<element name="TMsgDlgBtn.mbRetry">
<short>
Displays a 'Retry' button
</short>
</element>
<element name="TMsgDlgBtn.mbIgnore">
<short>
Displays an 'Ignore' button
</short>
</element>
<element name="TMsgDlgBtn.mbAll">
<short>
Displays an 'All' button
</short>
</element>
<element name="TMsgDlgBtn.mbNoToAll">
<short>
Displays a 'No to All' button
</short>
</element>
<element name="TMsgDlgBtn.mbYesToAll">
<short>
Displays a 'Yes to All' button
</short>
</element>
<element name="TMsgDlgBtn.mbHelp">
<short>
Displays a 'Help' button
</short>
</element>
<element name="TMsgDlgBtn.mbClose">
<short>
Displays a 'Close' button
</short>
</element>
<element name="TMsgDlgButtons">
<short>
Stores values from the TMsgDlgBtn enumeration
</short>
<descr>
<p>
TMsgDlgButtons is a set type used to store zero or more values from the TMsgDlgBtn enumeration. TMsgDlgButtons is passed as an argument to routines like: MessageDlg, MessageDlgPos, MessageDlgPosHelp, CreateMessageDialog, QuestionDlg, and LazMessageDlg.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TModalResult">
<short>
Value returned from a modal dialog box
</short>
<descr>
<p>
TModalResult is an Integer type with a value in the range low(Integer)..high(Integer). TModalResult is the type returned by routines that display modal dialog boxes, such as: MessageDlg, MessageDlgPos, MessageDlgPosHelp, QuestionDlg, and LazMessageDlg.
</p>
<p>
The value in TModalResult indicates the button clicked to close the modal dialog, and contains one of the constant values:
</p>
<ul>
<li>mrNone</li>
<li>mrOK</li>
<li>mrCancel</li>
<li>mrAbort</li>
<li>mrRetry</li>
<li>mrIgnore</li>
<li>mrYes</li>
<li>mrNo</li>
<li>mrAll</li>
<li>mrNoToAll</li>
<li>mrYesToAll</li>
<li>mrClose</li>
<li>mrLast</li>
</ul>
</descr>
<seealso></seealso>
</element>
<element name="PModalResult">
<short>
Pointer to a modal result value
</short>
<descr>
<p>
PModalResult is a pointer type to a TModalResult value.
</p>
</descr>
<seealso></seealso>
</element>
<element name="mrNone">
<short>Dialog was closed without pressing a button</short>
</element>
<element name="mrOK">
<short>OK button was clicked</short>
</element>
<element name="mrCancel">
<short>Cancel button was clicked</short>
</element>
<element name="mrAbort">
<short>Abort button was clicked</short>
</element>
<element name="mrRetry">
<short>Retry button was clicked</short>
</element>
<element name="mrIgnore">
<short>Ignore button was clicked</short>
</element>
<element name="mrYes">
<short>Yes button was clicked</short>
</element>
<element name="mrNo">
<short>No button was clicked</short>
</element>
<element name="mrAll">
<short>All button was clicked</short>
</element>
<element name="mrNoToAll">
<short>No to All button was clicked</short>
</element>
<element name="mrYesToAll">
<short>Yes to All button was clicked</short>
</element>
<element name="mrClose">
<short>Close button was clicked</short>
</element>
<element name="mrLast">
<short>Last modal result value (same as mrClose)</short>
</element>
<element name="ModalResultStr">
<short>
String representations for modal result values
</short>
<descr>
<p>
ModalResultStr is array of ShortString values that contains the string representations for values in TModalResult. ModalResultStr values can be accessed using the corresponding numeric modal result value. For example:
</p>
<code>
sResult := ModalResultStr[mrNone]; // returns 'mrNone'
</code>
<p>
ModalResultStr contains the following values:
</p>
<ul>
<li>'mrNone'</li>
<li>'mrOk'</li>
<li>'mrCancel'</li>
<li>'mrAbort'</li>
<li>'mrRetry'</li>
<li>'mrIgnore'</li>
<li>'mrYes'</li>
<li>'mrNo'</li>
<li>'mrAll'</li>
<li>'mrNoToAll'</li>
<li>'mrYesToAll'</li>
<li>'mrClose'</li>
</ul>
</descr>
<seealso></seealso>
</element>
</module>
<!-- UITypes -->
</package>
</fpdoc-descriptions>

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

@ -2,574 +2,493 @@
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
PairSplitter
====================================================================
-->
====================================================================
PairSplitter
====================================================================
-->
<module name="PairSplitter">
<short/>
<descr/>
<short>
Defines the TPairSplitter component
</short>
<descr>
Defines 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.
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<element name="Classes"/>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<element name="SysUtils"/>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<element name="LazTracer"/>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<element name="LCLType"/>
<!-- unresolved type reference Visibility: default -->
<element name="LMessages">
<short/>
<descr/>
<seealso/>
</element>
<element name="LCLIntf"/>
<!-- unresolved type reference Visibility: default -->
<element name="Graphics">
<short/>
<descr/>
<seealso/>
</element>
<element name="LMessages"/>
<!-- unresolved type reference Visibility: default -->
<element name="GraphType">
<short/>
<descr/>
<seealso/>
</element>
<element name="Graphics"/>
<!-- unresolved type reference Visibility: default -->
<element name="LCLIntf">
<short/>
<descr/>
<seealso/>
</element>
<element name="Controls"/>
<!-- unresolved type reference Visibility: default -->
<element name="Controls">
<short/>
<descr/>
<seealso/>
</element>
<element name="ExtCtrls"/>
<!-- object Visibility: default -->
<element name="TCustomPairSplitter">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TPairSplitterSide">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TPairSplitterSide.fCreatedBySplitter">
<short/>
<descr/>
<element name="TPairSplitterSide" link="#lcl.Controls.TWinControl">
<short>
Implements the child controls used in the TPairSplitter component.
</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.
</p>
</descr>
<seealso/>
</element>
<element name="TPairSplitterSide.fCreatedBySplitter"/>
<!-- function Visibility: private -->
<element name="TPairSplitterSide.GetSplitter">
<short/>
<descr/>
<errors/>
<seealso/>
<short>Gets the value for the Splitter property</short>
</element>
<!-- function result Visibility: default -->
<element name="TPairSplitterSide.GetSplitter.Result">
<short/>
<short>Value for the property</short>
</element>
<element name="TPairSplitterSide.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<!-- procedure Visibility: protected -->
<element name="TPairSplitterSide.SetParent">
<short/>
<descr/>
<errors/>
<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>.
</p>
<p>
SetParent is the reimplemented write access specifier for the Parent property.
</p>
</descr>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPairSplitterSide.SetParent.AParent">
<short/>
<short>New value for the Parent property</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TPairSplitterSide.WMPaint">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Provides custom handling for WMPaint messages
</short>
</element>
<!-- argument Visibility: default -->
<element name="TPairSplitterSide.WMPaint.PaintMessage">
<short/>
<short>WM_PAINT message for the control</short>
<descr></descr>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TPairSplitterSide.Paint">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: protected -->
<element name="TPairSplitterSide.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: protected -->
<element name="TPairSplitterSide.Anchors">
<short/>
<descr/>
<short>Renders the control on its Canvas</short>
<descr></descr>
<seealso/>
</element>
<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/>
<descr/>
<errors/>
<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.
</p>
</descr>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TPairSplitterSide.Create.TheOwner">
<short/>
<short>Owner of the control</short>
</element>
<!-- destructor Visibility: public -->
<element name="TPairSplitterSide.Destroy">
<short/>
<descr/>
<errors/>
<short>
Destructor for the class instance
</short>
<descr>
<p>
Destroy if the destructor for the class instance, and calls the inherited destructor.
</p>
</descr>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPairSplitterSide.Splitter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPairSplitterSide.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPairSplitterSide.Left">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPairSplitterSide.Top">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPairSplitterSide.Width">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TPairSplitterSide.Height">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.ChildSizing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.ClientWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.ClientHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitterSide.PopupMenu">
<short/>
<descr/>
<short>
TPairSplitter for the control
</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.
</p>
</descr>
<seealso/>
</element>
<element name="TPairSplitterSide.Visible" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.Left" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.Top" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.Width" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.Height" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.ChildSizing" link="#lcl.Controls.TWinControl"/>
<element name="TPairSplitterSide.ClientWidth" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.ClientHeight" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.Cursor" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.Enabled" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseDown" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseEnter" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseLeave" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseMove" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseUp" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseWheel" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseWheelDown" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnMouseWheelUp" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.OnResize" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.ShowHint" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.ParentShowHint" link="#lcl.Controls.TControl"/>
<element name="TPairSplitterSide.PopupMenu" link="#lcl.Controls.TControl"/>
<!-- enumeration type Visibility: default -->
<element name="TPairSplitterType">
<short/>
<descr/>
<short>
Sets the orientation for the Splitter in TPairSplitter
</short>
<descr>
<p>
<var>TPairSplitterType</var> is an enumeration type with values that set the orientation for the splitter in the TPairSplitter component. The values refer to the splitter orientation relative to the adjacent children.
</p>
<p>
TPairSplitterType is the type used for the <var>TCustomPairSplitter.SplitterType</var> property.
</p>
</descr>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPairSplitterType.pstHorizontal">
<short/>
<short>Splitter is oriented to size adjacent children horizontally</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TPairSplitterType.pstVertical">
<short/>
<short>Splitter is oriented to size adjacent children vertically</short>
</element>
<!-- object Visibility: default -->
<element name="TCustomPairSplitter">
<short/>
<descr/>
<errors/>
<element name="TCustomPairSplitter" link="#lcl.Controls.TWinControl">
<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.
</descr>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomPairSplitter.FPosition">
<short/>
<descr/>
<element name="TCustomPairSplitter.FPosition"/>
<element name="TCustomPairSplitter.FSides"/>
<element name="TCustomPairSplitter.FSplitterType"/>
<element name="TCustomPairSplitter.fDoNotCreateSides"/>
<element name="TCustomPairSplitter.GetPosition"/>
<element name="TCustomPairSplitter.GetPosition.Result"/>
<element name="TCustomPairSplitter.GetSides"/>
<element name="TCustomPairSplitter.GetSides.Result"/>
<element name="TCustomPairSplitter.GetSides.Index"/>
<element name="TCustomPairSplitter.SetPosition"/>
<element name="TCustomPairSplitter.SetPosition.AValue"/>
<element name="TCustomPairSplitter.SetSplitterType"/>
<element name="TCustomPairSplitter.SetSplitterType.AValue"/>
<element name="TCustomPairSplitter.AddSide"/>
<element name="TCustomPairSplitter.AddSide.ASide"/>
<element name="TCustomPairSplitter.RemoveSide"/>
<element name="TCustomPairSplitter.RemoveSide.ASide"/>
<element name="TCustomPairSplitter.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<!-- Visibility: protected -->
<element name="TCustomPairSplitter.GetCursor">
<short>Gets the value for the Cursor property</short>
</element>
<element name="TCustomPairSplitter.GetCursor.Result">
<short>Value for the Cursor property</short>
</element>
<element name="TCustomPairSplitter.SetCursor">
<short>Sets the value for the Cursor property</short>
</element>
<element name="TCustomPairSplitter.SetCursor.Value">
<short>New value for the Cursor property</short>
</element>
<element name="TCustomPairSplitter.GetControlClassDefaultSize">
<short>
Gets the default size for the control class
</short>
<descr>
<p>
<var>GetControlClassDefaultSize</var> is a TSize class function used to get the default size for instances of the class. GetControlClassDefaultSize sets the Height and Width in the TSize value. The default value in both CX and CY is 90 pixels.
</p>
<p>
GetControlClassDefaultSize is used the Create constructor.
</p>
</descr>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomPairSplitter.FSides">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomPairSplitter.FSplitterType">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomPairSplitter.fDoNotCreateSides">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TCustomPairSplitter.GetPosition">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomPairSplitter.GetPosition.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TCustomPairSplitter.GetSides">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomPairSplitter.GetSides.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.GetSides.Index">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomPairSplitter.SetPosition">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.SetPosition.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomPairSplitter.SetSplitterType">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.SetSplitterType.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomPairSplitter.AddSide">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.AddSide.ASide">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomPairSplitter.RemoveSide">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.RemoveSide.ASide">
<short/>
<element name="TCustomPairSplitter.GetControlClassDefaultSize.Result">
<short>
TSize type with the default Height and Width for instances of the class
</short>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomPairSplitter.Create">
<short/>
<descr/>
<errors/>
<short>
Constructor for the class instance
</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance. Create calls the inherited constructor using TheOwner as the owner of the component.
</p>
<p>
Create calls the GetControlClassDefaultSize class method to get the default height and width values used in instances of the class type, and calls SetBounds to apply the values. Create sets the default values for the following properties:
</p>
<dl>
<dt>ControlStyle</dt>
<dd>Removes the value csAcceptsControls in the property</dd>
<dt>SplitterType</dt>
<dd>pstHorizontal</dd>
<dt>Cursor</dt>
<dd>crHSplit</dd>
<dt>Position</dt>
<dd>45</dd>
</dl>
<p>
Create calls the CreateSides method when csDesigning is not in the ComponentState property. CreateSides ensures both TPairSplitterSide instances are created (and parented) in the Sides property.
</p>
</descr>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.Create.TheOwner">
<short/>
<short>Owner of the component</short>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomPairSplitter.Destroy">
<short/>
<descr/>
<errors/>
<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.
</p>
</descr>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomPairSplitter.CreateWnd">
<short/>
<descr/>
<errors/>
<short>
Creates the window handle for the control
</short>
<descr>
<p>
<var>CreateWnd</var> is an overridden procedure used to create the window handle for the control. CreateWnd calls CreateSides to ensure both TPairSplitterSide instances are created (and parented) in the Sides property. CreateWnd calls the inherited CreateWnd method.
</p>
</descr>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomPairSplitter.UpdatePosition">
<short/>
<descr/>
<errors/>
<short>
Updates the value in the Position property
</short>
<descr>
<var>UpdatePosition</var> is a procedure used to update the value in the Position property. UpdatePosition calls the SetPosition method in the WidgetSetClass to recalculate the current relative position for the Splitter in the component. UpdatePosition stores the value in the Position property.
</descr>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomPairSplitter.CreateSides">
<short/>
<descr/>
<errors/>
<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).
</p>
<p>
No actions are performed in the method when component streaming has not been completed, or when the component is freed.
</p>
<p>
CreateSides is called from the Create, CreateWnd, and Loaded methods.
</p>
</descr>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomPairSplitter.Loaded">
<short/>
<descr/>
<errors/>
<short>
Performs actions on completion of component streaming
</short>
<descr>
<p>
<var>Loaded</var> is an overridden procedure which performs actions needed when the component has been loaded using the LCL component streaming mechanism. Loaded calls the inherited Loaded method. Loaded calls the CreateSides method to ensure that both values in the Sides property have been created. Loaded updates the value in Position if the handle for the control has been allocated.
</p>
</descr>
<seealso/>
</element>
<!-- function Visibility: public -->
<element name="TCustomPairSplitter.IsSupportedByInterface">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomPairSplitter.IsSupportedByInterface.Result">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TCustomPairSplitter.ChildClassAllowed">
<short/>
<descr/>
<errors/>
<short>
Determines if the class is inherited from a specific ancestor
</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.
</p>
</descr>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomPairSplitter.ChildClassAllowed.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.ChildClassAllowed.ChildClass">
<short/>
<short>Class to compare in the method`</short>
</element>
<element name="TCustomPairSplitter.ChildClassAllowed.Result">
<short>True if the class has a specific ancestor</short>
</element>
<element name="TCustomPairSplitter.Cursor" link="#lcl.Controls.TControl">
<short>Cursor displayed when the control is resized</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomPairSplitter.Sides">
<short/>
<descr/>
<short>
Provides access to the adjacent children resized using the Splitter
</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.
</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 visibilities; for example, Align and Anchors are private, Top and Left are public.
</p>
</descr>
<errors>
<p>
Calls RaiseGDBException to raise an exception when Index &lt; 0 or Index &gt; 1. Raised with the message 'TCustomPairSplitter.GetSides: Index out of bounds'.
</p>
</errors>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPairSplitter.Sides.Index">
<short/>
<short>Ordinal position the adjacent child control</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomPairSplitter.SplitterType">
<short/>
<descr/>
<short>
Specifies the orientation for the splitter in the component
</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:
</p>
<dt>
<dt>pstHorizontal</dt>
<dd>
Splitter is oriented to size adjacent children horizontally. Cursor is set to <var>crHSplit</var>. (<b>Default value</b>)
</dd>
<dt>pstVertical</dt>
<dd>
Splitter is oriented to size adjacent children vertically. Cursor is set to <var>crVSplit</var>.
</dd>
</dt>
</descr>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomPairSplitter.Position">
<short/>
<descr/>
<short>
Indicates the position for the Splitter relative to its orientation
</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.
</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].
</p>
<p>
When SplitterType contains <var>pstVertical</var>, the value in Position is used as the Height for the child control in Sides[0]. The remaining Height in the component (less the 5 pixels used for the Splitter) is set as the Height for the child control in Sides[1].
</p>
</descr>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TPairSplitter">
<short/>
<descr/>
<errors/>
<element name="TPairSplitter" link="TCustomPairSplitter">
<short>
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.
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.SplitterType">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.Position">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPairSplitter.Visible">
<short/>
<descr/>
<seealso/>
</element>
<element name="TPairSplitter.Align" link="#lcl.Controls.TControl.Align"/>
<element name="TPairSplitter.Anchors" link="#lcl.Controls.TControl.Anchors"/>
<element name="TPairSplitter.BorderSpacing" link="#lcl.Controls.TControl.BorderSpacing"/>
<element name="TPairSplitter.Constraints" link="#lcl.Controls.TControl.Contraints"/>
<element name="TPairSplitter.Color" link="#lcl.Controls.TControl.Color"/>
<element name="TPairSplitter.Cursor" link="#lcl.Controls.TControl.Cursor"/>
<element name="TPairSplitter.Enabled" link="#lcl.Controls.TControl.Enabled"/>
<element name="TPairSplitter.OnMouseDown" link="#lcl.Controls.TControl.OnMouseDown"/>
<element name="TPairSplitter.OnMouseEnter" link="#lcl.Controls.TControl.OnMouseEnter"/>
<element name="TPairSplitter.OnMouseLeave" link="#lcl.Controls.TControl.OnMouseLeave"/>
<element name="TPairSplitter.OnMouseMove" link="#lcl.Controls.TControl.OnMouseMove"/>
<element name="TPairSplitter.OnMouseUp" link="#lcl.Controls.TControl.OnMouseUp"/>
<element name="TPairSplitter.OnMouseWheel" link="#lcl.Controls.TControl.OnMouseWheel"/>
<element name="TPairSplitter.OnMouseWheelDown" link="#lcl.Controls.TControl.OnMouseWheelDown"/>
<element name="TPairSplitter.OnMouseWheelUp" link="#lcl.Controls.TControl.OnMouseWheelUp"/>
<element name="TPairSplitter.OnResize" link="#lcl.Controls.TControl.OnResize"/>
<element name="TPairSplitter.OnChangeBounds" link="#lcl.Controls.TControl.OnChangeBounds"/>
<element name="TPairSplitter.ParentShowHint" link="#lcl.Controls.TControl.ParentShowHint"/>
<element name="TPairSplitter.PopupMenu" link="#lcl.Controls.TControl.PopupMenu"/>
<element name="TPairSplitter.Position" link="TCustomPairSplitter.Position"/>
<element name="TPairSplitter.ShowHint" link="#lcl.Controls.TControl.ShowHint"/>
<element name="TPairSplitter.SplitterType" link="TCustomPairSplitter.SplitterType"/>
<element name="TPairSplitter.Visible" link="#lcl.Controls.TControl.Visible"/>
<!-- procedure Visibility: default -->
<element name="Register">
<short/>
<descr/>
<errors/>
<seealso/>
<short></short>
</element>
<element name="TPairSplitterSide.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomPairSplitter.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
</module>
<!-- PairSplitter -->
</package>