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

Docs: Updates for LCL. Issue #38564, patch from Don Siders.

Browse Source 
git-svn-id: trunk@64718 -
This commit is contained in:
juha 2021-03-01 20:14:04 +00:00
parent 2e91d3ccef
commit c53aae59a8
13 changed files with 4944 additions and 5573 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

320
docs/xml/lcl/buttonpanel.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="ButtonPanel">
<short>Provides a panel with Bitmap buttons</short>
<short>Provides a panel with buttons using glyph images</short>
<descr>
<p>
<file>buttonpanel.pas</file> contains classes and types used to implement <var>TButtonPanel</var>, a panel which contains common buttons used in an application form. It is part of the Lazarus Component Library (<b>LCL</b>).
@ -45,21 +45,37 @@
</short>
<descr>
<p>
<var>TButtonOrder</var> is an enumeration with values which indicate the display order used for buttons on <var>TButtonPanel</var>.
<var>TButtonOrder</var> is an enumeration with values which indicate the display order used for buttons on <var>TCustomButtonPanel</var> and <var>TButtonPanel</var>.
</p>
<p>
The value <var>boDefault</var> has a special meaning, and causes the button order to be set to the sequence normally used for the platform or operating system.
</p>
<p>
For example:
</p>
<dl>
<dt>UNIX-like environments</dt>
<dd>Uses Ok, Cancel, Close, and Help button order.</dd>
<dt>All other platforms</dt>
<dd>Uses Cancel, Ok, Close, and Help button order.</dd>
</dl>
<p>
TButtonOrder is the type used to implement the <var>TCustomButtonPanel.ButtonOrder</var> property.
</p>
</descr>
<seealso>
<link id="TCustomButtonPanel.ButtonOrder"/>
<link id="TButtonPanel"/>
</seealso>
</element>
<element name="TButtonOrder.boDefault">
<short>Uses the default button order; OK, Cancel, Close, Help</short>
<short>Uses the common button order for the platform or operating system</short>
</element>
<element name="TButtonOrder.boCloseCancelOK">
<short>Use the button order Close, Cancel, OK</short>
<short>Use the button order Close, Cancel, OK, Help</short>
</element>
<element name="TButtonOrder.boCloseOKCancel">
<short>Use the button order Close, OK, Cancel</short>
<short>Use the button order Close, OK, Cancel, Help</short>
</element>
<element name="TPanelButton">
@ -224,7 +240,7 @@
<short>Defines the base class for TButtonPanel</short>
<descr>
<p>
<var>TCustomButtonPanel</var> is a <var>TCustomPanel</var> descendant which defines the base class for <var>TButtonPanel</var>, a panel containing Bitmap buttons. Buttons are provided for <b>OK</b>, <b>Help</b>, <b>Close</b>, and <b>Cancel</b> operations. Other properties are provided to control the display order for the buttons, the default button for the panel, visibility of the available buttons, and the use of glyphs.
<var>TCustomButtonPanel</var> is a <var>TCustomPanel</var> descendant which defines the base class for <var>TButtonPanel</var>, a panel containing buttons with glyph images. Buttons are provided for <b>OK</b>, <b>Help</b>, <b>Close</b>, and <b>Cancel</b> operations. Other properties are provided to control the display order for the buttons, the default button for the panel, visibility of the available buttons, and the use of glyphs.
</p>
<p>
Applications should not create instances of <var>TCustomButtonPanel</var>; use the <var>TButtonPanel</var> ancestor which specifies the visibility of properties (including event handlers).
@ -467,7 +483,7 @@
<var>UpdateBevel</var> is called when a value is assigned to the <var>ShowBevel</var> property.
</p>
<remark>
Please note: No actions are performed in the method when <var>ShowBevel</var> contains <b>False</b>.
No actions are performed in the method when <var>ShowBevel</var> is set to <b>False</b>.
</remark>
</descr>
<seealso>
@ -553,10 +569,18 @@
<element name="TCustomButtonPanel.IsLastButton">
<short>
Indicates if the specified button is the last one defined in the button order for the panel
Indicates if the specified button is the last one defined in the button order
</short>
<descr></descr>
<seealso></seealso>
<descr>
<p>
<var>IsLastButton</var> is a <var>Boolean</var> function used to determine if the button in <var>AControl</var> is the last button in the <var>ButtonOrder</var> for the panel. The return value is <b>True</b> when AControl is a visible <var>TPanelBitBtn</var> instance which occurs last in the tab order for the visible buttons.
</p>
</descr>
<seealso>
<link id="TCustomButtonPanel.ButtonOrder"/>
<link id="TCustomButtonPanel.ShowButtons"/>
<link id="TPanelBitBtn"/>
</seealso>
</element>
<element name="TCustomButtonPanel.IsLastButton.Result">
<short>True when the specified button is the last in the button order</short>
@ -637,12 +661,29 @@
</seealso>
</element>
<element name="TCustomButtonPanel.Notification" link="#rtl.Classes.TComponent.Notification"/>
<element name="TCustomButtonPanel.Notification">
<short>Called by components that are freed and which received a FreeNotification</short>
<descr>
<p>
<var>Notification</var> is called whenever a child component is destroyed, inserted or removed from the list of owned components. Components that were requested to send a notification when they are freed (with FreeNotification) will also call Notification when they are freed.
</p>
<p>
The <var>AComponent</var> parameter specifies which component sends the notification, and <var>Operation</var> specifies whether the component is being inserted into or removed from the child component list, or whether it is being destroyed.
</p>
<p>
Notification is overridden in <var>TCustomButtonPanel</var> to ensure that <var>TPanelBitBtn</var> instances which are freed are excluded from the <var>ShowButtons</var> property, and their internal storage is <b>Nil</b>'d. If the panel control is not being destroyed, the remaining buttons are re-sized and re-aligned.
</p>
</descr>
<seealso>
<link id="TCustomButtonPanel.ShowButtons"/>
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
</seealso>
</element>
<element name="TCustomButtonPanel.Notification.AComponent">
<short></short>
<short>Component for the notification</short>
</element>
<element name="TCustomButtonPanel.Notification.Operation">
<short></short>
<short>Operation performed for the component</short>
</element>
<element name="TCustomButtonPanel.SetAlign">
@ -715,7 +756,9 @@
Create calls the DoShowButtons method to create and configure the TPanelBitBtn instances used in the panel class.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="TCustomButtonPanel.Destroy"/>
</seealso>
</element>
<element name="TCustomButtonPanel.Create.AOwner">
<short>Owner for the class instance</short>
@ -728,7 +771,9 @@
<var>Destroy</var> is the overridden destructor for the class instance. Destroy ensures that <var>TBitmap</var> instances created for button glyphs in the panel are freed. Destroy calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="TCustomButtonPanel.Create"/>
</seealso>
</element>
<element name="TCustomButtonPanel.Align">
@ -737,52 +782,188 @@
</short>
<descr>
<p>
<var>Align</var> is a public property in <var>TCustomButtonPanel</var> used to specify the border (or edge) where the panel (and its buttons and bevel) are aligned. The default value for the property is <var>alBottom</var>. Changing the value in <var>Align</var> causes the <var>UpdateButtonLayout</var>, <var>UpdateBevel</var>, and <var>UpdateSizes</var> methods to be called.
<var>Align</var> is a public property in <var>TCustomButtonPanel</var> used to specify the border (or edge) where the panel (and its buttons and bevel) are aligned. The default value for the property is <var>alBottom</var>.
</p>
<p>
Changing the value in <var>Align</var> causes the private <var>UpdateButtonLayout</var>, <var>UpdateBevel</var>, and <var>UpdateSizes</var> methods to be called.
</p>
<p>
Use <var>AutoSize</var> to enable or disable auto-sizing for the non-aligned or anchored dimensions in the control.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="TCustomButtonPanel.AutoSize"/>
</seealso>
</element>
<element name="TCustomButtonPanel.AutoSize">
<short>Indicates if the panel can automatically adjust its size</short>
<descr></descr>
<seealso></seealso>
<descr>
<p>
<var>AutoSize</var> is a <var>Boolean</var> property which indicates if the button panel can automatically adjust its size. The default value for the property is <b>True</b>.
</p>
<p>
Please note that auto-sizing is affected by the value in the <var>Align</var> property. When Align is set to <var>alBottom</var> (the default), the panel width is determined by the available width for the parent. <var>Height</var> will be automatically sized, but <var>Width</var> will not.
</p>
</descr>
<seealso>
<link id="TCustomButtonPanel.Align"/>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
<link id="#lcl.controls.TControl.AdjustSize">TControl.AdjustSize</link>
</seealso>
</element>
<element name="TCustomButtonPanel.OKButton">
<short>
<var>OKButton</var> - a button with the caption 'OK' signifying acceptance by the user
</short>
<descr/>
<seealso/>
<descr>
<p>
<var>OKButton</var> is a read-only <var>TPanelBitBtn</var> property which provides access to the <b>OK</b> button for the panel. Read access is redirected to the internal array of buttons in the class instance.
</p>
<p>
Use OKButton to set custom values for properties in the TPanelBitBtn instance, including:
</p>
<ul>
<li>Caption</li>
<li>Cursor</li>
<li>DefaultCaption</li>
<li>Enabled</li>
<li>Font</li>
<li>Glyph</li>
<li>Name</li>
<li>PopupMenu</li>
<li>ShowHint</li>
<li>Tag</li>
</ul>
</descr>
<seealso>
<link id="TCustomButtonPanel.CancelButton"/>
<link id="TCustomButtonPanel.CloseButton"/>
<link id="TCustomButtonPanel.HelpButton"/>
</seealso>
</element>
<element name="TCustomButtonPanel.HelpButton">
<short>
<var>HelpButton</var> - a button with the 'Help' caption, for requesting help</short>
<descr/>
<seealso/>
<var>HelpButton</var> - a button with the 'Help' caption, for requesting help
</short>
<descr>
<p>
<var>HelpButton</var> is a read-only <var>TPanelBitBtn</var> property which provides access to the <b>Help</b> button for the panel. Read access is redirected to the internal array of buttons in the class instance.
</p>
<p>
Use HelpButton to set custom values for properties in the TPanelBitBtn instance, including:
</p>
<ul>
<li>Caption</li>
<li>Cursor</li>
<li>DefaultCaption</li>
<li>Enabled</li>
<li>Font</li>
<li>Glyph</li>
<li>Name</li>
<li>PopupMenu</li>
<li>ShowHint</li>
<li>Tag</li>
</ul>
</descr>
<seealso>
<link id="TCustomButtonPanel.CancelButton"/>
<link id="TCustomButtonPanel.CloseButton"/>
<link id="TCustomButtonPanel.OkButton"/>
</seealso>
</element>
<element name="TCustomButtonPanel.CloseButton">
<short>
<var>CloseButton</var> - a button with the 'Close' caption for terminating the Form or panel</short>
<descr/>
<seealso/>
<var>CloseButton</var> - a button with the 'Close' caption for terminating the Form or panel
</short>
<descr>
<p>
<var>CloseButton</var> is a read-only <var>TPanelBitBtn</var> property which provides access to the <b>Close</b> button for the panel. Read access is redirected to the internal array of buttons in the class instance.
</p>
<p>
Use CloseButton to set custom values for properties in the TPanelBitBtn instance, including:
</p>
<ul>
<li>Caption</li>
<li>Cursor</li>
<li>DefaultCaption</li>
<li>Enabled</li>
<li>Font</li>
<li>Glyph</li>
<li>Name</li>
<li>PopupMenu</li>
<li>ShowHint</li>
<li>Tag</li>
</ul>
</descr>
<seealso>
<link id="TCustomButtonPanel.CancelButton"/>
<link id="TCustomButtonPanel.HelpButton"/>
<link id="TCustomButtonPanel.OkButton"/>
</seealso>
</element>
<element name="TCustomButtonPanel.CancelButton">
<short>
<var>CancelButton</var> - a button with the 'Cancel' caption for cancelling the operation</short>
<descr/>
<seealso/>
<var>CancelButton</var> - a button with the 'Cancel' caption for cancelling the operation
</short>
<descr>
<p>
<var>CancelButton</var> is a read-only <var>TPanelBitBtn</var> property which provides access to the <b>Cancel</b> button for the panel. Read access is redirected to the internal array of buttons in the class instance.
</p>
<p>
Use CancelButton to set custom values for properties in the TPanelBitBtn instance, including:
</p>
<ul>
<li>Caption</li>
<li>Cursor</li>
<li>DefaultCaption</li>
<li>Enabled</li>
<li>Font</li>
<li>Glyph</li>
<li>Name</li>
<li>PopupMenu</li>
<li>ShowHint</li>
<li>Tag</li>
</ul>
</descr>
<seealso>
<link id="TCustomButtonPanel.CloseButton"/>
<link id="TCustomButtonPanel.HelpButton"/>
<link id="TCustomButtonPanel.OkButton"/>
</seealso>
</element>
<element name="TCustomButtonPanel.ButtonOrder">
<short>
<var>ButtonOrder</var> - the order in which the series of buttons will appear on the panel</short>
<descr/>
<seealso/>
<var>ButtonOrder</var> - the order in which the series of buttons will appear on the panel
</short>
<descr>
<p>
<var>ButtonOrder</var> is a <var>TButtonOrder</var> property which indicates the order of the buttons displayed on the panel. The default value for the property is <var>boDefault</var>, and causes the button order to be set to the sequence normally used for the platform or operating system.
</p>
<p>
For example:
</p>
<dl>
<dt>UNIX-like environments</dt>
<dd>Uses Ok, Cancel, Close, and Help button order.</dd>
<dt>All other platforms</dt>
<dd>Uses Cancel, Ok, Close, and Help button order.</dd>
</dl>
<p>
Use <var>boCloseCancelOK</var> or <var>boCloseOKCancel</var> to set the button order where <b>Help</b> is always the last button displayed.
</p>
<p>
Changing the value in ButtonOrder causes the button panel to be re-drawn.
</p>
</descr>
<seealso>
<link id="TButtonOrder"/>
</seealso>
</element>
<element name="TCustomButtonPanel.DefaultButton">
@ -791,7 +972,7 @@
</short>
<descr>
<p>
<var>DefaultButton</var> contains the button used as the default action performed when the <b>Return</b> or <b>Enter</b> key is pressed.
<var>DefaultButton</var> contains the button which performs the default action when the <b>Return</b> or <b>Enter</b> key is pressed.
</p>
</descr>
<seealso>
@ -799,27 +980,60 @@
</element>
<element name="TCustomButtonPanel.ShowButtons">
<short>
Indicates if buttons are displayed on the panel
</short>
<short>Indicates the buttons displayed on the panel</short>
<descr>
<p>
<var>ShowButtons</var> is a Boolean property which Indicates if buttons are displayed on the panel.
<var>ShowButtons</var> is a <var>TPanelButtons</var> property which contains the set of buttons displayed on the panel. The default value for the property is defined in the <var>DefShowButtons</var> constant.
</p>
<p>
Changing the values in the property causes the panel and its buttons to be re-sized and re-drawn.
</p>
<p>
Use ShowGlyphs to indicate which buttons have an image displayed on the button surface.
</p>
<p>
For example:
</p>
<code>
// var aButtonPanel: TButtonPanel...
// use Ok and Cancel buttons only
AButtonPanel.ShowButtons := [pbOk, pbCancel];
AButtonPanel.ShowGlyphs := [pbOk, pbCancel];
</code>
</descr>
<seealso/>
</element>
<element name="TCustomButtonPanel.ShowGlyphs">
<short>
Indicates whether Glyphs (small images) are shown on the buttons for the panel
</short>
<short>Indicates the panel buttons displayed with Glyphs (small images)</short>
<descr>
<p>
<var>ShowGlyphs</var> is a Boolean property which indicates whether Glyphs (small images) are shown on the buttons for the panel.
<var>ShowGlyphs</var> contains values from the <var>TPanelButton</var> enumeration, and defines which panel buttons in <var>ShowButtons</var> are displayed with glyph images. The default value for the property is defined in the <var>DefShowGlyphs</var> constant.
</p>
<p>
Changing the values in the property causes the panel and its buttons to be re-sized and re-drawn.
</p>
<p>
A default glyph image is provided for each TPanelBitBtn instance on the panel using the internal button name, like "OKButton" or "CancelButton". The default glyph image is loaded from LCL glyph resources when the button is created. Use OkButton, CancelButton, CloseButton, and HelpButton to provide custom values used in the panel buttons.
</p>
<p>
Use ShowButtons to control which buttons are displayed on the panel. For example:
</p>
<code>
// var aButtonPanel: TButtonPanel...
// use Ok and Cancel buttons only
AButtonPanel.ShowButtons := [pbOk, pbCancel];
AButtonPanel.ShowGlyphs := [pbOk, pbCancel];
</code>
</descr>
<seealso>
<link id="TCustomButtonPanel.OkButton"/>
<link id="TCustomButtonPanel.CancelButton"/>
<link id="TCustomButtonPanel.CloseButton"/>
<link id="TCustomButtonPanel.HelpButton"/>
<link id="TCustomButtonPanel.ShowButtons"/>
<link id="TPanelBitBtn"/>
<link id="DefShowGlyphs"/>
</seealso>
</element>
@ -827,7 +1041,7 @@
<short>Indicates if a bevel is displayed for the button panel</short>
<descr>
<p>
<var>ShowBevel</var> is a <var>Boolean</var> property which indicates if a TBevel is displayed on the edge opposite of the alignment for the panel. Changing the value for the property causes a <var>TBevel</var> instance to be created (or freed), and the <var>UpdateBevel</var> method to be called.
<var>ShowBevel</var> is a <var>Boolean</var> property which indicates if a <var>TBevel</var> is displayed on the edge opposite of the alignment for the panel. Changing the value for the property causes a TBevel instance to be created (or re-created). The private <var>UpdateBevel</var> method is called to apply the size, shape, and alignment needed for the bevel.
</p>
</descr>
<seealso>
@ -856,7 +1070,7 @@
<short>Implements a panel with Bitmap Button instances</short>
<descr>
<p>
<var>TButtonPanel</var> is a <var>TCustomButtonPanel</var> descendant which implements a panel containing Bitmap buttons. Buttons are provided for <b>OK</b>, <b>Help</b>, <b>Close</b>, and <b>Cancel</b> operations. Other properties are provided to control the display order for the buttons, the default button for the panel, visibility of the available buttons, and the use of glyphs.
<var>TButtonPanel</var> is a <var>TCustomButtonPanel</var> descendant which implements a panel containing buttons with glyph images. Buttons are provided for <b>OK</b>, <b>Help</b>, <b>Close</b>, and <b>Cancel</b> operations. Other properties are provided to control the display order for the buttons, the default button for the panel, visibility of the available buttons, and the use of glyphs.
</p>
</descr>
<seealso>
@ -888,13 +1102,13 @@
<element name="TButtonPanel.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TButtonPanel.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TButtonPanel.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TButtonPanel.OnMouseDown" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TButtonPanel.OnMouseDown" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TButtonPanel.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TButtonPanel.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TButtonPanel.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TButtonPanel.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TButtonPanel.OnMouseUp" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TButtonPanel.OnMouseUp" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TButtonPanel.OnMouseUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TButtonPanel.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TButtonPanel.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TButtonPanel.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TButtonPanel.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TButtonPanel.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TButtonPanel.ShowButtons" link="#lcl.buttonpanel.TCustomButtonPanel.ShowButtons"/>
@ -906,8 +1120,14 @@
<short>Registers the TButtonPanel class in the Lazarus IDE</short>
<descr>
<p>
<var>Register</var> is a procedure used to register the <var>TButtonPanel</var> component on the <b>Misc</b> tab in the Lazarus IDE.
<var>Register</var> is the procedure used to register components for use in the Lazarus IDE. The following components are added to the Lazarus IDE:
</p>
<p>
<b>Misc</b> Tab
</p>
<ul>
<li>TButtonPanel</li>
</ul>
</descr>
<seealso/>
</element>

