/docs/xml/lcl/comctrls.xml
http://github.com/graemeg/lazarus · XML · 18815 lines · 15749 code · 5 blank · 3061 comment · 0 complexity · 1c2943d4d86527605716a476f26eac71 MD5 · raw file
Large files are truncated click here to view the full file
- <?xml version="1.0" encoding="UTF-8"?>
- <fpdoc-descriptions>
- <package name="LCL">
- <!--
- ====================================================================
- ComCtrls
- ====================================================================
- -->
- <module name="ComCtrls">
- <short>Several controls commonly used in Lazarus forms</short>
- <descr/>
- <!-- unresolved type reference Visibility: default -->
- <element name="SysUtils"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="Classes"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="Math"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="FPCAdds"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="LCLStrConsts"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="LResources"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="LCLIntf"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="LCLType"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="LCLProc"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="AvgLvlTree"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="LMessages"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="ImgList"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="ActnList"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="GraphType"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="Graphics"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="Menus"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="Controls"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="Forms"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="StdCtrls"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="ExtCtrls"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="ToolWin"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="CommCtrl"/>
- <!-- unresolved type reference Visibility: default -->
- <element name="Buttons"/>
- <!-- object Visibility: default -->
- <!-- enumeration type Visibility: default -->
- <element name="THitTest">
- <short>
- <var>THitTest</var> - enumerated type giving permissable results of a hit test (position of a mouse click etc relative to objects on a form)</short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htAbove">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htBelow">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htNowhere">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htOnItem">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htOnButton">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htOnIcon">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htOnIndent">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htOnLabel">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htOnRight">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htOnStateIcon">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htToLeft">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="THitTest.htToRight">
- <short/>
- </element>
- <!-- set type Visibility: default -->
- <element name="THitTests">
- <short>
- <var>THitTests</var> - set of <var>THitTest</var>
- </short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration type Visibility: default -->
- <element name="TStatusPanelStyle">
- <short>
- <var>TStatusPanelStyle</var> - enumerated type for panel style</short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TStatusPanelStyle.psText">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TStatusPanelStyle.psOwnerDraw">
- <short/>
- </element>
- <!-- enumeration type Visibility: default -->
- <element name="TStatusPanelBevel">
- <short>
- <var>TStatusPanelBevel</var> - enumerated type for panel bevel style</short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TStatusPanelBevel.pbNone">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TStatusPanelBevel.pbLowered">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TStatusPanelBevel.pbRaised">
- <short/>
- </element>
- <!-- enumeration type Visibility: default -->
- <element name="TPanelPart">
- <short>
- <var>TPanelPart</var> - enumerated type listing the possible parts that comprise a Panel</short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TPanelPart.ppText">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TPanelPart.ppBorder">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TPanelPart.ppWidth">
- <short/>
- </element>
- <!-- set type Visibility: default -->
- <element name="TPanelParts">
- <short>
- <var>TPanelParts</var> - set ot <var>TPanelPart</var>
- </short>
- <descr/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TStatusPanel">
- <short>
- <var>TStatusPanel</var> - one of the panels contained in a <var>StatusBar</var>
- </short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusPanel.FText">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusPanel.FWidth">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusPanel.FAlignment">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusPanel.FBevel">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusPanel.FParentBiDiMode">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusPanel.FStyle">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusPanel.SetAlignment">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.SetAlignment.Value">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusPanel.SetBevel">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.SetBevel.Value">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusPanel.SetStyle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.SetStyle.Value">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusPanel.SetText">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.SetText.Value">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusPanel.SetWidth">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.SetWidth.Value">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TStatusPanel.GetDisplayName">
- <short>
- <var>GetDisplayName</var> - looks first at the <var>Text</var> property; if it is blank calls inherited method</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TCollectionItem.GetDisplayName">TCollectionItem.GetDisplayName</link>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="TStatusPanel.GetDisplayName.Result">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TStatusPanel.PanelChanged">
- <short>
- <var>PanelChanged</var> - method for dealing with a status panel, one or more of whose parts has changed</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.PanelChanged.Parts">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TStatusPanel.SetIndex">
- <short>
- <var>SetIndex</var> saves the old index value, checks that the supplied value is different then calls inherited method</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TCollectionItem.SetIndex">TCollectionItem.SetIndex</link>
- </seealso>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.SetIndex.Value">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TStatusPanel.Create">
- <short>
- <var>Create</var> - constructor for <var>TStatusPanel</var>: sets default width, alignment and bevel, calls inherited <var>Create</var> and loads into StatusBar</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TCollectionItem.Create">TCollectionItem.Create</link>
- </seealso>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.Create.aCollection">
- <short/>
- </element>
- <!-- destructor Visibility: public -->
- <element name="TStatusPanel.Destroy">
- <short>
- <var>Destroy</var> - destructor for <var>TStatusPanel</var>: calls inherited <var>Destroy</var> and removes itself from the StatusBar</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TCollectionItem.Destroy">TCollectionItem.Destroy</link>
- </seealso>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TStatusPanel.Assign">
- <short>
- <var>Assign</var> copies text, width, alignment, bevel and style properties from <var>Source</var> if it is of correct type, otherwise calls inherited <var>Assign</var> (which will probably raise an exception)</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TPersistent.Assign">TPersistent.Assign</link>
- </seealso>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanel.Assign.Source">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TStatusPanel.StatusBar">
- <short>The <var>StatusBar</var> that contains this <var>StatusPanel</var>
- </short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TStatusPanel.StatusBar.Result">
- <short/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusPanel.Alignment">
- <short>
- <var>Alignment</var> - whether left- or right-justified or centered</short>
- <descr>Only supported on Windows.</descr>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusPanel.Bevel">
- <short>The type of <var>Bevel</var> for the display</short>
- <descr>Only supported on Windows.</descr>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusPanel.Style">
- <short>
- <var>Style</var> - whether text or something drawn by the owner</short>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusPanel.Text">
- <short>
- <var>Text</var> - the string for display in the StatusBar</short>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusPanel.Width">
- <short>The <var>Width</var> of this panel on the StatusBar</short>
- <descr/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TStatusPanels">
- <short>
- <var>TStatusPanels</var> - the collection of Status Panels in this StatusBar</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusPanels.FStatusBar">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- function Visibility: private -->
- <element name="TStatusPanels.GetItem" link="#rtl.Classes.TCollection.GetItem">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TStatusPanels.GetItem.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanels.GetItem.Index">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusPanels.SetItem" link="#rtl.Classes.TCollection.SetItem">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanels.SetItem.Index">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanels.SetItem.Value">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TStatusPanels.GetOwner">
- <short>
- <var>GetOwner</var> returns a Status Bar, overriding the inherited method</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TPersistent.GetOwner">TPersistent.GetOwner</link>
- </seealso>
- </element>
- <!-- function result Visibility: default -->
- <element name="TStatusPanels.GetOwner.Result">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TStatusPanels.Update" link="#rtl.Classes.TCollection.Update">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanels.Update.Item">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TStatusPanels.Create">
- <short>
- <var>Create</var> - constructor for <var>TStatusPanels</var>: calls inherited <var>Create</var> and attaches itself to StatusBar</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TCollection.Create">TCollection.Create</link>
- </seealso>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanels.Create.TheStatusBar">
- <short/>
- </element>
- <!-- function Visibility: public -->
- <element name="TStatusPanels.Add" link="#rtl.Classes.TCollection.Add">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TStatusPanels.Add.Result">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TStatusPanels.Items" link="#rtl.Classes.TCollection.Items">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusPanels.Items.Index">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TStatusPanels.StatusBar">
- <short>The <var>StatusBar</var> to which this collection of Status Panels belongs</short>
- <descr/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TStatusBar">
- <short>
- <var>TStatusBar</var> - a strip along the bottom of a form for displaying information on current status</short>
- <descr>
- <p>
- <var>TStatusBar</var> - a strip along the bottom of a form for displaying information on current status</p>
- <p>The bar may consist of a single <var>SimplePanel</var>, in which case the displayed text is contained in <var>SimpleText</var>.</p>
- <p>However if <var>SimplePanel</var> is false, then there can be multiple panels or sub-sections of the status bar, whose properties are described in <var>Panels</var>.</p>
- <p>The property <var>SimpleText</var> can be assigned programatically to display the value of some variable, such as the position of the Splitter in the example</p>
- </descr>
- <example file="extctrls/statusbar.pas"/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FCanvas">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FHandlePanelCount">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FHandleObjectNeedsUpdate">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FHandleUpdatePanelIndex">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FUpdateLock">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FPanels">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FSimpleText">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FSimplePanel">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TStatusBar.FOnHint">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusBar.SetPanels">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusBar.SetPanels.Value">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusBar.SetSimpleText">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusBar.SetSimpleText.Value">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TStatusBar.SetSimplePanel">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusBar.SetSimplePanel.Value">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TStatusBar.CreateWnd">
- <short>
- <var>CreateWnd</var> calls inherited method, then fixes handles if needed</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#LCL.Controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
- </seealso>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TStatusBar.DestroyWnd">
- <short>
- <var>DestroyWnd</var> calls inherited method and frees handles</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#LCL.Controls.TWinControl.DestroyWnd">TWinControl.DestroyWnd</link>
- </seealso>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TStatusBar.Loaded">
- <short>
- <var>Loaded</var> calls inherited method and fixes handles if needed</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#LCL.Controls.TWinControl.Loaded">TWinControl.Loaded</link>
- </seealso>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TStatusBar.UpdateHandleObject">
- <short>
- <var>UpdateHandleObject</var> - updates all panel parts that have been changed</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusBar.UpdateHandleObject.PanelIndex">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TStatusBar.Create">
- <short>
- <var>Create</var> - constructor for <var>TStatusBar</var>: calls inherited <var>Create</var> and initialises a number of local variables</short>
- <descr>
- <p>
- <var>Create</var> - constructor for TStatusBar: calls inherited <var>Create</var> and initialises a number of local variables</p>
- <p>Among the variables initialised are:</p>
- <p>AutoHint (False), Canvas, ControlStyle, Colour, Align, AutoSize, and SimplePanel (True)</p>
- </descr>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
- <link id="#lcl.Controls.TWinControl.Create">TWinControl.Create</link>
- </seealso>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusBar.Create.TheOwner">
- <short/>
- </element>
- <!-- destructor Visibility: public -->
- <element name="TStatusBar.Destroy">
- <short>
- <var>Destroy</var> - destructor for <var>TStatusBar</var>: frees canvas and panels, then calls inherited <var>Destroy</var>
- </short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
- <link id="#lcl.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
- </seealso>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TStatusBar.InvalidatePanel">
- <short>
- <var>InvalidatePanel</var> - renders the panel with specified index non-valid</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusBar.InvalidatePanel.PanelIndex">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TStatusBar.InvalidatePanel.PanelParts">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TStatusBar.BeginUpdate">
- <short>
- <var>BeginUpdate</var> - starts the update process</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TStatusBar.EndUpdate">
- <short>
- <var>EndUpdate</var> - finishes the update process</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function Visibility: public -->
- <element name="TStatusBar.UpdatingStatusBar">
- <short>
- <var>UpdatingStatusBar</var> - returns True if the status bar is being updated</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TStatusBar.UpdatingStatusBar.Result">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TStatusBar.Canvas">
- <short>The <var>Canvas</var> where the Panels of the StatusBar are to be Painted</short>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.Action" link="#LCL.Controls.TControl.Action">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.Panels">
- <short>
- <var>Panels</var> - the list of strings to be placed in the sub-panels of <var>TStatusBar</var>
- </short>
- <descr>
- <p>If <var>SimplePanel</var> is false, the contents of <var>Panels</var> is displayed. </p>
- <p>Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to <var>Panels</var> in the Object Inspector is selected and allows insertion of an arbitrary number of sub-panels with their own strings</p>
- </descr>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.SimpleText">
- <short>
- <var>SimpleText</var> - a character string containing the information to be displayed in the Status Bar</short>
- <descr>
- <p>
- <var>SimpleText</var> - a character string containing the information to be displayed in the Status Bar</p>
- <p>This is displayed if <var>SimplePanel</var> is true; otherwise the information in Panels is displayed.</p>
- </descr>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.SimplePanel">
- <short>
- <var>SimplePanel </var>- boolean. Is there just one continuous panel, or several sub-panels?</short>
- <descr>
- <p>
- <var>SimplePanel </var>- boolean. Is there just one continuous panel, or several sub-panels?</p>
- <p>If true, the value of <var>SimpleText</var> is displayed; if false, the contents of <var>Panels</var> is displayed. </p>
- <p>Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to <var>Panels</var> is selected and allows insertion of an arbitrary number of sub-panels with their own strings</p>
- </descr>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.Visible" link="#LCL.Controls.TControl.Visible">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.Color" link="#LCL.Controls.TControl.Color">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.OnHint">
- <short>Event handler for showing a hint when required</short>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: published -->
- <element name="TStatusBar.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TCustomPage">
- <short>
- <var>TCustomPage</var>: The base type for
- <var>Page</var>
- </short>
- <descr>
- <var>TCustomPage</var>: The base type for the tabbed pages found in notebooks
- </descr>
- <seealso>
- <link id="#lcl.ExtCtrls.Multi-PageControls">Multi-PageControls</link>
- </seealso>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomPage.FFlags">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomPage.FImageIndex">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- function Visibility: private -->
- <element name="TCustomPage.GetTabVisible">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.GetTabVisible.Result">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TCustomPage.SetImageIndex">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.SetImageIndex.AValue">
- <short/>
- </element>
- <!-- procedure Visibility: private -->
- <element name="TCustomPage.SetTabVisible">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.SetTabVisible.AValue">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TCustomPage.WMPaint" link="#LCL.Controls.TWinControl.WMPaint">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.WMPaint.Msg">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TCustomPage.SetParent" link="#LCL.Controls.TControl.SetParent">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.SetParent.AParent">
- <short/>
- </element>
- <!-- property Visibility: protected -->
- <element name="TCustomPage.Flags">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TCustomPage.CMHitTest" link="#LCL.Controls.TControl.CMHitTest">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.CMHitTest.Message">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TCustomPage.DestroyHandle" link="#LCL.Controls.TWinControl.DestroyHandle">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TCustomPage.GetPageIndex">
- <short>
- <var>GetPageIndex</var> - returns the index of the current page</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.GetPageIndex.Result">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TCustomPage.SetPageIndex">
- <short>
- <var>SetPageIndex</var> - specifies an index for the current page</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.SetPageIndex.AValue">
- <short/>
- </element>
- <!-- property Visibility: protected -->
- <element name="TCustomPage.TabVisible">
- <short>
- <var>TabVisible</var> - is the Tab for this page visible?</short>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomPage.FTabVisible">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomPage.FOnHide">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomPage.FOnShow">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TCustomPage.DialogChar" link="#LCL.Controls.TControl.DialogChar">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.DialogChar.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.DialogChar.Message">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TCustomPage.DoHide">
- <short>
- <var>DoHide</var> - perform the code for the <var>OnHide</var> event handler</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TCustomPage.DoShow">
- <short>
- <var>DoShow</var> - perform the code for the <var>OnShow</var> event handler</short>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TCustomPage.Create">
- <short>
- <var>Create</var> - constructor for <var>TCustomPage</var>: calls inherited <var>Create</var> then initialises style, visibility, alignment and caption</short>
- <descr/>
- <errors/>
- <seealso>
- <link id="#lcl.Controls.TControl.Create">TControl.Create</link>
- </seealso>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.Create.TheOwner">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TCustomPage.AdjustClientRect" link="#LCL.Controls.TWinControl.AdjustClientRect">
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TCustomPage.AdjustClientRect.ARect">
- <short/>
- </element>
- <element name="TCustomPage.AutoSizeDelayed" link="#lcl.Controls.TControl.AutoSizeDelayed"/>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.AutoSizeDelayed.Result">
- <short/>
- </element>
- <element name="TCustomPage.IsControlVisible" link="#lcl.Controls.TControl.IsControlVisible"/>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.IsControlVisible.Result">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.Visible" link="#lcl.Controls.TControl.Visible">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.PageIndex">
- <short>
- <var>PageIndex </var>- integer index value for this page in the notebook</short>
- </element>
- <element name="TCustomPage.VisibleIndex">
- <short>
- <var>VisibleIndex</var> - returns the index number of a visible page</short>
- </element>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.VisibleIndex.Result">
- <short/>
- </element>
- <element name="TCustomPage.OnHide">
- <short>
- <var>OnHide</var> - event handler for hiding this page in a notebook</short>
- </element>
- <element name="TCustomPage.OnShow">
- <short>
- <var>OnShow</var> - event handler for showing (making visible) this page of a notebook</short>
- </element>
- <!-- function Visibility: public -->
- <element name="TCustomPage.CanTab" link="#LCL.Controls.TControl.CanTab"/>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.CanTab.Result"/>
- <!-- function Visibility: public -->
- <element name="TCustomPage.IsVisible">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TCustomPage.IsVisible.Result">
- <short/>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.ImageIndex">
- <short>
- <var>ImageIndex</var> - integer index value for the image associated with this page</short>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.Left" link="#lcl.Controls.TControl.Left">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.Top" link="#lcl.Controls.TControl.Top">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.Width" link="#lcl.Controls.TControl.Width">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.Height" link="#lcl.Controls.TControl.Height">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- property Visibility: public -->
- <element name="TCustomPage.TabOrder" link="#lcl.Controls.TWinControl.TabOrder">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- "class of" type Visibility: default -->
- <element name="TCustomPageClass">
- <short>
- <var>TCustomPageClass</var> - class of <var>TCustomPage</var>
- </short>
- <descr/>
- <seealso/>
- </element>
- <!-- object Visibility: default -->
- <element name="TNBPages">
- <short>
- <var>TNBPages</var> - NoteBook Pages: an array of strings containing the names of the pages</short>
- </element>
- <!-- variable Visibility: private -->
- <element name="TNBPages.FPageList">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TNBPages.FNotebook">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TNBPages.Get" link="#rtl.Classes.TStrings.Get">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TNBPages.Get.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Get.Index">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TNBPages.GetCount" link="#rtl.Classes.TStrings.GetCount">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TNBPages.GetCount.Result">
- <short/>
- </element>
- <!-- function Visibility: protected -->
- <element name="TNBPages.GetObject" link="#rtl.Classes.TStrings.GetObject">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- function result Visibility: default -->
- <element name="TNBPages.GetObject.Result">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.GetObject.Index">
- <short/>
- </element>
- <!-- procedure Visibility: protected -->
- <element name="TNBPages.Put" link="#rtl.Classes.TStrings.Put">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Put.Index">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Put.S">
- <short/>
- </element>
- <!-- constructor Visibility: public -->
- <element name="TNBPages.Create">
- <descr/>
- <errors/>
- <seealso>
- <link id="#rtl.System.TObject.Create">TObject.Create</link>
- </seealso>
- <short>
- <var>Create</var> - constructor for <var>TNBPages</var>: calls inherited <var>Create</var> then sets up the list of pages on the notebook</short>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Create.thePageList">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Create.theNotebook">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TNBPages.Clear" link="#rtl.Classes.TStrings.Clear">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TNBPages.Delete" link="#rtl.Classes.TStrings.Delete">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Delete.Index">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TNBPages.Insert" link="#rtl.Classes.TStrings.Insert">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Insert.Index">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Insert.S">
- <short/>
- </element>
- <!-- procedure Visibility: public -->
- <element name="TNBPages.Move" link="#rtl.Classes.TStrings.Move">
- <short/>
- <descr/>
- <errors/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Move.CurIndex">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TNBPages.Move.NewIndex">
- <short/>
- </element>
- <!-- procedure type Visibility: default -->
- <element name="TTabChangingEvent">
- <short>
- <var>TTabChangingEvent</var> - generic event handling method for a change in a notebook Tab</short>
- <descr/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TTabChangingEvent.Sender">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TTabChangingEvent.AllowChange">
- <short/>
- </element>
- <!-- enumeration type Visibility: default -->
- <element name="TTabPosition">
- <short>
- <var>TTabPosition</var> - enumerated type for position of tab relative to page: top, bottom, left or right</short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TTabPosition.tpTop">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TTabPosition.tpBottom">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TTabPosition.tpLeft">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TTabPosition.tpRight">
- <short/>
- </element>
- <!-- enumeration type Visibility: default -->
- <element name="TTabStyle">
- <short>
- <var>TTabStyle</var> - enumerated type for tab style: normal, buttons or flat buttons</short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TTabStyle.tsTabs">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TTabStyle.tsButtons">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TTabStyle.tsFlatButtons">
- <short/>
- </element>
- <!-- procedure type Visibility: default -->
- <element name="TTabGetImageEvent">
- <short>
- <var>TTabGetImageEvent</var> - generic event handling method for getting an image for a Tab</short>
- <descr/>
- <seealso/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TTabGetImageEvent.Sender">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TTabGetImageEvent.TabIndex">
- <short/>
- </element>
- <!-- argument Visibility: default -->
- <element name="TTabGetImageEvent.ImageIndex">
- <short/>
- </element>
- <!-- enumeration type Visibility: default -->
- <element name="TCTabControlOption">
- <short>
- <var>TCTabControlOption</var> - Show the close button on a tab, allow multi-line tabs</short>
- <descr/>
- <seealso/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TCTabControlOption.nboShowCloseButtons">
- <short/>
- </element>
- <!-- enumeration value Visibility: default -->
- <element name="TCTabControlOption.nboMultiLine">
- <short/>
- </element>
- <!-- set type Visibility: default -->
- <element name="TCTabControlOptions">
- <short>
- <var>TCTabControlOptions</var> - set of <var>TCTabControlOption</var>
- </short>
- <descr/>
- <seealso/>
- </element>
- <element name="TCustomTabControl">
- <short>
- <var>TCustomTabControl</var>: The base type for <var>TTabControl</var> and <var>TPageControl</var>
- </short>
- <descr>
- <p>
- <var>TCustom Notebook</var>: The base type for
- <var>TTabControl</var> and
- <var>TPageControl</var>
- </p>
- <p>A tab control has a series of <var>Tabs</var>, and it may or may not contain pages.</p>
- </descr>
- <seealso>
- <link id="#lcl.ExtCtrls.Multi-PageControls">Multi-PageControls</link>
- </seealso>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FAccess">
- <short/>
- <descr/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FAddingPages">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FImages">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FLoadedPageIndex">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FOnChanging">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FOnCloseTabClicked"/>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FOnGetImageIndex">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.fOnPageChanged">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FOptions">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FPageIndex">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FPageIndexOnLastChange">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FPageList">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FShowTabs">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- variable Visibility: private -->
- <element name="TCustomTabControl.FTabPosition">
- <short/>
- <descr/>
- <seealso/>
- </element>
- <!-- procedure Visibility: private -->
- <element name=…