mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-21 22:39:30 +02:00
LazDoc - updates to TCustomLabel, TLabel and TBoundLabel
git-svn-id: trunk@14092 -
This commit is contained in:
kirkpatc
parent
2a41b470fd
commit
92142a0d59
@ -3204,14 +3204,15 @@
|
||||
</element>
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TBevel.Paint">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Virtual <i>Paint</i> method called in response to paint requests.</short>
|
||||
<descr>Virtual <i>Paint</i> method called in response to paint requests received by the parent control.
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TBevel.Create">
|
||||
<short/>
|
||||
<short>Create a new instance of a Graphic Control</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -3222,59 +3223,89 @@
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TBevel.Destroy">
|
||||
<short/>
|
||||
<short>Destroy this instance of a graphic control and return its resources</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TBevel.Invalidate">
|
||||
<short/>
|
||||
<short>Render this control non-valid</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.Align">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Used to align the control in one of four directions.</short>
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</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="TBevel.Anchors">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>The set of anchor definitions for this control</short>
|
||||
<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 <i>IsAnchorsStored</i>
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.BorderSpacing">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Determines the border spacing for this control</short>
|
||||
<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="TBevel.Constraints">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Determine <i>Constraints</i> (max and min height and width) for this control</short>
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
<p>Determine <i>Constraints</i> (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="TBevel.Height">
|
||||
<short/>
|
||||
<short>
|
||||
<i>Height</i> - the vertical dimension of the control</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.Left">
|
||||
<short/>
|
||||
<short>
|
||||
<i>Left</i> - the coordinate of the left edge of the control</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.Name">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Name of the component.</short>
|
||||
<descr>
|
||||
<var>Name</var> is the name of the component. This name should be a valid
|
||||
identifier, i.e. must start with a letter, and can contain only letters,
|
||||
numbers and the underscore character. When attempting to set the name of a
|
||||
component, the name will be checked for validity. Furthermore, when a
|
||||
component is owned by another component, the name must be either empty
|
||||
or must be unique among the child component names.
|
||||
</descr>
|
||||
<seealso/>
|
||||
<errors>Attempting to set the name to an invalid value will result in an exception
|
||||
being raised.
|
||||
</errors>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.Shape">
|
||||
@ -3286,7 +3317,8 @@
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.Top">
|
||||
<short/>
|
||||
<short>
|
||||
<i>Top</i> - the coordinates of the top edge of the control</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -3300,49 +3332,63 @@
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.Visible">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
<i>Visible</i> - can the control be seen?</short>
|
||||
<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="TBevel.Width">
|
||||
<short/>
|
||||
<short>
|
||||
<i>Width </i>- the horizontal dimension of the control</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.OnChangeBounds">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Event handler for a change in bounds of the control</short>
|
||||
<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="TBevel.OnResize">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Event Handler for resize of control</short>
|
||||
<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="TBevel.OnMouseDown">
|
||||
<short/>
|
||||
<short>Event handler for when a mouse button is pressed down</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.OnMouseMove">
|
||||
<short/>
|
||||
<short>Event handler for mouse movement within the current control</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.OnMouseUp">
|
||||
<short/>
|
||||
<short>Event handler for when the mouse button is released, ie "up"</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBevel.OnPaint">
|
||||
<short/>
|
||||
<short>
|
||||
<i>OnPaint</i> - event handler for request to paint canvas</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -4364,7 +4410,7 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TBoundLabel.Create">
|
||||
<short/>
|
||||
<short>Create a new instance of a Graphic Control</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -4375,84 +4421,86 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TBoundLabel.FocusControl">
|
||||
<short/>
|
||||
<short>
|
||||
<i>FocusControl</i> - whether this control has focus</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.Caption">
|
||||
<short>Caption</short>
|
||||
<descr>Caption : the caption which will appear on the Bound Label, to identify its function</descr>
|
||||
<short>The Caption to be used for this label</short>
|
||||
<descr>Caption : the caption which will appear on the Bound Label, to identify its function
|
||||
</descr>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.Color">
|
||||
<short/>
|
||||
<short>The Colour to be used for this label</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.Height">
|
||||
<short/>
|
||||
<short>The height (vertical dimension) of the label</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.Left">
|
||||
<short/>
|
||||
<short>The coordinates of the left border</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.ParentColor">
|
||||
<short/>
|
||||
<short>The colour of the parent - should we stay the same?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.ParentFont">
|
||||
<short/>
|
||||
<short>Do we retain the font of the parent?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.ParentShowHint">
|
||||
<short/>
|
||||
<short>Do we use the same hinting rules as the parent?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.PopupMenu">
|
||||
<short/>
|
||||
<short>A popup menu to be shown if the right mouse button is clicked over this control</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.ShowAccelChar">
|
||||
<short/>
|
||||
<short>Should accelerator character be displayed (underlined in label)?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.ShowHint">
|
||||
<short/>
|
||||
<short>Should hint be shown?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.Top">
|
||||
<short/>
|
||||
<short>Coordinates of the top edge of the label</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.Layout">
|
||||
<short/>
|
||||
<short>Layout - is text at top, bottom, left or right of allocated rectangle?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.WordWrap">
|
||||
<short/>
|
||||
<short>WordWrap - do we wrap to the next line if text is too long to fit on one line?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -4464,31 +4512,31 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.OnClick">
|
||||
<short/>
|
||||
<short>Event Handler for mouse click</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.OnDblClick">
|
||||
<short/>
|
||||
<short>Event handler for mouse double-click</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.OnMouseDown">
|
||||
<short/>
|
||||
<short>Event handler for mouse button pressed over the label</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.OnMouseMove">
|
||||
<short/>
|
||||
<short>Event handler for mouse movement within label</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TBoundLabel.OnMouseUp">
|
||||
<short/>
|
||||
<short>Event handler for mouse button being released ('up') within label</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -5585,6 +5633,58 @@ After that, the parent's destroy method is called.
|
||||
<element name="TTrayIcon.OnPaint">
|
||||
<short>Use this to implement custom drawing to the icon. Draw using the canvas property of the icon. Note: Does not work on win32. </short>
|
||||
</element>
|
||||
<element name="TBevel.Assign">
|
||||
<short>Assign the contents of one class to another.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Assign</var> copies the contents of <var>Source</var> to
|
||||
<var>Self</var>, if the classes of the destination and source classes are
|
||||
compatible.
|
||||
</p>
|
||||
<p>The <var>TPersistent</var> implementation of <var>Assign</var> does nothing
|
||||
but calling the <link id="TPersistent.AssignTo">AssignTo</link> method of
|
||||
source. This means that if the destination class does not know how to assign
|
||||
the contents of the source class, the source class instance is asked to assign
|
||||
itself to the destination class. This means that it is necessary to
|
||||
implement only one of the two methods so that two classes can be assiged to
|
||||
one another.
|
||||
</p>
|
||||
<remark>
|
||||
<p>In general, a statement of the form
|
||||
</p>
|
||||
<code>Destination:=Source;
|
||||
</code>
|
||||
<p>(where <var>Destination</var> and <var>Source</var> are classes) does not
|
||||
achieve the same as a statement of the form
|
||||
</p>
|
||||
<code>Destination.Assign(Source);
|
||||
</code>
|
||||
<p>After the former statement, both <var>Source</var> and
|
||||
<var>Destination</var> will point to the same object. The latter statemtent
|
||||
will copy the <i>contents</i> of the <var>Source</var> class to the
|
||||
<var>Destination</var> class.
|
||||
</p>
|
||||
</remark>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TBoundLabel.DragCursor">
|
||||
<short>The type of cursor to be used if this control is being dragged</short>
|
||||
</element>
|
||||
<element name="TBoundLabel.DragMode">
|
||||
<short>The mode of dragging to be used</short>
|
||||
</element>
|
||||
<element name="TBoundLabel.OnDragDrop">
|
||||
<short>Event handler for Drag-drop process</short>
|
||||
</element>
|
||||
<element name="TBoundLabel.OnDragOver">
|
||||
<short>Event handler if another control is dragged over current label</short>
|
||||
</element>
|
||||
<element name="TBoundLabel.OnEndDrag">
|
||||
<short>event handler for end of drag manoeuvre</short>
|
||||
</element>
|
||||
<element name="TBoundLabel.OnStartDrag">
|
||||
<short>Event handler for beginning of drag manoeuvre</short>
|
||||
</element>
|
||||
</module>
|
||||
<!-- ExtCtrls -->
|
||||
</package>
|
||||
|
||||
@ -8901,7 +8901,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TCustomLabel.Create">
|
||||
<short/>
|
||||
<short>Create a new instance of a Graphic Control</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -8912,7 +8912,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLabel.CalcFittingFontHeight">
|
||||
<short/>
|
||||
<short>Calculate the height of the font needed to fit the available space, given the MaxWidth and MaxHeight constraints</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -8966,7 +8966,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLabel.ColorIsStored">
|
||||
<short/>
|
||||
<short>Colour is stored</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -8977,7 +8977,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLabel.AdjustFontForOptimalFill">
|
||||
<short/>
|
||||
<short>If True, attempts to adjust font for an optimal fill of the space available</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -8988,21 +8988,30 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomLabel.Paint">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Virtual <i>Paint</i> method called in response to paint requests.</short>
|
||||
<descr>Virtual <i>Paint</i> method called in response to paint requests received by the parent control.
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomLabel.AutoSize">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Whether auto-size is to be used</short>
|
||||
<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">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Determine the colour for the current control</short>
|
||||
<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 -->
|
||||
@ -9018,15 +9027,31 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.Align"/>
|
||||
<element name="TLabel.Align">
|
||||
<short>Used to align the control in one of four directions.</short>
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</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">
|
||||
<short/>
|
||||
<short>
|
||||
<i>Alignment </i>- whether text is centered, left- or right-justified</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.Anchors"/>
|
||||
<element name="TLabel.Anchors">
|
||||
<short>The set of anchor definitions for this control</short>
|
||||
<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 <i>IsAnchorsStored</i>
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.AutoSize">
|
||||
<short/>
|
||||
@ -9035,159 +9060,279 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.BidiMode">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
<i>TControlBiDiMode</i> - enabling bi-directional writing</short>
|
||||
<descr>Allows Languages such as Arabic and Hebrew to be used
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.BorderSpacing">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Determines the border spacing for this control</short>
|
||||
<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"/>
|
||||
<element name="TLabel.Caption">
|
||||
<short>
|
||||
<i>Caption</i> - the text-string appearing on the Control, usually used to identify its function</short>
|
||||
<descr>
|
||||
<p>Gets caption as a text-string (<i>GetText</i>), or stores the new caption (<i>SetText</i>). Shows flag if caption is stored (<i>IsCaptionStored</i>).</p>
|
||||
<p>By default, the <i>Caption</i> appears the same as the control <i>Name</i> 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 <i>Get/SetTextBuf</i> 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 <i>RealGet/SetText</i> is
|
||||
introduced. These functions interface with the LCLInterface. </p>
|
||||
<p>The default <i>Get/SetTextBuf</i> implementation calls the <i>RealGet/SetText</i>. As long as the <i>Get/SetTextBuf</i> isn't overridden <i>Get/SetText</i> calls <i>RealGet/SetText</i> 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">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Determine the colour for the current control</short>
|
||||
<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"/>
|
||||
<element name="TLabel.Constraints">
|
||||
<short>Determine <i>Constraints</i> (max and min height and width) for this control</short>
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
<p>Determine <i>Constraints</i> (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">
|
||||
<short/>
|
||||
<short>
|
||||
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.DragMode">
|
||||
<short/>
|
||||
<short>
|
||||
<i>DragMode </i>- whether manual or automatic</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.Enabled">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
<p>Whether the control is <i>Enabled</i>. 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">
|
||||
<short/>
|
||||
<short>
|
||||
<i>FocusControl</i> - whether this control has focus</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.Font">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>The <i>Font</i> to be used for text in this control</short>
|
||||
<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 <i>Font</i> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.Layout">
|
||||
<short/>
|
||||
<short>
|
||||
<i>Layout</i> - 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">
|
||||
<short/>
|
||||
<short>
|
||||
<i>ParentBiDiMode</i> - does the control follow the BiDiMode settings of its parent?</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.ParentColor">
|
||||
<short/>
|
||||
<short>
|
||||
<i>ParentColor</i> - should the control have the same colour as the parent? Default is true</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.ParentFont">
|
||||
<short/>
|
||||
<short>
|
||||
<i>ParentFont </i>- should the control use the same font as the parent? Default is true</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.ParentShowHint">
|
||||
<short/>
|
||||
<short>
|
||||
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.PopupMenu">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control</short>
|
||||
<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">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
<i>ShowAccelChar</i> - underline the character in the label that acts as an accelerator with a shortcut key</short>
|
||||
<descr>
|
||||
<p>
|
||||
<i>ShowAccelChar</i>
|
||||
|
||||
|
||||
|
||||
- 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">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Flag to determine: Is hint to be displayed for this control?</short>
|
||||
<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">
|
||||
<short/>
|
||||
<short>
|
||||
<i>Transparent </i>- whether the viewer can see through the control. Default True</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.Visible"/>
|
||||
<element name="TLabel.Visible">
|
||||
<short>
|
||||
<i>Visible</i> - can the control be seen?</short>
|
||||
<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"/>
|
||||
<element name="TLabel.WordWrap">
|
||||
<short>
|
||||
<i>WordWrap</i> - 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>
|
||||
<i>WordWrap</i>
|
||||
|
||||
|
||||
|
||||
- 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: published -->
|
||||
<element name="TLabel.OnClick"/>
|
||||
<element name="TLabel.OnClick">
|
||||
<short>Event Handler for mouse click</short>
|
||||
<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 <i>ActionList</i>
|
||||
</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"/>
|
||||
<element name="TLabel.OnDblClick">
|
||||
<short>Event Handle for mouse double-click</short>
|
||||
<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">
|
||||
<short/>
|
||||
<short>Event handler for the Drag-Drop manoeuvre</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnDragOver">
|
||||
<short/>
|
||||
<short>Event handler for the case when a control is dragged over another control</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnEndDrag">
|
||||
<short/>
|
||||
<short>Event handler for the end of a dragging process</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnMouseDown"/>
|
||||
<element name="TLabel.OnMouseDown">
|
||||
<short>Event handler for when a mouse button is pressed down</short>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnMouseMove"/>
|
||||
<element name="TLabel.OnMouseMove">
|
||||
<short>Event handler for mouse movement within the current control</short>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnMouseUp"/>
|
||||
<element name="TLabel.OnMouseUp">
|
||||
<short>Event handler for when the mouse button is released, ie "up"</short>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnMouseEnter"/>
|
||||
<element name="TLabel.OnMouseEnter">
|
||||
<short>Event handler for when the mouse enters the area of the current control</short>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnMouseLeave"/>
|
||||
<element name="TLabel.OnMouseLeave">
|
||||
<short>Event handler for when the mouse leaves the area of the current control</short>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OnChangeBounds"/>
|
||||
<element name="TLabel.OnChangeBounds">
|
||||
<short>Event handler for a change in bounds of the control</short>
|
||||
<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"/>
|
||||
<element name="TLabel.OnResize">
|
||||
<short>Event Handler for resize of control</short>
|
||||
<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">
|
||||
<short/>
|
||||
<short>Event handler for start of dragging process</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLabel.OptimalFill">
|
||||
<short/>
|
||||
<short>
|
||||
<i>OptimalFill </i>- boolean. If True, font size is adjusted for optimal fill of available space</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user