131
docs/xml/lcl/buttons.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!-- Buttons -->
<module name="Buttons">
<short>Contains types and classes used to implement specialized buttons</short>
<descr>
@ -14,7 +14,7 @@
</ul>
</descr>
<!-- unresolved type references -->
<!-- unresolved references -->
<element name="Types"/>
<element name="Classes"/>
<element name="SysUtils"/>
@ -578,37 +578,88 @@
<element name="TButtonGlyph.Draw">
<short>
Draws the image in the specified rectangle, within the client rectangle at a specified offset, with the specified state and transparency
Draws the glyph for the button using the specified settings
</short>
<descr></descr>
<seealso></seealso>
<descr>
<p>
<var>Draw</var> is a method used to draw the glyph for the button using the target and configuration specified in the arguments. Draw is overloaded to provide a variant which uses a scalilng factor for the glyph image.
</p>
<p>
<var>Canvas</var> is the TCanvas instance where the glyph is rendered.
</p>
<p>
<var>Client</var> is a TRectangle instance with the client coordinates for the drawing operation.
</p>
<p>
<var>Offset</var> is a TPoint instance which contains the offset where the glyph is drawn in the Client rectangle.
</p>
<p>
<var>State</var> contains the button drawing state and is used to get both the glyph image and graphic drawing effect applied in the method.
</p>
<p>
<var>Transparent</var> indicates if the glyph is draw transparently.
</p>
<p>
<var>PPI</var> indicates the display density for the image resolution requested in the method.
</p>
<p>
<var>ScaleFactor</var> is the canvas scaling factor applied when the image is drawn.
</p>
<p>
Images used for button glyphs can be loaded from three (3) different sources.
</p>
<ul>
<li>LCLGlyphResourceName property</li>
<li>ExternalImages property</li>
<li>Images property</li>
</ul>
<p>
By default, the LCL Glyph resource is used when the button is created. Setting values for the corresponding properties changes the source for the glyph image.
</p>
<p>
Draw calls <var>GetImageIndexAndEffect</var> to get the image resolution needed for the value in PPI, and the index for the image drawn in the method. The <var>TScaledImageListResolution.Draw</var> method is called to render the selected glyph in the resolution to the Canvas using the Client, Offset, and derived graphics drawing effect.
</p>
<p>
No actions are performed in the method when an bitmap has not been assigned to the Glyph property, when the coordinates in Client are invalid, or when an image resolution / image index was not found.
</p>
<p>
The return value is a TRectangle instance with the original value passed in Client. Please note, this is different than the Delphi VCL; it returns the text rectangle.
</p>
</descr>
<seealso>
<link id="TButtonGlyph.LCLGlyphName"/>
<link id="TButtonGlyph.ExternalImages"/>
<link id="TButtonGlyph.Images"/>
<link id="TButtonGlyph.GetImageIndexAndEffect"/>
<link id="#lcl.imglist.TScaledImageListResolution">TScaledImageListResolution</link>
</seealso>
</element>
<element name="TButtonGlyph.Draw.Result">
<short></short>
<short>Rectangle where the glyph was drawn</short>
</element>
<element name="TButtonGlyph.Draw.Canvas">
<short></short>
<short>Canvas where the glyph is rendered</short>
</element>
<element name="TButtonGlyph.Draw.Client">
<short></short>
<short>Ciient coodintates for the drawing operation</short>
</element>
<element name="TButtonGlyph.Draw.Offset">
<short></short>
<short>Offset in the client coordinates where the glyph is drawn</short>
</element>
<element name="TButtonGlyph.Draw.State">
<short></short>
<short>Button state</short>
</element>
<element name="TButtonGlyph.Draw.Transparent">
<short></short>
<short>True if the glyph is drawn transparently</short>
</element>
<element name="TButtonGlyph.Draw.BiDiFlags">
<short></short>
<short>Not used in the current implementation</short>
</element>
<element name="TButtonGlyph.Draw.PPI">
<short></short>
<short>Pixels Per Inch for the image resolution requested in the method</short>
</element>
<element name="TButtonGlyph.Draw.ScaleFactor">
<short></short>
<short>Canvas scaling factor used in the method</short>
</element>
<element name="TButtonGlyph.Refresh">
@ -732,7 +783,7 @@
Contains a reference to an existing list of images available for use in the Glyph property
</short>
<descr>
<!-- TODO: discuss ExternalImages vs LCLGlyphResourceName vs Images -->
<!-- TODO: -->
</descr>
<seealso></seealso>
</element>
@ -2726,10 +2777,15 @@
<element name="TSpeedButton.OnClick" link="#lcl.controls.TControl.OnClick">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>.
<p>
Standard properties, which should be supported by all descendants.
</p>
<p>
This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>.
</p>
<p>
Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.
</p>
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
</descr>
<seealso></seealso>
</element>
@ -2738,9 +2794,13 @@
<element name="TSpeedButton.OnDblClick" link="#lcl.controls.TControl.OnDblClick">
<descr>
<p>Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate.</p>
<p>
Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lcl.controls.TControl.OnDblClick">TControl.OnDblClick</link>
</seealso>
</element>
<element name="TSpeedButton.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
@ -2853,9 +2913,18 @@
Loads the bitmap for the specified Glyph using the image for the specified button identifier
</short>
<descr>
LoadGlyphFromStock is a procedure used to load a TBitmap into the AGlyph argument with the image used for the button identifier in idButton. LoadGlyphFromStock calls the GetButtonIcon routine to load the graphic image for the button identifier. Used in the implementation of the LoadGlyphFromStock method in both TCustomBitBtn and TCustomSpeedButton.
<p>
<var>LoadGlyphFromStock</var> is a procedure used to load a <var>TBitmap</var> into the <var>AGlyph</var> argument with the image used for the button identifier in <var>idButton</var>. LoadGlyphFromStock calls the <var>GetButtonIcon</var> routine to load the graphic image for the button identifier.
</p>
<p>
Used in the implementation of the <var>LoadGlyphFromStock</var> method in both <var>TCustomBitBtn</var> and <var>TCustomSpeedButton</var>.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="CustomBitBtn.LoadGlyphFromStock"/>
<link id="TCustomSpeedButton.LoadGlyphFromStock"/>
<link id="GetButtonIcon"/>
</seealso>
</element>
<element name="LoadGlyphFromStock.AGlyph">
<short>TButtonGlyph where the bitmap is stored</short>
@ -2975,25 +3044,35 @@
<short>Contains resource names for corresponding button identifiers in TBitBtn</short>
<descr>
<p>
BitBtnResNames is an Array constant that contains Strings with the resource name for button identifiers used in TBitBtn. Values in BitBtnResNames are indexed by the range of values defined in BitBtnImages as idButtonOk..idButtonNoToAll.
<var>BitBtnResNames</var> is an <var>Array</var> constant that contains Strings with the resource name for button identifiers used in TBitBtn. Values in BitBtnResNames are indexed by the range of values defined in <var>BitBtnImages</var>: <b><var>idButtonOk</var>..<var>idButtonNoToAll</var></b>.
</p>
<p>
BitBtnResNames is used in the implementation of the RealizeKind method in TCustomBitBtn.
BitBtnResNames is used in the implementation of the <var>RealizeKind</var> method in <var>TCustomBitBtn</var>.
</p>
</descr>
<seealso>
<link id="BitBtnImages"/>
<link id="TCustomBitBtn.RealizeKind"/>
</seealso>
</element>
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<descr>
Registers the <var>TBitBtn</var> and <var>TSpeedButton</var> components on the <b>Additional</b> tab in the Lazarus IDE component palette.
<p>
Register is the procedure used to register components for us in the Lazarus IDE. The following components are added to the Lazarus IDE:
</p>
<p>
<b>Additional</b> Tab
</p>
<ul>
<li>TBitBtn</li>
<li>TSpeedButton</li>
</ul>
</descr>
</element>
</module>
<!-- Buttons -->
</package>
</fpdoc-descriptions>

283
docs/xml/lcl/comboex.xml
View File

