mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-29 02:23:42 +02:00
10093 lines
401 KiB
XML
10093 lines
401 KiB
XML
<?xml version="1.0"?>
|
||
<fpdoc-descriptions>
|
||
<package name="LCL">
|
||
<!--
|
||
====================================================================
|
||
StdCtrls
|
||
====================================================================
|
||
-->
|
||
<module name="StdCtrls">
|
||
<short>Several standard controls used in most Lazarus forms</short>
|
||
<descr/>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="Classes">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="SysUtils">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="LCLStrConsts">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="LCLType">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="LCLProc">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="LMessages">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="Graphics">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="GraphType">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="ExtendedStrings">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="LCLIntf">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="ClipBrd">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="ActnList">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="Controls">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="Forms">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- unresolved type reference Visibility: default -->
|
||
<element name="Menus">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TEditCharCase">
|
||
<short>
|
||
<var>TEditCharCase</var> - enumerated type that determines the case of text displayed in the edit box or combobox.</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TEditCharCase.ecNormal">
|
||
<short>Normal mode - Character case according to what the user types.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TEditCharCase.ecUppercase">
|
||
<short>Converts every character that the user types into upper case characters.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TEditCharCase.ecLowerCase">
|
||
<short>Converts every character that the user types into lower case characters.</short>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TEchoMode">
|
||
<short>
|
||
<var>TEchoMode</var> - enumerated type that determines how strings in the edit box are displayed.</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TEchoMode.emNormal">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TEchoMode.emNone">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TEchoMode.emPassword">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TScrollStyle">
|
||
<short>
|
||
<var>TScrollStyle</var> - enumerated type determining style of scroll bars on a control</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollStyle.ssNone">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollStyle.ssHorizontal">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollStyle.ssVertical">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollStyle.ssBoth">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollStyle.ssAutoHorizontal">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollStyle.ssAutoVertical">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollStyle.ssAutoBoth">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TScrollCode">
|
||
<short>
|
||
<var>TScrollCode</var> - the scroll action type.</short>
|
||
<descr>
|
||
<p>!!! Beware. The position of these enums must correspond to the SB_xxx values in LCLType (Delphi compatibility, not our decision)</p>
|
||
<pre>scLineUp, // = SB_LINEUP
|
||
scLineDown, // = SB_LINEDOWN
|
||
scPageUp, // = SB_PAGEUP
|
||
scPageDown, // = SB_PAGEDOWN
|
||
scPosition, // = SB_THUMBPOSITION
|
||
scTrack, // = SB_THUMBTRACK
|
||
scTop, // = SB_TOP
|
||
scBottom, // = SB_BOTTOM
|
||
scEndScroll // = SB_ENDSCROLL
|
||
</pre>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scLineUp">
|
||
<short>Scroll one line up.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scLineDown">
|
||
<short>Scroll one line down.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scPageUp">
|
||
<short>Scroll one page up.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scPageDown">
|
||
<short>Scroll one page down.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scPosition">
|
||
<short>Scroll to the specified position.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scTrack">
|
||
<short>Scroll tracking to the specified position.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scTop">
|
||
<short>Scroll to the top.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scBottom">
|
||
<short>Scroll to the bottom.</short>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TScrollCode.scEndScroll">
|
||
<short>Scroll ends.</short>
|
||
</element>
|
||
<!-- procedure type Visibility: default -->
|
||
<element name="TScrollEvent">
|
||
<short>
|
||
<var>TScrollEvent</var> - generic event method for processing a scrolling event</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TScrollEvent.Sender">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TScrollEvent.ScrollCode">
|
||
<short>Determines the scroll action.</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TScrollEvent.ScrollPos">
|
||
<short>Contains the current scroll position.</short>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomScrollBar">
|
||
<short>
|
||
<var>TCustomScrollBar</var>
|
||
|
||
|
||
|
||
: the base class for <var>TScrollBar</var>
|
||
</short>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FKind">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FPosition">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FMin">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FMax">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FPageSize">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FRTLFactor">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FSmallChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FLargeChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomScrollBar.FOnScroll">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.DoScroll">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.DoScroll.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomScrollBar.NotRightToLeft">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomScrollBar.NotRightToLeft.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.SetKind">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetKind.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.SetMax">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetMax.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.SetMin">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetMin.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.SetPosition">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetPosition.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.SetPageSize">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetPageSize.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.CNHScroll">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.CNHScroll.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.CNVScroll">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.CNVScroll.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.CNCtlColorScrollBar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.CNCtlColorScrollBar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomScrollBar.WMEraseBkgnd">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.WMEraseBkgnd.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomScrollBar.CreateParams">
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomScrollBar.CreateParams"/>
|
||
</p>
|
||
<p>The inherited method creates parameters such as caption, style, size and position for a Control</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.CreateParams">WinControl.CreateParams</link>
|
||
</seealso>
|
||
<short>
|
||
<var>CreateParams</var> - calls inherited <var>CreateParams</var> then sets up style and alignment depending on whether horizontal or vertical</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.CreateParams.Params">
|
||
<short>The paramaeter list</short>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomScrollBar.CreateWnd">
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomScrollBar.CreateWnd"/>
|
||
</p>
|
||
<p>The inherited method creates the interface object, sets parameters and assigns the handle</p>
|
||
<p>Then the size of scrollbar, maximum and minimum values, page size and position of scrollbar are set</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
|
||
</seealso>
|
||
<short>
|
||
<var>CreateWnd</var> - calls inherited <var>CreateWnd</var> then initialises various Scroll Info properties</short>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomScrollBar.Change">
|
||
<short>
|
||
<var>Change</var> - method to signal that a change has occured</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.Changed">TControl.Changed</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomScrollBar.Scroll">
|
||
<short>The scrolling process</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.Scroll.ScrollCode">
|
||
<short>The code used for scrolling - up or down a line, a page, to the top or bottom etc</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.Scroll.ScrollPos">
|
||
<short>The position of the scrolling device</short>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomScrollBar.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomScrollBar</var>: calls inherited <var>Create</var> then initialises size, style and various local variables</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.Create.AOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomScrollBar.SetParams">
|
||
<short>Defines the Max and Min values, the size of the page and the position of the scroller</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetParams.APosition">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetParams.AMin">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetParams.AMax">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomScrollBar.SetParams.APageSize">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.Kind">
|
||
<short>
|
||
<var>Kind</var>
|
||
|
||
|
||
|
||
of scroll bar - whether Horizontal or Vertical</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.LargeChange">
|
||
<short>
|
||
<var>LargeChange </var>
|
||
|
||
|
||
|
||
- the size of the step to be taken by the slider for a large change</short>
|
||
<descr>A <var>LargeChange</var> is produced by the user clicking on the blank area above or below the slider; it is rather analogous to the Page Down or Page Up functions of the Keyboard and is typically set up to move the slider and the contents of the page or canvas by a whole paragraph or half a page or a full page.</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.Max">
|
||
<short>The maximum value (for bottom of the scroll bar or the right-most extent)</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.Min">
|
||
<short>The minimum value, for the top of the scroll bar or its left-most extent</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.PageSize">
|
||
<short>
|
||
<var>PageSize:</var>
|
||
|
||
|
||
|
||
the size of a page - typically used for <var>LargeChange</var>
|
||
</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.Position">
|
||
<short>The <var>Position</var> of the scroller along the ScrollBar</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.SmallChange">
|
||
<short>
|
||
<var>SmallChange</var> - the size of the step to be taken by the scroller for a small change</short>
|
||
<descr>A small change is produced by the user clicking on one of the triangular tags at either end of the scrollbar. It is rather analogous to the effect of using the up or down arrows on the keyboard, and is typically set to produce a movement of a few pixels or a single line of text
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.OnChange">
|
||
<short>
|
||
<var>OnChange</var> - Event handler for any change in position of the slider or other mouse movement or keyboard event associated with the scrollbar</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomScrollBar.OnScroll">
|
||
<short>
|
||
<var>OnScroll</var>
|
||
|
||
|
||
|
||
- Handler for a scrolling event (by mouse, keyboard or program)</short>
|
||
<descr>
|
||
<p>
|
||
<var>OnScroll</var>
|
||
|
||
|
||
|
||
- Handler for a scrolling event</p>
|
||
<p>Called when there is any movement of the slider by mouse, arrow keys or Page Up/Down keys, or if the display in the main window is caused to scroll</p>
|
||
</descr>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TScrollBar">
|
||
<short>
|
||
<var>TScrollBar</var>
|
||
|
||
|
||
|
||
- a control that allows the user to scroll the current page or document window by moving a slider</short>
|
||
<descr>
|
||
<p>
|
||
<var>TScrollBar</var>
|
||
|
||
|
||
|
||
- a control that allows the user to scroll the current page or document window by moving a slider</p>
|
||
<p>It appears as a long rectangular track or bar within which a smaller contrasting block or slider can move up and down (or from side to side in a horizontal ScrollBar)</p>
|
||
<p>It has small triangular indicators or pointers at each end. Typically, for a vertical ScrollBar the top indicator points up, and at the bottom there is a pair of pointers, one up and one down. Clicking with the mouse on one of the pointers moves the slider a small distance (<var>SmallChange</var>) in the specified direction, and the programmer's responsibility is to ensure that the page, image or document in which the ScrollBar is found will scroll by a corresponding small amount</p>
|
||
<p>Clicking with the mouse in the blank area of the scrollbar above or below the slider makes the slider move by a larger increment (<var>LargeChange</var>) and scrolls the contents of the window by a larger amount - several lines, a paragraph, half a page or anything up to a page (<var>PageSize</var>)</p>
|
||
<p>The slider can also be moved by clicking on it with the mouse, and holding down the button while moving the mouse. The slider follows the mouse until the button is released. If the mouse has a scrollwheel, the slider can be similarly moved by rotating the wheel. In each case, the contents of the window scroll by a corresponding amount</p>
|
||
<p>Scrolling of the window and movement of the slider can also be achieved by using the directional arrows or the Page Up/Page Down keys on the keyboard</p>
|
||
<p>The location of the slider along the track is held in the <var>Position</var> property, which reports where the mouse has placed it, or can alternatively be set to an arbitrary location by the program. If the mouse or arrow keys are used to move the cursor somewhere on the main window so as to make the display scroll (eg by moving beyond the top or bottom line in a text display) the scroll bar slider moves to indicate the corresponding location along the scroll bar</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Ctl3D" link="#LCL.Controls.TControl.Ctl3D">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.DragKind" link="#LCL.Controls.TControl.DragKind">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Kind" link="#LCL.StdCtrls.TCustomScrollBar.Kind"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.LargeChange" link="#LCL.StdCtrls.TCustomScrollBar.LargeChange">
|
||
<descr>A <var>LargeChange</var> is produced by the user clicking on the blank area above or below the slider; it is rather analogous to the Page Down or Page Up functions of the Keyboard and is typically set up to move the slider and the contents of the page or canvas by a whole paragraph or half a page or a full page.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Max" link="#LCL.StdCtrls.TCustomScrollBar.Max">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Min" link="#LCL.StdCtrls.TCustomScrollBar.Min">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.PageSize" link="#LCL.StdCtrls.TCustomScrollBar.PageSize">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.ParentCtl3D" link="#LCL.Controls.TWinControl.ParentCtl3D">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Position" link="#LCL.StdCtrls.TCustomScrollBar.Position">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.SmallChange" link="#LCL.StdCtrls.TCustomScrollBar.SmallChange">
|
||
<descr>A small change is produced by the user clicking on one of the triangular tags at either end of the scrollbar. It is rather analogous to the effect of using the up or down arrows on the keyboard, and is typically set to produce a movement of a few pixels or a single line of text
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnChange" link="#LCL.StdCtrls.TCustomScrollBar.OnChange">
|
||
<seealso>
|
||
<link id="TScrollBar.OnScroll"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnScroll" link="#LCL.StdCtrls.TCustomScrollBar.OnScroll">
|
||
<seealso>
|
||
<link id="TScrollBar.OnChange"/>
|
||
</seealso>
|
||
<descr>
|
||
<p>
|
||
<var>OnScroll</var>
|
||
|
||
|
||
|
||
|
||
- Handler for a scrolling event</p>
|
||
<p>Called when there is any movement of the slider by mouse, arrow keys or Page Up/Down keys, or if the display in the main window is caused to scroll</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TScrollBar.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomGroupBox">
|
||
<short>
|
||
<var>TCustomGroupBox </var>
|
||
|
||
|
||
|
||
- the base class for <var>TGroupBox</var>, <var>TRadioGroup</var> and <var>TCheckGroup</var>
|
||
</short>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomGroupBox.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> - sets its own defaults, overriding the inherited values</short>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomGroupBox.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomGroupBox.Create">
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomGroupBox</var>: calls inherited <var>Create</var> then initialises style and bounds</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomGroupBox.Create.AOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TGroupBox">
|
||
<short>
|
||
<var>TGroupBox </var>
|
||
|
||
|
||
|
||
- a container that allows a number of objects to be grouped physically and conceptually on the form</short>
|
||
<descr>
|
||
<p>Group Box. Allows a number of objects to be grouped physically and conceptually on the form; they can be moved around together and have certain properties in common.</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Caption" link="#LCL.Controls.TControl.Caption">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ChildSizing" link="#LCL.Controls.TWinControl.ChildSizing">
|
||
<descr>Reads values from flag or stores values to flag. Most of the properties are inherited from TControlChildSizing, <br/>
|
||
which you should read to find out more about this control
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ClientHeight" link="#LCL.Controls.TControl.ClientHeight">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Finds or sets the client height, and sets a flag if it has been stored</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ClientWidth" link="#LCL.Controls.TControl.ClientWidth">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>
|
||
<var>ClientWidth</var>
|
||
|
||
- determines the width of the client within which the control exists; reads the width of the client control or sets the value. Sets flag if value is stored</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Ctl3D" link="#LCL.Controls.TControl.Ctl3D">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.DockSite" link="#LCL.Controls.TWinControl.DockSite">
|
||
<descr>Reads or sets a flag to show whether this is a dock site. Default false
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.DragKind" link="#LCL.Controls.TControl.DragKind">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ParentCtl3D" link="#LCL.Controls.TWinControl.ParentCtl3D">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads or Writes flag if bounds are changed</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.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 spcified 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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnDockDrop" link="#LCL.Controls.TWinControl.OnDockDrop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnDockOver" link="#LCL.Controls.TWinControl.OnDockOver">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnEndDock" link="#LCL.Controls.TControl.OnEndDock">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnGetSiteInfo" link="#LCL.Controls.TWinControl.OnGetSiteInfo">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads or Writes flag if control is re-sized.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnStartDock" link="#LCL.Controls.TControl.OnStartDock">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TGroupBox.OnUnDock" link="#LCL.Controls.TWinControl.OnUnDock">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TComboBoxAutoCompleteTextOption">
|
||
<short>
|
||
<var>TComboBoxAutoCompleteTextOption</var> - Enumerated type that defines the behavior of the <var>AutoComplete</var> feature in a combobox control.</short>
|
||
<descr>
|
||
<p>
|
||
<var>TComboBoxAutoCompleteTextOption</var>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
defines the behavior of the <var>AutoComplete</var> feature.</p>
|
||
<ul>
|
||
<li>cbactEnabled: Enable Auto-Completion feature.</li>
|
||
<li>cbactEndOfLineComplete: Perform Auto-Complete only when cursor is at the end of the string.</li>
|
||
<li>cbactRetainPrefixCase: Retains the case of characters user has typed. (This option has no effect if cbactEndOfLineComplete is False)</li>
|
||
<li>cbactSearchCaseSensitive: Search completion string with case sensitivity.</li>
|
||
<li>cbactSearchAscending: Search completion string in ascending order. (False will search in descending order)</li>
|
||
</ul>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxAutoCompleteTextOption.cbactEnabled">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxAutoCompleteTextOption.cbactEndOfLineComplete">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxAutoCompleteTextOption.cbactRetainPrefixCase">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxAutoCompleteTextOption.cbactSearchCaseSensitive">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxAutoCompleteTextOption.cbactSearchAscending">
|
||
<short/>
|
||
</element>
|
||
<!-- set type Visibility: default -->
|
||
<element name="TComboBoxAutoCompleteText">
|
||
<short>
|
||
<var>TComboBoxAutoCompleteText </var>- Set of <var>TComboBoxAutoCompleteTextOption</var>
|
||
</short>
|
||
<descr/>
|
||
<seealso>
|
||
<link id="TComboBoxAutoCompleteTextOption"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TComboBoxStyle">
|
||
<short>
|
||
<var>ComboBox Style</var> - enumerated type for style of combobox</short>
|
||
<descr>ComboBox Style: may be Simple, a single-line Drop-Down or a Drop-Down list, or some version drawn by the Owner
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxStyle.csDropDown">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxStyle.csSimple">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxStyle.csDropDownList">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxStyle.csOwnerDrawFixed">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TComboBoxStyle.csOwnerDrawVariable">
|
||
<short/>
|
||
</element>
|
||
<!-- alias type Visibility: default -->
|
||
<element name="TOwnerDrawState">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure type Visibility: default -->
|
||
<element name="TDrawItemEvent">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TDrawItemEvent.Control">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TDrawItemEvent.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TDrawItemEvent.ARect">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TDrawItemEvent.State">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure type Visibility: default -->
|
||
<element name="TMeasureItemEvent">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TMeasureItemEvent.Control">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TMeasureItemEvent.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TMeasureItemEvent.Height">
|
||
<short/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomComboBox">
|
||
<short>
|
||
<var>TCustomComboBox</var>
|
||
|
||
|
||
|
||
- the base class from which <var>TComboBox </var> is derived</short>
|
||
<descr>
|
||
<p>
|
||
<var>TCustomComboBox</var>
|
||
|
||
|
||
|
||
- the base class from which <var>TComboBox </var>is derived</p>
|
||
<p>Despite similarities in appearance to <var>TCustomEdit</var>
|
||
and <var>TCustomList</var>
|
||
, the class inherits no properties from these classes, but only from <link id="#lcl.Controls.TWinControl">TWinControl</link>
|
||
</p>
|
||
<p>It has some interesting properties including <var>AutoComplete</var> and <var>AutoCompleteText</var>, <var>AutoDropDown</var> and the ability to create and add a History display</p>
|
||
</descr>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FCharCase">
|
||
<short>FCharCase: TEditCharCase</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FAutoCompleteText">
|
||
<short>FAutoCompleteText: TComboBoxAutoCompleteText</short>
|
||
<descr>Private variable of property AutoCompleteText.
|
||
|
||
Options for behavior of the Auto-Complete feature.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FAutoSelect">
|
||
<short>FAutoSelect: Boolean</short>
|
||
<descr>
|
||
<p>Private variable for property AutoSelect.
|
||
|
||
When True, the edit control will select all its text when:</p>
|
||
<ul>
|
||
<li>It receives focus</li>
|
||
<li>The Enter key is pressed.</li>
|
||
<li>A new item is selected.</li>
|
||
</ul>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FAutoSelected">
|
||
<short>FAutoSelected: Boolean</short>
|
||
<descr>Private variable for property AutoSelected.
|
||
|
||
True indicate that the edit or combobox control has just performed
|
||
an AutoSelect operation so that subsequent mouse-clicks and keystrokes
|
||
proceed normally without selecting the text.
|
||
|
||
False is set when the edit or combobox control loses focus.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FAutoDropDown">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FCanvas">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FDropDownCount">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FDroppedDown">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FItemHeight">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FItemIndex">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FItemWidth">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FItems">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FMaxLength">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FOnCloseUp">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FOnDrawItem">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FOnDropDown">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FOnGetItems">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FOnMeasureItem">
|
||
<short/>
|
||
<descr>
|
||
<short>Combo Box</short>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FOnSelect">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FReadOnly">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FSelLength">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FSelStart">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FSorted">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FStyle">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FArrowKeysTraverseList">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomComboBox.FReturnArrowState">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomComboBox.GetAutoComplete">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetAutoComplete.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomComboBox.GetDroppedDown">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetDroppedDown.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomComboBox.GetItemWidth">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetItemWidth.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.SetAutoComplete">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetAutoComplete.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.SetItemWidth">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetItemWidth.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.SetItems">
|
||
<short>
|
||
<var>SetItems</var> writes the strings specified in <var>Value</var> to the <var>Items</var> list</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetItems.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.LMDrawListItem">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.LMDrawListItem.TheMessage">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.LMMeasureItem">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.LMMeasureItem.TheMessage">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.LMSelChange">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.LMSelChange.TheMessage">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.CNCommand">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.CNCommand.TheMessage">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.SetReadOnly">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetReadOnly.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.UpdateSorted">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.SetArrowKeysTraverseList">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetArrowKeysTraverseList.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.WMChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.WMChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomComboBox.SetCharCase">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetCharCase.eccCharCase">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.InitializeWnd">
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.InitializeWnd"/>
|
||
</p>
|
||
<p>Inherited method works out the correct bounds, sets style, fonts and colours, performs any pending resize operations</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
|
||
</seealso>
|
||
<short>
|
||
<var>InitializeWnd</var> - creates the underlying interface-object: calls inherited <var>InitializeWnd</var> then sets up several local lists and variables notably for style and size</short>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.DestroyWnd">
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.DestroyWnd"/>
|
||
</p>
|
||
<p>Inherited method removes handles and restores colour and font flags</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.DestroyWnd">TWinControl.DestroyWnd</link>
|
||
</seealso>
|
||
<short>
|
||
<var>DestroyWnd</var> - finds somewhere to store locally held variables then frees lists, calls inherited <var>DestroyWnd</var>
|
||
</short>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.DoEnter">
|
||
<short>
|
||
<var>DoEnter</var> - cals inherited method then autoselects text in dropdown list if required</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.DoEnter">TWinControl.DoEnter</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.DoExit">
|
||
<short>
|
||
<var>DoExit</var> - disables <var>AutoSelect</var> then calls inherited <var>DoExit</var>
|
||
</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.DoExit">TWinControl.DoExit</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.DrawItem">
|
||
<short>
|
||
<var>DrawItem</var> - perform the action necessary to draw the specified indexed item at the specified position</short>
|
||
<descr>
|
||
<p>
|
||
<var>DrawItem</var> - perform the action necessary to draw the specified indexed item at the specified position</p>
|
||
<p>Software emulation of <var>OnDrawItem</var> event</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.DrawItem.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.DrawItem.ARect">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.DrawItem.State">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> - sets its own defaults, overriding inherited values</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.LMChanged">
|
||
<short>
|
||
<var>LMChanged</var> - LCL Message to signify that the control has changed</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.LMChanged.Msg">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.Change">
|
||
<short>
|
||
<var>Change</var> - software emulation of <var>OnChange</var> event</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.Select">
|
||
<short>
|
||
<var>Select</var> - software emulation of <var>OnSelect</var> event</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.DropDown">
|
||
<short>
|
||
<var>DropDown</var> - software emulation of <var>OnDropDown</var> event</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.CloseUp">
|
||
<short>
|
||
<var>CloseUp</var> - software emulation of <var>OnCloseUp</var> event</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.AdjustDropDown">
|
||
<short>
|
||
<var>AdjustDropDown</var> - adjust the properties of the DropDown list</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetItemCount">
|
||
<short>
|
||
<var>GetItemCount</var> - returns the number of items in the DropDown list</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetItemCount.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetItemHeight">
|
||
<short>
|
||
<var>GetItemHeight</var> - returns the height of the current list item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetItemHeight.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetSelLength">
|
||
<short>
|
||
<var>GetSelLength</var> - returns the length of the current selection</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetSelLength.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetSelStart">
|
||
<short>
|
||
<var>GetSelStart</var> - returns the start position of the current selection</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetSelStart.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetSelText">
|
||
<short>
|
||
<var>GetSelText</var> - returns the currently selected text string</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetSelText.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetItemIndex">
|
||
<short>
|
||
<var>GetItemIndex</var> - returns the Index value of the current list item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetItemIndex.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.GetMaxLength">
|
||
<short>
|
||
<var>GetMaxLength</var> - returns the maximum length of a list item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.GetMaxLength.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.IsReadOnlyStored">
|
||
<short>
|
||
<var>IsReadOnlyStored</var> - returns True if ReadOnly status is stored</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.IsReadOnlyStored.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetDropDownCount">
|
||
<short>
|
||
<var>SetDropDownCount</var> - writes the number of items in DropDown list to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetDropDownCount.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetDroppedDown">
|
||
<short>
|
||
<var>SetDroppedDown</var> - writes DroppedDown status to local boolean variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetDroppedDown.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetItemHeight">
|
||
<short>
|
||
<var>SetItemHeight</var> - writes height of current list item to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetItemHeight.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetItemIndex">
|
||
<short>
|
||
<var>SetItemIndex</var> - writes index value of current item to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetItemIndex.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetMaxLength">
|
||
<short>
|
||
<var>SetMaxLength</var> - writes maximum length of list item to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetMaxLength.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetSelLength">
|
||
<short>
|
||
<var>SetSelLength</var> - writes length of current selection to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetSelLength.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetSelStart">
|
||
<short>
|
||
<var>SetSelStart</var> - writes start position of current selection to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetSelStart.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetSelText">
|
||
<short>
|
||
<var>SetSelText</var> - writes currently selected text string to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetSelText.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetSorted">
|
||
<short>
|
||
<var>SetSorted</var> - writes to local (boolean) variable to show if list is Sorted</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetSorted.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.SetStyle">
|
||
<short>
|
||
<var>SetStyle</var> - writes the current Style specifier to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SetStyle.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.RealSetText">
|
||
<short>
|
||
<var>RealSetText</var> - sets the ComboBox text to the caption value specified </short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.RealSetText"/>
|
||
</p>
|
||
<p>If the text <var>AValue</var> occurs in the list of strings, then sets the <var>Itemindex</var>, otherwise does the default action which is to store text as a string rather than performing read-write to a <var>PChar</var> buffer</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.RealSetText">TControl.RealSetText</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.RealSetText.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.KeyDown">
|
||
<short>
|
||
<var>KeyDown</var> - performs code for traversing the dropdown list to the correct location before calling inherited <var>KeyDown</var>
|
||
</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.KeyDown"/>
|
||
</p>
|
||
<p>The inherited method provides software emulation of the event handler <var>OnKeyDown</var> which acts if a key has been pressed and is still down</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.KeyDown">TWinControl.KeyDown</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.KeyDown.Key">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.KeyDown.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.KeyUp">
|
||
<short>
|
||
<var>KeyUp</var> calls inherited method then performs specific actions depending on which key is being processed</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.KeyUp"/>
|
||
</p>
|
||
<p>The inherited method provides software emulation for the <var>OnKeyUp</var> event.</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.KeyUp">TWinControl.KeyUp</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.KeyUp.Key">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.KeyUp.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.KeyPress">
|
||
<short>
|
||
<var>KeyPress</var> adjusts character case if necessary then calls inherited method</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.KeyPress"/>
|
||
</p>
|
||
<p>The inherited method provides software emulation of the <var>OnKeyPress</var> event, which acts when a key is pressed. </p>
|
||
<p>The <var>OnKeyPress</var> event handler is usually provided by the application programmer as a specific action to be performed when the event occurs; it often contains a case statement or similar choice structure to divert execution along specific pathways in response to pressing different keys</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.KeyPress">TWinControl.KeyPress</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.KeyPress.Key">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomComboBox.MouseUp">
|
||
<short>
|
||
<var>MouseUp</var> calls inherited method then sets <var>AutoSelect</var> if left mouse button is clicked for the first time after receiving focus</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.MouseUp"/>
|
||
</p>
|
||
<p>The inherited method allows the programmer to simulate the action to be taken when the mouse is in the Up position over the specified control. It is usually a programmer-supplied method similar to the <var>OnMouseUp</var> event handler.</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.MouseUp">TControl.MouseUp</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.MouseUp.Button">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.MouseUp.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.MouseUp.X">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.MouseUp.Y">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomComboBox.SelectItem">
|
||
<short>
|
||
<var>SelectItem</var> - returns True if current item (specified by a string) is to be selected</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomComboBox.SelectItem.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.SelectItem.AnItem">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.DropDownCount">
|
||
<short>
|
||
<var>DropDownCount </var>
|
||
|
||
|
||
|
||
- number of entries in the drop-down list</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.ItemHeight">
|
||
<short>
|
||
<var>ItemHeight</var>
|
||
|
||
|
||
|
||
- the height of the current item in the drop-down list</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.ItemWidth">
|
||
<short>
|
||
<var>ItemWidth </var>
|
||
|
||
|
||
|
||
- the width of the current item in the drop-down list</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.MaxLength">
|
||
<short>
|
||
<var>MaxLength </var>
|
||
|
||
|
||
|
||
- the maximum allowed length of a string</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.OnChange">
|
||
<short>
|
||
<var>OnChange</var>
|
||
|
||
|
||
|
||
- event handler for any change in properties of the combo box</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.OnCloseUp">
|
||
<short>
|
||
<var>OnCloseUp</var>
|
||
|
||
|
||
|
||
- event handler for when the drop-down box is closed up again</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.OnDrawItem">
|
||
<short>
|
||
<var>OnDrawItem</var>
|
||
|
||
|
||
|
||
- event handler for when an entry is written to the <var>Items </var>list</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.OnDropDown">
|
||
<short>
|
||
<var>OnDropDown </var>
|
||
|
||
|
||
|
||
- event handler for when the drop-down list appears</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.OnGetItems">
|
||
<short>Event handler when items can be populated</short>
|
||
<descr>Some widgetsets like gtk call this just before the list drops down, while others do it on handle creation. This event allows to handle both cases with one event.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.OnMeasureItem">
|
||
<short>Event handler when measurement of an item is required</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.OnSelect">
|
||
<short>Event handler when an item or some text is selected</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomComboBox.Sorted">
|
||
<short>
|
||
<var>Sorted </var>
|
||
|
||
|
||
|
||
- whether the entries in the drop-down list have been sorted</short>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomComboBox.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomComboBox</var>: calls inherited <var>Create</var> then initialises styles, item lists, bounds and various other local variables</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- destructor Visibility: public -->
|
||
<element name="TCustomComboBox.Destroy">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Destroy</var> - destructor for <var>TCustomComboBox</var>: frees handles, itemlists, canvas and items then calls inherited <var>Destroy</var>
|
||
</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomComboBox.IntfGetItems">
|
||
<short>
|
||
<var>IntfGetItems</var> - gets list of items from the interface</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomComboBox.AddItem">
|
||
<short>
|
||
<var>AddItem </var>
|
||
|
||
|
||
|
||
- adds an Item to the list in the drop-down box</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.AddItem.Item">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.AddItem.AnObject">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomComboBox.AddHistoryItem">
|
||
<short>
|
||
<var>AddHistoryItem</var>
|
||
|
||
|
||
|
||
- Add an Item as first entry in History List</short>
|
||
<descr>
|
||
<p>
|
||
<var>AddHistoryItem</var>
|
||
|
||
|
||
|
||
- Add an Item as first entry in History List</p>
|
||
<p>Removes the Item from old position and removes last item if history is full</p>
|
||
</descr>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.AddHistoryItem.Item">
|
||
<short>The item to be addd to the list</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.AddHistoryItem.MaxHistoryCount">
|
||
<short>The maximum number of items that can be added to the history</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.AddHistoryItem.SetAsText">
|
||
<short>Whether the item is to be set as text</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.AddHistoryItem.CaseSensitive">
|
||
<short>Whether the item is added in a case sensitive manner (eg determines how they are sorted)</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.AddHistoryItem.AnObject">
|
||
<short>The history item to be added, expressed as an object</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomComboBox.Clear">
|
||
<short>
|
||
<var>Clear</var>
|
||
|
||
|
||
|
||
- remove all text and drop-down list</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomComboBox.ClearSelection">
|
||
<short>
|
||
<var>ClearSelection </var>
|
||
|
||
|
||
|
||
- clear the currently selected text or items from drop-down list</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.CharCase">
|
||
<short>
|
||
<var>CharCase:</var>
|
||
|
||
|
||
|
||
indicates whether text is to be displayed as Upper, Lower or Normal case (as entered)</short>
|
||
<descr>
|
||
<p>Indicates how text is displayed in a text editing control in the following ways:</p>
|
||
<ul>
|
||
<li>Normal case letters</li>
|
||
<li>Upper case letters</li>
|
||
<li>Lower case letters</li>
|
||
</ul>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.DroppedDown">
|
||
<short>
|
||
<var>DroppedDown </var>
|
||
|
||
|
||
|
||
- indicates whether or not the drop-down list has appeared</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomComboBox.MeasureItem">
|
||
<short>Measure the size (Height) of an item in the drop-down list</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.MeasureItem.Index">
|
||
<short>The index number of the item whose height is to be measured</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomComboBox.MeasureItem.TheHeight">
|
||
<short>The height as measured by the procedure</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomComboBox.SelectAll">
|
||
<short>Select all items in the list</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.AutoComplete">
|
||
<short>
|
||
<var>AutoComplete</var>
|
||
|
||
|
||
|
||
- enables the facility to offer suggestions for completing text-strings</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.AutoCompleteText">
|
||
<short>
|
||
<var>AutoCompleteText</var>
|
||
|
||
|
||
|
||
: Options for behavior of the Auto-Complete feature</short>
|
||
<descr>
|
||
<p>
|
||
<var>AutoCompleteText</var>
|
||
|
||
|
||
|
||
: Options for behavior of the <var>Auto-Complete</var> feature</p>
|
||
<ul>
|
||
<li>Enabled: Enable Auto-Completion feature.</li>
|
||
<li>EndOfLineComplete: Perform Auto-Complete only when cursor is at the end of the string.</li>
|
||
<li>RetainPrefixCase: Retains the case of characters user has typed. (This option has no effect if cbactEndOfLineComplete is False)</li>
|
||
<li>SearchCaseSensitive: Search completion string with case sensitivity.</li>
|
||
<li>cbactSearchAscending: Search completion string in accending order. (False will search in descending order)</li>
|
||
</ul>
|
||
<p>This property exists as a <var>Set</var> of <var>Options</var>, so zero or more options may be operational</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="TComboBoxAutoCompleteTextOption"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.AutoDropDown">
|
||
<short>
|
||
<var>AutoDropDown </var>
|
||
|
||
|
||
|
||
- if True, the drop-down list appears as soon as the cursor moves over the text box</short>
|
||
<descr>
|
||
<p>
|
||
<var>AutoDropDown </var>
|
||
|
||
|
||
|
||
- if True, the drop-down list appears as soon as the cursor moves over the text box</p>
|
||
<p>If False, the drop-down box only appears when the downward triangular indicator at the end of the box is selected</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.AutoSelect">
|
||
<short>
|
||
<var>AutoSelect</var>
|
||
|
||
|
||
|
||
: Boolean. If True, all contents of <var>Text</var> box are selected when control receives focus</short>
|
||
<descr>
|
||
<p>When True, the edit control will select all its text when:</p>
|
||
<ul>
|
||
<li>It receives focus</li>
|
||
<li>The Enter key is pressed.</li>
|
||
<li>A new item is selected.</li>
|
||
</ul>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.AutoSelected">
|
||
<short>
|
||
<var>AutoSelected</var>
|
||
|
||
|
||
|
||
: True indicates that the combobox control has just performed an <var>AutoSelect</var> operation</short>
|
||
<descr>
|
||
<p>True indicates that the combobox control has just performed an <var>AutoSelect</var> operation so that subsequent mouse-clicks and keystrokes
|
||
proceed normally without selecting the text.</p>
|
||
<p>False is set when the combobox control loses focus.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.ArrowKeysTraverseList">
|
||
<short>
|
||
<var>ArrowKeysTraverseList</var>
|
||
|
||
|
||
|
||
- enables the operator to use the keyboard Arrow keys to move through the list as an alternative to using the mouse</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.Canvas">
|
||
<short>
|
||
<var>Canvas</var>
|
||
|
||
|
||
|
||
- the area on which the components are drawn or painted</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.Items">
|
||
<short>
|
||
<var>Items </var>
|
||
|
||
|
||
|
||
- an array of strings that holds the entries of the drop-down list</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.ItemIndex">
|
||
<short>
|
||
<var>Index </var>
|
||
|
||
|
||
|
||
- the number of the currently selected item (starting at zero)</short>
|
||
<descr>
|
||
<p>
|
||
<var>Index </var>
|
||
|
||
|
||
|
||
- the number of the currently selected item</p>
|
||
<p>The first item has number 0, the second has number 1, the third number 2, etc. </p>
|
||
<p>In case no item is selected, ItemIndex
|
||
has value -1.</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="TCustomComboBox"/>
|
||
<link id="TCustomComboBox.Items"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.ReadOnly">
|
||
<short>
|
||
<var>ReadOnly </var>
|
||
|
||
|
||
|
||
- if True, information in the control can only be Read, not Written or Deleted</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.SelLength">
|
||
<short>
|
||
<var>SelLength </var>- the length of the text that has been selected in bytes</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.SelStart">
|
||
<short>
|
||
<var>SelStart </var>- if text is selected this is the starting position otherwise the cursor position in bytes starting at 0</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.SelText">
|
||
<short>
|
||
<var>SelText</var>
|
||
|
||
|
||
|
||
- the text string that has been selected for editing</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.Style">
|
||
<short>
|
||
<var>Style</var>
|
||
|
||
|
||
|
||
: may be Simple, a single-line Drop-Down or a Drop-Down list, or some version drawn by the Owner</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomComboBox.Text">
|
||
<short>
|
||
<var>Text</var>
|
||
|
||
|
||
|
||
- the string appearing in the main box. If an item on the drop-down list is selected, it replaces the contents of <var>Text</var>
|
||
</short>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCustomComboBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TComboBox">
|
||
<short>
|
||
<var>TComboBox </var>
|
||
|
||
|
||
|
||
- a simple combination of text box for free text entry, and a drop-down list allowing one of several options to be chosen.</short>
|
||
<descr>
|
||
<p>
|
||
<var>TComboBox </var>
|
||
|
||
|
||
|
||
- a simple combination of text box for free text entry, and a drop-down list allowing one of several options to be chosen.</p>
|
||
<p>The default text-string (if any, entered in the Form Designer) and the value of the text string that is ultimately selected from the drop-down list, is held in <var>Text</var>
|
||
</p>
|
||
<p>The values that can be selected from the drop-down list are held in the string-array <var>Items</var>. Clicking on the ellipsis (...) next to <var>Items</var> in the Object Inspector opens a pop-up string-list editor which allows the designer to enter and edit a number of lines of text to represent the selections</p>
|
||
<p>At run-time, the entry selected from the drop-down list in <var>Items</var> is used to replace any information previously found in <var>Text</var>, and <var>ItemIndex</var> holds the (zero-origin) index number of the selected item</p>
|
||
<p>If no value is selected from the drop-down list, the default text (if any) remains, or any information typed directly into <var>Text</var> will be returned, and <var>ItemIndex</var> takes the value of -1</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>Align the Control with other Controls in its vicinity
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>Anchors
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ArrowKeysTraverseList" link="#LCL.StdCtrls.TCustomComboBox.ArrowKeysTraverseList">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.AutoComplete" link="#LCL.StdCtrls.TCustomComboBox.AutoComplete"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.AutoCompleteText" link="#LCL.StdCtrls.TCustomComboBox.AutoCompleteText">
|
||
<seealso>
|
||
<link id="TComboBoxAutoCompleteTextOption"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.AutoDropDown" link="#LCL.StdCtrls.TCustomComboBox.AutoDropDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.AutoSelect" link="#LCL.StdCtrls.TCustomComboBox.AutoSelect"/>
|
||
<!-- property Visibility: published -->
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<element name="TComboBox.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.CharCase" link="#LCL.StdCtrls.TCustomComboBox.CharCase">
|
||
<descr>
|
||
<p>Indicates how text is displayed in a text editing control in the following ways:</p>
|
||
<ul>
|
||
<li>Normal case letters</li>
|
||
<li>Upper case letters</li>
|
||
<li>Lower case letters</li>
|
||
</ul>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Ctl3D" link="#LCL.Controls.TControl.Ctl3D">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.DropDownCount" link="#LCL.StdCtrls.TCustomComboBox.DropDownCount">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ItemHeight" link="#LCL.StdCtrls.TCustomComboBox.ItemHeight">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ItemIndex" link="#LCL.StdCtrls.TCustomComboBox.ItemIndex">
|
||
<descr>
|
||
<p>
|
||
<var>Index </var>
|
||
|
||
|
||
|
||
|
||
- the number of the currently selected item</p>
|
||
<p>The first item has number 0, the second has number 1, the third number 2, etc. </p>
|
||
<p>In case no item is selected, ItemIndex
|
||
has value -1.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Items" link="#LCL.StdCtrls.TCustomComboBox.Items">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ItemWidth" link="#LCL.StdCtrls.TCustomComboBox.ItemWidth">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.MaxLength" link="#LCL.StdCtrls.TCustomComboBox.MaxLength">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnChange" link="#LCL.StdCtrls.TCustomComboBox.OnChange">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads or Writes flag if bounds are changed</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.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 spcified 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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnCloseUp" link="#LCL.StdCtrls.TCustomComboBox.OnCloseUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnDrawItem" link="#LCL.StdCtrls.TCustomComboBox.OnDrawItem">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnDropDown" link="#LCL.StdCtrls.TCustomComboBox.OnDropDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnDropDown">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnMeasureItem" link="#LCL.StdCtrls.TCustomComboBox.OnMeasureItem">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.OnSelect" link="#LCL.StdCtrls.TCustomComboBox.OnSelect">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ParentCtl3D" link="#LCL.Controls.TWinControl.ParentCtl3D">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ReadOnly" link="#LCL.StdCtrls.TCustomComboBox.ReadOnly">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Sorted" link="#LCL.StdCtrls.TCustomComboBox.Sorted">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Style" link="#LCL.StdCtrls.TCustomComboBox.Style">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Text" link="#LCL.StdCtrls.TCustomComboBox.Text">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TComboBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TListBoxStyle">
|
||
<short>
|
||
<var>TListBoxStyle</var> - enumerated type for style of listbox</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TListBoxStyle.lbStandard">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TListBoxStyle.lbOwnerDrawFixed">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TListBoxStyle.lbOwnerDrawVariable">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure type Visibility: default -->
|
||
<element name="TSelectionChangeEvent">
|
||
<short>
|
||
<var>TSelectionChangeEvent</var> - generic procedure type for selection change event</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TSelectionChangeEvent.Sender">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TSelectionChangeEvent.User">
|
||
<short/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomListBox">
|
||
<short>
|
||
<var>TCustomList Box</var>
|
||
|
||
|
||
|
||
: the base class for <var>TListBox</var>
|
||
</short>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FCacheValid">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FCanvas">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FClickOnSelChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FClickTriggeredBySelectionChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FColumns">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FExtendedSelect">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FIntegralHeight">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FItemHeight">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FItemIndex">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FItems">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FLockSelectionChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FMultiSelect">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FOnDrawItem">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FOnMeasureItem">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FOnSelectionChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FSorted">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FStyle">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomListBox.FTopIndex">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomListBox.GetCount">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetCount.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomListBox.GetTopIndex">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetTopIndex.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.SetColumns">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetColumns.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.SetTopIndex">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetTopIndex.AValue">
|
||
<short/>
|
||
</element>
|
||
<element name="TCustomListBox.RaiseIndexOutOfBounds">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.RaiseIndexOutOfBounds.AIndex">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.BeginAutoDrag" link="#LCL.Controls.TControl.BeginAutoDrag">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetItemIndex.AIndex">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomListBox.ClearSelection">
|
||
<short>Clear the selected items</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.UpdateSelectionMode">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.UpdateSorted">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.LMDrawListItem">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.LMDrawListItem.TheMessage">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.LMMeasureItem">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.LMMeasureItem.TheMessage">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.LMSelChange">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.LMSelChange.TheMessage">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.WMLButtonUp" link="#LCL.Controls.TControl.WMLButtonUp">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.WMLButtonUp.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomListBox.SendItemSelected">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SendItemSelected.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SendItemSelected.IsSelected">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.AssignItemDataToCache">
|
||
<short>
|
||
<var>AssignItemDataToCache</var> - assigns data for the item, specified by a pointer <var>AData</var>, to a cache</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.AssignItemDataToCache.AIndex">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.AssignItemDataToCache.AData">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.AssignCacheToItemData">
|
||
<short>
|
||
<var>AssignCacheToItemData</var> - assigns the cache to the item data specified by the pointer <var>AData</var>
|
||
</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.AssignCacheToItemData.AIndex">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.AssignCacheToItemData.AData">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.Loaded">
|
||
<short>
|
||
<var>Loaded</var> calls inherited method then sends the item index value to the handle</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#rtl.Classes.TComponent.Loaded">TComponent.Loaded</link>
|
||
<link id="#LCL.Controls.TWinControl.Loaded">TWinControl.Loaded</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.InitializeWnd">
|
||
<short>
|
||
<var>InitializeWnd</var> calls inherited method then sets up the list of strings</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.FinalizeWnd">
|
||
<short>
|
||
<var>FinalizeWnd</var> frees the list of strings then calls inherited method</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomListBox.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> sets its own defaults, overriding inherited values</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.CheckIndex">
|
||
<short>
|
||
<var>CheckIndex</var> - check that the supplied index refers to valid data</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.CheckIndex.AIndex">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomListBox.GetItemHeight">
|
||
<short>
|
||
<var>GetItemHeight</var> - returns a value for the height of an item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetItemHeight.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomListBox.GetItemIndex">
|
||
<short>
|
||
<var>GetItemIndex</var> - returns an index value for the current list item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetItemIndex.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomListBox.GetSelCount">
|
||
<short>
|
||
<var>GetSelCount</var> - returns the number of selected items</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetSelCount.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomListBox.GetSelected">
|
||
<short>
|
||
<var>GetSelected</var> - returns True if the specified indexed item has been selected</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetSelected.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.GetSelected.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomListBox.GetCachedDataSize">
|
||
<short>
|
||
<var>GetCachedDataSize</var> - returns the amount of data needed per item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetCachedDataSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomListBox.GetCachedData">
|
||
<short>
|
||
<var>GetCachedData</var> - returns a pointer to the data corresponding to the supplied index</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetCachedData.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.GetCachedData.AIndex">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetExtendedSelect">
|
||
<short>
|
||
<var>SetExtendedSelect</var> - specifies a boolean indicator to show whether Extended Selection is permitted</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetExtendedSelect.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetItemIndex">
|
||
<short>
|
||
<var>SetItemIndex</var> - specifies an item index</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetItemIndex.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetItems">
|
||
<short>
|
||
<var>SetItems</var> - specifies the string values of the items</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetItems.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetItemHeight">
|
||
<short>
|
||
<var>SetItemHeight</var> - specifies the height of an item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetItemHeight.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetMultiSelect">
|
||
<short>
|
||
<var>SetMultiSelect</var> - specifies whether multiselect is permissible (ie select multiple entries by holding down Shift or Ctrl keys)</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetMultiSelect.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetSelected">
|
||
<short>
|
||
<var>SetSelected</var> - specifies the <var>Selected</var> property of the indexed item</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetSelected.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetSelected.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetSorted">
|
||
<short>
|
||
<var>SetSorted</var> - specifies whether the list is sorted</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetSorted.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SetStyle">
|
||
<short>
|
||
<var>SetStyle</var> - specifies the style of the listbox</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.SetStyle.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.DrawItem">
|
||
<short>
|
||
<var>DrawItem</var> - method to draw the nominated indexed item in the specified rectangle</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.DrawItem.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.DrawItem.ARect">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.DrawItem.State">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.DoSelectionChange">
|
||
<short>
|
||
<var>DoSelectionChange</var> - perform a change in the selection</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.DoSelectionChange.User">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomListBox.SendItemIndex">
|
||
<short>
|
||
<var>SendItemIndex</var> - transmit the item index to the system</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomListBox.OnMeasureItem">
|
||
<short>Event handler when an item requires to be measured</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomListBox.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomListBox</var>: calls inherited <var>Create</var> then initialises style, canvas, item list and various other local variables</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- destructor Visibility: public -->
|
||
<element name="TCustomListBox.Destroy">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Destroy</var>: destructor for <var>TCustomListBox</var>: frees canvas and item list, then calls inherited <var>Destroy</var>
|
||
</short>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomListBox.GetIndexAtY">
|
||
<short>Find the index at the Y coordinate</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetIndexAtY.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.GetIndexAtY.Y">
|
||
<short>The integer value of the Y coordinate</short>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomListBox.GetSelectedText">
|
||
<short>Get the selected text string</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.GetSelectedText.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomListBox.ItemAtPos">
|
||
<short>Returns the index value of the item at the specified position</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.ItemAtPos.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.ItemAtPos.Pos">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.ItemAtPos.Existing">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomListBox.ItemRect">
|
||
<short>Returns the coordinates of the rectangle in which the item lies</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.ItemRect.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.ItemRect.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomListBox.ItemVisible">
|
||
<short>Is the item with the specified index visible?</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.ItemVisible.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.ItemVisible.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomListBox.ItemFullyVisible">
|
||
<short>Is the item with the specified index fully visible (or is part of it outside the bounds of the visible window)?</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomListBox.ItemFullyVisible.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.ItemFullyVisible.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomListBox.MakeCurrentVisible">
|
||
<short>
|
||
<var>MakeCurrentVisible</var> - makes the current item visible</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomListBox.MeasureItem">
|
||
<short>Measure the height of the item in the list with the specified index</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.MeasureItem.Index">
|
||
<short>The index value of the item to be measured</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.MeasureItem.TheHeight">
|
||
<short>The height of the item as measured by the procedure</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomListBox.Clear">
|
||
<short>Clear the listbox - both the edit box and the drop-down list</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomListBox.LockSelectionChange">
|
||
<short>Lock ( make permanent) the change in the selection</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomListBox.UnlockSelectionChange">
|
||
<short>Unlock the previously locked change in selection</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomListBox.Click" link="#LCL.Controls.TControl.Click">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Canvas">
|
||
<short>
|
||
<var>Canvas</var>
|
||
|
||
|
||
|
||
- defines the area on which all graphic material is drawn</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.ClickOnSelChange">
|
||
<short>Performs Click procedure when the selection is changed (which usually puts the selected item into the edit box)</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Columns">
|
||
<short>
|
||
<var>Columns</var>
|
||
|
||
|
||
|
||
- the number of vertical columns in which the <var>Items</var> are arranged</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Count">
|
||
<short>
|
||
<var>Count</var> - the number of entries in the list of <var>Items</var>
|
||
</short>
|
||
<descr>
|
||
<p>
|
||
<var>Count</var> - the number of entries in the list of <var>Items</var>
|
||
</p>
|
||
<p>For Delphi compatability</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.ExtendedSelect">
|
||
<short>
|
||
<var>ExtendedSelect</var>
|
||
|
||
|
||
|
||
- boolean. Whether extended selection is allowed. Default True</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.IntegralHeight">
|
||
<short>not implemented</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.ItemHeight">
|
||
<short>
|
||
<var>ItemHeight </var>
|
||
|
||
|
||
|
||
- the height of the individual <var>Items</var>
|
||
</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.ItemIndex">
|
||
<short>
|
||
<var>ItemIndex:</var>
|
||
|
||
|
||
|
||
Integer to indicate the currently selected item (zero origin)</short>
|
||
<descr>Indicates the currently selected item. The first item has number 0,
|
||
the second has number 1, the third number 2, etc. In case no item is selected, ItemIndex
|
||
has value -1. If MultiSelect is True, ItemIndex represents the item which has focus, which
|
||
typically has a different color from the other items.</descr>
|
||
<seealso>
|
||
<link id="TCustomListBox"/>
|
||
<link id="TCustomListBox.Items"/>
|
||
<link id="TCustomListBox.MultiSelect"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Items">
|
||
<short>
|
||
<var>Items </var>
|
||
|
||
|
||
|
||
- an array of strings representing the list of entries</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.MultiSelect">
|
||
<short>
|
||
<var>MultiSelect</var>
|
||
|
||
|
||
|
||
- allows more than one Item from the list to be selected at a time, by pressing the CTRL or SHIFT key while selecting</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads or Writes flag if bounds are changed</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.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 spcified 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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnDrawItem">
|
||
<short>
|
||
<var>OnDrawItem</var>
|
||
|
||
|
||
|
||
- event handler for drawing an Item</short>
|
||
<descr>
|
||
<p>
|
||
<var>OnDrawItem</var>
|
||
|
||
|
||
|
||
- event handler for drawing an Item</p>
|
||
<p>For example, selecting an item may require it to be highlighted or have its font or background changed</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel"/>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown"/>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp"/>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads or Writes flag if control is re-sized.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.OnSelectionChange">
|
||
<short>
|
||
<var>OnSelectionChange</var>
|
||
|
||
|
||
|
||
- event handler for changing the <var>Item</var> selected</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.SelCount">
|
||
<short>The number of selected iems in the drop-down list</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Selected">
|
||
<short>
|
||
<var>Selected </var>
|
||
|
||
|
||
|
||
- whether the <var>Item</var> with given <var>Index</var> has been selected</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomListBox.Selected.Index">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Sorted">
|
||
<short>
|
||
<var>Sorted</var>
|
||
|
||
|
||
|
||
- whether the selected <var>Items</var> in the list have been arranged in alphabetical order</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Style">
|
||
<short>
|
||
<var>Style </var>
|
||
|
||
|
||
|
||
of List Box - normal, owner-draw fixed, or owner-draw variable</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.TopIndex">
|
||
<short>
|
||
<var>Topindex </var>- the highest value of Index in this list</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomListBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TListBox">
|
||
<short>
|
||
<var>TListBox</var>
|
||
|
||
|
||
|
||
: a simple string list from which a choice is made</short>
|
||
<descr>
|
||
<p>
|
||
<var>TListBox</var>
|
||
|
||
|
||
|
||
: a simple string list from which a choice is made</p>
|
||
<p>The array of strings is held in <var>Items</var>
|
||
</p>
|
||
<p>Clicking on the ellipsis (...) next to the <var>Items</var> entry in the Object Inspector at design-time opens a string-list editor in which the individual text-strings for the list can be entered or edited. The editor also allows the entries to be sorted alphabetically in normal or reverse order.</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.ClickOnSelChange" link="#LCL.StdCtrls.TCustomListBox.ClickOnSelChange">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Columns" link="#LCL.StdCtrls.TCustomListBox.Columns">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.ExtendedSelect" link="#LCL.StdCtrls.TCustomListBox.ExtendedSelect">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.IntegralHeight" link="#LCL.StdCtrls.TCustomListBox.IntegralHeight">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Items" link="#LCL.StdCtrls.TCustomListBox.Items">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.ItemHeight" link="#LCL.StdCtrls.TCustomListBox.ItemHeight">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.MultiSelect" link="#LCL.StdCtrls.TCustomListBox.MultiSelect">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads or Writes flag if bounds are changed</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.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 spcified 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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnDrawItem" link="#LCL.StdCtrls.TCustomListBox.OnDrawItem">
|
||
<descr>
|
||
<p>
|
||
<var>OnDrawItem</var>
|
||
|
||
|
||
|
||
- event handler for drawing an Item</p>
|
||
<p>For example, selecting an item may require it to be highlighted or have its font or background changed</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads or Writes flag if control is re-sized.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnSelectionChange" link="#LCL.StdCtrls.TCustomListBox.OnSelectionChange">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnShowHint" link="#LCL.Controls.TControl.OnShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads or Writes a flag when a hint (a small pop-up box, appearing when the mouse hovers over an object) is to be shown
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.OnStartDrag">
|
||
<short>Event handler for start of dragging process</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.ParentBidiMode">
|
||
<short>
|
||
<var>ParentBiDiMode</var> - does the control follow the BiDiMode settings of its parent?</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.ParentShowHint">
|
||
<short>
|
||
<var>ParentShowHint </var>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.TopIndex" link="#LCL.StdCtrls.TCustomListBox.TopIndex">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TListBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomEdit">
|
||
<short>
|
||
<var>TCustomEdit</var>
|
||
|
||
|
||
|
||
: the base type from which the <var>TEdit</var> Box is derived.</short>
|
||
<descr>
|
||
<p>
|
||
<var>TCustomEdit</var>
|
||
|
||
|
||
|
||
|
||
: the base type from which the <var>TEdit</var>
|
||
Box is derived.</p>
|
||
<p>This control deals, for example, with issues such as selection of text sub-strings within the whole text string which are to be edited (cut, pasted, deleted, highlighted etc)</p>
|
||
</descr>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FAutoSelect">
|
||
<short>FAutoSelect: Boolean</short>
|
||
<descr>
|
||
<p>Private variable for property AutoSelect.</p>
|
||
<p>When True, the edit control will select all its text when:</p>
|
||
<ul>
|
||
<li>It receives focus</li>
|
||
<li>The Enter key is pressed.</li>
|
||
<li>A new item is selected.</li>
|
||
</ul>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FAutoSelected">
|
||
<short>FAutoSelected: Boolean</short>
|
||
<descr>Private variable for property AutoSelected.
|
||
|
||
True indicate that the edit or combobox control has just performed
|
||
an AutoSelect opertation so that subsequent mouse-clicks and keystrokes
|
||
proceds normally without selecting the text.
|
||
|
||
False is set when the edit or combobox control loses focus.</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FCharCase">
|
||
<short>FCharCase: TEditCharCase</short>
|
||
<descr>
|
||
<p>Private variable for property CharCase.
|
||
|
||
Indicates how text is displayed in a text editing control.</p>
|
||
<ul>
|
||
<li>Normal case letters</li>
|
||
<li>Upper case letters</li>
|
||
<li>Lower case letters</li>
|
||
</ul>
|
||
</descr>
|
||
<seealso>
|
||
<link id="TEditCharCase"/>
|
||
<link id="TEditCharCase.ecNormal"/>
|
||
<link id="TEditCharCase.ecUppercase"/>
|
||
<link id="TEditCharCase.ecLowerCase"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FEchoMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FMaxLength">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FModified">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FPasswordChar">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FReadOnly">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FSelLength">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomEdit.FSelStart">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomEdit.GetModified">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomEdit.GetModified.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomEdit.SetCharCase">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetCharCase.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomEdit.SetMaxLength">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetMaxLength.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomEdit.SetModified">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetModified.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomEdit.SetPasswordChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetPasswordChar.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomEdit.SetReadOnly">
|
||
<short>
|
||
<var>SetReadOnly</var> - specifies whether <var>ReadOnly</var> applies</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetReadOnly.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.CalculatePreferredSize" link="#LCL.Controls.TControl.CalculatePreferredSize">
|
||
<descr>
|
||
<p>
|
||
<var>CalculatePreferredSize</var>
|
||
- find default/preferred height and width</p>
|
||
<p>procedure TControl.CalculatePreferredSize </p>
|
||
<p>(var PreferredWidth, PreferredHeight: integer; WithThemeSpace: Boolean);</p>
|
||
<p>Calculates the default/preferred width and height for a control, which is used
|
||
by the LCL autosizing algorithms as default size. Only positive values are
|
||
valid. Negative or 0 are treated as undefined and the LCL uses other sizes
|
||
instead.</p>
|
||
<p>
|
||
<var>TWinControl</var>
|
||
overrides this and asks the interface for theme dependent values.
|
||
See <link id="#lcl.Controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link> for more information.</p>
|
||
<p>WithThemeSpace: If true, adds space for stacking.</p>
|
||
<p>For example: <var>TRadioButton</var> has a minimum size. But for stacking multiple TRadioButtons there should be
|
||
some space around. This space is theme dependent, so the parameter is passed to the widgetset.</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.CalculatePreferredSize.PreferredWidth">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.CalculatePreferredSize.PreferredHeight">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.CalculatePreferredSize.WithThemeSpace">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.CreateWnd">
|
||
<short>CreateWnd - calls inherited <var>CreateWnd</var>, then initialises various properties relevant to the Widget Set in use</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.TextChanged" link="#LCL.Controls.TControl.TextChanged">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.Change">
|
||
<short>
|
||
<var>Change</var> - software emulation of the <var>OnChange</var> event</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.DoEnter">
|
||
<short>
|
||
<var>DoEnter</var> - sets <var>AutoSelect</var> if required then calls inherited method</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.DoEnter">TWinControl.DoEnter</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.DoExit">
|
||
<short>
|
||
<var>DoExit</var> - disables <var>AutoSelect</var> then calls inherited method</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.DoExit">TWinControl.DoExit</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomEdit.GetSelLength">
|
||
<short>
|
||
<var>GetSelLength</var> - returns the length of the selected text</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomEdit.GetSelLength.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomEdit.GetSelStart">
|
||
<short>
|
||
<var>GetSelStart</var> - returns the position of the start of the selection</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomEdit.GetSelStart.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomEdit.GetSelText">
|
||
<short>
|
||
<var>GetSelText</var> - returns the selected text string</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomEdit.GetSelText.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.SetEchoMode">
|
||
<short>
|
||
<var>SetEchoMode</var> - specifies the echo mode</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetEchoMode.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.SetSelLength">
|
||
<short>
|
||
<var>SetSelLength</var> - specifies the length for the selected text</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetSelLength.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.SetSelStart">
|
||
<short>
|
||
<var>SetSelStart</var> - specifies the position for the start of selection</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetSelStart.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.SetSelText">
|
||
<short>
|
||
<var>SetSelText</var> - specifies the selected text string</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.SetSelText.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.RealSetText" link="#LCL.Controls.TControl.RealSetText">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.RealSetText.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomEdit.ChildClassAllowed" link="#LCL.Controls.TWinControl.ChildClassAllowed">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomEdit.ChildClassAllowed.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.ChildClassAllowed.ChildClass">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomEdit.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> returns its own defaults, overriding inherited values</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomEdit.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.KeyUp">
|
||
<short>
|
||
<var>KeyUp</var> calls inherited method then processes according to the identity of <var>Key</var>
|
||
</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.KeyUp">TWinControl.KeyUp</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.KeyUp.Key">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.KeyUp.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.WMChar" link="#LCL.Controls.TWinControl.WMChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.WMChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomEdit.MouseUp" link="#LCL.Controls.TControl.MouseUp">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.MouseUp.Button">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.MouseUp.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.MouseUp.X">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.MouseUp.Y">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomEdit.AutoSelect">
|
||
<short>
|
||
<var>AutoSelect</var>
|
||
|
||
|
||
|
||
: if True, the edit control will select all its text when it receives focus or when the Enter key is pressed.</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomEdit.AutoSelected">
|
||
<short>
|
||
<var>AutoSelected</var>
|
||
|
||
|
||
|
||
: if True, indicates that the edit control has just performed an <var>AutoSelect</var> operation</short>
|
||
<descr>
|
||
<p>If True, indicates that the edit control has just performed an <var>AutoSelect</var> operation so that subsequent mouse-clicks and keystrokes proceed normally without selecting the text.</p>
|
||
<p>False is set when the edit control loses focus.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomEdit.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomEdit</var>: calls inherited <var>Create</var> then initialises style, colour, size and various other local variables</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomEdit.Create.AOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomEdit.Clear">
|
||
<short>
|
||
<var>Clear </var>
|
||
|
||
|
||
|
||
- delete all text</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomEdit.SelectAll">
|
||
<short>
|
||
<var>SelectAll</var>
|
||
|
||
|
||
|
||
text, for example in order to copy or delete it</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomEdit.ClearSelection">
|
||
<short>
|
||
<var>ClearSelection</var>
|
||
|
||
|
||
|
||
- delete all characters in selected text</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomEdit.CopyToClipboard">
|
||
<short>
|
||
<var>CopyToClipboard</var>
|
||
|
||
|
||
|
||
- put a copy of the selection on the clipboard, while leaving the original text in place</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomEdit.CutToClipboard">
|
||
<short>
|
||
<var>CutToClipboard</var>
|
||
|
||
|
||
|
||
- remove the selected text from its original location and put it on the clipboard</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomEdit.PasteFromClipboard">
|
||
<short>
|
||
<var>PasteFromClipboard </var>
|
||
|
||
|
||
|
||
- put a copy of the clipboard contents at the current writing position</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.CharCase">
|
||
<short>
|
||
<var>CharCase</var> - rules for what case to use (upper or lower) to display text</short>
|
||
<descr>
|
||
<p>Indicates how text is displayed in a text editing control in the following ways:</p>
|
||
<ul>
|
||
<li>Normal case letters</li>
|
||
<li>Upper case letters</li>
|
||
<li>Lower case letters</li>
|
||
</ul>
|
||
<p>The rules can, of course, be overridden by use of the shift key.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.EchoMode">
|
||
<short>
|
||
<var>EchoMode </var>
|
||
|
||
|
||
|
||
- how to echo keypresses on screen: normal (returning the actual character for that key), all upper or lower case, or a masking character as used in entering passwords</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.MaxLength">
|
||
<short>
|
||
<var>MaxLength</var>: maximum length allowed for text string</short>
|
||
<descr>MaxLength determines the maximum number of characters allowed in a TCustomEdit. When its value is 0, the user is allowed to enter any number of characters.
|
||
|
||
Unlike VCL, if a text set through the Text property has more characters then MaxLength it will be truncated. It's not possible to implement the VCL behavior due to characteristics of non win32 widgetsets.</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.Modified">
|
||
<short>Whether the text has been modified</short>
|
||
<descr>Modified: has the text been modified since creation?
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.OnChange">
|
||
<short>
|
||
<var>OnChange</var> - event handler for any change in text</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.PasswordChar">
|
||
<short>
|
||
<var>PasswordChar</var>
|
||
|
||
|
||
|
||
: the character which appears in the Edit box replacing and masking the actual character typed</short>
|
||
<descr>
|
||
<p>
|
||
<var>PasswordChar</var>
|
||
|
||
|
||
|
||
: the character which appears in the Edit box replacing and masking the actual character typed.</p>
|
||
<p>Typically used in password input, to prevent the typed characters from being seen by passers-by or casual observers (or even malicious observers!)</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.ReadOnly">
|
||
<short>
|
||
<var>ReadOnly </var>
|
||
|
||
|
||
|
||
- the contents of the edit box may only be read, not written or erased</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.SelLength">
|
||
<short>
|
||
<var>SelLength</var>
|
||
|
||
|
||
|
||
: the length (in characters) of the text that has been selected for editing</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.SelStart">
|
||
<short>
|
||
<var>Sel Start:</var>
|
||
|
||
|
||
|
||
the index of the character from which selection (for editing) begins</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.SelText">
|
||
<short>
|
||
<var>Sel Text</var>
|
||
|
||
|
||
|
||
: the string within the edit control that has been selected for editing</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomEdit.Text">
|
||
<short>
|
||
<var>Text</var>
|
||
|
||
|
||
|
||
: the character string contained in the Edit Box</short>
|
||
<descr>
|
||
<var>Text</var>
|
||
|
||
|
||
|
||
: the character string contained in the Edit Box</descr>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TMemoScrollbar">
|
||
<short>
|
||
<var>TMemoScrollBar</var>
|
||
|
||
|
||
|
||
- a Scroll Bar specifically for use in Memo Boxes</short>
|
||
<descr>Scroll Bar specifically for use in Memo Boxes. Inherits most of its properties from its ancestor, <link id="#lcl.Forms.TControlScrollBar">TControlScrollBar</link>
|
||
</descr>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TMemoScrollbar.GetHorzScrollBar" link="#LCL.Forms.TControlScrollBar.GetHorzScrollBar">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TMemoScrollbar.GetHorzScrollBar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TMemoScrollbar.GetVertScrollBar" link="#LCL.Forms.TControlScrollBar.GetVertScrollBar">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TMemoScrollbar.GetVertScrollBar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TMemoScrollbar.Increment" link="#LCL.Forms.TControlScrollBar.Increment">
|
||
<descr>The amount by which the scroll indicator moves if the triangle at either end of the bar is selected.<br/>
|
||
|
||
Read or write a flag to determine the increment, an integer with a default value of 8 (pixels)
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TMemoScrollbar.Page" link="#LCL.Forms.TControlScrollBar.Page">
|
||
<descr>The amount by which the scroll indicator moves if the cursor selects the scroll bar above, below or on either side of the scroll indicator. <br/>
|
||
Reads or writes a flag to determine paging increment; default value is 80 pixels
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TMemoScrollbar.Smooth" link="#LCL.Forms.TControlScrollBar.Smooth">
|
||
<descr>Reads or writes a flag to determine smooth scrolling, and sets a flag is the scrolling status is stored
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TMemoScrollbar.Position" link="#LCL.Forms.TControlScrollBar.Position">
|
||
<descr>Reads or writes a flag with the position; default is zero
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TMemoScrollbar.Range" link="#LCL.Forms.TControlScrollBar.Range">
|
||
<descr>Reads or writes a flag to determine the range; default is zero
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TMemoScrollbar.Size" link="#LCL.Forms.TControlScrollBar.Size">
|
||
<descr>Reads or writes a flag to determine the size; by default the size is not stored
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TMemoScrollbar.Visible" link="#LCL.Forms.TControlScrollBar.Visible">
|
||
<descr>Reads or writes flag to determine visibility, and sets a flag if the property is stored
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomMemo">
|
||
<short>
|
||
<var>TCustomMemo</var>
|
||
|
||
|
||
|
||
: the base class for <var>TMemo</var>
|
||
</short>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FAlignment">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FHorzScrollBar">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FLines">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FScrollBars">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FVertScrollBar">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FWantReturns">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FWantTabs">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomMemo.FWordWrap">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomMemo.SetHorzScrollBar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetHorzScrollBar.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomMemo.SetVertScrollBar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetVertScrollBar.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomMemo.StoreScrollBars">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomMemo.StoreScrollBars.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.CreateHandle">
|
||
<short>
|
||
<var>CreateHandle</var> calls inherited method then initialises <var>Lines</var>
|
||
</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.CreateHandle">TWinControl.CreateHandle</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.DestroyHandle">
|
||
<short>
|
||
<var>DestroyHandle</var> frees <var>Lines</var> then calls inherited method</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.DestroyHandle">TWinControl.DestroyHandle</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomMemo.RealGetText">
|
||
<short>
|
||
<var>RealGetText</var> - returns the contents of <var>Lines.Text</var> (overriding inherited method)</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.RealGetText">TControl.RealGetText</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomMemo.RealGetText.Result">
|
||
<short>Returns the value found in <var>Lines.Text</var>, the area allocated for storage of the textual data of the Memo.</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomMemo.RealGetText.Result"/>
|
||
</p>
|
||
<p>The result is of type <var>TCaption</var>, a string type for the caption of a control: may be translated</p>
|
||
</descr>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.RealSetText">
|
||
<short>
|
||
<var>RealSetText</var> - copies <var>Value</var> into <var>Lines.Text </var>(overriding inherited method)</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.RealSetText">TControl.RealSetText</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.RealSetText.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomMemo.GetCachedText" link="#LCL.Controls.TControl.GetCachedText">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomMemo.GetCachedText.Result">
|
||
<short>Returns a False result</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.GetCachedText.CachedText">
|
||
<short>The <var>CachedText</var> of type TCaption that is being fetched</short>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.SetAlignment">
|
||
<short>
|
||
<var>SetAlignment</var> - right or left justified, or centered</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetAlignment.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.SetLines">
|
||
<short>
|
||
<var>SetLines</var> - specify the text strings to occupy <var>Lines</var>
|
||
</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetLines.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.SetSelText" link="#LCL.StdCtrls.TCustomEdit.SetSelText">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetSelText.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.SetWantReturns">
|
||
<short>
|
||
<var>SetWantReturns</var> - sets a boolean flag showing that Return characters are to be included in the edit strings</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetWantReturns.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.SetWantTabs">
|
||
<short>
|
||
<var>SetWantTabs</var> - sets a boolean flag to show that the use of tabs in the edit string is required</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetWantTabs.NewWantTabs">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.SetWordWrap">
|
||
<short>
|
||
<var>SetWordWrap</var> - speifies the value of the <var>WordWrap</var> property</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetWordWrap.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.SetScrollBars">
|
||
<short>
|
||
<var>SetScrollBars</var> - specifies the style of the scroll bars</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.SetScrollBars.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.Loaded">
|
||
<short>
|
||
<var>Loaded</var> calls inherited method then sets the ScrollBar and WordWrap properties</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomMemo.Loaded"/>
|
||
</p>
|
||
<p>The <var>Loaded</var> method is called when a component has finished loading; the various ancestor classes copy properties from client and parent classes into the newly loaded component, and notify any child components of changes that have been made</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#rtl.Classes.TComponent.Loaded">TComponent.Loaded</link>
|
||
<link id="#LCL.Controls.TWinControl.Loaded">TWinControl.Loaded</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomMemo.WordWrapIsStored">
|
||
<short>
|
||
<var>WordWrapIsStored</var> - returns True if the WordWrap flag is stored</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomMemo.WordWrapIsStored.Result">
|
||
<short>The result of a test to see whether the property <var>WordWrap</var> has been stored</short>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.ControlKeyDown" link="#LCL.Controls.TWinControl.ControlKeyDown">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.ControlKeyDown.Key">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.ControlKeyDown.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomMemo.CNChar" link="#LCL.Controls.TWinControl.CNChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.CNChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomMemo.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> - makes its own defaults, overriding inherited method</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomMemo.GetControlClassDefaultSize.Result">
|
||
<short>Returns the default size, stored as a TPoint</short>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomMemo.Create">
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomMemo.Create"/>
|
||
</p>
|
||
<p>The various ancestor methods first create the object, then initialise sizes, styles, fonts and positions of subsidiary objects</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
<link id="#LCL.StdCtrls.TCustomEdit.Create">TCustomEdit.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomMemo</var>: calls inherited <var>Create</var> then initialises some variables, creates the stringlist and creates scrollbars</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.Create.AOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- destructor Visibility: public -->
|
||
<element name="TCustomMemo.Destroy">
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomMemo.Destroy"/>
|
||
</p>
|
||
<p>The ancestor destructor removes the resources that have been used, in a systematic and orderly way</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Destroy</var> - destructor for <var>TCustomMemo</var>: frees stringlist and scrollbars then calls inherited <var>Destroy</var>
|
||
</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomMemo.Append">
|
||
<short>
|
||
<var>Append</var>
|
||
|
||
|
||
|
||
- procedure for adding a text string to the Memo</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomMemo.Append.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.Alignment">
|
||
<short>
|
||
<var>Alignment </var>
|
||
|
||
|
||
|
||
- whether text is centered, left- or right-justified</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.Lines">
|
||
<short>
|
||
<var>Lines</var>
|
||
|
||
|
||
|
||
: an array of strings (single lines of characters) which contains the text held or being entered in the Memo</short>
|
||
<descr>
|
||
<var>Lines</var>
|
||
|
||
|
||
|
||
: an array of strings (representing single lines of characters) which contains the textual material held or being entered in the Memo. The array is zero-indexed, ie the strings are numbered [0..numLines-1]</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.HorzScrollBar">
|
||
<short>The horizontal scroll bar for this memo</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.VertScrollBar">
|
||
<short>The Vertical scroll bar for this memo</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.ScrollBars">
|
||
<short>Whether the <var>Memo </var>has <var>ScrollBars</var> - none, horizontal or vertical or both, or automatically placed if needed</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.WantReturns">
|
||
<short>Whether Return characters are required to be included in the memo</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.WantTabs">
|
||
<short>Whether Tab characters are required to be retained in the Memo</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomMemo.WordWrap">
|
||
<short>Is <var>WordWrap</var> enabled, allowing long words to be carried on to the next line?</short>
|
||
<descr>Word Wrap: a logical flag to show whether or not word-wrap is enabled, ie if a word is close to the end of a line and is going to be too long for the line, it is wrapped down to the next line
|
||
</descr>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TEdit">
|
||
<short>
|
||
<var>TEdit</var>
|
||
|
||
|
||
|
||
- an Edit Box: for entry or display of a single line of text.</short>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TEdit.AutoSelected" link="#LCL.StdCtrls.TCustomEdit.AutoSelected">
|
||
<descr>
|
||
<p>If True, indicates that the edit control has just performed an <var>AutoSelect</var> operation so that subsequent mouse-clicks and keystrokes proceed normally without selecting the text.</p>
|
||
<p>False is set when the edit control loses focus.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Action" link="#LCL.Controls.TControl.Action">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>The (default) action to be associated with this control</p>
|
||
<p>Can either read the action already associated with the control (GetAction), or write an action to be associated (SetAction)</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.AutoSelect" link="#LCL.StdCtrls.TCustomEdit.AutoSelect"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.CharCase" link="#LCL.StdCtrls.TCustomEdit.CharCase">
|
||
<descr>
|
||
<p>Indicates how text is displayed in a text editing control in the following ways:</p>
|
||
<ul>
|
||
<li>Normal case letters</li>
|
||
<li>Upper case letters</li>
|
||
<li>Lower case letters</li>
|
||
</ul>
|
||
<p>The rules can, of course, be overridden by use of the shift key.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.EchoMode" link="#LCL.StdCtrls.TCustomEdit.EchoMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.MaxLength" link="#LCL.StdCtrls.TCustomEdit.MaxLength">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnChange" link="#LCL.StdCtrls.TCustomEdit.OnChange"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads or Writes flag if bounds are changed</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.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 spcified 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>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnExit" link="#LCL.Controls.TWinControl.OnExit"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads or Writes flag if control is re-sized.
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.PasswordChar" link="#LCL.StdCtrls.TCustomEdit.PasswordChar">
|
||
<descr>
|
||
<p>
|
||
<var>PasswordChar</var>
|
||
|
||
|
||
|
||
: the character which appears in the Edit box replacing and masking the actual character typed.</p>
|
||
<p>Typically used in password input, to prevent the typed characters from being seen by passers-by or casual observers (or even malicious observers!)</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.ReadOnly" link="#LCL.StdCtrls.TCustomEdit.ReadOnly"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Text" link="#LCL.StdCtrls.TCustomEdit.Text">
|
||
<descr>
|
||
<var>Text</var>
|
||
|
||
|
||
|
||
: the character string contained in the Edit Box
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TEdit.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TMemo">
|
||
<short>
|
||
<var>TMemo</var>
|
||
|
||
|
||
|
||
- a box for entry or display of multiple lines of text</short>
|
||
<descr>
|
||
<p>
|
||
<var>TMemo</var>
|
||
|
||
|
||
|
||
- a box for entry or display of multiple lines of text.</p>
|
||
<p>The textual data is held as an array of strings in <var>Lines</var>, where it can be edited</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Alignment" link="#LCL.StdCtrls.TCustomMemo.Alignment">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Lines" link="#LCL.StdCtrls.TCustomMemo.Lines">
|
||
<descr>
|
||
<var>Lines</var>
|
||
|
||
|
||
|
||
: an array of strings (representing single lines of characters) which contains the textual material held or being entered in the Memo. The array is zero-indexed, ie the strings are numbered [0..numLines-1]
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.MaxLength" link="#LCL.StdCtrls.TCustomEdit.MaxLength">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnChange" link="#LCL.StdCtrls.TCustomEdit.OnChange">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.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 spcified 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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.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>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.ReadOnly" link="#LCL.StdCtrls.TCustomEdit.ReadOnly">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.ScrollBars" link="#LCL.StdCtrls.TCustomMemo.ScrollBars">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>
|
||
<p>Reads or writes boolean flag; default is False</p>
|
||
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
||
<p>If <var>TabStop</var> is True, the control is in the tab order. If <var>TabStop</var> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.WantReturns" link="#LCL.StdCtrls.TCustomMemo.WantReturns">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.WantTabs" link="#LCL.StdCtrls.TCustomMemo.WantTabs">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TMemo.WordWrap" link="#LCL.StdCtrls.TCustomMemo.WordWrap">
|
||
<descr>Word Wrap: a logical flag to show whether or not word-wrap is enabled, ie if a word is close to the end of a line and is going to be too long for the line, it is wrapped down to the next line
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TStaticBorderStyle">
|
||
<short>
|
||
<var>TStaticBorderStyle</var> - enumerated type for border of static text: none, single or sunken</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TStaticBorderStyle.sbsNone">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TStaticBorderStyle.sbsSingle">
|
||
<short/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TStaticBorderStyle.sbsSunken">
|
||
<short/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomStaticText">
|
||
<short>
|
||
<var>TCustomStaticText</var>
|
||
|
||
|
||
|
||
: the base class for <var>Static Text</var>
|
||
</short>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomStaticText.FAlignment"/>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomStaticText.FFocusControl">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomStaticText.FShowAccelChar">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomStaticText.FStaticBorderStyle">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomStaticText.SetAlignment">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.SetAlignment.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomStaticText.SetStaticBorderStyle">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.SetStaticBorderStyle.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomStaticText.WMActivate">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.WMActivate.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomStaticText.GetLabelText">
|
||
<short>
|
||
<var>GetLabelText</var> - returns text string for label</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomStaticText.GetLabelText.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomStaticText.RealSetText">
|
||
<short>
|
||
<var>RealSetText</var> - calls inherited method then adjusts size</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.RealSetText">TControl.RealSetText</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.RealSetText.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomStaticText.Notification" link="#LCL.Controls.TControl.Notification">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.Notification.AComponent">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.Notification.Operation">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomStaticText.SetFocusControl">
|
||
<short>
|
||
<var>SetFocusControl</var> - specifies which control has focus</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.SetFocusControl.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomStaticText.SetShowAccelChar">
|
||
<short>
|
||
<var>SetShowAccelChar</var> - sets boolean flag to determine whether accelerator characters are to be shown</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.SetShowAccelChar.Val">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomStaticText.DialogChar" link="#LCL.Controls.TControl.DialogChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomStaticText.DialogChar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.DialogChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomStaticText.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> returns its own defaults, overriding inherited values</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomStaticText.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomStaticText.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomStaticText</var>: calls inherited <var>Create</var> the initialises style, alignment and bounds</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomStaticText.Create.AOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomStaticText.Alignment">
|
||
<short>
|
||
<var>Alignment </var>
|
||
|
||
|
||
|
||
- whether text is centered, left- or right-justified</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomStaticText.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomStaticText.FocusControl">
|
||
<short>
|
||
<var>FocusControl</var> - the control that currently receives focus</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomStaticText.ShowAccelChar">
|
||
<short>
|
||
<var>ShowAccelChar</var>
|
||
|
||
|
||
|
||
- underline the character in the static text that acts as an accelerator with a shortcut key</short>
|
||
<descr>
|
||
<p>
|
||
<var>ShowAccelChar</var>
|
||
|
||
|
||
|
||
- underline the character in the static text that acts as an accelerator with a shortcut key</p>
|
||
<p>Boolean property - default True</p>
|
||
</descr>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TStaticText">
|
||
<short>
|
||
<var>TStaticText</var>
|
||
|
||
|
||
|
||
: a box to display a Constant Text String</short>
|
||
<descr>
|
||
<p>
|
||
<var>TStaticText</var>
|
||
|
||
|
||
|
||
: a box to display a Constant Text String</p>
|
||
<p>Use this control to display a statement or comment that is not likely to change very often, or is not usually responsive to user actions</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Alignment" link="#LCL.StdCtrls.TCustomStaticText.Alignment">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Caption" link="#LCL.Controls.TControl.Caption">
|
||
<descr>
|
||
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
|
||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||
and the developer needs to set it explicitly to some new text.</p>
|
||
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
|
||
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
|
||
introduced. These functions interface with the LCLInterface. </p>
|
||
<p>The default <var>Get/SetTextBuf</var> implementation calls the <var>RealGet/SetText</var>. As long as the <var>Get/SetTextBuf</var> isn't overridden <var>Get/SetText</var> calls <var>RealGet/SetText</var> to avoid PChar copying.</p>
|
||
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.FocusControl" link="#LCL.StdCtrls.TCustomStaticText.FocusControl">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Font" link="#LCL.Controls.TControl.Font">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnClick" link="#LCL.Controls.TControl.OnClick">
|
||
<descr>On Click - Action to be taken when the mouse button is clicked with the cursor over this control. User-defined Procedure
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
|
||
<descr>On Double-click - Action to be taken when the mouse button is double-clicked while the cursor is over the control. User-defined Procedure
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<descr>On Mouse Down - Action to be taken when the mouse button is down while the cursor is over this control. User-defined Procedure
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
||
<descr>On Mouse Entry - Action to be taken when the mouse cursor enters the bounds of this control. User-defined Procedure
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
||
<descr>On Mouse Leaving - Action to be taken when the mouse cursor leaves the boundaries of this control. User-defined Procedure.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<descr>On Mouse Movement - Action to be taken if the mouse cursor moves within the bounds of this control. User-defined Procedure
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<descr>On Mouse Up - Action to be taken if the mouse button is up while the cursor is over this control.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<descr>On Resize - Action to be taken when the control is resized. Might include re-alignment of text or selection of a different font size etc. User-defined Procedure
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.ShowAccelChar" link="#LCL.StdCtrls.TCustomStaticText.ShowAccelChar">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TStaticText.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>Visible - determines whether or not the control can be seen
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TButtonControl">
|
||
<short>
|
||
<var>TButtonControl</var>
|
||
|
||
|
||
|
||
: ancestor class for several Button (including Radio Button) and Check Box classes</short>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TButtonControl.FClicksDisabled">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TButtonControl.FOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TButtonControl.FUseOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TButtonControl.IsCheckedStored">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TButtonControl.IsCheckedStored.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TButtonControl.UseOnChangeIsStored">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TButtonControl.UseOnChangeIsStored.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- variable Visibility: protected -->
|
||
<element name="TButtonControl.fLastCheckedOnChange">
|
||
<short>
|
||
<var>fLastCheckedOnChange</var> - local boolean variable to show whether the button was checked at the last <var>OnChange</var> event</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TButtonControl.GetChecked">
|
||
<short>
|
||
<var>GetChecked</var> - returns True if the button is checked</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TButtonControl.GetChecked.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TButtonControl.SetChecked">
|
||
<short>
|
||
<var>SetChecked</var> - specifies whether or not the button is checked</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TButtonControl.SetChecked.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TButtonControl.DoOnChange">
|
||
<short>
|
||
<var>DoOnChange</var> - perform the code of the <var>OnChange</var> event</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TButtonControl.Click" link="#LCL.Controls.TControl.Click">
|
||
<descr>
|
||
<p>
|
||
<var>Click </var>
|
||
|
||
|
||
|
||
- the procedure which allows programmatic simulation of a mouse click, and thus activation of the <var>Action</var> associated with the <var>OnClick</var> event
|
||
</p>
|
||
</descr>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TButtonControl.ColorIsStored" link="#LCL.Controls.TControl.ColorIsStored">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TButtonControl.ColorIsStored.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TButtonControl.Loaded" link="#LCL.Controls.TWinControl.Loaded">
|
||
<descr>
|
||
<p>
|
||
<var>Loaded</var> is called by the streaming system when a root
|
||
component was completely read from a stream and all properties and
|
||
references to other objects have been resolved by the streaming
|
||
system. Descendents of <var>TComponent</var> should override this method to
|
||
do some additional processing of properties after all published
|
||
properties have been set from values obtained from the stream.
|
||
</p>
|
||
<p>Application programmers should never call <var>Loaded</var> directly, this
|
||
is done automatically by the streaming system.
|
||
</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TButtonControl.Checked">
|
||
<short>
|
||
<var>Checked</var>
|
||
|
||
|
||
|
||
- whether this button has been checked, which signifies selection</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TButtonControl.ClicksDisabled">
|
||
<short>
|
||
<var>ClicksDisabled</var> - if True, clicks are disabled for this button control</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TButtonControl.UseOnChange">
|
||
<short>
|
||
<var>UseOnChange</var> - if true, this control is to be used if any change occurs</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TButtonControl.OnChange">
|
||
<short>
|
||
<var>OnChange </var>
|
||
|
||
|
||
|
||
- event handler for any change in properties of the control</short>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TButtonControl.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TButtonControl</var>: calls inherited <var>Create</var> then initialises style</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TButtonControl.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TButtonActionLink">
|
||
<short>
|
||
<var>TButtonActionLink</var>
|
||
|
||
|
||
|
||
- provides a link between a button and its corresponding action</short>
|
||
<descr>
|
||
<p>
|
||
<var>TButtonActionLink</var>
|
||
|
||
|
||
|
||
- provides a link between a button and its corresponding action</p>
|
||
<p>This class provides very few properties of its own, but inherits a lot from its ancestors, <link id="#lcl.Controls.TWinControlActionLink">TWinControlActionLink</link>, <link id="#lcl.Controls.TControlActionLink">TControlActionLink</link>, <link id="#lcl.ActnList.TActionLink">TActionLink</link> and <link id="#rtl.Classes.TBasicActionLink">TBasicActionLink</link>
|
||
</p>
|
||
</descr>
|
||
</element>
|
||
<!-- variable Visibility: protected -->
|
||
<element name="TButtonActionLink.FClientButton">
|
||
<short>
|
||
<var>FClientButton</var> - local variable showing the button to which this action applies</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TButtonActionLink.AssignClient">
|
||
<short>
|
||
<var>AssignClient</var> calls inherited method then sets up client as a ButtonControl</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#rtl.Classes.TBasicActionLink.AssignClient">TBasicActionLink.AssignClient</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TButtonActionLink.AssignClient.AClient">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TButtonActionLink.IsCheckedLinked" link="#LCL.ActnList.TActionLink.IsCheckedLinked">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TButtonActionLink.IsCheckedLinked.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TButtonActionLink.SetChecked">
|
||
<short>
|
||
<var>SetChecked</var> - writes Checked status of button to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.ActnList.TActionLink.SetChecked">TActionLink.SetChecked</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TButtonActionLink.SetChecked.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- "class of" type Visibility: default -->
|
||
<element name="TButtonActionLinkClass">
|
||
<short>
|
||
<var>TButtonActionLinkClass</var> - class of <var>TButtonActionLink</var>
|
||
</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomButton">
|
||
<short>
|
||
<var>TCustomButton</var> - the base class for <var>TButton</var> and <var>TBitBtn</var>
|
||
</short>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomButton.FCancel">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomButton.FDefault">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomButton.FActive">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomButton.FModalResult">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomButton.FShortCut">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomButton.SetCancel">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.SetCancel.NewCancel">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomButton.SetDefault">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.SetDefault.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomButton.SetModalResult">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.SetModalResult.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomButton.CMUIActivate">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.CMUIActivate.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomButton.WMDefaultClicked">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.WMDefaultClicked.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomButton.WMKillFocus">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.WMKillFocus.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.Click">
|
||
<descr>
|
||
<p>
|
||
<var>Click </var>
|
||
|
||
|
||
|
||
- the procedure which allows programmatic simulation of a mouse click, and thus activation of the <var>Action</var> associated with the <var>OnClick</var> event
|
||
</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.Click">TControl.Click</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Click</var> - checks if the parent form has a Modal Result, then calls inherited method</short>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.CreateWnd">
|
||
<short>
|
||
<var>CreateWnd</var> calls inherited method and sets default Widget Set</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.ControlKeyDown" link="#LCL.Controls.TWinControl.ControlKeyDown">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.ControlKeyDown.Key">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.ControlKeyDown.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.ControlKeyUp" link="#LCL.Controls.TWinControl.ControlKeyUp">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.ControlKeyUp.Key">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.ControlKeyUp.Shift">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.SetParent" link="#LCL.Controls.TControl.SetParent">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.SetParent.AParent">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomButton.DialogChar" link="#LCL.Controls.TControl.DialogChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomButton.DialogChar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.DialogChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomButton.ChildClassAllowed" link="#LCL.Controls.TWinControl.ChildClassAllowed">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomButton.ChildClassAllowed.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.ChildClassAllowed.ChildClass">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomButton.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> returns its own defaults, overriding the inherited values</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomButton.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomButton.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.TextChanged" link="#LCL.Controls.TControl.TextChanged">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomButton.UseRightToLeftAlignment" link="#LCL.Controls.TControl.UseRightToLeftAlignment">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomButton.UseRightToLeftAlignment.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.WSSetDefault">
|
||
<short>
|
||
<var>WSSetDefault</var> - writes the default widget set to local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomButton.WSSetText">
|
||
<short>
|
||
<var>WSSetText</var> - writes the text name of the widget set to a local variable</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.WSSetText.AText">
|
||
<short/>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomButton.Create">
|
||
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomButton</var>: calls inherited <var>Create</var> then initialises style, colour, bounds, alignment and various other properties</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomButton.ExecuteDefaultAction">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.ExecuteDefaultAction">TControl.ExecuteDefaultAction</link>
|
||
</seealso>
|
||
<short>
|
||
<var>ExecuteDefaultAction</var> if the control is active or default, executes the <var>Click</var> action</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomButton.ExecuteCancelAction">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.ExecuteCancelAction">TControl.ExecuteCancelAction</link>
|
||
</seealso>
|
||
<short>
|
||
<var>ExecuteCancelAction</var> if this is a <var>Cancel</var> button, executes the <var>Click</var> action</short>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomButton.ActiveDefaultControlChanged" link="#LCL.Controls.TControl.ActiveDefaultControlChanged">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomButton.ActiveDefaultControlChanged.NewControl">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomButton.UpdateRolesForForm" link="#LCL.Controls.TControl.UpdateRolesForForm">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomButton.Active">
|
||
<short>Is this control <var>Active </var>- has it got Focus; is the mouse over it?</short>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomButton.Default">
|
||
<short>Is this the Default button? (default setting is False)</short>
|
||
<descr>
|
||
<p>Defines if a button is the <var>Default</var> on a form. That is, pressing ENTER will execute its onClick method, whether the control has focus or not!</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomButton.ModalResult">
|
||
<short>Determines whether the button closes its modal parent form.</short>
|
||
<descr>The default value is <link id="controls.mrNone">mrNone</link>.</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomButton.Cancel">
|
||
<short>Is this the Cancel button? (default setting is False)</short>
|
||
<descr>
|
||
<p>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to <link id="controls.mrCancel">mrCancel</link>.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomButton.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomButton.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TButton"/>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TButton.Click" link="#LCL.Controls.TControl.Click">
|
||
<descr>If you want to programmatically Click on a button you can call its Click method. This will have the same effect as a user clicking on the button.
|
||
</descr>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Action" link="#LCL.Controls.TControl.Action">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>The (default) action to be associated with this control</p>
|
||
<p>Can either read the action already associated with the control (GetAction), or write an action to be associated (SetAction)</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Cancel" link="#LCL.StdCtrls.TCustomButton.Cancel">
|
||
<descr>
|
||
<p>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Caption" link="#LCL.Controls.TControl.Caption">
|
||
<descr>
|
||
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
|
||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||
and the developer needs to set it explicitly to some new text.</p>
|
||
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
|
||
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
|
||
introduced. These functions interface with the LCLInterface. </p>
|
||
<p>The default <var>Get/SetTextBuf</var> implementation calls the <var>RealGet/SetText</var>. As long as the <var>Get/SetTextBuf</var> isn't overridden <var>Get/SetText</var> calls <var>RealGet/SetText</var> to avoid PChar copying.</p>
|
||
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Default" link="#LCL.StdCtrls.TCustomButton.Default">
|
||
<descr>
|
||
<p>Defines if a button is the <var>Default</var> on a form. That is, pressing ENTER will execute its onClick method, whether the control has focus or not!</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.ModalResult" link="#LCL.StdCtrls.TCustomButton.ModalResult">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads or Writes flag if bounds are changed</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.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 spcified 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>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnExit" link="#LCL.Controls.TWinControl.OnExit"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyDown</var>
|
||
- event handler for instance when key is down while control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyPress</var>
|
||
- event controller for a key being pressed while the control has focus</p>
|
||
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
||
<descr>
|
||
<p>
|
||
<var>OnKeyUp</var>
|
||
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
||
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads or Writes flag if control is re-sized.
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<descr>Reads or writes information in flag; default is -1
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.TabStop" link="#LCL.Controls.TWinControl.TabStop"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TButton.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
</element>
|
||
<!-- enumeration type Visibility: default -->
|
||
<element name="TCheckBoxState">
|
||
<short>
|
||
<var>TCheckBoxState</var> - enumerated type for state of checkbox</short>
|
||
<descr>Check Box State: an enumerated list of constants defining the possible states of a Check Box -
|
||
Unchecked, Checked or Greyed
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TCheckBoxState.cbUnchecked">
|
||
<short/>
|
||
<descr>The check box has no check mark, indicating that the user has not selected the option.</descr>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TCheckBoxState.cbChecked">
|
||
<short/>
|
||
<descr>The check box has a check mark in it, indicating that the user has selected the option.</descr>
|
||
</element>
|
||
<!-- enumeration value Visibility: default -->
|
||
<element name="TCheckBoxState.cbGrayed">
|
||
<short/>
|
||
<descr>The check box has a check mark in it, but it is grayed.</descr>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomCheckBox">
|
||
<short>
|
||
<var>TCustomCheckBox </var>
|
||
|
||
|
||
|
||
is the ancestor of all check-box components.</short>
|
||
<descr>
|
||
<p>
|
||
<var>TCustomCheckBox</var>
|
||
|
||
|
||
|
||
: The base (abstract) class from which the <var>TCheckBox </var>is derived.</p>
|
||
<p>Check boxes present the user with options that can be selected (checked) or deselected (unchecked).</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="TCheckBox"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomCheckBox.FAllowGrayed">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomCheckBox.FState">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomCheckBox.FShortCut">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomCheckBox.SetState">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomCheckBox.SetState.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: private -->
|
||
<element name="TCustomCheckBox.GetState">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomCheckBox.GetState.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomCheckBox.DoChange">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomCheckBox.DoChange.Msg">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.Click" link="#LCL.Controls.TControl.Click">
|
||
<descr>
|
||
<p>
|
||
<var>Click </var>
|
||
|
||
|
||
|
||
- the procedure which allows programmatic simulation of a mouse click, and thus activation of the <var>Action</var> associated with the <var>OnClick</var> event
|
||
</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomCheckBox.RetrieveState">
|
||
<short>
|
||
<var>RetrieveState</var> - returns the value for check box state</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomCheckBox.RetrieveState.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.TextChanged" link="#LCL.Controls.TControl.TextChanged">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.InitializeWnd">
|
||
<short>
|
||
<var>InitializeWnd</var> calls inherited method and applies any changes</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.Toggle">
|
||
<short>
|
||
<var>Toggle</var> - method to alternate between checked and unchecked states on successive activations</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomCheckBox.DialogChar" link="#LCL.Controls.TControl.DialogChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomCheckBox.DialogChar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomCheckBox.DialogChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomCheckBox.GetChecked" link="#LCL.StdCtrls.TButtonControl.GetChecked">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomCheckBox.GetChecked.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.SetChecked" link="#LCL.StdCtrls.TButtonControl.SetChecked">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomCheckBox.SetChecked.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.RealSetText" link="#LCL.Controls.TControl.RealSetText">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomCheckBox.RealSetText.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.ApplyChanges">
|
||
<short>
|
||
<var>ApplyChanges</var> - method for applying specified changes</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomCheckBox.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> - returns its own defaults, overriding the inherited values</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomCheckBox.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.Loaded">
|
||
<short>
|
||
<var>Loaded</var> - sends the State of the box to the interface before calling inherited method</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#rtl.Classes.TComponent.Loaded">TComponent.Loaded</link>
|
||
<link id="#LCL.Controls.TWinControl.Loaded">TWinControl.Loaded</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomCheckBox.WSSetText" link="#LCL.Controls.TWinControl.WSSetText">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomCheckBox.WSSetText.AText">
|
||
<short/>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomCheckBox.Create">
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomCheckBox</var>: calls inherited <var>Create</var> then initialises style, and state, bounds, tabstop and autosize</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomCheckBox.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomCheckBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomCheckBox.AllowGrayed">
|
||
<short>Determines whether the check box can be in a "grayed" state.</short>
|
||
<descr>
|
||
<p>If <var>AllowGrayed</var> is set to True, the check box has three possible states: checked, unchecked and grayed. If <var>AllowGrayed</var> is set to False, the check box has only two possible states: checked and unchecked.</p>
|
||
</descr>
|
||
<example file="stdctrls/tcustomcheckbox_allowgrayed.pas"/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomCheckBox.State">
|
||
<short>Indicates whether the check box is checked (selected), unchecked (deselected) or grayed.</short>
|
||
<descr>
|
||
<p>See <link id="#lcl.StdCtrls.TCheckBoxState">TCheckBoxState</link> for possible values of <var>State</var>.</p>
|
||
</descr>
|
||
<example file="stdctrls/tcustomcheckbox_allowgrayed.pas"/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomCheckBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<descr>Use the TabStop to allow or disallow access to the control using the Tab key.
|
||
|
||
If the TabStop is True, the control is in the tab order. If TabStop is False, the control is not in the tab order and the user can't press the Tab key to move to the control.
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomCheckBox.UseOnChange" link="#LCL.StdCtrls.TButtonControl.UseOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomCheckBox.OnChange" link="#LCL.StdCtrls.TButtonControl.OnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCheckBox">
|
||
<short>
|
||
<var>TCheckBox</var>
|
||
|
||
|
||
|
||
- a small box which can contain a check mark to indicate that it has been selected by a mouse click</short>
|
||
<descr>
|
||
<p>
|
||
<var>TCheckBox</var>
|
||
|
||
|
||
|
||
: a small box which can contain a check mark to indicate that it has been selected by a mouse click. May be associated with a <var>Caption</var> that describes its function.</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Action" link="#LCL.Controls.TControl.Action"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Align" link="#LCL.Controls.TControl.Align"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.AllowGrayed" link="#LCL.StdCtrls.TCustomCheckBox.AllowGrayed"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Anchors" link="#LCL.Controls.TControl.Anchors"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Caption" link="#LCL.Controls.TControl.Caption"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Checked" link="#LCL.StdCtrls.TButtonControl.Checked"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Color" link="#LCL.Controls.TControl.Color">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Constraints" link="#LCL.Controls.TControl.Constraints"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.DragKind" link="#LCL.Controls.TControl.DragKind">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Enabled" link="#LCL.Controls.TControl.Enabled"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Font" link="#LCL.Controls.TControl.Font">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Hint" link="#LCL.Controls.TControl.Hint"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnChange" link="#LCL.StdCtrls.TButtonControl.OnChange"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnClick" link="#LCL.Controls.TControl.OnClick"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnExit" link="#LCL.Controls.TWinControl.OnExit"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnResize" link="#LCL.Controls.TControl.OnResize"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.ShowHint" link="#LCL.Controls.TControl.ShowHint"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.State" link="#LCL.StdCtrls.TCustomCheckBox.State">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.UseOnChange" link="#LCL.StdCtrls.TButtonControl.UseOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TCheckBox.Visible" link="#LCL.Controls.TControl.Visible"/>
|
||
<!-- object Visibility: default -->
|
||
<element name="TToggleBox">
|
||
<short>
|
||
<var>TToggle Box</var>
|
||
|
||
|
||
|
||
: a labelled box capable of being checked or unchecked</short>
|
||
<descr>
|
||
<p>
|
||
<var>TToggle Box</var>
|
||
|
||
|
||
|
||
: a labelled box capable of being checked (when it becomes recessed) or unchecked (when it is raised).</p>
|
||
<p>The Application Programmer is responsible for ensuring that the <var>OnClick</var> event handler recognises the <var>State</var> of the box, takes the appropriate <var>Action</var> and places the <var>State</var> into the next appropriate value</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TToggleBox.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.StdCtrls.TCustomCheckBox.Create">TCustomCheckBox.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TToggleBox</var>: calls inherited <var>Create</var> then initialises style and makes autosize False</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TToggleBox.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.AllowGrayed" link="#LCL.StdCtrls.TCustomCheckBox.AllowGrayed">
|
||
<descr>
|
||
<p>If <var>AllowGrayed</var> is set to True, the check box has three possible states: checked, unchecked and grayed. If <var>AllowGrayed</var> is set to False, the check box has only two possible states: checked and unchecked.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.Caption" link="#LCL.Controls.TControl.Caption">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.Checked" link="#LCL.StdCtrls.TButtonControl.Checked">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.DragKind" link="#LCL.Controls.TControl.DragKind">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.Hint" link="#LCL.Controls.TControl.Hint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnChange" link="#LCL.StdCtrls.TButtonControl.OnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnClick" link="#LCL.Controls.TControl.OnClick">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.State" link="#LCL.StdCtrls.TCustomCheckBox.State">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.UseOnChange" link="#LCL.StdCtrls.TButtonControl.UseOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TToggleBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TRadioButton">
|
||
<short>
|
||
<var>TRadioButton</var>
|
||
|
||
|
||
|
||
: a button that works with other Radio Buttons in a mutually exclusive way - if one button is selected, none of the others in the group can be selected</short>
|
||
<descr>
|
||
<p>
|
||
<var>TRadioButton</var>
|
||
|
||
|
||
|
||
: a button that works in conjunction with other Radio Buttons in a mutually exclusive manner - if one button of a group is selected, none of the others in that group can be selected.</p>
|
||
<p>The Application Programmer is responsible for ensuring that the <var>OnClick</var> event handler for each button has a unique <var>Action</var>, and that the Actions of the other (deselected and therefore inactive) buttons are turned off.</p>
|
||
<p>
|
||
<var>TRadioGroup</var>
|
||
|
||
|
||
|
||
behaves differently from a group of <var>TRadioButton</var> controls placed arbitrarily around a form. </p>
|
||
<p>In the case of <var>TRadioButton</var>, the mutual exclusivity is a feature that applies to any <var>RadioButton</var> anywhere in the Form, and the <var>RadioButtons</var> can be rearranged in any order or placed anywhere within the containing <var>Form</var>, while in <var>TRadioGroup</var> the exclusivity applies only to buttons within the Group, which are ordered strictly according to their <var>ItemIndex</var> within the <var>Items</var> stringlist. </p>
|
||
<p>
|
||
<var>TRadioButton</var>
|
||
|
||
|
||
|
||
is an entity in itself, with a number of additional properties, whereas the buttons within <var>TRadioGroup</var> are not separate entities, but rather are simply entries in a list of strings, each of which is associated with the on-screen image of a <var>RadioButton</var>. </p>
|
||
<p>The example shows the difference between the use of <var>TRadioButton</var> and <var>TRadioGroup</var>
|
||
</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
<link id="#lcl.ExtCtrls.TRadioGroup">TRadioGroup</link>
|
||
</seealso>
|
||
<example file="extctrls/radiobutton.pas"/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TRadioButton.DialogChar" link="#LCL.Controls.TControl.DialogChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TRadioButton.DialogChar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TRadioButton.DialogChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TRadioButton.RealSetText" link="#LCL.Controls.TControl.RealSetText">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TRadioButton.RealSetText.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TRadioButton.ApplyChanges" link="#LCL.StdCtrls.TCustomCheckBox.ApplyChanges">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TRadioButton.Create">
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TRadioButton</var>: calls inherited <var>Create</var> then initialises style</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.StdCtrls.TCustomCheckBox.Create">TCustomCheckBox.Create</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TRadioButton.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Align" link="#LCL.Controls.TControl.Align">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.AllowGrayed" link="#LCL.StdCtrls.TCustomCheckBox.AllowGrayed">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Caption" link="#LCL.Controls.TControl.Caption">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Checked" link="#LCL.StdCtrls.TButtonControl.Checked">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.DragKind" link="#LCL.Controls.TControl.DragKind">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Font" link="#LCL.Controls.TControl.Font">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Hint" link="#LCL.Controls.TControl.Hint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnChange" link="#LCL.StdCtrls.TButtonControl.OnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnClick" link="#LCL.Controls.TControl.OnClick">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.State" link="#LCL.StdCtrls.TCustomCheckBox.State">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.UseOnChange" link="#LCL.StdCtrls.TButtonControl.UseOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TRadioButton.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TCustomLabel">
|
||
<short>
|
||
<var>TCustomLabel</var>
|
||
|
||
|
||
|
||
: the base type from which <var>TLabel </var>is derived.</short>
|
||
<descr>
|
||
<var>TCustomLabel</var>
|
||
|
||
|
||
|
||
: the base type from which <var>TLabel </var>is derived.</descr>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomLabel.FAlignment">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomLabel.FFocusControl">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomLabel.FOptimalFill">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomLabel.FShowAccelChar">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomLabel.FWordWrap">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: private -->
|
||
<element name="TCustomLabel.FLayout">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: private -->
|
||
<element name="TCustomLabel.SetOptimalFill">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetOptimalFill.AValue">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.CanTab">
|
||
<short>
|
||
<var>CanTab</var> - always set to False, as you can't tab to a label</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.CanTab">TControl.CanTab</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.CanTab.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.DoMeasureTextPosition">
|
||
<short>
|
||
<var>DoMeasureTextPosition</var> - method for measuring position of text; shows position of top and left edges</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.DoMeasureTextPosition.TextTop">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.DoMeasureTextPosition.TextLeft">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.HasMultiLine">
|
||
<short>
|
||
<var>HasMultiLine</var> - returns True if label has multiple lines</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.HasMultiLine.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.CalcSize">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcSize.AWidth">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcSize.AHeight">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.DoAutoSize" link="#LCL.Controls.TControl.DoAutoSize">
|
||
<short>
|
||
<var>DoAutoSize</var>
|
||
</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.DialogChar" link="#LCL.Controls.TControl.DialogChar">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.DialogChar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.DialogChar.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.TextChanged" link="#LCL.Controls.TControl.TextChanged">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.Resize" link="#LCL.Controls.TControl.Resize">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.FontChanged" link="#LCL.Controls.TControl.FontChanged">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.FontChanged.Sender">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.GetControlClassDefaultSize">
|
||
<short>
|
||
<var>GetControlClassDefaultSize</var> returns its own defaults, overriding inherited values</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.GetControlClassDefaultSize.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.WMActivate">
|
||
<short>
|
||
<var>WMActivate</var> - LCL message to activate control</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.WMActivate.Message">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.Notification">
|
||
<short>
|
||
<var>Notification</var> calls inherited method and adjusts focus, if required</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.Notification">TControl.Notification</link>
|
||
</seealso>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.Notification.AComponent">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.Notification.Operation">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.GetShowAccelChar">
|
||
<short>
|
||
<var>GetShowAccelChar</var> - returns True if accelerator characters aer to be shown</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.GetShowAccelChar.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.GetAlignment">
|
||
<short>
|
||
<var>GetAlignment</var> - returns the value of alignment required</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.GetAlignment.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.GetLabelText">
|
||
<short>
|
||
<var>GetLabelText</var> - returns the string for text of the label</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.GetLabelText.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: protected -->
|
||
<element name="TCustomLabel.GetTransparent">
|
||
<short>
|
||
<var>GetTransparent</var> - returns True if the control is to be transparent</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.GetTransparent.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.SetAlignment">
|
||
<short>
|
||
<var>SetAlignment</var> - specifies the sort of alignment (left or right justified or centered)</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetAlignment.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.SetColor" link="#LCL.Controls.TControl.SetColor">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetColor.NewColor">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.SetFocusControl">
|
||
<short>
|
||
<var>SetFocusControl</var> - specifies which control has focus</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetFocusControl.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.SetLayout">
|
||
<short>
|
||
<var>SetLayout</var> - specifies text layout</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetLayout.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.SetShowAccelChar">
|
||
<short>
|
||
<var>SetShowAccelChar</var> - specifies whether accelerator characters are to be shown</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetShowAccelChar.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.SetTransparent">
|
||
<short>
|
||
<var>SetTransparent</var> - specifies whether the control is to be transparent</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetTransparent.NewTransparent">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.SetWordWrap">
|
||
<short>
|
||
<var>SetWordWrap</var> - specifies whether WordWrap is to be used</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.SetWordWrap.Value">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.Loaded">
|
||
<descr>
|
||
<p>
|
||
<var>Loaded</var> is called by the streaming system when a root
|
||
component was completely read from a stream and all properties and
|
||
references to other objects have been resolved by the streaming
|
||
system. Descendents of <var>TComponent</var> should override this method to
|
||
do some additional processing of properties after all published
|
||
properties have been set from values obtained from the stream.
|
||
</p>
|
||
<p>Application programmers should never call <var>Loaded</var> directly, this
|
||
is done automatically by the streaming system.
|
||
</p>
|
||
</descr>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.Loaded">TControl.Loaded</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Loaded</var> calls inherited method and adjusts size</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomLabel.Alignment">
|
||
<short>
|
||
<var>Alignment </var>
|
||
|
||
|
||
|
||
- whether text is centered, left- or right-justified</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomLabel.FocusControl">
|
||
<short>
|
||
<var>FocusControl</var> - which control has focus</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomLabel.Layout">
|
||
<short>
|
||
<var>Layout</var>
|
||
|
||
|
||
|
||
- How the Text is to be laid out in the text rectangle: at the Bottom, Centre or Top</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomLabel.ShowAccelChar">
|
||
<short>
|
||
<var>ShowAccelChar</var>
|
||
|
||
|
||
|
||
- underline the character in the label that acts as an accelerator with a shortcut key</short>
|
||
<descr>
|
||
<p>
|
||
<var>ShowAccelChar</var>
|
||
|
||
|
||
|
||
- underline the character in the label that acts as an accelerator with a shortcut key</p>
|
||
<p>Boolean property - default True</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomLabel.Transparent">
|
||
<short>
|
||
<var>Transparent </var>
|
||
|
||
|
||
|
||
- whether the viewer can see through the control. Default True</short>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomLabel.WordWrap">
|
||
<short>
|
||
<var>WordWrap</var>
|
||
|
||
|
||
|
||
- whether a word is to be wrapped to the next line if the text is about to become too long for the width available</short>
|
||
<descr>
|
||
<p>
|
||
<var>WordWrap</var>
|
||
|
||
|
||
|
||
- whether a word is to be wrapped to the next line if the text is about to become too long for the width available</p>
|
||
<p>Boolean property, default False</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: protected -->
|
||
<element name="TCustomLabel.OptimalFill">
|
||
<short>
|
||
<var>OptimalFill </var>
|
||
|
||
|
||
|
||
- boolean. If True, font size is adjusted for optimal fill of available space</short>
|
||
</element>
|
||
<!-- constructor Visibility: public -->
|
||
<element name="TCustomLabel.Create">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TGraphicControl.Create">TGraphicControl.Create</link>
|
||
</seealso>
|
||
<short>
|
||
<var>Create</var> - constructor for <var>TCustomLabel</var>: calls inherited <var>Create</var> then initialises style, bounds, colour and some other properties</short>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.Create.TheOwner">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight">
|
||
<short>Calculate the height of the font needed to fit the available space, given the MaxWidth and MaxHeight constraints</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: protected -->
|
||
<element name="TCustomLabel.CalculatePreferredSize" link="#LCL.Controls.TControl.CalculatePreferredSize">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalculatePreferredSize.PreferredWidth">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalculatePreferredSize.PreferredHeight">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalculatePreferredSize.WithThemeSpace">
|
||
<short/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight.TheText">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight.MaxWidth">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight.MaxHeight">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight.FontHeight">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight.NeededWidth">
|
||
<short/>
|
||
</element>
|
||
<!-- argument Visibility: default -->
|
||
<element name="TCustomLabel.CalcFittingFontHeight.NeededHeight">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomLabel.ColorIsStored" link="#LCL.Controls.TControl.ColorIsStored">
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.ColorIsStored.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- function Visibility: public -->
|
||
<element name="TCustomLabel.AdjustFontForOptimalFill">
|
||
<short>If True, attempts to adjust font for an optimal fill of the space available</short>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- function result Visibility: default -->
|
||
<element name="TCustomLabel.AdjustFontForOptimalFill.Result">
|
||
<short/>
|
||
</element>
|
||
<!-- procedure Visibility: public -->
|
||
<element name="TCustomLabel.Paint" link="#LCL.Controls.TGraphicControl.Paint">
|
||
<descr>Virtual <var>Paint</var> method called in response to paint requests received by the parent control.
|
||
</descr>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomLabel.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: public -->
|
||
<element name="TCustomLabel.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- object Visibility: default -->
|
||
<element name="TLabel">
|
||
<short>
|
||
<var>TLabel</var>
|
||
|
||
|
||
|
||
: a brief text label to be placed in the Form near any object that needs to be identified.</short>
|
||
<seealso>
|
||
<link id="HowToUseStdCtrls"/>
|
||
</seealso>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Align" link="#LCL.Controls.TControl.Align">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
|
||
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Alignment" link="#LCL.StdCtrls.TCustomLabel.Alignment">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
||
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
|
||
</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.BidiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determines the border spacing for this control</p>
|
||
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
||
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Caption" link="#LCL.Controls.TControl.Caption">
|
||
<descr>
|
||
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
|
||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||
and the developer needs to set it explicitly to some new text.</p>
|
||
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
|
||
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
|
||
introduced. These functions interface with the LCLInterface. </p>
|
||
<p>The default <var>Get/SetTextBuf</var> implementation calls the <var>RealGet/SetText</var>. As long as the <var>Get/SetTextBuf</var> isn't overridden <var>Get/SetText</var> calls <var>RealGet/SetText</var> to avoid PChar copying.</p>
|
||
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Color" link="#LCL.Controls.TControl.Color">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
||
<p>The default colour is the same as the window in which the control is located.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.DragMode" link="#LCL.Controls.TControl.DragMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
|
||
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.FocusControl" link="#LCL.StdCtrls.TCustomLabel.FocusControl">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Font" link="#LCL.Controls.TControl.Font">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
||
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||
</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Layout" link="#LCL.StdCtrls.TCustomLabel.Layout">
|
||
<short>
|
||
<var>Layout</var> - How the Text is to be laid out in the text rectangle: at the Bottom, Centre or Top</short>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads the details of the pop-up menu, or stores them.<br/>
|
||
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.ShowAccelChar" link="#LCL.StdCtrls.TCustomLabel.ShowAccelChar">
|
||
<descr>
|
||
<p>
|
||
<var>ShowAccelChar</var>
|
||
|
||
|
||
|
||
- underline the character in the label that acts as an accelerator with a shortcut key</p>
|
||
<p>Boolean property - default True</p>
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
||
</descr>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Transparent" link="#LCL.StdCtrls.TCustomLabel.Transparent">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.Visible" link="#LCL.Controls.TControl.Visible">
|
||
<descr>
|
||
<pre>The Visible property represents the ability to see a visual control.
|
||
If Visible is True the control is shown, otherwise it is hidden.
|
||
Calling Show sets, among others, Visible to True.
|
||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.WordWrap" link="#LCL.StdCtrls.TCustomLabel.WordWrap">
|
||
<descr>
|
||
<p>
|
||
<var>WordWrap</var>
|
||
- whether a word is to be wrapped to the next line if the text is about to become too long for the width available. WordWrap=true and AutoSize=true requires that the Width is fixed. For example by anchoring the left and right side.</p>
|
||
<p>Boolean property, default False</p>
|
||
</descr>
|
||
<short>Enable automatic line breaks if the Width of the Label is too small for the Caption</short>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.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 spcified 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>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.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>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave"/>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>Reads or Writes flag if bounds are changed</p>
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnResize" link="#LCL.Controls.TControl.OnResize">
|
||
<descr>// standard properties, which should be supported by all descendants<br/>
|
||
Reads or Writes flag if control is re-sized.
|
||
</descr>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- property Visibility: published -->
|
||
<element name="TLabel.OptimalFill" link="#LCL.StdCtrls.TCustomLabel.OptimalFill">
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- variable Visibility: default -->
|
||
<element name="DefaultButtonControlUseOnChange">
|
||
<short/>
|
||
<descr/>
|
||
<seealso/>
|
||
</element>
|
||
<!-- procedure Visibility: default -->
|
||
<element name="Register">
|
||
<short/>
|
||
<descr/>
|
||
<errors/>
|
||
<seealso/>
|
||
</element>
|
||
<topic name="HowToUseStdCtrls">
|
||
<short>How to use <var>StdCtrls</var>, <var>ComCtrls</var> or <var>ExtCtrls</var>
|
||
</short>
|
||
<descr>
|
||
<p>The Units <var>StdCtrls</var>, <var>ComCtrls</var> and <var>ExtCtrls</var> contain definitions and descriptions of many of the most commonly used controls for constructing Forms and other Objects in Lazarus Applications.</p>
|
||
<p>Many of the final target controls that the application developer wants to use, such as <var>TButton</var>, <var>TMemo</var>, <var>TScrollBar</var> etc, have a corresponding ancestor class such as <var>TCustomButton</var>, <var>TCustomMemo</var> or <var>TCustomScrollBar</var>. Several of the properties and methods relevant to the final target control are defined (and explained) more fully in the <var>TCustomXXX</var> class, and are <b>inherited</b> by the final target control.</p>
|
||
<p>If you drop a component on the form editor you don't need to add code explicitly to create it. The component is automatically created by the IDE together with the form, and destroyed when the form is destroyed.</p>
|
||
<p>However, if you create the component yourself by code don't forget to free it when it is no longer needed.</p>
|
||
<p>If you place a component on the Form Designer and look at the Object Inspector, you can observe the properties change as you move the component around.</p>
|
||
<p>For example, if you place a button (TButton) on the form, click on it to select it, then move it around the form with the mouse, you can watch the values of Top and Left change in the Object Inspector to reflect the new position. If you use the object's re-sizing bars to adjust its size, you can watch the Height and Width properties change as well.</p>
|
||
<p>On the other hand, by using the Object Inspector, you can select the value associated with a property such as height, and type in a new value; you can watch the size of the object on the form change to reflect the new value.</p>
|
||
<p>You can also explicitly change the properties of the object in code by typing (in the appropriate Implementation section of the Source editor), for example</p>
|
||
<code>Form1.Button1.Height := 48;</code>
|
||
<p>If you type this new value into the Source Editor and then look back at the Form Designer, you will see that the button on the Form has taken the new size. The new value will also be shown in the Object Inspector.</p>
|
||
<p>In summary, there are usually about three different ways to determine each property of an object:</p>
|
||
<ul>
|
||
<li>by using the mouse,</li>
|
||
<li>by setting the values in the Object Inspector,</li>
|
||
<li>or explicitly by writing code.</li>
|
||
</ul>
|
||
<p>The components defined in these Units have several properties that are common to most of them, and other properties that are specific to the individual components. We shall describe the most common ones here. Unusual or control-specific properties will be described for the individual controls. </p>
|
||
<p>Additional Help can always be obtained by selecting a property or keyword, in either the Object Inspector or the Source Editor, and pressing <b>F1</b>. You will be taken by your Help browser to the appropriate page in the documentation. </p>
|
||
<p>If the description of a property on that page is insufficient, you can navigate to the corresponding description in the ancestor classes, by selecting the links in the Inheritance listing or by selecting the ancestor Type in the declaration of the object.</p>
|
||
<p>
|
||
<var>Constructors</var>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
such as <var>Create</var> allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</p>
|
||
<p>
|
||
<var>Destructors:</var>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
remove the object and de-allocate memory and other resources. If you call <var>Destroy</var> for an object which hasn't being initialized yet it will generate an error. Always use the <var>Free</var> method to deallocate objects, because it checks whether an object's value is <b>nil</b> before invoking <var>Destroy</var>.</p>
|
||
<p>Take the following precautions when creating your own <var>Destroy</var> method:</p>
|
||
<ul>
|
||
<li>Declare <var>Destroy</var> with the <b>override</b> directive, because it is a <b>virtual</b> method.</li>
|
||
<li>Always call '<var>inherited Destroy;</var>' as the last thing on the destructor code.</li>
|
||
<li>Be aware that an <var>exception</var> may be raised on the <var>constructor</var> in case there is not enought memory to create an object, or something else goes wrong. If the <var>exception</var> is not handled inside the constructor, the object will be only partially built. In this case <var>Destroy</var> will be called when you weren't expecting it, so your destructor must check if the resources were really allocated before disposing of them.</li>
|
||
<li>Remember to call <var>Free</var> for all objects created on the constructor.</li>
|
||
</ul>
|
||
<table>
|
||
<caption>Some commonly listed properties</caption>
|
||
<th>
|
||
<td>Property</td>
|
||
<td>Meaning</td>
|
||
</th>
|
||
<tr>
|
||
<td>Action</td>
|
||
<td>The main action or event associated with the object. For example selecting an 'Exit' Button might cause the 'Close' action</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Align</td>
|
||
<td>Defines the way in which an object is to be lined up with the parent object. Possible values are alTop (placed at the top and using the full available width), alBottom, alLeft (placed at the left and using the full available height), alRight. alNone (place anywhere on parent control) or alClient (takes all available space next to controls aligned to top, bottom, left or right)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Anchor</td>
|
||
<td>Used to keep a control a certain distance from the defined edges of a parent control, when the parent is resized. For example <b>[akBottom, akRight]</b> will keep the control a fixed distance from the bottom right corner.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>AutoSelect</td>
|
||
<td>When True, an editing control will select all its text when it receives focus or when the Enter key is pressed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>AutoSelected</td>
|
||
<td>True indicate that the edit or combobox control has just performed an AutoSelect operation so that subsequent mouse-clicks and keystrokes proceed normally without selecting the text.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>BorderSpacing</td>
|
||
<td>The space around the edge between an <var>Anchored</var> control and its parent.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Caption</td>
|
||
<td>The text that is displayed on or near the control; it should preferably give some clue as to the function of the control, or an instruction such as 'Close' or 'Execute'. By default Caption is set to be the same as the 'Name' property, and the application programmer should substitute meaningful text instead of the default values.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CharCase</td>
|
||
<td>Indicates how text is displayed in a text editing control: Normal (retaining the case of the letters typed by the user), converted to uppercase, or converted to lowercase</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Constraints</td>
|
||
<td>Sets the minimum and maximum sizes for a control. If a control is resized the new dimensions are always within the ranges given here. You should take care when setting these options that they do not conflict with the Anchors and Align settings.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Color</td>
|
||
<td>The Colour to be used to draw the control or to write the text it contains.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Enabled</td>
|
||
<td>A Boolean property to determine whether or not a control is capable of being selected and performing an action. If it is not <var>Enabled</var>, it is often <b>Grayed</b> out on the Form.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Font</td>
|
||
<td>The Font to be used for writing the text associated with the control - either the caption or label, or the text-strings contained within the control. The entry on the Object Inspector usually has a (+) box on the left, and selecting this box reveals further options such as character set, colour and size.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Hint</td>
|
||
<td>A short piece of informative pop-up text that appears if the mouse-cursor hovers over the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Items</td>
|
||
<td>The list of 'Things' that the object contains, such as a group of images, a series of lines of text, a number of actions in an actionlist, etc</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Lines</td>
|
||
<td>An array of strings, containing the textual data in controls with more than a single line of data, such as an Edit-Box or a Combo-Box. The array is zero-indexed, ie the lines are numbered [0..numLines-1]</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Name</td>
|
||
<td>The identifier by which the control is known in the program. The IDE gives it a default name based on the underlying type, for example successive instances of TBitButton would be named Form1.BitBitton1 and Form1.BitButton2; it is up to the application programmer to give them more meaningful names such as ExitButton or OKButton. By default the Name of the control is applied to the Caption for the control, but the text of the Caption may be changed separately.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PopUpMenu</td>
|
||
<td>A window containing context-sensitive menu information that pops up when the right mouse button is clicked on the object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Position (or Top, Left)</td>
|
||
<td>Determines where the control is located on the parent form or window</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ReadOnly</td>
|
||
<td>Boolean property which, if True, signifies that the contents of the control can be read by the user or the calling routine, but cannot be written or changed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ShowHint</td>
|
||
<td>Allows a small window containing a context-sensitive Help or other description to be displayed when the mouse cursor 'hovers' over the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Size (or Height and Width)</td>
|
||
<td>The dimensions of the control</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Style</td>
|
||
<td>The options available for Style depend upon the sort of Control being considered: for instance the Style may be defined by TFormStyle, TBorderStyle, TButtonStyle etc.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>TabOrder</td>
|
||
<td>Integer defining where in the sequence of tabs on the Form this control is to lie</td>
|
||
</tr>
|
||
<tr>
|
||
<td>TabStop</td>
|
||
<td>Boolean property which if True places this control in the sequence of objects that the user can reach by successively pressing the Tab key</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Text</td>
|
||
<td>The String of Text that represents the actual data that this control contains. Applies particularly to Text, Memo and StringList types of object. Most of the editing operations (such as <var>Select</var>, <var>Clear</var>, <var>Cut</var>, <var>Copy</var>) are performed in this part of the object, which holds the actual string being edited. If the control contains more than a single line of text, for example <var>TMemo</var> or <var>TComboBox</var>, then the textual elements are arranged as an array of strings (zero-indexed, ie numbered from [0..numLines-1]) in <var>Lines</var>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Visible</td>
|
||
<td>If true, the object can be seen on the Form; if False, object is hidden</td>
|
||
</tr>
|
||
<tr>
|
||
<td>WordWrap</td>
|
||
<td>Logical flag to show whether or not word-wrap is enabled, ie if a word comes close to the end of a line and is going to be too long for the line, it is wrapped down to the next line.</td>
|
||
</tr>
|
||
</table>
|
||
<p>Many actions are commonly listed in the 'Events' tab of the Object Inspector. If you select an entry in the list, a ComboBox appears with a DropDown list showing any actions that have aleady been defined, and allowing you to choose one to be associated with this event. Alternatively you can select the ellipsis (three dots ...) and you will be taken to an area of the Source Editor where you can begin typing your own action instructions for the selected event.</p>
|
||
<p>While a large number of events is available for any given control, in practice it is only necessary to populate a few of them. For most controls, it is sufficient to provide coding for 'OnClick'; for more complex controls it may be necessary also to provide for 'OnEntry' (when the mouse cursor enters the Control and gives it focus) and 'OnExit' (when the mouse cursor leaves the Control; or you may need to write an event handler for 'OnChange' or 'OnScroll', depending on the nature of the particular control with which you are dealing.</p>
|
||
<p>The pop-up menu that appears when you right-click an object in the Form Designer has, as its first item: 'Create default event' and selecting this option will have the same effect as selecting the ellipsis in the Object Inspector for the default event, usually OnClick: you are taken to the Implementation area of the Source Editor where you can type the code for the event handler.</p>
|
||
<p>A common strategy in Object-Oriented programming is to provide an <link id="#lcl.ActnList.TActionList">ActionList</link> with the facility for entering, removing or editing a number of pre-defined actions from which the most appropriate can be selected to use in any particular instance.</p>
|
||
<table>
|
||
<caption>Some commonly listed Actions</caption>
|
||
<th>
|
||
<td>Action</td>
|
||
<td>Meaning</td>
|
||
</th>
|
||
<tr>
|
||
<td>OnChange</td>
|
||
<td>Action to be taken if any change is detected (eg mouse move, mouse click, key press, edit text, alter picture, etc)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnClick</td>
|
||
<td>Action to be taken when the (left) mouse button is clicked. This is usually the main or default action of the control; for example clicking on a button or checkbox initiates the action associated with the checkbox. It may alternatively initate a process of selection, for instance in a TextBox or Memo, or signal the beginning of painting with a Pen or Brush.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Click</td>
|
||
<td>A method to emulate in code the effect of clicking on a control. This method is most often found in Button-type controls (TButton, TBitBtn, TSpeedButton etc). A procedure can be written that calls the same code as the OnClick action. This facility can be particularly useful if the activation of one control by clicking causes a cascade of other controls to be activated, and the Click method can be used to initiate the action rather than having the user explicitly click on a lot of controls.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnDragDrop</td>
|
||
<td>Action to be taken during Drag-Drop manoeuvres, ie when the mouse is used to 'capture' an item or some text etc and move it around the screen to a new location.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnEntry</td>
|
||
<td>Action to be taken when the mouse cursor enters the area occupied by the object, usually transfering focus to that object. This might include changes in the appearance of the object such as highlighting or raising the border.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnExit</td>
|
||
<td>Action to be taken when the mouse moves out of the area of the object, usually transferring focus out of the object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnKeyPress</td>
|
||
<td>Action to be taken for any key-press. Subtly different from OnKeyDown, which simply responds to a key being down, whether or not it was already down when focus was given to this control. OnKeyPress requires that a key becomes pressed while focus is in this control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnKeyDown</td>
|
||
<td>Action to be taken if a key is down while focus is in this control. Subtly different from OnKeyPress - for example the key might already have been down when focus entered this control, whereas OnKeyPress requires the key to become pressed while focus is in the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>On Key Up</td>
|
||
<td>Action to be taken if a key is up (ie not pressed) while focus is in this control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnMouseMove</td>
|
||
<td>On Mouse Down - Action to be taken if the mouse cursor moves while focus is in this control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnMouseDown</td>
|
||
<td>Action to be taken if the mouse button is down while focus is in this control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnMouseUp</td>
|
||
<td>Action to be taken if the mouse button is up while the cursor is over this control. Implies that the mouse button was previously down and has been released. The case where the cursor enters the control but the mouse button has not yet been pressed is covered by OnEntry or OnMouseEnter.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OnResize</td>
|
||
<td>Action to be taken when the control is resized. Might include re-alignment of text or selection of a different font size etc.</td>
|
||
</tr>
|
||
</table>
|
||
</descr>
|
||
</topic>
|
||
<element name="TCustomComboBox.AutoSize">
|
||
<descr>
|
||
<p>// standard properties, which should be supported by all descendants</p>
|
||
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
||
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
||
</descr>
|
||
<short>
|
||
<var>AutoSize</var> defaults to True, overriding any previous default</short>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.AutoSize">TControl.AutoSize</link>
|
||
</seealso>
|
||
</element>
|
||
<element name="TGroupBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TComboBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TCustomListBox.SelectAll">
|
||
<short>
|
||
<var>SelectAll</var> - select all items in list</short>
|
||
</element>
|
||
<element name="TListBox.DragKind" link="#LCL.Controls.TControl.DragKind"/>
|
||
<element name="TListBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TCustomEdit.Undo">
|
||
<short>
|
||
<var>Undo</var> the last edit action</short>
|
||
</element>
|
||
<element name="TCustomEdit.CanUndo">
|
||
<short>
|
||
<var>CanUndo</var> - if True, the <var>Undo</var> action is permitted</short>
|
||
</element>
|
||
<element name="TCustomEdit.CaretPos">
|
||
<short>
|
||
<var>CaretPos</var> - the position of the Caret indicator in the text</short>
|
||
</element>
|
||
<element name="TEdit.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TMemo.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TMemo.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel"/>
|
||
<element name="TMemo.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown"/>
|
||
<element name="TMemo.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp"/>
|
||
<element name="TStaticText.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TButton.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TCheckBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TCheckBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress"/>
|
||
<element name="TCheckBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown"/>
|
||
<element name="TCheckBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp"/>
|
||
<element name="TRadioButton.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TLabel.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TScrollBar.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
||
<element name="TCustomListBox.CalculateStandardItemHeight">
|
||
<short>
|
||
<var>CalculateStandardItemHeight</var> - returns a calculated value for the standard height of items in th elistbox</short>
|
||
</element>
|
||
<element name="TCustomEdit.GetCaretPos">
|
||
<short>
|
||
<var>GetCaretPos</var> - returns the position of the caret or edit cursor</short>
|
||
</element>
|
||
<element name="TCustomEdit.GetReadOnly">
|
||
<short>
|
||
<var>GetReadOnly</var> - returns the boolean <var>ReadOnly</var> status</short>
|
||
</element>
|
||
<element name="TCustomEdit.SetCaretPos">
|
||
<short>
|
||
<var>SetCaretPos</var> - specifies the position of the caret or edit cursor</short>
|
||
</element>
|
||
<element name="TCustomMemo.GetCaretPos" link="#LCL.StdCtrls.TCustomEdit.GetCaretPos"/>
|
||
<element name="TScrollBar.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TGroupBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TCustomComboBox.GetItems">
|
||
<short>
|
||
<var>GetItems</var> - finds the list of items for the dropdown box</short>
|
||
</element>
|
||
<element name="TComboBox.OnGetItems">
|
||
<short>
|
||
<var>OnGetItems</var> - event handler for getting list of items for dropdown box</short>
|
||
</element>
|
||
<element name="TComboBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TCustomListBox.GetIndexAtXY">
|
||
<short>
|
||
<var>GetIndexAtXY</var> - returns the index of an item at the specified coordinates</short>
|
||
</element>
|
||
<element name="TCustomListBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TCustomListBox.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||
<element name="TListBox.OnMeasureItem" link="#LCL.StdCtrls.TCustomListBox.OnMeasureItem"/>
|
||
<element name="TListBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TListBox.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||
<element name="TCustomMemo.SetCaretPos" link="#LCL.StdCtrls.TCustomEdit.SetCaretPos"/>
|
||
<element name="TEdit.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TMemo.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TButton.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TCheckBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||
<element name="TCustomComboBox.UTF8KeyPress">
|
||
<short>
|
||
<var>UTF8KeyPress</var> converts character case if required then calls inherited method</short>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.UTF8KeyPress">TWinControl.UTF8KeyPress</link>
|
||
</seealso>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomComboBox.UTF8KeyPress"/>
|
||
</p>
|
||
<p>The inherited method emulates the pressing of a key, with UTF8 coding. The UTF8 coding should be used where there is the possibility that input/output will occur in any language that requires multiple bytes to represent each character, ie almost all languages except the standard Western European languages.</p>
|
||
</descr>
|
||
</element>
|
||
<element name="TCustomButton.Loaded">
|
||
<short>
|
||
<var>Loaded</var> calls inherited method, checks to see whether it is a default or cancel control, sets the default widget set</short>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.Loaded">TWinControl.Loaded</link>
|
||
</seealso>
|
||
</element>
|
||
<element name="TRadioButton.Click">
|
||
<short>
|
||
<var>Click</var> - sets <var>Checked</var> to True then calls inherited <var>Click</var>
|
||
</short>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TControl.Click">TControl.Click</link>
|
||
</seealso>
|
||
</element>
|
||
<element name="TRadioButton.SetChecked" link="#LCL.StdCtrls.TButtonControl.SetChecked"/>
|
||
<element name="TCustomEdit.Alignment">
|
||
<short>
|
||
<var>Alignment</var> - whether text is left- or right-justified, or centered</short>
|
||
</element>
|
||
<element name="TCustomEdit.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||
<element name="TEdit.Alignment" link="#LCL.StdCtrls.TCustomEdit.Alignment"/>
|
||
<element name="TMemo.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle"/>
|
||
<element name="TMemo.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint"/>
|
||
<element name="TMemo.ShowHint" link="#LCL.Controls.TControl.ShowHint"/>
|
||
<element name="TButtonControl.CMWantSpecialKey" link="#LCL.Controls.TControl.CMWantSpecialKey"/>
|
||
<element name="TRadioButton.Color" link="#LCL.Controls.TControl.Color"/>
|
||
<element name="TRadioButton.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||
<element name="TMemo.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||
<element name="TEdit.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle"/>
|
||
<element name="TEdit.DragKind" link="#LCL.Controls.TControl.DragKind"/>
|
||
<element name="TEdit.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||
<element name="TGroupBox.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter"/>
|
||
<element name="TGroupBox.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave"/>
|
||
<element name="TLabel.DragKind" link="#LCL.Controls.TControl.DragKind"/>
|
||
<element name="TRadioButton.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomCheckBox.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TButtonControl.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomScrollBar.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomGroupBox.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomComboBox.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomListBox.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomEdit.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomMemo.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomStaticText.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomButton.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TToggleBox.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TCustomLabel.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
||
<element name="TStaticText.DragKind" link="#LCL.Controls.TControl.DragKind"/>
|
||
<element name="TCustomMemo.InitializeWnd">
|
||
<short>
|
||
<var>InitializeWnd</var> - initialises the window by creating the borders and outline, then loading up any strings that have already been specified for display</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomMemo.InitializeWnd"/>
|
||
</p>
|
||
<p>Calls the inherited method which works out the correct bounds, sets style, fonts and colours, performs any pending resize operations</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
|
||
</seealso>
|
||
</element>
|
||
<element name="TCustomMemo.FinalizeWnd">
|
||
<short>
|
||
<var>FinalizeWnd</var> - getting ready to close down the window: first stores the text strings in a safe place, then frees the storage occupied by them</short>
|
||
<descr>
|
||
<p>
|
||
<printshort id="TCustomMemo.FinalizeWnd"/>
|
||
</p>
|
||
<p>Calls the inherited method, which prepares to free the handle for this window</p>
|
||
</descr>
|
||
<seealso>
|
||
<link id="#LCL.Controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
|
||
</seealso>
|
||
</element>
|
||
<element name="TCustomMemo.GetCaretPos.Result">
|
||
<short>Returns the position of the cursor marker or caret</short>
|
||
</element>
|
||
<element name="TCustomEdit.HideSelection">
|
||
<short>
|
||
<var>HideSelection</var>: hide the selection when control has no focus</short>
|
||
<descr>Allows to turn on the persistent selection. Therefore when control loses focus it still highlights the selected text.</descr>
|
||
</element>
|
||
</module>
|
||
<!-- StdCtrls -->
|
||
</package>
|
||
</fpdoc-descriptions>
|