mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-06 07:58:07 +02:00
Docs: LCL. Adds or updates topic content.
This commit is contained in:
dsiders
parent
f353e71e8a
commit
b4b11c6f2a
@ -7889,7 +7889,7 @@
|
||||
<element name="TControl.RealGetText">
|
||||
<short>Returns the Caption property.</short>
|
||||
<descr>
|
||||
This method is called by <var>GetText</var>, when GetTextBuf is not overridden.
|
||||
This method is called by <var>GetText</var>, when GetTextBuf has not been overridden.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TControl.GetTextBuf"/>
|
||||
@ -7898,22 +7898,38 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TControl.RealGetText.Result">
|
||||
<short>The Caption property.</short>
|
||||
<short>Value for the Caption property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TControl.RealSetText">
|
||||
<short>Sets the Caption property.</short>
|
||||
<short>Sets the value for the Caption property.</short>
|
||||
<descr>
|
||||
This method is called by <var>SetText</var>, when SetTextBuf is not overridden.
|
||||
<p>
|
||||
RealSetText is a method used to apply the TCaption value in AValue to the text or caption for the control. RealSetText is called by the private <var>SetText</var> method, when <var>SetTextBuf</var> has not been overridden.
|
||||
</p>
|
||||
<p>
|
||||
<b>Notes on TControl.Caption, TControl.Text, et. al.</b>
|
||||
</p>
|
||||
<p>
|
||||
The Delphi VCL implementation relies on the virtual GetTextBuf and SetTextBuf methods to exchange text for controls.. This requires a lot of (unnecessary) copies to move values between Text and Caption.
|
||||
</p>
|
||||
<p>
|
||||
The LCL uses strings to exchange text values because it is more efficient. To maintain VCL compatibility, the virtual RealGetText and RealSetText methods were introduced. These functions use the LCLInterface. The default GetTextBuf and SetTextBuf implementations calls the RealGetText and RealSetText methods as needed. As long as the GetTextBuf and/or SetTextBuf aren't overridden, GetText and SetText call RealGetText and RealSetText to avoid copying PChar values.
|
||||
</p>
|
||||
<p>
|
||||
To keep things optimal, LCL implementations should always override RealGetText and RealSetText. GetTextBuf and SetTextBuf are only kept for compatibility with Delphi code.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TControl.SetTextBuf"/>
|
||||
<link id="TControl.Caption"/>
|
||||
<link id="TControl.Text"/>
|
||||
<link id="TControl.RealGetText"/>
|
||||
<link id="TControl.SetTextBuf"/>
|
||||
<link id="TControl.GetTextBuf"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TControl.RealSetText.Value">
|
||||
<short>The string to store.</short>
|
||||
<short>The string value to store in the Text / Caption properties.</short>
|
||||
</element>
|
||||
|
||||
<element name="TControl.TextChanged">
|
||||
@ -7934,9 +7950,19 @@
|
||||
<short>Here: FCaption (can be overridden).</short>
|
||||
</element>
|
||||
|
||||
<element link="#lcl.controls.TControl.Action" name="TControl.SetAction"/>
|
||||
<element name="TControl.SetAction">
|
||||
<short>Sets the value for the Action property.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Ensures that ActionLink is updated when the value for the property is updated. When Value is unassigned (Nil), ActionLink is freed and set to Nil. The control style flags are also updated to remove the value csActionClient. Otherwise, a new ActionLink class instance is created for ActionLink and Value is assigned to its Action property. Its OnChange handler is assigned, and the ActionChange method is called to apply values from the action to the control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TControl.Action"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TControl.SetAction.Value">
|
||||
<short/>
|
||||
<short>New value for the Action property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TControl.SetColor">
|
||||
@ -7957,9 +7983,19 @@
|
||||
<short>New value for the Color property.</short>
|
||||
</element>
|
||||
|
||||
<element link="#lcl.controls.TControl.Enabled" name="TControl.SetEnabled"/>
|
||||
<element name="TControl.SetEnabled">
|
||||
<short>Sets the value for the Enabled property.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls EnabledChanging to notify handlers for the chtOnEnabledChanged type. Stores the new value for the property, and performs a CM_ENABLEDCHANGED control message. Calls EnabledChanged to notify handlers for the chtOnEnabledChanged type.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TControl.Enabled"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TControl.SetEnabled.Value">
|
||||
<short/>
|
||||
<short>New value for the Enabled property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TControl.SetHint">
|
||||
@ -14085,9 +14121,24 @@
|
||||
<short>Value for the MouseCapture property.</short>
|
||||
</element>
|
||||
|
||||
<element link="#lcl.controls.TControl.RealSetText" name="TWinControl.RealSetText"/>
|
||||
<element name="TWinControl.RealSetText">
|
||||
<short>Sets the text / caption for the control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>RealSetText</var> is an overridden method in TWinControl. It ensures that the new value is applied to the widgetset class when its Handle has been allocated, and the control size is adjusted when needed/enabled. The inherited method is called to apply AValue to the Text and/or Caption properties for the control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TWinControl.WSSetText"/>
|
||||
<link id="TControl.Caption"/>
|
||||
<link id="TControl.Text"/>
|
||||
<link id="TControl.RealSetText"/>
|
||||
<link id="TControl.RealGetText"/>
|
||||
<link id="TControl.AdjustSize"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TWinControl.RealSetText.AValue">
|
||||
<short/>
|
||||
<short>New value for the text / caption for the control.</short>
|
||||
</element>
|
||||
|
||||
<element name="TWinControl.RemoveFocus">
|
||||
|
||||
@ -1771,7 +1771,7 @@ ADialog.CustomColors.Values['ColorA'] := 'FFFF00';
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create allocates resources needed for the Font property, and sets the default values in the Options property.
|
||||
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create allocates resources needed for the <var>Font</var> property, and sets the default values in the <var>Options</var> property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -1813,12 +1813,13 @@ ADialog.CustomColors.Values['ColorA'] := 'FFFF00';
|
||||
<short>Minimum font size allowed in the font selection dialog.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>MinFontSize</var> is an Integer property which contains the minimum font size allowed in the font selection dialog. Limiting font size selection to the range in <var>MinFontSize</var> and <var>MaxFontSize</var> must be enabled using the <var>Options</var> property.
|
||||
<var>MinFontSize</var> is an Integer property which contains the minimum font size allowed in the font selection dialog. Limiting font size selection to the range in <var>MinFontSize</var> and <var>MaxFontSize</var> must be enabled by including <var>fdLimitSize</var> in the <var>Options</var> property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TFontDialog.MaxFontSize"/>
|
||||
<link id="TFontDialog.Options"/>
|
||||
<link id="TFontDialogOption"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
@ -1826,17 +1827,18 @@ ADialog.CustomColors.Values['ColorA'] := 'FFFF00';
|
||||
<short>Maximum font size allowed in the font selection dialog.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>MaxFontSize</var> is an Integer property which contains the maximum font size allowed in the font selection dialog. Limiting font size selection to the range in <var>MinFontSize</var> and <var>MaxFontSize</var> must be enabled using the <var>Options</var> property.
|
||||
<var>MaxFontSize</var> is an Integer property which contains the maximum font size allowed in the font selection dialog. Limiting font size selection to the range in <var>MinFontSize</var> and <var>MaxFontSize</var> must be enabled by including <var>fdLimitSize</var> in the <var>Options</var> property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TFontDialog.MinFontSize"/>
|
||||
<link id="TFontDialog.Options"/>
|
||||
<link id="TFontDialogOption"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TFontDialog.Options">
|
||||
<short>A set of options available from TFontDialogOptions.</short>
|
||||
<short>A set of TFontDialogOption options enabled for the dialog.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Options</var> is a <var>TFontDialogOptions</var> property which controls the options enabled for the font selection dialog. Options contains zero or more values from the <var>TFontDialogOption</var> enumeration. The default value for the property is <var>[fdEffects]</var>, and enables the font effects check boxes in the dialog.
|
||||
@ -1845,7 +1847,7 @@ ADialog.CustomColors.Values['ColorA'] := 'FFFF00';
|
||||
See <link id="TFontDialogOption">TFontDialogOption</link> for more information about the values in the enumeration and their usage.
|
||||
</p>
|
||||
<p>
|
||||
Set (or Include and Exclude) values in the property prior to calling the Execute method.
|
||||
Include or Exclude values for the property prior to calling the <var>Execute</var> method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -4342,7 +4344,7 @@ end;
|
||||
</element>
|
||||
|
||||
<element name="TCustomCopyToClipboardDialog">
|
||||
<short>Base class for a dialog form used for copy to clipboard operations.</short>
|
||||
<short>Base class for a dialog form used during copy to clipboard operations.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -4381,7 +4383,9 @@ end;
|
||||
Enables key preview and adds the OnKeyDown handler for the specified dialog.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TCustomCopyToClipboardDialog.DoCreate"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="RegisterDialogForCopyToClipboard.ADlg">
|
||||
<short>Dialog form instance updated in the routine.</short>
|
||||
@ -4416,7 +4420,7 @@ end;
|
||||
</element>
|
||||
|
||||
<element name="cInputQueryEditSizePercents">
|
||||
<short>Input Query Edit size in % of monitor width.</short>
|
||||
<short>Input Query Edit size as a percentage of the monitor width.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -4431,16 +4435,30 @@ end;
|
||||
<short>List of options available when selecting a directory.</short>
|
||||
</element>
|
||||
<element name="TSelectDirOpt.sdAllowCreate">
|
||||
<short/>
|
||||
<short>Allows a new directory to be created in a select directory dialog.</short>
|
||||
</element>
|
||||
<element name="TSelectDirOpt.sdPerformCreate">
|
||||
<short/>
|
||||
<short>
|
||||
Indicates a directory that does not already exist should be created following execution of the dialog.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TSelectDirOpt.sdPrompt">
|
||||
<short/>
|
||||
<short>
|
||||
Indicates the dialog should prompt the user for confirmation of the selected action.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TSelectDirOpts">
|
||||
<short>Set type for directory selection options.</short>
|
||||
<short>Set type used to store directory selection options.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TSelectDirOpts</var> is a set type used to store zero or more values from the TSelectDirOpt enumeration. Values added to the set indicate the options enabled for a directory selection dialog. A TSelectDirOpts argument is passed to the <var>SelectDirectory</var> routine.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TSelectDirOpt"/>
|
||||
<link id="SelectDirectory"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TInputCloseQueryEvent">
|
||||
@ -4668,7 +4686,7 @@ end;
|
||||
</element>
|
||||
<element name="InputComboEx.Result">
|
||||
<short>
|
||||
String with the item selected in the combo-box, or and empty string if the dialog is cancelled.
|
||||
String with the item selected in the combo-box, or an empty string if the dialog is cancelled.
|
||||
</short>
|
||||
</element>
|
||||
<element name="InputComboEx.ACaption">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user