@ -226,10 +226,12 @@
</element>
<element name="TCheckItemChange">
<short>Specifies an event handler signalled when a checkbox in TCustomCheckCombo is changed</short>
<short>
Specifies an event handler signalled when a check box in TCustomCheckCombo is changed
</short>
<descr>
<p>
<var>TCheckItemChange</var> is an object procedure which specifies an event handler signalled when a checkbox in <var>TCustomCheckCombo</var> is changed. TCheckItemChange is the type used to implement the <var>OnItemChange</var> property in <var>TCustomCheckCombo</var> and <var>TCheckComboBox</var>.
<var>TCheckItemChange</var> is an object procedure which specifies an event handler signalled when a check box in <var>TCustomCheckCombo</var> is changed. TCheckItemChange is the type used to implement the <var>OnItemChange</var> property in <var>TCustomCheckCombo</var> and <var>TCheckComboBox</var>.
</p>
</descr>
<seealso>
@ -243,7 +245,7 @@
<short>Object for the event notification</short>
</element>
<element name="TCheckItemChange.AIndex">
<short>Ordinal position for the changed checkbox</short>
<short>Ordinal position for the changed check box</short>
</element>
<element name="TListCompareEvent" link="#lcl.comboex.TListItemsCompare">
@ -512,7 +514,7 @@
The default value for the property is <b>-1</b>, and indicates that an overlay image index has not been explicitly assigned for the item. The overlay image is not drawn when the property contains <b>-1</b>.
</p>
<remark>
Please note: Changing the value for the property does not call the <var>Changed</var> method in the current LCL version. This may be different than the behavior from a previous LCL version.
Changing the value for the property does not call the <var>Changed</var> method in the current LCL version. This may be different than the behavior from a previous LCL version.
</remark>
</descr>
<seealso>
@ -632,44 +634,85 @@
</element>
<element name="TListControlItems.DoCustomSort">
<short/>
<descr/>
<seealso/>
<short>Performs the comparison for the CustomSort method</short>
<descr>
<p>
<var>DoCustomSort</var> is an <var>Integer</var> function which performs the comparison for the CustomSort method. Arguments passed to the method contain the <var>TListControlItem</var> instances compared in the method.
</p>
<p>
DoCustomSort calls the <var>TListItemsCompare</var> routine passed as an argument to the <var>CustomSort</var> method.
</p>
<p>
The return value contains the relative sort order for the items compared in the method. For example:
</p>
<dl>
<dt>&lt;0</dt>
<dd>Item1 comes before Item2 using the custom sort.</dd>
<dt>0</dt>
<dd>Item1 and Item2 have the same value in the custom sort.</dd>
<dt>&gt;0</dt>
<dd>Item1 comes after Item2 in the custom sort.</dd>
</dl>
</descr>
<seealso>
<link id="TListControlItems.CustomSort"/>
<link id="TListControlItems.Sort"/>
<link id="TListControlItems.SortType"/>
<link id="TListControlItems.OnCompare"/>
<link id="TListControlItems.CompareItems"/>
<link id="TListItemsCompare"/>
</seealso>
</element>
<element name="TListControlItems.DoCustomSort.Result">
<short/>
<short>Relative sort order for the compared items</short>
</element>
<element name="TListControlItems.DoCustomSort.AItem1">
<short/>
<short>First TListControlItem for the comparison</short>
</element>
<element name="TListControlItems.DoCustomSort.AItem2">
<short/>
<short>Second TListControlItem for the comparison</short>
</element>
<element name="TListControlItems.DoOnCompare">
<short/>
<descr/>
<seealso/>
<short>Signals the OnCompare event handler to compare items in the collection</short>
<descr>
<p>
<var>DoOnCompare</var> is called from the <var>Sort</var> method when <var>SortType</var> is set to <var>stData</var> or <var>stBoth</var>.
</p>
</descr>
<seealso>
<link id="TListControlItems.Sort"/>
<link id="TListControlItems.SortType"/>
<link id="TListControlItems.OnCompare"/>
<link id="TListControlItems.CompareItems"/>
<link id="TListControlItems.CustomSort"/>
<link id="TListItemsCompare"/>
</seealso>
</element>
<element name="TListControlItems.DoOnCompare.Result">
<short/>
<short>Relative sort order for the compared items</short>
</element>
<element name="TListControlItems.DoOnCompare.AItem1">
<short/>
<short>First TListControlItem for the comparison</short>
</element>
<element name="TListControlItems.DoOnCompare.AItem2">
<short/>
<short>Second TListControlItem for the comparison</short>
</element>
<element name="TListControlItems.Update" link="#rtl.classes.TCollection.Update">
<short/>
<descr/>
<element name="TListControlItems.Update">
<short>Performs a notifcation when an item in the collection has been changed</short>
<descr>
<p>
<var>Update</var> is an overridden method in <var>TListControlItems</var> used to send a notification to observers when the value in <var>AItem</var> has been changed. Update calls the inherited method in <var>TCollection</var>.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TCollection.Update">TCollection.Update</link>
<link id="#rtl.classes.TCollection">TCollection</link>
<link id="#rtl.classes.TPersistent.FPONotifyObservers">TPersistent.FPONotifyObservers</link>
</seealso>
</element>
<element name="TListControlItems.Update.AItem">
<short>Collection item updated in the method</short>
<short>Collection item for the update notification</short>
</element>
<element name="TListControlItems.Add">
@ -1071,7 +1114,7 @@
<seealso/>
</element>
<element name="TCustomComboBoxEx.CMBiDiModeChanged.Message">
<short/>
<short>Message handled in the method</short>
</element>
<element name="TCustomComboBoxEx.DrawItem">
@ -1105,7 +1148,7 @@
DrawItem configures the Canvas to use the brush style and font color needed for the value in State. Text drawing flags are derived for the item, and the text is rendered by calling the <var>DrawText</var> method.
</p>
<remark>
Please note: DrawItem does <b>NOT</b> call the inherited method in <var>TCustomComboBox</var> or trigger its <var>OnDrawItem</var> event handler. The item is rendered entirely in this method.
DrawItem does <b>NOT</b> call the inherited method in <var>TCustomComboBox</var> or trigger its <var>OnDrawItem</var> event handler. The item is rendered entirely in this method.
</remark>
</descr>
<seealso/>
@ -1120,7 +1163,7 @@
<short>State used to draw the item in the control</short>
</element>
<element name="TCustomComboBoxEx.FontChanged" link="#lcl.controls.TWinControl.FontChanged">
<element name="TCustomComboBoxEx.FontChanged">
<short>
Performs actions needed when the font in the control has been changed
</short>
@ -1432,7 +1475,7 @@
</element>
<element name="TCustomComboBoxEx.StyleEx">
<short>Enables feature or behaviors in the extended combo-box control</short>
<short>Enables features or behaviors in the extended combo-box control</short>
<descr>
<p>
<var>StyleEx</var> is a <var>TComboBoxExStyles</var> property used to store <var>TComboBoxExStyleEx</var> values which enable features in the extended combo-box control. Including a value from the enumeration enables the corresponding feature or behavior in the control. See <link id="TComboBoxExStyleEx"/> for more information on the enumeration values and their meanings.
@ -1441,7 +1484,7 @@
The default value for the property is an empty set ([]).
</p>
<remark>
Please note: Values in StyleEx are not used in the current implementation of TCustomComboBoxEx.
Values in StyleEx are not used in the current implementation of TCustomComboBoxEx.
</remark>
</descr>
<seealso/>
@ -1460,7 +1503,7 @@
<element name="TComboBoxEx.ArrowKeysTraverseList" link="#lcl.stdctrls.TCustomComboBox.ArrowKeysTraverseList"/>
<element name="TComboBoxEx.AutoComplete" link="#lcl.stdctrls.TCustomComboBox.AutoComplete"/>
<element name="TComboBoxEx.AutoCompleteOptions" link="#lcl.comboex.TCustomComboBoxEx.AutoCompleteOptions"/>
<element name="TComboBoxEx.AutoCompleteText" link="#lcl.comboex.TCustomComboBoxEx.AutoCompleteText"/>
<element name="TComboBoxEx.AutoCompleteText" link="#lcl.stdctrls.TCustomComboBox.AutoCompleteText"/>
<element name="TComboBoxEx.AutoDropDown" link="#lcl.stdctrls.TCustomComboBox.AutoDropDown"/>
<element name="TComboBoxEx.AutoSelect" link="#lcl.stdctrls.TCustomComboBox.AutoSelect"/>
<element name="TComboBoxEx.AutoSize" link="#lcl.stdctrls.TCustomComboBox.AutoSize"/>
@ -1514,7 +1557,7 @@
<element name="TComboBoxEx.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TComboBoxEx.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TComboBoxEx.ParentBidiMode" link="#lcl.controls.TControl.ParentBidiMode"/>
<element name="TComboBoxEx.ParentColor" link="#lcl.stdctrls.TCustomComboBox.ParentColor"/>
<element name="TComboBoxEx.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TComboBoxEx.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TComboBoxEx.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TComboBoxEx.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
@ -1522,18 +1565,19 @@
<element name="TComboBoxEx.Style" link="#lcl.comboex.TCustomComboBoxEx.Style"/>
<element name="TComboBoxEx.StyleEx" link="#lcl.comboex.TCustomComboBoxEx.StyleEx"/>
<element name="TComboBoxEx.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TComboBoxEx.TabStop" link="#lcl.stdctrls.TCustomComboBox.TabStop"/>
<element name="TComboBoxEx.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TComboBoxEx.Text" link="#lcl.stdctrls.TCustomComboBox.Text"/>
<element name="TComboBoxEx.TextHint" link="#lcl.stdctrls.TCustomComboBox.TextHint"/>
<element name="TComboBoxEx.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TCheckComboItemState">
<short>Represents state and data for a Checkbox item displayed in TCustomCheckCombo</short>
<short>Represents state and data for a check box item displayed in TCustomCheckCombo</short>
<descr>
<p>
<var>TCheckComboItemState</var> is a class used to represent state and data for a Checkbox item displayed in <var>TCustomCheckCombo</var> and <var>TCheckComboBox</var>. Properties are provided to store the checkbox state, the enabled setting for the checkbox control, and arbitrary data used for the checkbox.
<var>TCheckComboItemState</var> is a class used to represent state and data for a check box item displayed in <var>TCustomCheckCombo</var> and <var>TCheckComboBox</var>. Properties are provided to store the check box state, the enabled setting for the control, and arbitrary data.
</p>
<p>
TCheckComboItemState instances are created when the checkboxes are added or assigned in TCustomCheckCombo.
TCheckComboItemState instances are created when the check boxes are added or assigned in TCustomCheckCombo.
</p>
</descr>
<seealso>
@ -1545,10 +1589,10 @@
</element>
<element name="TCheckComboItemState.State">
<short>Represents the current state for a checkbox</short>
<short>Represents the current state for a check box</short>
<descr>
<p>
<var>State</var> is a <var>TCheckBoxState</var> property with the enumeration value which represents the current checked, unchecked, or grayed state for the checkbox.
<var>State</var> is a <var>TCheckBoxState</var> property with the enumeration value which represents the current checked, unchecked, or grayed state for the check box.
</p>
</descr>
<seealso>
@ -1560,10 +1604,10 @@
</element>
<element name="TCheckComboItemState.Enabled">
<short>Indicates the current enabled state for a checkbox</short>
<short>Indicates the current enabled state for a check box</short>
<descr>
<p>
<var>Enabled</var> is a <var>Boolean</var> property which indicates the current enabled state for a checkbox control in <var>TCustomCheckCombo</var>.
<var>Enabled</var> is a <var>Boolean</var> property which indicates the current enabled state for a check box control in <var>TCustomCheckCombo</var>.
</p>
</descr>
<seealso>
@ -1574,7 +1618,7 @@
</element>
<element name="TCheckComboItemState.Data">
<short>Contains arbitrary data associated with a checkbox item</short>
<short>Contains arbitrary data associated with a check box item</short>
<descr/>
<seealso>
<link id="TCustomCheckCombo.Objects"/>
@ -1583,10 +1627,23 @@
<element name="TCustomCheckCombo">
<short>
Implements the base class for a combo-box which displays checkboxes for items in the controls
Base class for a combo-box which displays check boxes for Items in the control
</short>
<descr/>
<seealso/>
<descr>
<p>
<var>TCustomCheckCombo</var> is a <var>TCustomComboBox</var> descendant which defines the base class for a combo-box which displays check boxes for the Items in the control. It behaves like an ordinary combo-box with a drop-down using a customizable number of visible rows.
</p>
<p>
TCustomCheckCombo provides additional properties, methods, and events which allow the checked state for values in Items to be specified as either a <var>Boolean</var> or a <var>TCheckBoxState</var> value. An <var>OnItemChange</var> event handler is added to perform custom actions when the <var>Checked</var> value for an item is changed. Convenience methods are included which allow check boxes to be added or deleted, or toggle their value.
</p>
<p>
TCustomCheckCombo is the ancestor for the <var>TCheckComboBox</var> control.
</p>
</descr>
<seealso>
<link id="TCheckComboBox"/>
<link id="#lcl.stdctrls.TCustomComboBox">TCustomComboBox</link>
</seealso>
</element>
<element name="TCustomCheckCombo.FAllowGrayed"/>
@ -1790,7 +1847,7 @@
<element name="TCustomCheckCombo.FRejectToggleOnSelect">
<short>
Internal member used to track whether the current checkbox selection can toggle its value; i. e. whether the drop down is visible
Internal member used to track whether the current check box selection can toggle its value; i. e. whether the drop down is visible
</short>
<descr/>
<seealso/>
@ -1803,7 +1860,7 @@
</element>
<element name="TCustomCheckCombo.FTextHeight">
<short>Internal member used to track the text height for checkboxes in the control</short>
<short>Internal member used to track the text height for check boxes in the control</short>
<descr/>
<seealso/>
</element>
@ -1814,14 +1871,14 @@
<seealso/>
</element>
<element name="TCustomCheckCombo.CMBiDiModeChanged.Message">
<short/>
<short>Message handled in the method</short>
</element>
<element name="TCustomCheckCombo.ClearItemStates">
<short>Removes all state classes allocated for the checkboxes in the control</short>
<short>Removes all state classes allocated for the check boxes in the control</short>
<descr>
<p>
<var>ClearItemStates</var> is a procedure used to remove all state information classes allocated for the checkboxes in the control. ClearItemStates iterates over the <var>Items</var> defined in the control, and frees the <var>TCheckBoxState</var> class instances stored in its <var>Objects</var> property.
<var>ClearItemStates</var> is a procedure used to remove all state information classes allocated for the check boxes in the control. ClearItemStates iterates over the <var>Items</var> defined in the control, and frees the <var>TCheckBoxState</var> class instances stored in its <var>Objects</var> property.
</p>
<p>
ClearItemStates is used in the implementation of the <var>SetItems</var>, <var>AssignItems</var>, and <var>Clear</var> methods.
@ -1852,37 +1909,37 @@
</element>
<element name="TCustomCheckCombo.DrawItem">
<short>Draws a checkbox item defined in the combo-box control</short>
<short>Draws a check box item defined in the combo-box control</short>
<descr>
<p>
<var>DrawItem</var> is an overridden procedure used to draw a checkbox defined in the Items for the control.
<var>DrawItem</var> is an overridden procedure used to draw a check box defined in the Items for the control.
</p>
<p>
<var>Index</var> contains the ordinal position for the <var>TComboExItem</var> instance in <var>ItemsEx</var> that is drawn in the method.
</p>
<p>
<var>ARect</var> is the rectangle with the coordinates for the checkbox item drawn in the method. The values in ARect are set in the calling procedure (LMDrawListItem in TCustomComboBox).
<var>ARect</var> is the rectangle with the coordinates for the check box item drawn in the method. The values in ARect are set in the calling procedure (LMDrawListItem in TCustomComboBox).
</p>
<p>
<var>State</var> contains the owner draw state used to render the checkbox item, and determines the window and font colors for the checkbox.
<var>State</var> contains the owner draw state used to render the check box item, and determines the window and font colors for the check box.
</p>
<p>
DrawItem uses <var>ThemeServices</var> to get theme element details applied to checkbox items in the combo-box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the check box.
DrawItem uses <var>ThemeServices</var> to get theme element details applied to check box items in the combo-box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the check box.
</p>
<p>
DrawItem configures the Canvas to use the brush style and font color needed for the value in State. Text drawing flags are derived for the item, and the text is rendered by calling the <var>DrawText</var> method.
</p>
<remark>
Please note: DrawItem does <b>NOT</b> call the inherited method in <var>TCustomComboBox</var> or trigger its <var>OnDrawItem</var> event handler. The item is rendered entirely in this method.
DrawItem does <b>NOT</b> call the inherited method in <var>TCustomComboBox</var> or trigger its <var>OnDrawItem</var> event handler. The item is rendered entirely in this method.
</remark>
</descr>
<seealso/>
</element>
<element name="TCustomCheckCombo.DrawItem.Index">
<short>Ordinal position for the checkbox drawn in the method</short>
<short>Ordinal position for the check box drawn in the method</short>
</element>
<element name="TCustomCheckCombo.DrawItem.ARect">
<short>Rectangle with the coordinates for the checkbox drawn in the method</short>
<short>Rectangle with the coordinates for the check box drawn in the method</short>
</element>
<element name="TCustomCheckCombo.DrawItem.State">
<short>Owner draw state for the check box</short>
@ -1907,7 +1964,7 @@
<short>Performs actions needed when the font for the control has been changed</short>
<descr>
<p>
<var>FontChanged</var> is an overridden method in <var>TCustomCheckCombo</var>. It sets the internal <var>FNeedMeasure</var> flag to recalculate the text height for checkbox <var>Items</var> displayed in the control, and calls the inherited method.
<var>FontChanged</var> is an overridden method in <var>TCustomCheckCombo</var>. It sets the internal <var>FNeedMeasure</var> flag to recalculate the text height for check box <var>Items</var> displayed in the control, and calls the inherited method.
</p>
</descr>
<seealso>
@ -1923,7 +1980,7 @@
<short>Initializes the window handle for the control</short>
<descr>
<p>
<var>InitializeWnd</var> is an overridden method used to Initializes the window handle for the control. InitializeWnd ensures that the item states for checkboxes defined in <var>Items</var> is initialized by calling the <var>InitItemStates</var> method. InitializeWnd call the inherited method, and sets the internal <var>FRightToLeft</var> flag used to track the BiDi mode for the control.
<var>InitializeWnd</var> is an overridden method used to Initializes the window handle for the control. InitializeWnd ensures that the item states for check boxes defined in <var>Items</var> is initialized by calling the <var>InitItemStates</var> method. InitializeWnd call the inherited method, and sets the internal <var>FRightToLeft</var> flag used to track the BiDi mode for the control.
</p>
</descr>
<seealso>
@ -1936,10 +1993,10 @@
</element>
<element name="TCustomCheckCombo.InitItemStates">
<short>Initializes checkbox state information for items in the control</short>
<short>Initializes check box state information for items in the control</short>
<descr>
<p>
<var>InitItemStates</var> is used to initialize state information for the Items defined in the checkbox control. InitItemStates iterates over the values in <var>Items</var>, and creates a <var>TCheckComboItemState</var> instance with the enabled, checked state, and state data for each of the items.
<var>InitItemStates</var> is used to initialize state information for the Items defined in the check box control. InitItemStates iterates over the values in <var>Items</var>, and creates a <var>TCheckComboItemState</var> instance with the enabled, checked state, and state data for each of the items.
</p>
<p>
The TCheckComboItemState instance is stored in the indexed <var>Objects</var> property. Existing values in Objects are not modified. An <var>Exception</var> is raised if an existing value not derived from TCheckComboItemState is found in Objects.
@ -1958,17 +2015,17 @@
</element>
<element name="TCustomCheckCombo.CheckItemStates">
<short>Ensures that checkbox item state classes have been allocated for items in the control</short>
<short>Ensures that check box item state classes have been allocated for items in the control</short>
<descr>
<p>
<var>CheckItemStates</var> is a procedure used to ensure that <var>TCheckComboItemState</var> class instances exist for the <var>Items</var> defined in the checkbox combo control. CheckItemStates iterates over the values in Items to determine if its Objects property contains a valid TCheckComboItemState instance. An Exception is raised when the object is not derived from TCheckComboItemState.
<var>CheckItemStates</var> is a procedure used to ensure that <var>TCheckComboItemState</var> class instances exist for the <var>Items</var> defined in the control. CheckItemStates iterates over the values in Items to determine if its Objects property contains a valid TCheckComboItemState instance. An Exception is raised when the object is not derived from TCheckComboItemState.
</p>
<p>
CheckItemStates is used in the implementation of the <var>InitializeWnd</var> and <var>AsyncCheckItemStates</var> methods.
</p>
</descr>
<errors>
Raises an Exception when a checkbox in Items does not have a valid TCheckComboItemState object.
Raises an Exception when a check box in Items does not have a valid TCheckComboItemState object.
</errors>
<seealso>
<link id="#lcl.stdctrls.TCustomComboBox.Items">TCustomComboBox.Items</link>
@ -1996,7 +2053,7 @@
<short>Handles key down events for the control</short>
<descr>
<p>
<var>KeyDown</var> is the overridden method used to handle key down events for the control. KeyDown ensures that Return (<var>VK_RETURN</var>) and Space (<var>VK_SPACE</var>) are applied to the control. Return causes the value for an enabled item to be toggled when highlighted. Space also toggles the value in an enabled checkbox, and makes the item selected before hiding the drop down for the combo-box.
<var>KeyDown</var> is the overridden method used to handle key down events for the control. KeyDown ensures that Return (<var>VK_RETURN</var>) and Space (<var>VK_SPACE</var>) are applied to the control. Return causes the value for an enabled item to be toggled when highlighted. Space also toggles the value in an enabled check box, and makes the item selected before hiding the drop down for the combo-box.
</p>
<p>
KeyDown calls the inherited method.
@ -2019,7 +2076,7 @@
</short>
<descr>
<p>
<var>Loaded</var> is an overridden method used to perform actions needed when the component has finished loading from the LCL streaming mechanism. Loaded calls the inherited method, and calls <var>InitItemStates</var> to allocate <var>TCheckComboItemState</var> instances (when needed) for the checkbox Items defined in the control.
<var>Loaded</var> is an overridden method used to perform actions needed when the component has finished loading from the LCL streaming mechanism. Loaded calls the inherited method, and calls <var>InitItemStates</var> to allocate <var>TCheckComboItemState</var> instances (when needed) for the check box Items defined in the control.
</p>
</descr>
<seealso>
@ -2030,16 +2087,20 @@
</element>
<element name="TCustomCheckCombo.MouseLeave" link="#lcl.controls.TControl.MouseLeave">
<short>Deactivates tracking the highlighted checkbox when the mouse leaves the control</short>
<short>
Deactivates tracking the highlighted check box when the mouse leaves the control
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomCheckCombo.MouseMove" link="#lcl.controls.TControl.MouseMove">
<short>Tracks changes to the mouse positon for the highlighted checkbox in the control</short>
<short>
Tracks changes to the mouse positon for the highlighted check box in the control
</short>
<descr>
<p>
<var>MouseMove</var> is overridden in <var>TCustomCheckCombo</var> to track the X and Y coordinates for the highlighted checkbox item, and to refresh the control when needed. MouseMove calls the inherited method.
<var>MouseMove</var> is overridden in <var>TCustomCheckCombo</var> to track the X and Y coordinates for the highlighted check box item, and to refresh the control when needed. MouseMove calls the inherited method.
</p>
</descr>
<seealso>
@ -2084,10 +2145,10 @@
For the Windows platform, the value for the selection cannot be toggled if the combo-box is already in a dropped-down state (when the <var>DropDown</var> method has been called).
</p>
<p>
Select calls the <var>Toggle</var> method using the value in <var>ItemIndex</var> as the affected checkbox item. The internal flag used to track drop down state is reset prior to exiting from the method. Toggle is not called when ItemIndex contains a negative value, or when the item at the position in ItemIndex is not enabled.
Select calls the <var>Toggle</var> method using the value in <var>ItemIndex</var> as the affected check box item. The internal flag used to track drop down state is reset prior to exiting from the method. Toggle is not called when ItemIndex contains a negative value, or when the item at the position in ItemIndex is not enabled.
</p>
<p>
Alternatively, you can use the <var>Checked</var> property to assign an explicit <var>Boolean</var> value for the checkbox in ItemIndex.
Alternatively, you can use the <var>Checked</var> property to assign an explicit <var>Boolean</var> value for the check box in ItemIndex.
</p>
<p>
Select is called from the <var>KeyDown</var> event handler to apply a <b>Space</b> key which occurs in the control.
@ -2141,23 +2202,23 @@
</element>
<element name="TCustomCheckCombo.AddItem" link ="#Lcl.StdCtrls.TCustomComboBox.AddItem">
<short>Adds a checkbox with the specified settings to the Items property</short>
<short>Adds a check box with the specified settings to the Items property</short>
<descr>
<p>
<var>AddItem</var> is a reintroduced procedure used to add a checkbox with the specified settings to the <var>Items</var> property. AddItem creates a TCheckComboItemState instance which stores the values specified in the <var>AItem</var>, <var>AState</var>, and <var>AEnabled</var> parameters. AddItem calls the inherited method to allocate a new item for the control with the associated item state object.
<var>AddItem</var> is a reintroduced procedure used to add a check box with the specified settings to the <var>Items</var> property. AddItem creates a TCheckComboItemState instance which stores the values specified in the <var>AItem</var>, <var>AState</var>, and <var>AEnabled</var> parameters. AddItem calls the inherited method to allocate a new item for the control with the associated item state object.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomCheckCombo.AddItem.AItem">
<short>Caption for the new checkbox item</short>
<short>Caption for the new check box item</short>
</element>
<element name="TCustomCheckCombo.AddItem.AState">
<short>Checkbox State for the new checkbox item</short>
<short>Check box State for the new item</short>
</element>
<element name="TCustomCheckCombo.AddItem.AEnabled">
<short>Enabled state for the new checkbox item</short>
<short>Enabled state for the new check box item</short>
</element>
<element name="TCustomCheckCombo.AssignItems">
@ -2167,7 +2228,7 @@
<var>AssignItems</var> calls <var>ClearItemStates</var> to reset the state flags for the existing Items. The <var>Assign</var> method in <var>Items</var> is called to store the values in <var>AItems</var>. The <var>InitItemStates</var> method is called to initialize the Objects properties in Items with <var>TCheckComboItemState</var> instances for each of the check boxes.
</p>
<remark>
Please note: InitItemStates can raise an exception if any of the Objects in AItems contains a class not derived from TCheckComboItemState.
InitItemStates can raise an exception if any of the Objects in AItems contains a class not derived from TCheckComboItemState.
</remark>
</descr>
<seealso>
@ -2186,7 +2247,7 @@
<short>Removes the values stored in the Items property</short>
<descr>
<p>
<var>Clear</var> is an overridden procedure in <var>TCustomCheckCombo</var> used to remove checkbox item state information. Clear calls <var>ClearItemStates</var> to free <var>TCheckComboItemState</var> classes instances stored in the <var>Objects</var> property in <var>Items</var>. Clear calls the inherited method prior to exit to remove its contents.
<var>Clear</var> is an overridden procedure in <var>TCustomCheckCombo</var> used to remove check box item state information. Clear calls <var>ClearItemStates</var> to free <var>TCheckComboItemState</var> classes instances stored in the <var>Objects</var> property in <var>Items</var>. Clear calls the inherited method prior to exit to remove its contents.
</p>
</descr>
<seealso>
@ -2198,7 +2259,7 @@
</element>
<element name="TCustomCheckCombo.DeleteItem">
<short>Deletes the checkbox at the specified position</short>
<short>Deletes the check box at the specified position</short>
<descr>
<p>
Ensures that an object instance stored in <var>Objects</var> is freed before removing the item.
@ -2215,19 +2276,19 @@
</element>
<element name="TCustomCheckCombo.CheckAll">
<short>Sets the state for all checkboxes defined in the control meeting the specified criteria</short>
<short>Sets the state for all check boxes defined in the control meeting the specified criteria</short>
<descr>
<p>
<var>CheckAll</var> is a procedure used to set the checked state for all checkboxes defined in the <var>Items</var> for the control. <var>AState</var> contains the state applied to the checkboxes defined in the control.
<var>CheckAll</var> is a procedure used to set the checked state for all check boxes defined in the <var>Items</var> for the control. <var>AState</var> contains the state applied to the check boxes defined in the control.
</p>
<p>
<var>AAllowGrayed</var> indicates whether checkboxes with an indeterminate ("grayed") state can be updated in the method. <var>AAllowDisabled</var> indicates whether checkboxes which are not enabled can be updated in the method.
<var>AAllowGrayed</var> indicates whether check boxes with an indeterminate ("grayed") state can be updated in the method. <var>AAllowDisabled</var> indicates whether check boxes which are not enabled can be updated in the method.
</p>
<p>
CheckAll iterates over the <var>Items</var> defined for the control, and when allowed using the specified arguments, sets the value in the <var>State</var> property to the value in <var>AState</var>.
</p>
<p>
CheckAll is a convenience method; the same result can be achieved by setting the value in the <var>State</var> or <var>Checked</var> properties for an individual checkbox at a specified position.
CheckAll is a convenience method; the same result can be achieved by setting the value in the <var>State</var> or <var>Checked</var> properties for an individual check box at a specified position.
</p>
</descr>
<seealso>
@ -2236,17 +2297,17 @@
</seealso>
</element>
<element name="TCustomCheckCombo.CheckAll.AState">
<short>Checked state for the matching checkboxes</short>
<short>Checked state for the matching check boxes</short>
</element>
<element name="TCustomCheckCombo.CheckAll.AAllowGrayed">
<short>Indicates if grayed checkboxes can be updated in the method</short>
<short>Indicates if grayed check boxes can be updated in the method</short>
</element>
<element name="TCustomCheckCombo.CheckAll.AAllowDisabled">
<short>Indicates if disabled checkboxes can be updated in the method</short>
<short>Indicates if disabled check boxes can be updated in the method</short>
</element>
<element name="TCustomCheckCombo.Toggle">
<short>Toggles the checked state for the checkbox at the specified position</short>
<short>Toggles the checked state for the check box at the specified position</short>
<descr/>
<seealso/>
<notes>
@ -2254,27 +2315,27 @@
</notes>
</element>
<element name="TCustomCheckCombo.Toggle.AIndex">
<short>Ordinal position for the checkbox affected in the method</short>
<short>Ordinal position for the check box affected in the method</short>
</element>
<element name="TCustomCheckCombo.AllowGrayed">
<short>Indicates if checkboxes can be drawn in the indeterminate state</short>
<short>Indicates if check boxes can be drawn in the indeterminate state</short>
<descr>
<p>
<var>AllowGrayed</var> is a <var>Boolean</var> property which indicates if checkboxes can be displayed in the "grayed" or indeterminate state. The default value for the property is <b>False</b>.
<var>AllowGrayed</var> is a <var>Boolean</var> property which indicates if check boxes can be displayed in the "grayed" or indeterminate state. The default value for the property is <b>False</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomCheckCombo.Count">
<short>Reflects the number of checkboxes defined for the control</short>
<short>Reflects the number of check boxes defined for the control</short>
<descr>
<p>
<var>Count</var> is a read-only <var>Integer</var> property which reflects the number of checkboxes defined for the control. The value for the property is retrieved from the corresponding property in <var>Items</var>.
<var>Count</var> is a read-only <var>Integer</var> property which reflects the number of check boxes defined for the control. The value for the property is retrieved from the corresponding property in <var>Items</var>.
</p>
<p>
Use the <var>AddItem</var> method to add a new checkbox to the control. Use the <var>DeleteItem</var> method to remove a specific checkbox defined in <var>Items</var>. Use <var>Clear</var> to remove all checkboxes defined for the control.
Use the <var>AddItem</var> method to add a new check box to the control. Use the <var>DeleteItem</var> method to remove a specific check box defined in <var>Items</var>. Use <var>Clear</var> to remove all check boxes defined for the control.
</p>
</descr>
<seealso>
@ -2287,10 +2348,10 @@
</element>
<element name="TCustomCheckCombo.Checked">
<short>Provides indexed access to the Boolean value for a checkbox defined in Items</short>
<short>Provides indexed access to the Boolean value for a check box defined in Items</short>
<descr>
<p>
<var>Checked</var> is an indexed <var>Boolean</var> property which provides access to the checked state for a checkbox item defined in the control. <var>AIndex</var> specifies the ordinal position in Items for the checkbox. Checked uses the value from the <var>TCheckComboItemState</var> object stored in the <var>Items</var> property. <b>True</b> indicates that TCheckComboItemState.Checked contains the value <var>cbChecked</var>. <b>False</b> indicates that it contains the value <var>cbUnchecked</var>.
<var>Checked</var> is an indexed <var>Boolean</var> property which provides access to the checked state for a check box item defined in the control. <var>AIndex</var> specifies the ordinal position in Items for the check box. Checked uses the value from the <var>TCheckComboItemState</var> object stored in the <var>Items</var> property. <b>True</b> indicates that TCheckComboItemState.Checked contains the value <var>cbChecked</var>. <b>False</b> indicates that it contains the value <var>cbUnchecked</var>.
</p>
<p>
Changing the value for the property causes the <var>OnItemChange</var> event handler to be signalled, and the <var>Invalidate</var> method is called when <var>AIndex</var> is also the selected <var>ItemIndex</var> for the control.
@ -2300,11 +2361,11 @@
</seealso>
</element>
<element name="TCustomCheckCombo.Checked.AIndex">
<short>Ordinal position for the requested checkbox value</short>
<short>Ordinal position for the requested check box value</short>
</element>
<element name="TCustomCheckCombo.ItemEnabled">
<short>Provides indexed access to the Boolean enabled value for a checkbox defined in Items</short>
<short>Provides indexed access to the Boolean enabled value for a check box defined in Items</short>
<descr/>
<seealso>
<link id="TCustomCheckCombo.State"/>
@ -2315,14 +2376,14 @@
</seealso>
</element>
<element name="TCustomCheckCombo.ItemEnabled.AIndex">
<short>Ordinal position for the requested checkbox enabled value</short>
<short>Ordinal position for the requested check box enabled value</short>
</element>
<element name="TCustomCheckCombo.Objects">
<short>Provides indexed access to the Data for a checkbox defined in Items</short>
<short>Provides indexed access to the Data for a check box defined in Items</short>
<descr>
<p>
<var>Objects</var> is an indexed <var>TObject</var> property which provides access to the Data for a checkbox defined in <var>Items</var>. AIndex specifies the ordinal position in Items for the checkbox. Objects return the value from the TCheckComboItemState object stored in the Items property. The object instance is the property value that represents the content stored in the TCheckComboItemState.Data property.
<var>Objects</var> is an indexed <var>TObject</var> property which provides access to the Data for a check box defined in <var>Items</var>. AIndex specifies the ordinal position in Items for the check box. Objects return the value from the TCheckComboItemState object stored in the Items property. The object instance is the property value that represents the content stored in the TCheckComboItemState.Data property.
</p>
</descr>
<seealso>
@ -2330,14 +2391,14 @@
</seealso>
</element>
<element name="TCustomCheckCombo.Objects.AIndex">
<short>Ordinal position for the requested checkbox item state</short>
<short>Ordinal position for the requested check box item state</short>
</element>
<element name="TCustomCheckCombo.State">
<short>Provides indexed access to the checked State for a checkbox defined in Items</short>
<short>Provides indexed access to the checked State for a check box defined in Items</short>
<descr>
<p>
<var>State</var> is an indexed <var>TCheckBoxState</var> property which provides access to the checked State for a checkbox defined in Items. <var>AIndex</var> specifies the ordinal position in Items for the checkbox. State returns the <var>TCheckBoxState</var> value in <var>TCheckComboItemState.State</var> for the associated object instance.
<var>State</var> is an indexed <var>TCheckBoxState</var> property which provides access to the checked State for a check box defined in Items. <var>AIndex</var> specifies the ordinal position in Items for the check box. State returns the <var>TCheckBoxState</var> value in <var>TCheckComboItemState.State</var> for the associated object instance.
</p>
<p>
Changing the value for the property causes the <var>OnItemChange</var> event handler to be signalled. The <var>Invalidate</var> method is also called when <var>AIndex</var> is the current value in the <var>ItemIndex</var> property.
@ -2352,14 +2413,14 @@
</seealso>
</element>
<element name="TCustomCheckCombo.State.AIndex">
<short>Ordinal position for the checkbox state requested</short>
<short>Ordinal position for the check box state requested</short>
</element>
<element name="TCustomCheckCombo.OnItemChange">
<short>Event handler signalled when the state for a checkbox in the control is changed</short>
<short>Event handler signalled when the state for a check box in the control is changed</short>
<descr>
<p>
<var>OnItemChange</var> is a <var>TCheckItemChange</var> property with the event handler signalled when a value in the <var>Checked</var> or <var>State</var> properties is changed. Arguments passed to the event handler identify the object for the event notification, and the ordinal position in <var>Items</var> for the modified checkbox.
<var>OnItemChange</var> is a <var>TCheckItemChange</var> property with the event handler signalled when a value in the <var>Checked</var> or <var>State</var> properties is changed. Arguments passed to the event handler identify the object for the event notification, and the ordinal position in <var>Items</var> for the modified check box.
</p>
</descr>
<seealso>
@ -2370,9 +2431,21 @@
</element>
<element name="TCheckComboBox" link="#lcl.comboex.TCustomCheckCombo">
<short>Custom combo-box which displays checkboxes for the items in the control</short>
<descr/>
<seealso/>
<short>Combo-box control which displays check boxes for the items in the control</short>
<descr>
<p>
<var>TCheckComboBox</var> is a <var>TCustomCheckCombo</var> descendant which implements a combo-box which displays check boxes for the Items in the control. It behaves like an ordinary combo-box with a drop-down using a customizable number of visible rows.
</p>
<p>
TCheckComboBox provides additional properties, methods, and events which allow the checked state for values in Items to be specified as either a <var>Boolean</var> or a <var>TCheckBoxState</var> value. An <var>OnItemChange</var> event handler is added to perform custom actions when the <var>Checked</var> value for an item is changed. Convenience methods are included which allow check boxes to be added or deleted, or toggle their value.
</p>
<p>
TCheckComboBox sets the visibility for property defined in ancestor classes.
</p>
</descr>
<seealso>
<link id="TCustomCheckComboBox"/>
</seealso>
</element>
<element name="TCheckComboBox.Align" link="#lcl.controls.TControl.Align"/>

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

