mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-09-07 18:40:41 +02:00
Docs: LCL,LazUtils. Updated topics for source changes in version 2.1.
git-svn-id: trunk@65261 -
This commit is contained in:
dsiders
parent
c2a25b1805
commit
9883a587f5
@ -1293,14 +1293,16 @@ D:\db\employee.fdb
|
||||
|
||||
<element name="FileExistsUTF8">
|
||||
<short>
|
||||
Indicates if the specified file name exists
|
||||
Indicates if the specified UTF-8-encoded file name exists
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>FileExistsUTF8</var> is a <var>Boolean</var> function which indicates if the specified file name exists in the local file system. For the Windows environment, FileExistsUTF8 uses FileGetAttrUTF8 to ensure that Filename does not have the <b>FILE_ATTRIBUTE_DIRECTORY</b> attribute. For UNIX-like environments, the FileExists function in <file>SysUtils</file> is used to get the return value.
|
||||
<var>FileExistsUTF8</var> is a <var>Boolean</var> function which indicates if the specified file name exists on the local file system. FileExistsUTF8 calls the <var>FileExists</var> function in <file>SysUtils</file> to get the return value for the routine.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.sysutils.FileExists">FileExists</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="FileExistsUTF8.Result">
|
||||
@ -1308,7 +1310,7 @@ D:\db\employee.fdb
|
||||
</element>
|
||||
|
||||
<element name="FileExistsUTF8.Filename">
|
||||
<short>UTF-8-encoded file name to locate in the local file system</short>
|
||||
<short>UTF-8-encoded file name to locate on the local file system</short>
|
||||
</element>
|
||||
|
||||
<element name="FileAgeUTF8">
|
||||
|
||||
@ -43,7 +43,7 @@
|
||||
<short>Represents any valid text</short>
|
||||
</element>
|
||||
<element name="TMaskOption">
|
||||
<short>Contains options which can be enabled or disabled for TMask comparisons</short>
|
||||
<short>Contains options which can be enabled or disabled in TMask comparisons</short>
|
||||
<seealso>
|
||||
<link id="#lazutils.masks.MasksOverview">Masks Overview</link>
|
||||
</seealso>
|
||||
@ -160,7 +160,7 @@
|
||||
Each <b>literal character</b> must match a single character in the string. Case sensitivity requires the value <link id="TMaskOption">moCaseSensitive</link> in the options passed to the constructor.
|
||||
</p>
|
||||
<p>
|
||||
A <b>set</b> starts with "<b>[</b>" and ends with "<b>]</b>". Each element of a set is a literal character and or a range. A range is defined as a first-to-last literal character string. One character of a set must match a single character in the string. A set [!...] matches if the character is not in the set. The option value <link id="TMaskOption">moDisableSets</link> passed to the constructor disables set processing.
|
||||
A <b>set</b> starts with "<b>[</b>" and ends with "<b>]</b>". Each element of a set is a literal character and or a range. A range is defined as a first-to-last literal character string. One character of a set must match a single character in the string. A set [!...] matches if the character is not in the set. The option value <link id="TMaskOption">moDisableSets</link> passed to the constructor disables set processing and treats the brackets as literal characters.
|
||||
</p>
|
||||
<p>
|
||||
<b>Wildcards</b> are the <b>*</b> and <b>?</b> characters. An asterisk matches any number of characters. A question mark matches a single character.
|
||||
@ -427,7 +427,7 @@
|
||||
<short>Indicates if case sensitivity is used for masks</short>
|
||||
</element>
|
||||
<element name="TMaskList.Create.Options">
|
||||
<short>Indicates the options enabled for the mask instances</short>
|
||||
<short>Contains the options enabled for the mask instances</short>
|
||||
</element>
|
||||
<element name="TMaskList.Destroy">
|
||||
<short>Destructor for the class instance</short>
|
||||
|
||||
@ -43,10 +43,16 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
TDisplaySetting is an enumerated type with values that control display settings in TCalendar. Values from TDisplaySetting are stored in the TDisplaySettings type.
|
||||
<var>TDisplaySetting</var> is an enumerated type with values that control display settings in <var>TCalendar</var>. Values from TDisplaySetting are stored in the <var>TDisplaySettings</var> type.
|
||||
</p>
|
||||
<remark>
|
||||
The value <var>dsStartMonday</var> has been removed in LCL version 2.2 or higher.
|
||||
</remark>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
<seealso>
|
||||
<link id="DefaultDisplaySettings"/>
|
||||
<link id="TCustomCalendar.DisplaySettings"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TDisplaySetting.dsShowHeadings">
|
||||
@ -64,20 +70,19 @@
|
||||
<element name="TDisplaySetting.dsShowWeekNumbers">
|
||||
<short>Displays week numbers</short>
|
||||
</element>
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TDisplaySetting.dsStartMonday">
|
||||
<short>Display days starting with Monday (instead of Sunday)</short>
|
||||
</element>
|
||||
|
||||
<!-- set type Visibility: default -->
|
||||
<element name="TDisplaySettings">
|
||||
<short>Set type for TDisplaySetting values</short>
|
||||
<descr>
|
||||
<p>
|
||||
TDisplaySettings is a set type used to store enumerations values from TDisplaySetting.
|
||||
<var>TDisplaySettings</var> is a set type used to store enumerations values from TDisplaySetting. It is the type used for the <var>DisplaySettings</var> property in <var>TCustomCalendar</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
<seealso>
|
||||
<link id="TCustomCalendar.DisplaySettings"/>
|
||||
<link id="TDisplaySetting"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="DefaultDisplaySettings">
|
||||
@ -86,7 +91,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
DefaultDisplaySettings is a constant with the default display settings used in TCalendar. DefaultDisplaySettings contains the following values:
|
||||
<var>DefaultDisplaySettings</var> is a constant with the default display settings used in <var>TCalendar</var>. DefaultDisplaySettings contains the following values:
|
||||
</p>
|
||||
<dl>
|
||||
<dt>dsShowHeadings</dt>
|
||||
@ -176,6 +181,43 @@
|
||||
<short>Grid has decades for one century</short>
|
||||
</element>
|
||||
|
||||
<element name="TCalDayOfWeek">
|
||||
<short>Represents days of the week used in TCalendar</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TCalDayOfWeek</var> is an enumerated type with values which represent the day used as the first day of the week in <var>TCustomCalendar</var> and descendants.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomCalendar.FirstDayOfWeek"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowMonday">
|
||||
<short>Represents Monday.</short>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowTuesday">
|
||||
<short>Represents Tuesday.</short>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowWednesday">
|
||||
<short>Represents Wednesday.</short>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowThursday">
|
||||
<short>Represents Thursday.</short>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowFriday">
|
||||
<short>Represents Friday.</short>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowSaturday">
|
||||
<short>Represents Saturday.</short>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowSunday">
|
||||
<short>Represents Sunday.</short>
|
||||
</element>
|
||||
<element name="TCalDayOfWeek.dowDefault">
|
||||
<short>
|
||||
Use the default day of the week setting for the platform for the first day of the week. Not compatible with the value used in Delphi (dowLocaleDefault).
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="EInvalidDate">
|
||||
@ -280,7 +322,11 @@
|
||||
<!-- function Visibility: private -->
|
||||
<element name="TCustomCalendar.GetDisplaySettings">
|
||||
<short>Gets the value for the DisplaySettings property</short>
|
||||
<descr></descr>
|
||||
<descr>
|
||||
<link id="TCustomCalendar.DisplaySettings"/>
|
||||
<link id="TDisplaySettings"/>
|
||||
<link id="TDisplaySetting"/>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -293,8 +339,11 @@
|
||||
<element name="TCustomCalendar.SetDisplaySettings">
|
||||
<short>Sets the value for the DisplaySettings property</short>
|
||||
<descr></descr>
|
||||
<errors/>
|
||||
<seealso></seealso>
|
||||
<seealso>
|
||||
<link id="TCustomCalendar.DisplaySettings"/>
|
||||
<link id="TDisplaySettings"/>
|
||||
<link id="TDisplaySetting"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomCalendar.SetDisplaySettings.AValue">
|
||||
@ -505,11 +554,28 @@
|
||||
<dd>Prevents changing the month</dd>
|
||||
<dt>dsShowWeekNumbers</dt>
|
||||
<dd>Displays week numbers</dd>
|
||||
<dt>dsStartMonday</dt>
|
||||
<dd>Days are ordered starting with Monday instead of Sunday</dd>
|
||||
</dl>
|
||||
<remark>
|
||||
The value <var>dsStartMonday</var> is no longer available in LCL version 2.2 or higher. It has been replaced by the <var>FirstDayOfWeek</var> property on platforms where the capablity is supported (Win32, QT, QT5). This is Delphi compatible, and allows any day of the week to be used as the first day of the week.
|
||||
</remark>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
<seealso>
|
||||
<link id="TDisplaySettings"/>
|
||||
<link id="TDisplaySetting"/>
|
||||
<link id="TCustomCalendar.FirstDayOfWeek"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCalendar.FirstDayOfWeek">
|
||||
<short>
|
||||
Indicates the day of the week displayed as the first column in the calendar grid
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>FirstDayOfWeek</var> is a <var>TCalDayOfWeek</var> property which indicates the day used as the first day of the week. It contains a value from the TCalDayOfWeek enumeration, and determines the order of the cells displayed in the calendar grid. The default value is <var>dowDefault</var>, and indicates the default value provided by the platform or operating system is used.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
|
||||
@ -3449,11 +3449,14 @@
|
||||
<short>Event handler signalled when a radio button in the group receives focus</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>OnItemEnter</var> is a <var>TNotifyEvent</var> property that implements the event handler signalled when a radio button in the group receives focus. An application must implement and assign an object procedure to the property to respond to the event notification.
|
||||
<var>OnItemEnter</var> is a <var>TNotifyEvent</var> property that implements the event handler signalled when a radio button in the group receives focus. It occurs when the value in ItemIndex has been changed. An application must implement and assign an object procedure to the property to respond to the event notification. The Sender argument contains the radio button which is selected in the control.
|
||||
</p>
|
||||
<p>
|
||||
OnItemEnter is signalled (when assigned) from the <var>ItemEnter</var> method.
|
||||
</p>
|
||||
<remark>
|
||||
OnItemEnter was added in LCL version 2.2, and should be used in place of the OnEnter event handler. This change is Delphi compatible.
|
||||
</remark>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TRadioButton.OnEnter">TRadioButton.OnEnter</link>
|
||||
@ -3464,11 +3467,14 @@
|
||||
<short>Event handler signalled when a radio button in the group loses focus</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>OnItemExit</var> is a <var>TNotifyEvent</var> property which implements an event handler signalled when a radio button in the group loses focus. An application must implement and assign an object procedure to the property to respond to the event notification.
|
||||
<var>OnItemExit</var> is a <var>TNotifyEvent</var> property which implements an event handler signalled when a radio button in the group loses focus. It occurs when the value in ItemIndex is changed. The Sender argument contains the radio button which has been de-selected in the control. An application must implement and assign an object procedure to the property to respond to the event notification.
|
||||
</p>
|
||||
<p>
|
||||
OnItemExit is signalled from the <var>ItemExit</var> method (when assigned).
|
||||
</p>
|
||||
<remark>
|
||||
OnItemExit was added in LCL version 2.2, and should be used in place of the OnExit event handler. This change is Delphi compatible.
|
||||
</remark>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TRadioButton.OnExit">TRadioButton.OnExit</link>
|
||||
|
||||
@ -47,7 +47,6 @@
|
||||
<element name="FPReadJpeg"/>
|
||||
<element name="FPWriteJpeg"/>
|
||||
<element name="FPReadTiff"/>
|
||||
<element name="FPWriteTiff"/>
|
||||
<element name="FPTiffCmn"/>
|
||||
<element name="FPReadGif"/>
|
||||
<element name="LCLVersion"/>
|
||||
@ -63,7 +62,6 @@
|
||||
<element name="GraphType"/>
|
||||
<element name="GraphMath"/>
|
||||
<element name="FPCAdds"/>
|
||||
<element name="LazUTF8Classes"/>
|
||||
<element name="LazLoggerBase"/>
|
||||
<element name="LazTracer"/>
|
||||
<element name="LazUtilities"/>
|
||||
|
||||
@ -1914,6 +1914,9 @@
|
||||
<li>TTiffImage</li>
|
||||
<li>TPixMap</li>
|
||||
</ul>
|
||||
<remark>
|
||||
Starting with Lazarus 2.2, binary bitmap data stored for the image list in an LFM file uses ZLib compression. While this makes both the LFM and the EXE smaller, it also prevents Lazarus versions prior to 2.0 from opening the LFM file. If you need to maintain a Version 2.X project in an older Lazarus version, you first have to open it in Lazarus 2.0 and resave any forms with a TImageList. Then you can open these resaved LFMs in Lazarus 1versions prior to 2.0.
|
||||
</remark>
|
||||
<p>
|
||||
Use the <var>Width</var> and <var>Height</var> properties to set the default resolution (or size) used for images in the image list. If an image with a size different than the values in Width and Height is added to the default resolution, it is scaled the dimensions required for the resolution. The Width and Height properties also establish the image size used at the 100% scaling level on a 96 PPI display.
|
||||
</p>
|
||||
|
||||
@ -335,7 +335,7 @@
|
||||
</element>
|
||||
|
||||
<element name="ShortCutToText">
|
||||
<short>Returns the textual representation of an shortcut</short>
|
||||
<short>Returns the textual representation for a shortcut value</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -359,7 +359,7 @@
|
||||
</element>
|
||||
|
||||
<element name="TextToShortCut">
|
||||
<short>Converts the textual representation of an shortcut into an shortcut</short>
|
||||
<short>Converts the textual representation for a shortcut into a shortcut value</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
@ -429,6 +429,27 @@
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TMaskEditValidationErrorMode">
|
||||
<short>Represents the action taken for an error in TMaskEdit validation</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TMaskEditValidationErrorMode</var> is an enumerated type with values that represent the action taken when a error occurs while validating the value in <var>TCustomMaskEdit</var> and descendants. It is the type used to implement the <var>ValidationErrorMode</var> property in TCustomMaskEdit.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomMaskEdit.ValidationErrorMode"/>
|
||||
<link id="TCustomMaskEdit.OnValidationError"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TMaskEditValidationErrorMode.mvemException">
|
||||
<short>Causes an exception to be raised for a validation error in TMaskEdit</short>
|
||||
</element>
|
||||
<element name="TMaskEditValidationErrorMode.mvemEvent">
|
||||
<short>
|
||||
Causes the OnValidationError event handler to be signalled for a validation error in TMaskEdit
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="EDBEditError">
|
||||
<short>Exception class raised for an error in a masked edit control</short>
|
||||
<descr>
|
||||
@ -1832,11 +1853,11 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>c</b></td>
|
||||
<td>any optional Utf-8 character</td>
|
||||
<td>any optional Utf-8 character (including a Space character)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>C</b></td>
|
||||
<td>any Utf-8 character in the range #32-#255</td>
|
||||
<td>any Utf-8 character in the range #33-#255 (does not include Space)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>9</b></td>
|
||||
@ -1996,10 +2017,10 @@
|
||||
<short>Enables or disables use of set notation in the EditMask</short>
|
||||
<descr>
|
||||
<p>
|
||||
EnableSets is an experimental Boolean property. It is used when a new value assigned to the EditMask property is parsed to reconstruct the internal mask characters and literals for the control.
|
||||
<var>EnableSets</var> is an experimental <var>Boolean</var> property. It is used when a new value assigned to the EditMask property is parsed to reconstruct the internal mask characters and literals for the control.
|
||||
</p>
|
||||
<p>
|
||||
When set to False, the '[' and ']' characters used to for set notation are treated as literal characters. When set to True, the optional or required set definition is added to the mask. The default value for the property is False.
|
||||
When set to <b>False</b>, the '[' and ']' characters used in set notation are treated as literal characters. When set to <b>True</b>, the optional or required set definition is added to the mask. The default value for the property is <b>False</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -2051,8 +2072,24 @@
|
||||
|
||||
<element name="TMaskEdit.ValidationErrorMode">
|
||||
<short>Indicates the action taken when the control value is invalid for its mask</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ValidationErrorMode</var> is a <var>TMaskEditValidationErrorMode</var> property which indicates the action taken when the value for the control is invalid for the mask in the <var>EditMask</var> property.
|
||||
</p>
|
||||
<p>
|
||||
The default value for the property is <var>mvemException</var>, and causes an exception to be raised when control value is invalid for its mask. Use <var>mvemException</var> to cause the <var>OnValidationError</var> event handler to be signalled for the validation error.
|
||||
</p>
|
||||
<p>
|
||||
The property value is used in the <var>ValidateEdit</var> method when <var>IsMasked</var> is set to <b>True</b> and the EditText for the control is not valid.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomMaskEdit.OnValidationError"/>
|
||||
<link id="TCustomMaskEdit.ValidateEdit"/>
|
||||
<link id="TCustomMaskEdit.IsMasked"/>
|
||||
<link id="TCustomMaskEdit.EditText"/>
|
||||
<link id="TMaskEditValidationErrorMode"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TMaskEdit.Align" link="#lcl.controls.TControl.Align"/>
|
||||
|
||||
@ -442,10 +442,6 @@
|
||||
<short>Tree node examined in the method</short>
|
||||
</element>
|
||||
|
||||
<!--
|
||||
|
||||
The code is stil a Work-In-Progress, and these items were reverted. I expect they will return at some point - so these topics are commented instead of deleted.
|
||||
|
||||
<element name="TCustomShellTreeView.DrawBuiltInIcon">
|
||||
<short>Draws the Shell Icon for the specified tree node</short>
|
||||
<descr>
|
||||
@ -505,7 +501,6 @@
|
||||
<element name="TCustomShellTreeView.GetBuiltinIconSize.Result">
|
||||
<short>TSize instance with the dimensions for the shell icon</short>
|
||||
</element>
|
||||
-->
|
||||
|
||||
<element name="TCustomShellTreeView.Create">
|
||||
<short>Constructor for the class instance</short>
|
||||
@ -771,7 +766,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>OnAddItem</var> is a <var>TAddItemEvent</var> property which contains the event handler signalled when an item (tree node) is added to the shell control. OnAddItem is signalled from the <var>PopulateTreeNodeWithFiles</var> method.
|
||||
<var>OnAddItem</var> is a <var>TAddItemEvent</var> property which contains the event handler signalled when an item (tree node) is added to the shell control. OnAddItem is signalled from the <var>PopulateTreeNodeWithFiles</var> method, and allows the base path and file information for each file to be checked before it is added to the tree view.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -1362,6 +1357,7 @@
|
||||
<link id="TAddItemEvent"/>
|
||||
<link id="TCustomShellListView.Items"/>
|
||||
<link id="TCustomShellListView.DoAddItem"/>
|
||||
<link id="TCustomShellListView.PopulateWithRoot"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
|
||||
@ -800,7 +800,7 @@
|
||||
<short>Updates the control style when the parent background is used</short>
|
||||
<descr>
|
||||
<p>
|
||||
UpdateOpaque is a method used to update the control style flags when the parent background is used for the control. When the ParentBackground property is set to True, ControlStyle is updated to remove the csOpaque flag. If ParentBackground is not enabled, CornStyle is updated to include the csOpaque flag.
|
||||
<var>UpdateOpaque</var> is a method used to update the control style flags when the parent background is used for the control. When the <var>ParentBackground</var> property is set to <b>True</b>, <var>ControlStyle</var> is updated to remove the <var>csOpaque</var> flag. If ParentBackground is not enabled, ControlStyle is updated to include the csOpaque flag.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -829,7 +829,7 @@
|
||||
<short>Sets the value for the Color property</short>
|
||||
<descr>
|
||||
<p>
|
||||
SetColor is a method used to set the value in the Color property. It calls the inherited method on entry.
|
||||
<var>SetColor</var> is a method used to set the value in the <var>Color</var> property. It calls the inherited method on entry.
|
||||
</p>
|
||||
<p>
|
||||
When the value for the Color property is set to <var>clDefault</var>, or has the same value as the Color property in <var>Parent</var>, no additional actions are performed in the method. Otherwise, the value in ParentBackground is set to <b>False</b>.
|
||||
@ -846,9 +846,23 @@
|
||||
|
||||
<element name="TCustomGroupBox.SetParentBackground">
|
||||
<short>Sets the value for the ParentBackground proprety</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetParentBackground</var> is an overridden method in <var>TCustomGroupBox</var> used to set the value for the <var>ParentBackground</var> property. It calls the inherited method on entry.
|
||||
</p>
|
||||
<p>
|
||||
When the property value is set to <b>True</b> and <var>ParentColor</var> is enabled, the Color property in the <var>Parent</var> control is assigned to the Color property for the group box. Otherwise, <var>clDefault</var> is assigned to the <var>Color</var> property.
|
||||
</p>
|
||||
<p>
|
||||
SetParentBackground calls the <var>UpdateOpaque</var> method to ensure that the ControlStyle flags for the control reflect the transparency needed to draw the parent background.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomGroupBox.SetParentBackground"/>
|
||||
<link id="TCustomGroupBox.UpdateOpaque"/>
|
||||
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
|
||||
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
|
||||
<link id="#lcl.graphics.clDefault">clDefault</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomGroupBox.SetParentBackground.AParentBackground">
|
||||
|
||||
@ -1067,7 +1067,7 @@
|
||||
<short>Key data for the modified row</short>
|
||||
</element>
|
||||
|
||||
<element name="TValueListEditor" link="#lcl.grids.TCustomStringGrid">
|
||||
<element name="TValueListEditor">
|
||||
<short>
|
||||
A visual grid control for editing Key-Value pairs
|
||||
</short>
|
||||
@ -1076,8 +1076,11 @@
|
||||
<var>TValueListEditor</var> is a <var>TCustomStringGrid</var> descendant which implements a grid-style editor control for Key-Value pairs. TValueListEditor displays a two column grid where the first column is read-only, and lists the key names. The second column is for editing the associated values for the key names.
|
||||
</p>
|
||||
<p>
|
||||
TValueListEditor provides properties with the Keys and Values displayed in the rows for the control. The Cells property allows access using the familiar column and row number mechanism used in grid controls. The Strings property allows access to the strings used for the Key and Value in a row.
|
||||
TValueListEditor provides properties with the Keys and Values displayed in the rows and columns for the control. The Cells property allows access using the familiar column and row number mechanism used in grid controls. The Strings property allows access to the strings used for the Key and Value in a row.
|
||||
</p>
|
||||
<remark>
|
||||
Since version 2.2.0, Keys will no longer allow the name/value separator used in the Strings property to be entered as a value in the Key column. When entered, focus is moved to the Value column. If pasted into the Key column, the value is silently discarded.
|
||||
</remark>
|
||||
<p>
|
||||
The ItemProps property is used to configure the cell editors used for the Keys and Values. This includes setting the editor style, edit mask, maximum length for the value, a list of selectable pick list values, and a read-only flag. Descriptive text for the Key name can also be stored in the ItemProps.
|
||||
</p>
|
||||
@ -1100,7 +1103,7 @@
|
||||
<seealso>
|
||||
<link id="TItemPropList"/>
|
||||
<link id="TItemProp"/>
|
||||
<link id="#LCL.Grids.TCustomStringGrid">TCustomStringGrid</link>
|
||||
<link id="#lcl.grids.tcustomstringgrid">TCustomStringGrid</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
@ -2368,6 +2371,9 @@
|
||||
<p>
|
||||
Use <var>Values</var> to access the value for a specific Key name in the control.
|
||||
</p>
|
||||
<remark>
|
||||
Since version 2.2.0, Keys will no longer allow the name/value separator used in the Strings property to be used as a value in the property.
|
||||
</remark>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TValueListEditor.Values"/>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user