@ -120,7 +120,7 @@
<short>Represents the style used for a panel on a status bar</short>
<descr>
<p>
<var>TStatusPanelStyle</var> is an enumerated type representing the style used for a panel on a status bar. TStatusPanelStyle is the type used to implement the <var>Style</var> property in <var>TStatusPanel</var>, and used in widget set classes which initialize or update a status bar panel.
<var>TStatusPanelStyle</var> is an enumerated type representing the style used for a panel on a status bar. TStatusPanelStyle is the type used to implement the <var>Style</var> property in <var>TStatusPanel</var>, and used in widgetset classes which initialize or update a status bar panel.
</p>
</descr>
<seealso>
@ -272,8 +272,8 @@
</element>
<element name="TStatusPanel.FIntfFlag">
<short>Field used by Widget set classes. Do not use it in the LCL.</short>
<descr>Field used by Widget set classes. Do not use it in the LCL.</descr>
<short>Field used by Widgetset classes. Do not use it in the LCL.</short>
<descr>Field used by Widgetset classes. Do not use it in the LCL.</descr>
<seealso/>
</element>
@ -591,7 +591,7 @@
<element name="TStatusBar.SetSimpleText">
<short>Sets the value for the SimpleText property</short>
<descr>
Notifies the widget set class of the value change when a handle has been allocated and SimplePanel is set to True.
Notifies the widgetset class of the value change when a handle has been allocated and SimplePanel is set to True.
</descr>
<seealso>
<link id="TStatusBar.SimpleText"/>
@ -826,7 +826,7 @@
</short>
<descr>
<p>
<var>InvalidatePanel</var> renders the panel with specified index non-valid. Calls <var>UpdateHandleObject</var> to ensure that the widget set class is notified of the change to the specified panel.
<var>InvalidatePanel</var> renders the panel with specified index non-valid. Calls <var>UpdateHandleObject</var> to ensure that the widgetset class is notified of the change to the specified panel.
</p>
<remark>
No actions are performed in the method when the PanelParts argument is an empty set (<b>[]</b>).
@ -993,7 +993,7 @@
<element name="TStatusBar.UseSystemFont">
<short>Indicates the System font is used for the control</short>
<descr>
This is used to provide VCL-compatibility in widget set classes.
This is used to provide VCL-compatibility in widgetset classes.
</descr>
<seealso/>
</element>
@ -1107,7 +1107,7 @@
<element name="TCustomPage.SetImageIndex">
<short>Sets the value for the ImageIndex property</short>
<descr>
Notifies the widget set class of changes to properties in the custom page.
Notifies the widgetset class of changes to properties in the custom page.
</descr>
<seealso>
<link id="TCustomPage.ImageIndex"/>
@ -1129,7 +1129,7 @@
</element>
<element name="TCustomPage.WSRegisterClass">
<short>Registers the widget set class used for the class instance</short>
<short>Registers the widgetset class used for the class instance</short>
<descr/>
<seealso/>
</element>
@ -2252,7 +2252,7 @@
<element name="TCustomTabControl.DoImageListDestroyResolutionHandle">
<short>
Notifies the widget set class when the handle for the image resolution is freed
Notifies the widgetset class when the handle for the image resolution is freed
</short>
<descr/>
<seealso>
@ -2814,7 +2814,7 @@
<var>ImagesWidth</var> specifies the width used for the <var>Images</var> in the control. ImagesWidth determines the resolution (either selected or resized) for the current display density (PPI).
</p>
<p>
Changing the value in the property causes the <var>DoImageListChange</var> method to be called to select the image resolution, and to notify the widget set class of the change. The <var>UpdateTabProperties</var> method is called to propogate the change to all tabs in the control.
Changing the value in the property causes the <var>DoImageListChange</var> method to be called to select the image resolution, and to notify the widgetset class of the change. The <var>UpdateTabProperties</var> method is called to propogate the change to all tabs in the control.
</p>
</descr>
<seealso>
@ -2963,9 +2963,7 @@
</element>
<element name="TCustomTabControl.TabWidth">
<short>
<var>TabWidth</var> - width of the tabs
</short>
<short>Width of the tabs displayed on the control</short>
<descr/>
<seealso/>
</element>
@ -2980,18 +2978,15 @@
</element>
<element name="TTabSheet">
<short>
<var>TTabSheet</var> - individual page of a <var>TPageControl</var>; a more elaborate version of <var>TPage</var>
</short>
<short>An individual page used in TPageControl</short>
<descr>
<p>
<var>TTabSheet</var> - individual page of a <var>TPageControl</var>; a more elaborate version of <var>TPage</var>.
<var>TTabSheet</var> - individual page of a <var>TPageControl</var>. It is a more elaborate version of <var>TPage</var>, and adds the following features:
</p>
<p>Contains the following features lacked by <var>TPage</var>:</p>
<ul>
<li>Drag/Drop properties</li>
<li>Ability to Enable/Disable the page</li>
<li>Ability to make the Tab visible or not</li>
<li>Ability to make the Tab visible or hidden</li>
</ul>
</descr>
<seealso>
@ -3794,6 +3789,31 @@
<seealso/>
</element>
<element name="TNoteBookStringsTabControl.AdjustXY">
<short>Adjusts the specified coordinates to the ClientOrigin for the parent</short>
<descr>
<p>
The adjustment amount is the difference between the <var>ClientOrigin</var> for the control and the <var>ClientOrigin</var> for the <var>Parent</var> of the control. The offset amounts are then applied to the values <var>X</var> and <var>Y</var>.
</p>
<p>
Called from the <var>DragDrop</var>, <var>DragOver</var>, <var>MouseMove</var>, <var>MouseDown</var>, and <var>MouseUp</var> methods.
</p>
</descr>
<seealso>
<link id="TNoteBookStringsTabControl.DragDrop"/>
<link id="TNoteBookStringsTabControl.DragOver"/>
<link id="TNoteBookStringsTabControl.MouseMove"/>
<link id="TNoteBookStringsTabControl.MouseDown"/>
<link id="TNoteBookStringsTabControl.MouseUp"/>
</seealso>
</element>
<element name="TNoteBookStringsTabControl.AdjustXY.X">
<short>Horizontal coordinate adjusted in the method</short>
</element>
<element name="TNoteBookStringsTabControl.AdjustXY.Y">
<short>Vertical coordinate adjusted in the method</short>
</element>
<element name="TNoteBookStringsTabControl.DoStartDrag">
<short/>
<descr/>
@ -4567,7 +4587,7 @@
<short/>
<descr>
<p>
<var>WSRegisterClass</var> is an overridden class procedure used to register the widget set class used to create new instances of the class. WSRegisterClass calls the inherited method, and calls RegisterPropertyToSkip to omit the <var>OnDrawTab</var> property when the component is loaded at run-time. OnDrawTab was used in an older version of the Lazarus LCL.
<var>WSRegisterClass</var> is an overridden class procedure used to register the widgetset class used to create new instances of the class. WSRegisterClass calls the inherited method, and calls RegisterPropertyToSkip to omit the <var>OnDrawTab</var> property when the component is loaded at run-time. OnDrawTab was used in an older version of the Lazarus LCL.
</p>
</descr>
<seealso/>
@ -6018,7 +6038,7 @@
</element>
<element name="TListItemsFlag">
<short>Widget set flags applied to the TListItems container</short>
<short>Widgetset flags applied to the TListItems container</short>
<descr/>
<seealso/>
</element>
@ -6184,7 +6204,7 @@
<element name="TListItems.WSCreateItems">
<short>
<var>WSCreateItems</var> - instruction to the Widget Set to create Items
<var>WSCreateItems</var> - instruction to the widgetset to create Items
</short>
<descr/>
<seealso/>
@ -8353,7 +8373,7 @@
<var>DoAutoAdjustLayout</var> is an overridden procedure used to adjust the layout for the list view using the specified arguments. DoAutoAdjustLayout calls the inherited method.
</p>
<p>
DoAutoAdjustLayout extends the ancestor method to include support for sizing the columns in the list view using the proportions specified in AXProportion and AYProportion for the display density (DPI). DoAutoAdjustLayout also ensures that the widget set class is initialized for each of the image list sizes represented by the TListViewImageList enumeration.
DoAutoAdjustLayout extends the ancestor method to include support for sizing the columns in the list view using the proportions specified in AXProportion and AYProportion for the display density (DPI). DoAutoAdjustLayout also ensures that the widgetset class is initialized for each of the image list sizes represented by the TListViewImageList enumeration.
</p>
<p>
No actions are performed in the method if AMode does NOT include one of the following values: lapAutoAdjustWithoutHorizontalScrolling or lapAutoAdjustForDPI.
@ -9883,7 +9903,7 @@
<element name="TCustomProgressBar.BarShowText">
<short>
<var>BarShowText</var> - some widget sets allow text to be displayed on the bar to indicate its position (e.g. 32%)
<var>BarShowText</var> - some widgetsets allow text to be displayed on the bar to indicate its position (e.g. 32%)
</short>
<descr/>
<seealso/>
@ -22271,14 +22291,14 @@
<element name="RegisterCustomPage">
<short>
Calls WSRegisterCustomPage to register a custom page using the widget set classes
Calls WSRegisterCustomPage to register a custom page using the widgetset classes
</short>
<descr/>
<seealso/>
</element>
<element name="RegisterCustomTabControl">
<short>Registers TCustomTabControl and its widget set class type when needed</short>
<short>Registers TCustomTabControl and its widgetset class type when needed</short>
<descr/>
<seealso/>
</element>

4029
docs/xml/lcl/dialogs.xml
View File

File diff suppressed because it is too large Load Diff

2
docs/xml/lcl/extdlgs.xml
View File

@ -37,11 +37,11 @@
<element name="Forms"/>
<element name="Calendar"/>
<element name="Buttons"/>
<element name="Masks"/>
<element name="CalcForm"/>
<element name="GraphType"/>
<element name="FileUtil"/>
<element name="LazFileUtils"/>
<element name="Masks"/>
<element name="TPreviewFileControl">
<short>

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

@ -24,11 +24,11 @@
<element name="Classes"/>
<element name="SysUtils"/>
<element name="StdCtrls"/>
<element name="Graphics"/>
<element name="ShellCtrls"/>
<element name="FileUtil"/>
<element name="LazFileUtils"/>
<element name="Masks"/>
<element name="Graphics"/>
<element name="ShellCtrls"/>
<element name="TFileAttr">
<short>Enumerated type with file and directory attributes used in TFileListBox</short>
@ -79,7 +79,7 @@
</element>
<element name="TFileAttr.ftDirectory">
<short>
File is a directory entry.
File attribute for a directory entry.
</short>
</element>
<element name="TFileAttr.ftArchive">
@ -516,7 +516,7 @@
<short>Contains the mask for files selected for the control</short>
<descr>
<p>
<var>Mask</var> should be filled with one or more file masks separated by semi-colons. For example: <b>'*.pdf;*.svg'</b> will show all files with the extensions pdf and svg. The default value for the property is "*" which is the generic mask meaning any file or directory. Do not use the Windows specific mask <b>'*.*'</b> to attempt to show all files, which is the behavior from Delphi. In the LCL version of the control '*.*' will require the file name to have an extension.
<var>Mask</var> should be filled with one or more file masks separated by semi-colons. For example: <b>'*.pdf;*.svg'</b> will show all files with the extensions pdf and svg. The default value for the property is <b>'*'</b> which is the generic mask meaning any file or directory. Do not use the Windows specific mask <b>'*.*'</b> to attempt to show all files, which is the behavior from Delphi. In the LCL version of the control '*.*' will <b>require</b> the file name to have an extension.
</p>
<p>
Allowed wildcards include <b>'*.*'</b> which means zero or more characters, and <b>'?'</b> which means exactly 1 character with any value. Other characters represent themselves with one important detail: The file matching algorithm is <b>not</b> case sensitive. So if you set '*.PDF' in the mask, then 'PostScript.pdf' will also be shown, even on Linux which is a case sensitive file system.

2
docs/xml/lcl/forms.xml
View File

@ -3874,7 +3874,7 @@
<short>The Monitor where the form is shown</short>
<descr>
<p>
<var>Monitor</var> is a read-only <var>TMonitor</var> property wich contains the monitor where the form was displayed. Monitor defaults to the <var>TMonitor</var> instance for the Parent form when it has been assigned.
<var>Monitor</var> is a read-only <var>TMonitor</var> property which contains the monitor where the form was displayed. Monitor defaults to the <var>TMonitor</var> instance for the Parent form when it has been assigned.
</p>
<p>
When the parent form has not been assigned, and a handle exists for the form instance, the widgetset class is notified of the current coordinates for the form. The <var>MonitorFromWindow</var> method in the <var>Screen</var> singleton is called to locate the window closest to the the form (using its handle).

412
docs/xml/lcl/lclmemmanager.xml
View File

@ -1,292 +1,276 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
LCLMemManager
====================================================================
====================================================================
LCLMemManager
====================================================================
-->
<module name="LCLMemManager">
<short/>
<short>Base class for a mempry manager used in the LCL and its interfaces</short>
<descr>
<p>
<file>lclmemmanager.pas</file> contains classes and type used to define the base
class for various memory managers used in the Lazarus Component Library
(<b>LCL</b>) and its interfaces. An own memory manager is somewhat faster and
makes debugging and profiling easier.
</p>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
<p>
Author: Mattias Gaertner
</p>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved references -->
<element name="Classes"/>
<element name="Math"/>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- pointer type Visibility: default -->
<element name="PLCLMemManagerItem">
<short/>
<short>Pointer to a TLCLMemManagerItem type</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- record type Visibility: default -->
<element name="TLCLMemManagerItem">
<short/>
<short>
Represents a memory manager item with a pointer to the next item in the list
</short>
<descr>
</descr>
<seealso>
<link id="PLCLMemManagerItem"/>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TLCLMemManagerItem.Next">
<short/>
<short>Pointer to the next item in the memory manager</short>
<descr>
</descr>
<seealso>
<link id="PLCLMemManagerItem"/>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TLCLMemManager">
<short/>
<short>Template for memory manager implementations</short>
<descr>
<p>
<var>TLCLMemManager</var> is a class which provides a template for memory
manager implementations used in the LCL. It is used as a base class for
specialized memory managers in widgetset classes.
</p>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private -->
<element name="TLCLMemManager.SetMaxFreeRatio">
<short/>
<descr>
</descr>
<errors>
</errors>
<short>Sets the value for the MaximumFreeCountRatio property</short>
<seealso>
<link id="TLCLMemManager.MaximumFreeCountRatio"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLCLMemManager.SetMaxFreeRatio.NewValue">
<short/>
<short>New value for the property</short>
</element>
<!-- procedure Visibility: private -->
<element name="TLCLMemManager.SetMinFree">
<short/>
<descr>
</descr>
<errors>
</errors>
<short>Sets the value for the MinimumFreeCount property</short>
<seealso>
<link id="TLCLMemManager.MinimumFreeCount"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLCLMemManager.SetMinFree.NewValue">
<short/>
<short>New value for the property</short>
</element>
<!-- variable Visibility: protected -->
<element name="TLCLMemManager.FFirstFree">
<short/>
<descr>
</descr>
<seealso>
</seealso>
<short>
Internal member with the pointer the first item in the memory manager
</short>
</element>
<!-- variable Visibility: protected -->
<element name="TLCLMemManager.FFreeCount">
<short/>
<descr>
</descr>
<seealso>
</seealso>
<short>Member used to store the value for the FreeCount property</short>
</element>
<!-- variable Visibility: protected -->
<element name="TLCLMemManager.FCount">
<short/>
<descr>
</descr>
<seealso>
</seealso>
<short>Member used to store the value for the Count property</short>
</element>
<!-- variable Visibility: protected -->
<element name="TLCLMemManager.FMinFree">
<short/>
<descr>
</descr>
<seealso>
</seealso>
<short>Member used to store the value for the MinimumFreeCount property</short>
</element>
<!-- variable Visibility: protected -->
<element name="TLCLMemManager.FMaxFreeRatio">
<short/>
<descr>
</descr>
<seealso>
</seealso>
<short>
Member used to store the value for the MaximumFreeCountRatio property
</short>
</element>
<!-- variable Visibility: protected -->
<element name="TLCLMemManager.FAllocatedCount">
<short/>
<descr>
</descr>
<seealso>
</seealso>
<short>
Member used to store the value for the AllocatedCount property
</short>
</element>
<!-- variable Visibility: protected -->
<element name="TLCLMemManager.FFreedCount">
<short/>
<descr>
</descr>
<seealso>
</seealso>
<short>
Member used to store the value for the FreedCount property
</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLCLMemManager.DisposeItem">
<short/>
<short>
Maintains values in FreeCount and Count when the memory manager item is freed
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLMemManager.FreeCount"/>
<link id="TLCLMemManager.MinimumFreeCount"/>
<link id="TLCLMemManager.MaximumFreeCountRatio"/>
<link id="TLCLMemManager.Count"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLCLMemManager.DisposeItem.AnItem">
<short/>
<short>Pointer to the memory manager item</short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLMemManager.NewItem">
<short/>
<short>
Gets a pointer to a free memory manager item, or creates a new one
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLMemManager.FFirstFree"/>
<link id="TLCLMemManager.FreeCount"/>
<link id="TLCLMemManager.AllocatedCount"/>
<link id="TLCLMemManager.Count"/>
<link id="PLCLMemManagerItem"/>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TLCLMemManager.NewItem.Result">
<short/>
<short>Pointer to the new memory manager item</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLCLMemManager.FreeFirstItem">
<short/>
<short>
Frees the first item in the memory manager and maintains the list
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLMemManager.FFirstFree"/>
<link id="PLCLMemManagerItem"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLCLMemManager.MinimumFreeCount">
<short/>
<short>
Minimum block size that can be freed in the memory manager
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLCLMemManager.MaximumFreeCountRatio">
<short/>
<short>
Threshold which determines if the memory manager marks a block or frees it
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLCLMemManager.Count">
<short/>
<short>
Total number of items in the memory manager list
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLCLMemManager.FreeCount">
<short/>
<short>
Number of items marked as free in the list
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLCLMemManager.AllocatedCount">
<short/>
<short>
Number of items allocated in the memory manager list
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLCLMemManager.FreedCount">
<short/>
<short>
Number of freed memory blocks in the list
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TLCLMemManager.Clear">
<short/>
<short>
Frees all items in the memory manager list
</short>
<descr>
<p>
Called from the destructor for the class instance.
</p>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLMemManager.FreeFirstItem"/>
<link id="TLCLMemManager.FreeCount"/>
<link id="TLCLMemManager.FreedCount"/>
</seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TLCLMemManager.Create">
<short/>
<short>Constructor for the class instance</short>
<descr>
<p>
Calls the inherited constructor on entry, and sets the default values for
properties in the class instance.
</p>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLMemManager.Destroy"/>
</seealso>
</element>
<!-- destructor Visibility: public -->
<element name="TLCLMemManager.Destroy">
<short/>
<short>
Destructor for the class instance
</short>
<descr>
<p>
Calls Clear to remove all items in the memory manager list. Calls the inherited
destructor prior to exit.
</p>
</descr>
<errors>
</errors>
@ -294,23 +278,21 @@
</seealso>
</element>
<!-- procedure type Visibility: default -->
<element name="TLCLEnumItemsMethod">
<short/>
<short>
Defines an object procedure type used to enumerate memory manager items
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLCLEnumItemsMethod.Item">
<short/>
<short>Pointer to a memory manager item enumerated in the procedure</short>
</element>
<!-- object Visibility: default -->
<element name="TLCLNonFreeMemManager">
<short/>
<short>A memory manager for records without freeing</short>
<descr>
</descr>
<errors>
@ -319,7 +301,6 @@
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLCLNonFreeMemManager.FItemSize">
<short/>
<descr>
@ -328,7 +309,6 @@
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLCLNonFreeMemManager.FItems">
<short/>
<descr>
@ -337,7 +317,6 @@
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLCLNonFreeMemManager.FCurItem">
<short/>
<descr>
@ -346,7 +325,6 @@
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLCLNonFreeMemManager.FEndItem">
<short/>
<descr>
@ -355,7 +333,6 @@
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLCLNonFreeMemManager.FCurSize">
<short/>
<descr>
@ -364,7 +341,6 @@
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLCLNonFreeMemManager.FFirstSize">
<short/>
<descr>
@ -373,113 +349,175 @@
</seealso>
</element>
<!-- variable Visibility: public -->
<element name="TLCLNonFreeMemManager.ClearOnCreate">
<short/>
<short>
Public member used to control zero-filling memory allocated for items
</short>
<descr>
Used in the NewItem method.
</descr>
<seealso>
<link id="TLCLNonFreeMemManager.NewItem"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLCLNonFreeMemManager.ItemSize">
<short/>
<short>
Size of the memory allocated for each item in the list
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TLCLNonFreeMemManager.Clear">
<short/>
<short>
Frees memory allocated to items, and frees the list
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TLCLNonFreeMemManager.Create">
<short/>
<short>
Constructor for the class instance
</short>
<descr>
<p>
Sets ItemSize to the value specified in TheItemSize, and sets the size of the
first item to 4 times the ItemSize value.
</p>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLCLNonFreeMemManager.Create.TheItemSize">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TLCLNonFreeMemManager.Destroy">
<short/>
<short>
Destructor for the class instance
</short>
<descr>
<p>
Calls Clear on entry.
Calls the inherited destructor prior to exit.
</p>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLNonFreeMemManager.Create"/>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TLCLNonFreeMemManager.NewItem">
<short/>
<short>Gets a Pointer to a new item in the list</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLNonFreeMemManager.ClearOnCreate"/>
<link id="TLCLNonFreeMemManager.ItemSize"/>
<link id="TLCLNonFreeMemManager.FItems"/>
<link id="TLCLNonFreeMemManager.FCurItem"/>
<link id="TLCLNonFreeMemManager.FEndItem"/>
<link id="TLCLNonFreeMemManager.FCurSize"/>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TLCLNonFreeMemManager.NewItem.Result">
<short/>
<short>Pointer to the item added to the internal list</short>
</element>
<!-- procedure Visibility: public -->
<element name="TLCLNonFreeMemManager.EnumerateItems">
<short/>
<short>
Enumerates items in the list using the specified object procedure
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="TLCLNonFreeMemManager.ItemSize"/>
<link id="TLCLNonFreeMemManager.FItems"/>
<link id="TLCLNonFreeMemManager.FFirstSize"/>
<link id="TLCLEnumItemsMethod"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLCLNonFreeMemManager.EnumerateItems.Method">
<short/>
<short>Object procedure used to enumerate the items in the list</short>
</element>
<element name="TStreamSizeType">
<short>
Alias to the type used for stream sizes
</short>
<descr>
<p>
<var>PtrInt</var> for FPC 2.04.02 or higher.
<var>LongInt</var> for versions prior to FPC 2.04.02.
</p>
</descr>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TExtMemoryStream">
<short/>
<short>
Implements an extended memory stream with a minimum growth factor
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<notes>
<note>
Realloc performs the same action as in TMemoryStream now;
grow by 25% minimum.
</note>
</notes>
</element>
<element name="TExtMemoryStream.Realloc">
<short>
Reallocates memory for the stream using the specified capacity
</short>
<descr>
<p>
<var>Realloc</var> is an overridden method in <var>TExtMemoryStream</var>.
It ensures that the new <var>Capacity</var> is at least 25% larger than the
existing Capacity. Realloc calls the inherited method to re-allocate memory to the
size needed.
</p>
</descr>
<seealso>
<link id="TExtMemoryStream.Capacity"/>
<link id="#rtl.classes.TMemoryStream.Realloc">TMemoryStream.Realloc</link>
</seealso>
</element>
<element name="TExtMemoryStream.Realloc.Result">
<short>Pointer to the newly allocated memory for the stream</short>
</element>
<element name="TExtMemoryStream.Realloc.NewCapacity">
<short>New capacity requested in the method</short>
</element>
<element name="TExtMemoryStream.Capacity">
<short>Size of the allocated memory for the stream</short>
<descr>
<p>
<var>Capacity</var> is a public <var>PtrInt</var> property in TExtMemoryStream
which contains the memory size allocated for the stream. Setting a new value for
the property causes the <var>Realloc</var> method to be called to re-allocate
memory to the requested value.
</p>
</descr>
<seealso>
<link id="TExtMemoryStream.Realloc"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TExtMemoryStream.Capacity">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- LCLMemManager -->
</module>
<!-- LCLMemManager -->
</package>
</fpdoc-descriptions>

146
docs/xml/lcl/lclplatformdef.xml
View File

@ -1,164 +1,170 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
LCLPlatformDef
====================================================================
-->
<module name="LCLPlatformDef">
<short></short>
<short>Contains the non-GUI dependent parts of LCL Platform definition</short>
<descr>
<file>lclplatformdef.pas</file> contains types, constants, variables and
routines used in non-GUI dependent parts of LCL Platform definition.
This file is part of the Lazarus Component Library (<b>LCL</b>).
</descr>
<!-- enumeration type Visibility: default -->
<element name="TLCLPlatform">
<short></short>
<short>Represents the platforms supported in the LCL</short>
<descr>
</descr>
<seealso>
<link id="LCLPlatformDirNames"/>
<link id="TLCLPlatforms"/>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpGtk">
<short></short>
<short>GIMP ToolKit</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpGtk2">
<short></short>
<short>GTK version 2</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpGtk3">
<short></short>
<short>GTK version 3</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpWin32">
<short></short>
<short>Windows API (formerly called Win32 API)</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpWinCE">
<short></short>
<short>Windows CE</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpCarbon">
<short></short>
<short>MacOS Carbon API</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpQT">
<short></short>
<short>QT version 4</short>
</element>
<element name="TLCLPlatform.lpQt5">
<short></short>
<short>QT version 5</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpfpGUI">
<short></short>
<short>FreePascal GUI</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpNoGUI">
<short></short>
<short>No GUI</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpCocoa">
<short></short>
<short>MacOS Cocoa API</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLCLPlatform.lpCustomDrawn">
<short></short>
<short>Custom-drawn</short>
</element>
<element name="TLCLPlatform.lpMUI">
<short></short>
<short>Magic User Interface (MUI) for AmigaOS, AROS</short>
</element>
<!-- set type Visibility: default -->
<element name="TLCLPlatforms">
<short></short>
<short>Set type used to store TLCLPlatform value(s)</short>
<descr>
</descr>
<seealso>
<link id="TLCLPlatform"/>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="DirNameToLCLPlatform">
<short></short>
<short>Gets the platform enumeration value for the specified directory name</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="DirNameToLCLPlatform.Result">
<short></short>
<short>TLCLPlatform enumeration value for the given directory name</short>
</element>
<!-- argument Visibility: default -->
<element name="DirNameToLCLPlatform.ADirName">
<short></short>
<short>DIrectory name to convert to a TLCLPlatform enumertation value</short>
</element>
<!-- function Visibility: default -->
<element name="GetBuildLCLWidgetType">
<short></short>
<short>Gets the value in the BuildLCLWidgetType variable</short>
<descr>
<p>
Used in the <var>lazbuild</var> utility to get the target widgetset using the
platform defines.
</p>
</descr>
<errors>
</errors>
<seealso>
<link id="BuildLCLWidgetType"/>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="GetBuildLCLWidgetType.Result">
<short></short>
<short>TLCLPlatform enumeration value for the platform</short>
</element>
<!-- constant Visibility: default -->
<element name="LCLPlatformDirNames">
<short></short>
<short>Array constant with the directory names for supported LCL platforms</short>
<descr>
<p>
LCLPlatformDirNames is a array of Strings with directory names for the supported
LCL platforms. The directory names are relative to the './lcl/interfaces/' base path.
Values in the array are indexed by TLCLPlatform enumeration values. For example:
</p>
<code>
// var SDir, SName: String;
// SDir contains 'win32'
SDir := LCLPlatformDirNames[lpWin32];
// SName contains 'win32/win64'
SName := LCLPlatformDisplayNames[lpWin32];
</code>
<p>
Use LCLPlatformDisplayNames to get the display name for a given TLCLPlatform
enumeration value.
</p>
</descr>
<seealso>
<link id="LCLPlatformDisplayNames"/>
</seealso>
</element>
<!-- constant Visibility: default -->
<element name="LCLPlatformDisplayNames">
<short></short>
<short>Array constant with the display names for supported LCL platforms</short>
<descr>
<p>
LCLPlatformDisplayNames is a array of Strings with display names for the supported
LCL platforms. Values in the array are indexed by TLCLPlatform enumeration values.
For example:
</p>
<code>
// var SDir, SName: String;
// SDir contains 'win32'
SDir := LCLPlatformDirNames[lpWin32];
// SName contains 'win32/win64'
SName := LCLPlatformDisplayNames[lpWin32];
</code>
<p>
Use LCLPlatformDirNames to get the directory name for a given TLCLPlatform
enumeration value.
</p>
</descr>
<seealso>
<link id="LCLPlatformDirNames"/>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="BuildLCLWidgetType">
<short></short>
<short>Gets the TLCLPlatform enumeration value for the current platform</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- LCLPlatformDef -->
</module>
<!-- LCLPlatformDef -->
</package>
</fpdoc-descriptions>

1793
docs/xml/lcl/lclstrconsts.xml
View File

File diff suppressed because it is too large Load Diff

3218
docs/xml/lcl/lmessages.xml
View File

File diff suppressed because it is too large Load Diff

101
docs/xml/lcl/shellctrls.xml
View File

@ -112,7 +112,6 @@
</descr>
<seealso>
<link id="TCustomShellListView.MaskCaseSensitivity"/>
<link id="TCustomShellTreeView.GetFilesInDir"/>
</seealso>
</element>
<element name="TMaskCaseSensitivity.mcsPlatformDefault">
@ -131,7 +130,10 @@
</short>
<descr>
<p>
<var>TAddItemEvent</var> specifies an event handler signalled when an item is added to a shell control. TAddItemEvent is the type used to implement the <var>OnAddItem</var> event handler in <var>TCustomShellListView</var> and <var>TCustomShellTreeView</var>. Applications must implement an object procedure using the signature for the event to respond to the event notification.
<var>TAddItemEvent</var> specifies an event handler signalled when an item is added to a shell control. TAddItemEvent is the type used to implement the <var>OnAddItem</var> event handler in <var>TCustomShellListView</var> and <var>TCustomShellTreeView</var>.
</p>
<p>
Applications must implement and assign an object procedure using the signature for the event to respond to the notification. The <var>Sender</var> argument must be cast to the correct class type to access properties and method in the control. Set the value in the <var>CanAdd</var> variable parameter to <b>False</b> to prevent the item from being added in the calling procedure.
</p>
</descr>
<seealso>
@ -140,7 +142,7 @@
</seealso>
</element>
<element name="TAddItemEvent.Sender">
<short>Object generating the event notification</short>
<short>Object (control) generating the event notification</short>
</element>
<element name="TAddItemEvent.ABasePath">
<short>Base path for the item added to the shell control</short>
@ -149,7 +151,7 @@
<short>Search record with information for the item added to the shell control</short>
</element>
<element name="TAddItemEvent.CanAdd">
<short>True if the action can continue</short>
<short>True if the item can be added</short>
</element>
<element name="TCustomShellTreeView">
@ -288,10 +290,10 @@
<short>Creates a new tree node for the shell control</short>
<descr>
<p>
<var>CreateNode</var> is an overridden method used to create an new <var>TTreeNode</var> instance for the shell control. CreateNode calls the inherited method to create the class instance for the tree node which used as the return value contains for the method.
<var>CreateNode</var> is an overridden method used to create an new <var>TTreeNode</var> instance for the shell control. CreateNode calls the inherited method to create the class instance used as the return value for the method.
</p>
<p>
CreateNode ensures that the tree node is a <var>TShellTreeNode</var> class instance; it may have been overridden in the <var>OnCreateNodeClass</var> event handler. If the new tree node is not derived from <var>TShellTreeNode</var>, an <var>EShellCtrl</var> exception is raised to indicate the invalid node type.
CreateNode ensures that the tree node is a <var>TShellTreeNode</var> class instance; the class type can be overridden in the <var>OnCreateNodeClass</var> event handler. If the new tree node is not derived from <var>TShellTreeNode</var>, an <var>EShellCtrl</var> exception is raised to indicate the invalid node type.
</p>
</descr>
<errors>
@ -300,6 +302,8 @@
<seealso>
<link id="TShellTreeNode"/>
<link id="EShellCtrl"/>
<link id="#lcl.comctrls.TTreeNodeClass">TTreeNodeClass</link>
<link id="#lcl.comctrls.TCustomTreeView.OnCreateNodeClass">TCustomTreeView.OnCreateNodeClass</link>
</seealso>
</element>
<element name="TCustomShellTreeView.CreateNode.Result">
@ -308,17 +312,20 @@
<element name="TCustomShellTreeView.PopulateTreeNodeWithFiles">
<short>
Adds tree nodes for file system objects found starting at the specified node/path
Adds tree nodes for file system objects found starting at the specified node / path
</short>
<descr>
<p>
<var>PopulateTreeNodeWithFiles</var> is a <var>Boolean</var> function used to fill the <var>Items</var> property with tree nodes for file system objects. <var>ANode</var> contains the initial tree node examined in the method. <var>ANodePath</var> contains the path on the local file system to the tree node in <var>ANode</var>. The return value is <b>True</b> if at least on item was added in the method.
<var>PopulateTreeNodeWithFiles</var> is a <var>Boolean</var> function used to fill the <var>Items</var> property with the file system objects for a given tree node. <var>ANode</var> contains the initial tree node examined in the method. <var>ANodePath</var> contains the path on the local file system to the tree node in <var>ANode</var>. The return value is <b>True</b> if at least one node was added to Items in the method.
</p>
<p>
No actions are performed in the method at design-time; the return value is set to <b>False</b>.
No actions are performed in the method at design-time, and the return value is set to <b>False</b>.
</p>
<p>
<var>PopulateTreeNodeWithFiles</var> calls <var>GetFilesInDir</var> to get a list with <var>TFileItem</var> instances for all file system objects matching the <var>ObjectTypes</var> enabled in the shell control. Each of the <var>TFileItem</var> instances are passed to the <var>DoAddItem</var> method to determine if they can be added to the <var>Items</var> in the control. If the new node is for a directory, its <var>HasChildren</var> property is set to <b>True</b>.
<var>PopulateTreeNodeWithFiles</var> fills a list with <var>TFileItem</var> instances for file system objects matching the <var>ObjectTypes</var> for the shell control. <var>DoAddItem</var> is called for each <var>TFileItem</var> instance, which signals the <var>OnAddItem</var> event handler (when assigned). The event handler is used to selectively filter file system objects added to the <var>Items</var> in the control. If the <var>TAddItemEvent</var> handler sets its <var>CanAdd</var> argument to <b>False</b>, the file system object is not added to Items.
</p>
<p>
On exit, Items contains the <var>TShellTreeNode</var> instances where ANode is the parent. If an entry is a directory which has sub-directories, its <var>HasChildren</var> property is set to <b>True</b>.
</p>
<p>
<var>PopulateTreeNodeWithFiles</var> is used in the implementation of the <var>PopulateWithBaseFiles</var> and <var>CanExpand</var> methods in <var>TCustomShellTreeView</var>.
@ -328,7 +335,6 @@
<link id="TCustomShellTreeView.ObjectTypes"/>
<link id="TCustomShellTreeView.Items"/>
<link id="TCustomShellTreeView.DoAddItem"/>
<link id="TCustomShellTreeView.GetFilesInDir"/>
<link id="TCustomShellTreeView.CanExpand"/>
<link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
<link id="TShellTreeNode"/>
@ -436,6 +442,8 @@
<short>Tree node examined in the method</short>
</element>
<!--
<element name="TCustomShellTreeView.FBuiltinIconSize">
<descr>Defined for the Windows platform only.</descr>
</element>
@ -499,6 +507,7 @@
<element name="TCustomShellTreeView.GetBuiltinIconSize.Result">
<short>TSize instance with the dimensions for the shell icon</short>
</element>
-->
<element name="TCustomShellTreeView.Create">
<short>Constructor for the class instance</short>
@ -570,42 +579,6 @@
</seealso>
</element>
<element name="TCustomShellTreeView.GetFilesInDir">
<short>Finds all files/directories directly inside a directory</short>
<descr>
<p>
Helper routine. Finds all files/directories directly inside a directory. Does not recurse subdirectories found the current directory.
</p>
<p>
AMask may contain multiple file masks separated by the Semicolon (';') character. Do not add a final delimiter after the last mask in the argument.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomShellTreeView.GetFilesInDir.ABaseDir">
<short>The base directory</short>
</element>
<element name="TCustomShellTreeView.GetFilesInDir.AMask">
<short>
A list of masks used to obtain files which match the mask. The masks should be separated by a Semicolon (';') character. For example: "*.exe;*.txt"
</short>
</element>
<element name="TCustomShellTreeView.GetFilesInDir.AObjectTypes">
<short>The kinds of objects to add to the list</short>
</element>
<element name="TCustomShellTreeView.GetFilesInDir.AResult">
<short>
An existing TStringList object used to store the list of files found in the method
</short>
</element>
<element name="TCustomShellTreeView.GetFilesInDir.AFileSortType">
<short>Indicates the sort order for the items in the list</short>
</element>
<element name="TCustomShellTreeView.GetFilesInDir.ACaseSensitivity">
<short>Indicates if file names are compared using case sensitivity in the method</short>
</element>
<element name="TCustomShellTreeView.GetPathFromNode">
<short>
Returns the path (including the file name) from the file system that a particular node represents
@ -663,15 +636,17 @@
<p>
The default value for the property is <b>True</b>. Setting a new value for the property causes the <var>Invalidate</var> method to be called to redraw the control.
</p>
<!--
<p>
UseBuiltinIcons is used in the <var>DrawBuiltinIcon</var> method, and controls whether the internal <var>GetShellIcon</var> routine is used to get the icon drawn in the method. When UseBuiltinIcons is set to <b>False</b>, an icon is not drawn in the DrawBuiltinIcon method.
</p>
<remark>
The <var>DrawBuiltinIcon</var> and <var>GetBuiltinIconSize</var> methods are defined for the Windows platform only; they requires use of the <var>SHGetFileInfoW</var> routine in the FPC <file>ShellApi.pp</file> unit.
</remark>
-->
</descr>
<seealso>
<link id="TCustomShellTreeView.DrawBuiltinIcon"/>
<!-- link id="TCustomShellTreeView.DrawBuiltinIcon"/ -->
</seealso>
</element>
@ -722,8 +697,11 @@
No action other than setting the property value is performed in the method at design-time.
</p>
<p>
The value in <var>FileSortType</var> is used in the <var>PopulateTreeNodeWithFiles</var> method and passed as an argument to <var>GetFilesInDir</var>.
The value in <var>FileSortType</var> is used in the <var>PopulateTreeNodeWithFiles</var> method and passed as an argument to the internal <var>GetFilesInDir</var> procedure.
</p>
<remark>
The value in FileSortType is not used in <var>PopulateWithBaseFiles</var> on Windows platforms. The entries are logical drive letters, and are processed in the order provided by the file system.
</remark>
</descr>
<seealso>
<link id="TFileSortType"/>
@ -733,7 +711,6 @@
<link id="TCustomShellTreeView.Path"/>
<link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
<link id="TCustomShellTreeView.PopulateTreeNodeWithFiles"/>
<link id="TCustomShellTreeView.GetFilesInDir"/>
</seealso>
</element>
@ -846,6 +823,7 @@
<element name="TShellTreeView.HotTrack" link="#lcl.comctrls.TTreeView.HotTrack"/>
<element name="TShellTreeView.Images" link="#lcl.comctrls.TCustomTreeView.Images"/>
<element name="TShellTreeView.Indent" link="#lcl.comctrls.TCustomTreeView.Indent"/>
<element name="TShellTreeView.MultiSelectStyle" link="#lcl.comctrls.TCustomTreeView.MultiSelectStyle"/>
<element name="TShellTreeView.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TShellTreeView.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TShellTreeView.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
@ -915,16 +893,19 @@
</short>
<descr>
<p>
<var>TCSLVFileAddedEvent</var> specifies the interface for an event handler signalled when a <var>TListItem</var> instance is added to <var>TCustomShellListView</var>. TCSLVFileAddedEvent is the type used to implement the <var>OnAddItem</var> property in <var>TCustomShellTreeView</var>. Applications must implement an object procedure using the event signature to respond to the notification.
<var>TCSLVFileAddedEvent</var> specifies the interface for an event handler signalled when a <var>TListItem</var> instance is added to <var>TCustomShellListView</var>. TCSLVFileAddedEvent is the type used to implement the <var>OnAddItem</var> property in <var>TCustomShellListView</var>.
</p>
<p>
Applications must implement and assign an object procedure using the event signature to respond to the notification. <var>Sender</var> must be cast to the correct class type to access properties and methods in the control for the notification. Or, use the <var>ListView</var> property in the <var>Item</var> argument.
</p>
</descr>
<seealso>
<link id="TCustomShellListView.OnAddItem"/>
<link id="#lcl.comctrls.TListItem">TListItem</link>
<link id="TCustomShellTreeView.OnAddItem"/>
</seealso>
</element>
<element name="TCSLVFileAddedEvent.Sender">
<short>Object generating the event notification</short>
<short>Object (control) generating the event notification</short>
</element>
<element name="TCSLVFileAddedEvent.Item">
<short>List item for the event notification</short>
@ -1039,7 +1020,7 @@
No actions are performed in the method at design-time, or when <var>Root</var> contains an empty string (<b>''</b>).
</p>
<p>
<var>PopulateWithRoot</var> calls <var>GetFilesInDir</var> 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 file information items in the list are passed to <var>DoAddItem</var> and <var>OnAddItem</var> to determine if they can be added to the <var>Items</var> in the control. The <var>OnFileAdded</var> event handler is signalled (when assigned) for each new entry added to Items.
<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> and <var>OnAddItem</var> to determine if they can be added to the <var>Items</var> in the control. The <var>OnFileAdded</var> event handler is signalled (when assigned) for each new entry added to Items.
</p>
<p>
The <var>Sort</var> method is called prior to exit to order the Items in the control using the option specified in the <var>FileSortType</var> property.
@ -1051,10 +1032,11 @@
<link id="TCustomShellListView.Mask"/>
<link id="TCustomShellListView.ObjectTypes"/>
<link id="TCustomShellTreeView.FileSortType"/>
<link id="TCustomShellTreeView.GetFilesInDir"/>
<link id="TCustomShellListView.DoAddItem"/>
<link id="TCustomShellListView.OnAddItem"/>
<link id="TCustomShellListView.OnFileAdded"/>
<link id="TAddItemEvent"/>
<link id="TCSLVFileAddedEvent"/>
</seealso>
</element>
@ -1189,14 +1171,14 @@
<short>File mask used to select items displayed in the shell control</short>
<descr>
<p>
<var>Mask</var> is a <var>String</var> property used to supply a mask which determines the file system objects displayed in the shell control. Mask can contain one or more mask values delimited by the Semicolon (';') character. For example:
<var>Mask</var> is a <var>String</var> property used to supply a mask which determines the file system objects displayed in the shell control. Mask can contain one or more mask values delimited by the Semicolon (<b>';'</b>) character. For example:
</p>
<pre>*.exe; br*.com; c??.*</pre>
<p>
Changing the value in Mask causes the <var>Clear</var> method to be called for the shell control. In addition, the <var>Items</var> property calls its <var>Clear</var> method to remove entries stored in the property. The <var>PopulateWithRoot</var> method is called to re-populate the shell control using the new mask value.
</p>
<p>
The value in Mask is passed as an argument to the <var>GetFilesInDir</var> method for the <var>ShellTreeView</var> assigned in the control.
The value in Mask is passed as an argument to the internal <var>GetFilesInDir</var> helper which gets the file system objects displayed in the List View control.
</p>
<p>
Use <var>MaskCaseSensitivity</var> to specify the case sensitivity option used when matching file masks in the shell control.
@ -1475,13 +1457,16 @@
<p>
<var>IsDirectory</var> is a <var>Boolean</var> function which indicates if the file system object for the the tree node is a directory on the local file system. The return value is <b>True</b> when the file attributes in the <var>TSearchRec</var> for the tree node includes the <var>faDirectory</var> attribute.
</p>
<p>
Use <var>HasChildren</var> to determine if the shell tree node has child nodes representing sub-directories.
</p>
</descr>
<seealso>
<link id="TShellTreeNode.SetBasePath"/>
<link id="TCustomShellTreeView.GetFilesInDir"/>
<link id="TCustomShellTreeView.PopulateTreeNodeWithFiles"/>
<link id="TCustomShellTreeView.PopulateWithBaseFiles"/>
<link id="TCustomShellListView.PopulateWithRoot"/>
<link id="#lcl.comctrls.TTreeNode.HasChildren">TTreeNode.HasChildren</link>
</seealso>
</element>
<element name="TShellTreeNode.IsDirectory.Result">