paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-11-25 11:17:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL. Updates topic content. Adds missing topics. Fixes broken or missing links.

Browse Source 
git-svn-id: trunk@65325 -
This commit is contained in:
dsiders 2021-06-29 05:03:35 +00:00
parent 5ae03bd920
commit c16bbd6e94
5 changed files with 896 additions and 235 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/xml/lcl/controls.xml
View File

@ -13022,12 +13022,18 @@
<short/>
</element>
<element link="#lcl.controls.TWinControl.DoKeyPress" name="TWinControl.DoUTF8KeyPress"/>
<element name="TWinControl.DoUTF8KeyPress">
<short>
Tries all <link id="#lcl.Controls.TWinControl.OnUTF8KeyPress">OnUTF8KeyPress</link> handlers; the Parent OnUTF8KeyPress handler is tried first.
</short>
<descr/>
<seealso/>
</element>
<element name="TWinControl.DoUTF8KeyPress.Result">
<short>True if the key was handled.</short>
</element>
<element name="TWinControl.DoUTF8KeyPress.UTF8Key">
<short/>
<short>UTF-8-encoded character examined in the method.</short>
</element>
<element name="TWinControl.DoKeyUpBeforeInterface">

37
docs/xml/lcl/filectrl.xml
View File

@ -597,8 +597,15 @@
<element name="TFileListBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TFileListBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TFileListBox.BiDiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TFileListBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TFileListBox.BorderStyle" link="#lcl.controls.TWinControl.BorderStyle"/>
<element name="TFileListBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TFileListBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TFileListBox.Directory" link="#lcl.filectrl.TCustomFileListBox.Directory"/>
<element name="TFileListBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TFileListBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TFileListBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TFileListBox.ExtendedSelect" link="#lcl.stdctrls.TCustomListBox.ExtendedSelect"/>
<element name="TFileListBox.FileType" link="#lcl.filectrl.TCustomFileListBox.FileType"/>
<element name="TFileListBox.Font" link="#lcl.controls.TControl.Font"/>
@ -608,28 +615,31 @@
<element name="TFileListBox.MultiSelect" link="#lcl.stdctrls.TCustomListBox.MultiSelect"/>
<element name="TFileListBox.OnChange" link="#lcl.filectrl.TCustomFileListBox.OnChange"/>
<element name="TFileListBox.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TFileListBox.Directory" link="#lcl.filectrl.TCustomFileListBox.Directory"/>
<element name="TFileListBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TFileListBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TFileListBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TFileListBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TFileListBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TFileListBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TFileListBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TFileListBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TFileListBox.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TFileListBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TFileListBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TFileListBox.OnDrawItem" link="#lcl.stdctrls.TCustomListBox.OnDrawItem"/>
<element name="TFileListBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TFileListBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TFileListBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TFileListBox.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TFileListBox.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TFileListBox.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TFileListBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TFileListBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TFileListBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TFileListBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TFileListBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TFileListBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TFileListBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TFileListBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TFileListBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TFileListBox.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TFileListBox.OnSelectionChange" link="#lcl.stdctrls.TCustomListBox.OnSelectionChange"/>
<element name="TFileListBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TFileListBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TFileListBox.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TFileListBox.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TFileListBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TFileListBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TFileListBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
@ -640,10 +650,6 @@
<element name="TFileListBox.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TFileListBox.TopIndex" link="#lcl.stdctrls.TCustomListBox.TopIndex"/>
<element name="TFileListBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TFileListBox.BiDiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TFileListBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TFileListBox.OnSelectionChange" link="#lcl.stdctrls.TCustomListBox.OnSelectionChange"/>
<element name="TFileListBox.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TCustomFilterComboBox">
<short>Specifies a combo-box used to select a file filter.</short>
@ -936,8 +942,13 @@ Binaries (*.exe)</pre>
<element name="TFilterComboBox.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TFilterComboBox.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TFilterComboBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TFilterComboBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TFilterComboBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TFilterComboBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TFilterComboBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TFilterComboBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TFilterComboBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TFilterComboBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TFilterComboBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TFilterComboBox.OnSelect" link="#lcl.stdctrls.TCustomComboBox.OnSelect"/>
<element name="TFilterComboBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>

319
docs/xml/lcl/forms.xml
View File

@ -1251,7 +1251,19 @@
<short>New value for the property.</short>
</element>
<element name="TScrollingWinControl.Create" link="#rtl.classes.TComponent.Create"/>
<element name="TScrollingWinControl.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method on entry. It allocates resources needed for the <var>VertScrollBar</var> and <var>HorzScrollBar</var> properties, sets the default value in <var>AutoScroll</var> to <b>False</b>, and sets the initial bounds for the class instance.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.AutoScroll"/>
</seealso>
</element>
<element name="TScrollingWinControl.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
@ -1381,11 +1393,28 @@
<link id="TScrollingWinControl"/>
</seealso>
</element>
<element name="TScrollBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TScrollBox.Create" link="#rtl.classes.TComponent.Create"/>
<element name="TScrollBox.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. It calls the inherited method on entry, an updates the component and control style flags as needed for the class instance. It sets the default values for the following properties:
</p>
<ul>
<li>AutoScroll (True)</li>
<li>BorderStyle (bsSingle)</li>
</ul>
</descr>
<seealso>
<link id="#lcl.forms.TScrollingWinControl.Create">TScrollingWinControl.Create</link>
</seealso>
</element>
<element name="TScrollBox.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TScrollBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TScrollBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TScrollBox.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
@ -1404,7 +1433,7 @@
<element name="TScrollBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TScrollBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TScrollBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TScrollBox.ParentBackground" link="#lcl.controls.TControl.ParentBackground"/>
<element name="TScrollBox.ParentBackground" link="#lcl.controls.TWinControl.ParentBackground"/>
<element name="TScrollBox.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TScrollBox.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TScrollBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
@ -1621,6 +1650,7 @@
<descr/>
<seealso/>
</element>
<element name="TCustomDesignControl.Scaled">
<short>
Indicates if the design surface is scaled to reflect changes in display density (Pixels Per Inch).
@ -1804,20 +1834,42 @@
<short>Control message handled in the method.</short>
</element>
<element name="TCustomFrame.DefineProperties" link="#rtl.classes.TComponent.DefineProperties"/>
<element name="TCustomFrame.DefineProperties">
<short>
Defines non-published properties that are included in LCL component streaming.
</short>
<descr>
<p>
<var>DefineProperties</var> is an overridden method used to include non-published properties in the values read and written during LCL component streaming. In TCustomFrame, design-time information for the Top and Left coordinates for the frame are included (when available) in the specified TFiler instance.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.DefineProperties">TControl.DefineProperties</link>
</seealso>
</element>
<element name="TCustomFrame.DefineProperties.Filer">
<short/>
<short>TFiler instance where property definitions are added.</short>
</element>
<element name="TCustomFrame.CalculatePreferredSize" link="#lcl.controls.TControl.CalculatePreferredSize"/>
<element name="TCustomFrame.CalculatePreferredSize.PreferredWidth">
<short/>
</element>
<element name="TCustomFrame.CalculatePreferredSize.PreferredHeight">
<short/>
</element>
<element name="TCustomFrame.CalculatePreferredSize.WithThemeSpace">
<short/>
<element name="TCustomFrame.CalculatePreferredSize.PreferredWidth"/>
<element name="TCustomFrame.CalculatePreferredSize.PreferredHeight"/>
<element name="TCustomFrame.CalculatePreferredSize.WithThemeSpace"/>
<element name="TCustomFrame.UpdateOpaque">
<short>Updates control style flags to reflect the transparency for the frame.</short>
<descr>
<p>
<var>UpdateOpaque</var> is a method used to update <var>ControlStyle</var> flags to reflect the transparency for the frame. When <var>ParentBackground</var> is <b>True</b>, the value <var>csOpaque</var> is excluded from the <var>ControlStyle</var> property to allow the frame to be drawn with transparency. When set to <b>False</b>, csOpaque is included in ControlStyle.
</p>
<p>
UpdateOpaque is called when the value for the ParentBackground has been changed, and when the <var>CM_PARENTCOLORCHANGED</var> control message is handled for the frame.
</p>
</descr>
<seealso>
<link id="TCustomFrame.ParentBackground"/>
<link id="#lcl.controls.TControl.ControlStyle">TControl.ControlStyle</link>
</seealso>
</element>
<element name="TCustomFrame.Create">
@ -1921,6 +1973,7 @@
<element name="TFrame.ClientWidth" link="#lcl.controls.TControl.ClientWidth"/>
<element name="TFrame.Color" link="#lcl.controls.TControl.Color"/>
<element name="TFrame.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TFrame.DesignTimePPI" link="#lcl.forms.TCustomDesignControl.DesignTimePPI"/>
<element name="TFrame.DockSite" link="#lcl.controls.TWinControl.DockSite"/>
<element name="TFrame.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TFrame.DragKind" link="#lcl.controls.TControl.DragKind"/>
@ -1949,15 +2002,20 @@
<element name="TFrame.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TFrame.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TFrame.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TFrame.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TFrame.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TFrame.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TFrame.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TFrame.OnStartDock" link="#lcl.controls.TControl.OnStartDock"/>
<element name="TFrame.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TFrame.OnUnDock" link="#lcl.controls.TWinControl.OnUnDock"/>
<element name="TFrame.ParentBackground" link="#lcl.forms.TCustomFrame.ParentBackground"/>
<element name="TFrame.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TFrame.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TFrame.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TFrame.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TFrame.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TFrame.Scaled" link="#lcl.forms.TCustomDesignControl.Scaled"/>
<element name="TFrame.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TFrame.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TFrame.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
@ -3137,7 +3195,7 @@
<short>Values examined and updated in the method.</short>
</element>
<element name="TCustomForm.CreateWnd" link="#lcl.controls.TWinControl.CreateWnd">
<element name="TCustomForm.CreateWnd">
<short>
Creates the handle for the widgetset class and updates it Menu and Icons.
</short>
@ -3373,12 +3431,27 @@
</seealso>
</element>
<element name="TCustomForm.Notification" link="#rtl.classes.TComponent.Notification"/>
<element name="TCustomForm.Notification">
<short>
Handles the notification when a component is added to or removed from the form.
</short>
<descr>
<p>
<var>Notification</var> is an overridden method in <var>TCustomForm</var> used to handle the notification when the component in <var>AComponent</var> has been added to or removed from the form instance. Operation is the action performed for the component.
</p>
<p>
Notification calls the inherited method on entry, and performs additional actions for the ActionList, Menu, and pop-up parent form used in the control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Notification">TControl.Notification</link>
</seealso>
</element>
<element name="TCustomForm.Notification.AComponent">
<short/>
<short>Component for the notification.</short>
</element>
<element name="TCustomForm.Notification.Operation">
<short/>
<short>Operation performed for the component.</short>
</element>
<element name="TCustomForm.PaintWindow" link="#lcl.controls.TCustomControl.PaintWindow">
@ -3451,6 +3524,18 @@
<short/>
</element>
<element name="TCustomForm.DoOnResize">
<short>Performs a delayed resize action using the DelayedEvent for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.DoOnChangeBounds">
<short>Performs a delayed bounds change using the DelayedEvent for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.SetZOrder">
<short>Moves a top-level form in front or back of all forms.</short>
<descr/>
@ -3669,14 +3754,16 @@
</descr>
</element>
<element name="TCustomForm.VisibleIsStored" link="#lcl.forms.TCustomForm.Visible">
<element name="TCustomForm.VisibleIsStored">
<short>Implements the storage specifier for the Visible property.</short>
<descr>
<p>
Returns the value in the Visible property.
</p>
</descr>
<seealso/>
<seealso>
<link id="TCustomForm.Visible"/>
</seealso>
</element>
<element name="TCustomForm.VisibleIsStored.Result">
<short>True when the Visible property is set to True.</short>
@ -3734,7 +3821,6 @@
<link id="TCustomDesignControl.Scaled"/>
<link id="TCustomDesignControl.SetScaled"/>
<link id="TApplication.Scaled"/>
<link id="TForm.Scaled"/>
</seealso>
</element>
<element name="TCustomForm.SetScaled.AScaled">
@ -4494,8 +4580,14 @@
</element>
<element name="TCustomForm.WantChildKey">
<short/>
<descr>Always returns False in TCustomForm</descr>
<short>
Indicates if key messages in a child control are handled in the message processing loop for the form.
</short>
<descr>
<p>
Always returns <b>False</b> in <var>TCustomForm</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WantChildKey.Result">
@ -5619,11 +5711,58 @@
<seealso/>
</element>
<element name="TForm.CreateWnd" link="#lcl.controls.TWinControl.CreateWnd"/>
<element name="TForm.Loaded" link="#lcl.forms.TCustomForm.Loaded"/>
<element name="TForm.Create" link="#rtl.classes.TComponent.Create"/>
<element name="TForm.CreateWnd">
<short>
Creates the handle for the widgetset class and updates it menu and icons.
</short>
<descr>
<p>
<var>CreateWnd</var> is an overridden method in <var>TForm</var>. It makes the form instance the main form in the <var>Application</var> singleton if not already assigned and the form is not a MDI Child or a splash form.
</p>
<p>
CreateWnd calls the inherited method to create (or re-create) the Handle for the widgetset class, set the form state and auto-sizing behavior, and update its Menu and Icons.
</p>
</descr>
<seealso>
<link id="TCustomForm.CreateWnd"/>
<link id="TCustomForm.FormStyle"/>
<link id="TCustomForm.Menu"/>
<link id="TCustomForm.Icon"/>
<link id="TCustomForm.BorderIcons"/>
<link id="TApplication.MainForm"/>
</seealso>
</element>
<element name="TForm.Loaded">
<short>
Performs actions when LCL component streaming has been completed for the form instance.
</short>
<descr>
<p>
<var>Loaded</var> is an overridden method in <var>TForm</var>, and calls the inherited method on entry. It ensures that the value in the <var>LCLVersion</var> property is set to the <var>lcl_version</var> constant from the <file>LCLVersion</file> unit.
</p>
</descr>
<seealso>
<link id="TForm.LCLVersion"/>
<link id="TCustomForm.Loaded"/>
</seealso>
</element>
<element name="TForm.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is an overridden constructor for the class instance. Create ensures that the <var>LCLVersion</var> property is updated with the value from the <var>lcl_version</var> constant in the <file>LCLVersion</file> unit. Create calls the inherited constructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TCustomForm.Create"/>
<link id="TCustomForm.CreateNew"/>
<link id="#lcl.lclversion.lcl_version">lcl_version</link>
</seealso>
</element>
<element name="TForm.Create.TheOwner">
<short/>
<short>Owner of the form instance.</short>
</element>
<element name="TForm.Cascade">
@ -5660,6 +5799,20 @@
<seealso/>
</element>
<element name="TForm.ArrangeIcons">
<short>Arranges the icons for minimized forms in a MDI form.</short>
<descr>
<p>
<var>ArrangeIcons</var> is a method used to arrange the icons for minimized forms on a MDI form. No actions are performed in the method at design-time, or when <var>FormStyle</var> is set to a value other than <var>fsMDIForm</var>. ArrangeIcons calls the corresponding method in the widgetset class when its <var>Handle</var> has been allocated.
</p>
</descr>
<seealso>
<link id="TCustomForm.FormStyle"/>
<link id="#lcl.controls.TWinControl.Handle">TWinControl.Handle</link>
<link id="#lcl.controls.TWinControl.HandleAllocated">TWinControl.HandleAllocated</link>
</seealso>
</element>
<element name="TForm.ClientHandle" link="#lcl.forms.TCustomForm.ClientHandle"/>
<element name="TForm.DockManager" link="#lcl.controls.TWinControl.DockManager"/>
<element name="TForm.Action" link="#lcl.controls.TControl.Action"/>
@ -5684,7 +5837,7 @@
<element name="TForm.DefaultMonitor" link="#lcl.forms.TCustomForm.DefaultMonitor"/>
<element name="TForm.DesignTimePPI" link="#lcl.forms.TCustomDesignControl.DesignTimePPI"/>
<element name="TForm.DockSite" link="#lcl.controls.TWinControl.DockSite"/>
<element name="TForm.DoubleBuffered" link="#lcl.controls.TControl.DoubleBuffered"/>
<element name="TForm.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TForm.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TForm.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TForm.Enabled" link="#lcl.controls.TControl.Enabled"/>
@ -5699,7 +5852,8 @@
<element name="TForm.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TForm.OnClose" link="#lcl.forms.TCustomForm.OnClose"/>
<element name="TForm.OnCloseQuery" link="#lcl.forms.TCustomForm.OnCloseQuery"/>
<element name="TForm.OnContextPopup" link="#lcl.forms.TCustomForm.OnContextPopup"/>
<element name="TForm.OnConstrainedResize" link="#lcl.controls.TControl.OnConstrainedResize"/>
<element name="TForm.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TForm.OnCreate" link="#lcl.forms.TCustomForm.OnCreate"/>
<element name="TForm.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TForm.OnDeactivate" link="#lcl.forms.TCustomForm.OnDeactivate"/>
@ -5724,6 +5878,9 @@
<element name="TForm.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TForm.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TForm.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TForm.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TForm.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TForm.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TForm.OnPaint" link="#lcl.controls.TCustomControl.OnPaint"/>
<element name="TForm.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TForm.OnShortCut" link="#lcl.forms.TCustomForm.OnShortcut"/>
@ -5734,9 +5891,9 @@
<element name="TForm.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TForm.OnWindowStateChange" link="#lcl.forms.TCustomForm.OnWindowStateChange"/>
<element name="TForm.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TForm.ParentDoubleBuffered" link="#lcl.controls.TControl.ParentDoubleBuffered"/>
<element name="TForm.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TForm.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TForm.PixelsPerInch" link="#lcl.forms.TCustomForm.PixelsPerInch"/>
<element name="TForm.PixelsPerInch" link="#lcl.forms.TCustomDesignControl.PixelsPerInch"/>
<element name="TForm.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TForm.PopupMode" link="#lcl.forms.TCustomForm.PopupMode"/>
<element name="TForm.PopupParent" link="#lcl.forms.TCustomForm.PopupParent"/>
@ -5757,7 +5914,7 @@
</descr>
</element>
<element name="TForm.Scaled"/>
<element name="TForm.Scaled" link="#lcl.forms.TCustomDesignControl.Scaled"/>
<element name="TForm.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TForm.WindowState" link="#lcl.forms.TCustomForm.WindowState"/>
@ -5827,15 +5984,32 @@
<seealso/>
</element>
<element name="TCustomDockForm.Create" link="#rtl.classes.TComponent.Create"/>
<element name="TCustomDockForm.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance. It calls CreateNew to create a new form instance, and sets the default values for:
</p>
<ul>
<li>AutoScroll (False)</li>
<li>BorderStyle (bsSizeToolWin)</li>
<li>DockSite (True)</li>
<li>FormStyle (fsStayOnTop)</li>
</ul>
</descr>
<seealso>
<link id="TCustomForm.CreateNew"/>
</seealso>
</element>
<element name="TCustomDockForm.Create.TheOwner">
<short>Owner for the class instance.</short>
</element>
<element name="TCustomDockForm.AutoScroll" link="#lcl.forms.TScrollingWinControl.AutoScroll"/>
<element name="TCustomDockForm.AutoScroll" link="#lcl.forms.TCustomForm.AutoScroll"/>
<element name="TCustomDockForm.BorderStyle" link="#lcl.forms.TCustomForm.BorderStyle"/>
<element name="TCustomDockForm.FormStyle" link="#lcl.forms.TCustomForm.FormStyle"/>
<element name="TCustomDockForm.PixelsPerInch" link="#lcl.forms.TCustomForm.PixelsPerInch"/>
<element name="TCustomDockForm.PixelsPerInch" link="#lcl.forms.TCustomDesignControl.PixelsPerInch"/>
<element name="THintWindow">
<short>
@ -10536,19 +10710,31 @@
</element>
<element name="TApplication.DisableIdleHandler">
<short>.
</short>
<short>Disables Idle handling.</short>
<descr>
Blocks Idle handling. Can be called more often, every call must be followed by EnableIdleHandler.
<p>
Blocks Idle handling by incrementing the internal idle lock counter. Can be called multiple times, but each call must be followed by EnableIdleHandler.
</p>
<p>
Used in the ShowException method while an exception dialog is active.
</p>
</descr>
<seealso>
<link id="TApplication.EnableIdleHandler"/>
<link id="TApplication.ShowException"/>
</seealso>
</element>
<element name="TApplication.EnableIdleHandler">
<short>Resume Idle handling.</short>
<descr/>
<short>Resumes Idle handling.</short>
<descr>
<p>
Attempts to re-enable idle handling by decrementing the internal idle lock counter. Idle handling is enabled when the internal idle lock counter is 0.
</p>
<p>
Called from the ShowException method when the exception dialog is exited.
</p>
</descr>
<errors>
Raises a catchable GDB Exception if the idle handler has not already been disabled.
</errors>
@ -10558,7 +10744,7 @@
</element>
<element name="TApplication.NotifyUserInputHandler">
<short>Notifies all user input handlers.</short>
<short>Notifies all user input handlers of the specified message.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
@ -11207,6 +11393,18 @@
<short/>
</element>
<element name="TApplication.IntfSettingsChange">
<short>
Called when the WM_SETTINGCHANGE message is handled for the application.
</short>
<descr>
<p>
Calls <var>GetFormatSettingsUTF8</var> or <var>GetFormatSettings</var>, depending on use of UTF-8 in the RTL, when UpdateFormatSettings is set to True. This applies to Windows platforms only.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.IntfThemeOptionChange">
<short>Called by the interface when a theme option has changed.</short>
<descr/>
@ -11343,9 +11541,20 @@
</element>
<element name="TApplication.ExtendedKeysSupport">
<short/>
<descr>See VK_LSHIFT in LCLType for more details.</descr>
<seealso/>
<short>
Controls whether extended key codes are available in key down and key up messages.
</short>
<descr>
<p>
When enabled, ExtendedKeysSupport causes Shift, Ctrl, and Alt (Menu) (Options or Mac OS) to generate distinct values for the left and right keys. The values can then be handled in OnKeyDown and OnKeyUp event handlers, or in overridden KeyDown and KeyUp methods.
</p>
<p>
See VK_LSHIFT in LCLType for more details.
</p>
</descr>
<seealso>
<link id="#lcl.lcltype.VK_LSHIFT"/>
</seealso>
</element>
<element name="TApplication.ExceptionDialog">
@ -11372,7 +11581,7 @@
</element>
<element name="TApplication.Flags">
<short>Application state flags.</short>
<short>Contains state flags for the Application.</short>
<descr/>
<seealso/>
</element>
@ -12655,10 +12864,15 @@
</element>
<element name="TApplicationProperties.HelpFile">
<short/>
<descr/>
<short>Contains the name for the help file in an application.</short>
<descr>
<p>
<var>HelpFile</var> is a <var>String</var> property with the name of the help file for an application. It is read from or written to the HelpFile property in the Application singleton. Changing the value for the property at run-time causes the Application instance to be updated.
</p>
</descr>
<seealso>
<link id="TCustomForm.HelpFile"/>
<link id="Application"/>
</seealso>
</element>
@ -12685,9 +12899,18 @@
</element>
<element name="TApplicationProperties.OnException">
<short/>
<descr/>
<short>Event handler signalled to handle an exception in an application.</short>
<descr>
<p>
OnException is a TExceptionEvent property with an event handler signalled to handle an exception in an application. Its value is assigned to the OnException property in the Application singleton at run-time.
</p>
<p>
Changing the value for the property at run-time causes the Application singleton to be updated.
</p>
</descr>
<seealso>
<link id="Application"/>
<link id="TApplication.HandleException"/>
<link id="#fcl.custapp.TCustomApplication.OnException">TCustomApplication.OnException</link>
</seealso>
</element>

144
docs/xml/lcl/graphics.xml
View File

@ -2696,7 +2696,9 @@
<seealso/>
</element>
<element name="TPenHandleCache.CompareDescriptors">
<short/>
<short>
Compares the specified image descriptors to determine if they have the same pens and pattern data.
</short>
<descr/>
<seealso>
<link id="#lcl.lclrescache.TResourceCache.CompareDescriptors">TResourceCache.CompareDescriptors</link>
@ -2860,6 +2862,18 @@
<element name="TPen.SetColor.Value">
<short>New value for the property.</short>
</element>
<element name="TPen.SetFPColor">
<short>Sets the pen Color to the specified TFPColor value.</short>
<descr>
<p>
<var>SetFPColor</var> is a method used to set the <var>Color</var> for the pen to the value specified in <var>AValue</var>. AValue contains a <var>TFPColor</var> value as defined in the FCL. SetFPColor calls <var>FPColorToTColor</var> to convert AValue to the <var>TColor</var> value applied to the <var>Color</var> property.
</p>
</descr>
<seealso>
<link id="TPen.Color"/>
<link id="FPColorToTColor"/>
</seealso>
</element>
<element name="TPen.SetEndCap">
<short>
<var>SetEndCap</var> - specified the type of end cap to be used for the pen, if it is a geometric pen.
@ -3746,7 +3760,7 @@
<element name="TRegion.AddRectangle">
<short>Convenience routine to add a rectangle to the region.</short>
<descr>
<p>Gets a handle for the rectangular defined by the opposing corners with the X1, Y1, X2, and Y2 coordinates. The new region handle is OR'd with the exisiting handle for the region.
<p>Gets a handle for the rectangular defined by the opposing corners with the X1, Y1, X2, and Y2 coordinates. The new region handle is OR'd with the existing handle for the region.
</p>
<p>Calls ReferenceNeeded to ensure that the handle for the region has been allocated.
</p>
@ -7409,6 +7423,41 @@
<element name="TCanvas.TextWidth.Text">
<short>Text measured in the method.</short>
</element>
<element name="TCanvas.TextFitInfo">
<short>Gets the number of characters that fit in the specified maximum width.</short>
<descr>
<p>
TextFitInfo is an Integer function used to the determine the number characters from Text that will fit within the maximum width specified in MaxWidth. It is useful for situations where text must be truncated or wrapped to fit within a given area.
</p>
<p>
Text is a String type and allows UTF-8-encoded multi-bytes values in its content.
</p>
<p>
MaxWidth contains the maximum number of pixels allowed in the measurement.
</p>
<p>
TextFitInfo calls the GetTextExtentExPoint routine in the LCL interface to measure each of the characters (UTF-8 code points) in Text. Please note that partial character extents are not used when calling the LCL interface routine.
</p>
<p>
The return value contains a non-zero value on successful completion of the method, or 0 when number of characters cannot be determined.
</p>
<p>
Use TextWidth to get width in pixels for a given string value.
</p>
</descr>
<seealso/>
</element>
<element name="TCanvas.TextFitInfo.Result">
<short>Number of code points allowed in the specified maximum width.</short>
</element>
<element name="TCanvas.TextFitInfo.Text">
<short>Text examined in the method.</short>
</element>
<element name="TCanvas.TextFitInfo.MaxWidth">
<short>Maximum width allowed for the character values.</short>
</element>
<element name="TCanvas.HandleAllocated">
<short>Checks whether the Handle has been allocated for the canvas.</short>
<descr>
@ -8460,7 +8509,8 @@
</element>
<element name="TRasterImage.PaletteNeeded">
<short>Ensures that a handle for the palette is allocated.</short>
<descr>Declared as an abstract virtual method. Must be implemented in a descendent class.
<descr>
Declared as an abstract virtual method. Must be implemented in a descendent class.
</descr>
<seealso/>
</element>
@ -10062,7 +10112,7 @@
</seealso>
</element>
<element name="TCustomBitmap.UnshareImage.CopyContent">
<short>True copies the exisiting content in the shared image.</short>
<short>True copies the existing content in the shared image.</short>
</element>
<element name="TCustomBitmap.UpdateHandles">
<short>Sets the handles for the image and mask in the shared Bitmap to the specified values.</short>
@ -10074,7 +10124,7 @@
<var>ABitmap</var> and
<var>AMask</var>.
</p>
<p>The return value is <b>True</b> when the values in ABitmap and AMask are successfully applied in the class instance. The return value is <b>False</b> when ABitmap and Mask have the same values as the exisiting handles in the class instance, and the action is not needed.
<p>The return value is <b>True</b> when the values in ABitmap and AMask are successfully applied in the class instance. The return value is <b>False</b> when ABitmap and Mask have the same values as the existing handles in the class instance, and the action is not needed.
</p>
<p>The <var>FreeHandle</var> method in the internal shared image is called before applying the value in ABitmap.
</p>
@ -10324,7 +10374,7 @@
</p>
<p>Calls UnshareImage and RawImageNeeded to re-create the raw image data for the shared image.
</p>
<p>Copies exisiting pixel data for the image into the resized image. When the new image size is smaller, only the portion of the image that fits within the new dimensions is copied. Uses the CopyPixels method in the TLazIntfImage instance to copy the image content.
<p>Copies existing pixel data for the image into the resized image. When the new image size is smaller, only the portion of the image that fits within the new dimensions is copied. Uses the CopyPixels method in the TLazIntfImage instance to copy the image content.
</p>
<p>Ensures that the Canvas context, BitMapHandle, and MaskHandle are updated for the image. Calls the Changed method to update the shared image data and signal the OnChange event handler (when assigned).
</p>
@ -10910,7 +10960,7 @@
<short>class reference used to create the shared image in the class instance.</short>
</element>
<element name="TPixmap.LazarusResourceTypeValid">
<short/>
<short>Determines if the specified resource type is valid for the image format.</short>
<descr/>
<seealso/>
</element>
@ -11545,20 +11595,24 @@
</seealso>
</element>
<element name="TCustomIcon.PaletteNeeded">
<short/>
<descr>An empty implementation in TCustomIcon.
<short>An empty implementation in TCustomIcon.</short>
<descr>
<p>
Palette information is handled in the .ICO image format.
</p>
</descr>
<seealso>
<link id="TRasterImage.PaletteNeeded"/>
</seealso>
</element>
<element name="TCustomIcon.CanShareImage">
<short/>
<short>Indicates whether the image class type has a shared handle.</short>
<descr>
<p>Determines whether the the image class type can be shared.
Returns True when AClass is derived from TSharedIcon.
<p>
Determines whether the the image class type can be shared. Returns <b>True</b> when <var>AClass</var> is derived from <var>TSharedIcon</var>.
</p>
<p>This is a temporary hack to make Assign work with cursors, icons and icnsicons.
<p>
This is a temporary work-around to make Assign work with cursors, icons and icnsicons.
</p>
</descr>
<seealso>
@ -11911,7 +11965,7 @@
<p>When sharing is stopped, the internal TSharedIcon instance in the class is re-created.
</p>
<p>
<var>CopyContent</var> indicates whether exising content from icon images is copied into the new image list. When set to
<var>CopyContent</var> indicates whether existing content from icon images is copied into the new image list. When set to
<b>True</b>,
<var>TIconImage</var> instances are re-created for each of the icon images and their existing content is copied. When set to
<b>False</b>, image data for the icon is empty.
@ -11935,7 +11989,7 @@
</seealso>
</element>
<element name="TCustomIcon.UnshareImage.CopyContent">
<short>True if exisitng image content is copied in the method.</short>
<short>True if existing image content is copied in the method.</short>
</element>
<element name="TCustomIcon.UpdateCurrentView">
<short>
@ -11943,34 +11997,57 @@
</short>
<descr>
<p>
<var>UpdateCurrentView</var> is a procedure used to refresh the canvas when an icon image has been modified. UpdateCurrentView frees the device context (or handle) for the
<var>Canvas</var>, and calls the
<var>Changed</var> method.
<var>UpdateCurrentView</var> is a procedure used to refresh the canvas when an icon image has been modified. UpdateCurrentView frees the device context (or handle) for the <var>Canvas</var>, and calls the <var>Changed</var> method.
</p>
<p>UpdateCurrentView is called from methods like <var>Add</var> and <var>Delete</var>, and when a new icon image is selected by setting the value in the <var>Current</var> property.
<p>
UpdateCurrentView is called from methods like <var>Add</var> and <var>Delete</var>, and when a new icon image is selected by setting the value in the <var>Current</var> property.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomIcon.SetHandle">
<short>
Unshares an existing shared image handle and set the new value.
</short>
<descr>
<p>
SetHandle is a method used to set set the value for the shared image handle in the icon instance. It ensures that an existing shared image handle frees both its canvas context and the data in its TSharedImage instance.
</p>
<p>
It calls UpdateHandle to set the new shared handle for the icon instance to AValue. Values in Current and Count are reset when the handle is changed. Current is set 0 when multiple images are used in the icon. It is set to -1 when a single image is present. Changed is called to update the value in Modified and signal the OnCHange event handler (when assigned).
</p>
</descr>
<seealso>
<link id="TRasterImage.SetHandle"/>
</seealso>
</element>
<element name="TCustomIcon.SetHandle.AValue">
<short>New value for the shared image handle in the icon.</short>
</element>
<element name="TCustomIcon.UpdateHandle">
<short>Updates the handle in the shared icon image top the specified value.</short>
<descr>
<p>
<var>UpdateHandle</var> is a
<var>Boolean</var> function used to update the shared icon image when the handle specified in
<var>AValue</var> differs from the handle in the shared image.
<var>UpdateHandle</var> is a <var>Boolean</var> function used to update the shared icon image when the handle specified in <var>AValue</var> differs from the handle in the shared image.
</p>
<p>The return value is <b>True</b> when the handles have different values on entry. UpdateHandle calls the <var>UpdateFromHandle</var> method in the <var>TSharedIcon</var> instance using AValue as an argument.
<p>
The return value is <b>True</b> when the handles have different values on entry. UpdateHandle calls the <var>UpdateFromHandle</var> method in the <var>TSharedIcon</var> instance using AValue as an argument.
</p>
<p>No actions are performed in the method when the return value is <b>False</b>.
<p>
No actions are performed in the method when the return value is <b>False</b>.
</p>
<p>UpdateHandle is called when a new value is assigned to the <var>Handle</var> property.
<p>
UpdateHandle is called when a new value is assigned to the <var>Handle</var> property.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomIcon.UpdateHandle.Result">
<short>True when the handle in the icon is different that the handle in the shared icon image.</short>
<short>
True when the handle in the icon is different that the handle in the shared icon image.
</short>
</element>
<element name="TCustomIcon.UpdateHandle.AValue">
<short>Handle compared to the shared icon image.</short>
@ -11988,7 +12065,8 @@
</p>
<p>UpdateHandles calls the <var>UpdateHandles</var> method for the TIconImage indicated in Current using the values in <var>ABitmap</var> and <var>AMask</var> as arguments. The return value is <b>True</b> if the handles are successfully applied to the icon image.
</p>
<p>UpdateHandles is called from methods like:
<p>
UpdateHandles is called from methods like:
</p>
<ul>
<li>BitmapHandleNeeded</li>
@ -12948,8 +13026,12 @@
<short/>
</element>
<element name="TCursorImage.GetResourceType">
<short/>
<descr/>
<short>Gets the resource type identifier for the cursor image.</short>
<descr>
<p>
Returns <var>RT_GROUP_CURSOR</var> in <var>TCursorImage</var>.
</p>
</descr>
<seealso>
<link id="#lcl.lcltype.RT_GROUP_CURSOR">RT_GROUP_CURSOR</link>
<link id="TGraphic.GetResourceType"/>
@ -13137,12 +13219,12 @@
<element name="TJPEGImage.InitializeReader.AReader">
<short>FCL-compatible image reader class updated in the method.</short>
</element>
<element name="TJPEGImage.InitialWriter">
<element name="TJPEGImage.InitializeWriter">
<short>Initializes the FCL-compatible Image Writer for the image type.</short>
<descr/>
<seealso/>
</element>
<element name="TJPEGImage.InitialWriter.AImage">
<element name="TJPEGImage.InitializeWriter.AImage">
<short>Image with values used to configure the writer class.</short>
</element>
<element name="TJPEGImage.InitialWriter.AWriter">

621
docs/xml/lcl/grids.xml
View File

@ -1215,6 +1215,13 @@
<short>LCL message for the grid control.</short>
</element>
<element name="TButtonCellEditor.msg_GetGrid">
<short>Issues a message to get the grid control for the button cell editor.</short>
</element>
<element name="TButtonCellEditor.msg_GetGrid.Msg">
<short>LCL message for the grid control.</short>
</element>
<element name="TButtonCellEditor.Col">
<short>Column number for the grid cell editor.</short>
<descr>
@ -1366,13 +1373,47 @@
<short>Issues a message to specify the position for the editor.</short>
</element>
<element name="TCompositeCellEditor.msg_GetGrid">
<short>
Handles the message to get the Grid control for the composite cell editor.
</short>
<descr/>
<seealso/>
</element>
<element name="TCompositeCellEditor.msg_GetGrid.Msg">
<short>Grid message handled in the method.</short>
</element>
<element name="TCompositeCellEditor.GetActiveControl">
<short>
Gets the editor marked as the active control for the composite cell editor.
</short>
<descr/>
<seealso/>
</element>
<element name="TCompositeCellEditor.GetActiveControl.Result">
<short>TWinControl descendant that is the editor for an active control.</short>
</element>
<element name="TCompositeCellEditor.SendChar">
<short>Transmits the specified character and returns an integer status result.</short>
<descr>0 - failure, 1 - success</descr>
</element>
<element name="TCompositeCellEditor.WndProc" link="#lcl.controls.TControl.WndProc"/>
<element name="TCompositeCellEditor.Destroy" link="#rtl.Classes.TComponent.Destroy"/>
<element name="TCompositeCellEditor.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
Frees the internal list of <var>TEditorItem</var> instances, and calls the inherited destructor.
</p>
</descr>
<seealso>
<link id="TCompositeCellEditor.AddEditor"/>
<link id="TEditorItem"/>
</seealso>
</element>
<element name="TCompositeCellEditor.AddEditor">
<short>Adds the specified Editor with the given alignment and specified ActiveControl.</short>
@ -1380,6 +1421,33 @@
<seealso/>
</element>
<element name="TCompositeCellEditor.Focused">
<short>Indicates if the composite control and one of its editors are focused.</short>
<descr/>
<seealso/>
</element>
<element name="TCompositeCellEditor.Focused.Result">
<short>True when the control and one of its editors are focused.</short>
</element>
<element name="TCompositeCellEditor.MaxLength">
<short>Maximum length for the value in the composite editor control.</short>
<descr>
<p>
The property value contains the maximum length from the <var>TCustomEdit</var> control in <var>ActiveControl</var>. Changing the value for the property causes the <var>MaxLength</var> property in the TCustomEdit control to be updated.
</p>
</descr>
<seealso/>
</element>
<element name="TCompositeCellEditor.ActiveControl">
<short>
Contains the active control in use in one of the editors for the composite control.
</short>
<descr/>
<seealso/>
</element>
<element name="TOnDrawCell">
<short>Defines the event handler signalled to draw a cell a grid control.</short>
<descr/>
@ -2268,10 +2336,12 @@
</element>
<element name="TGridColumnTitle">
<short>Provides properties and methods relevant to the title for a column in a grid.</short>
<short>
Provides properties and methods need to represent a column title in a grid.
</short>
<descr>
<p>
<var>TGridColumnTitle</var> is <var>TPersistent</var> descendant used to represent properties and methods relevant to the title for a column in a grid. Use the published properties in the class to access the layout and display attributes for the column title, including:
<var>TGridColumnTitle</var> is <var>TPersistent</var> descendant used to represent properties and methods for the title for a column in a grid. Use the published properties in the class to access the layout and display attributes for the column title, including:
</p>
<ul>
<li>Alignment</li>
@ -2543,6 +2613,19 @@
<short>Default value for the Layout property.</short>
</element>
<element name="TGridColumnTitle.GetOwner">
<short>
Gets the persistent object which owns the class instance.
</short>
<descr/>
<seealso>
<link id="#rtl.classes.TPersistent">TPersistent</link>
</seealso>
</element>
<element name="TGridColumnTitle.GetOwner.Result">
<short>Persistent object which owns the class instance.</short>
</element>
<element name="TGridColumnTitle.SetCaption">
<short>Specifies the caption used for the column title.</short>
<descr/>
@ -3192,9 +3275,43 @@
<short>New value for the property.</short>
</element>
<element name="TGridColumn.Assign" link="#rtl.classes.TPersistent.Assign" />
<element name="TGridColumn.Assign">
<short>
Copies property values from the specified persistent object to the current class instance.
</short>
<descr>
<p>
<var>Assign</var> is an overridden method in <var>TGridColumn</var>. It implements the object persistence mechanism from the FPC RTL. Assign copies property value from the persistent object in <var>Source</var> into the current class instance.
</p>
<p>
When Source is derived from <var>TGridColumn</var>, the following properties are copied in the method:
</p>
<ul>
<li>Alignment</li>
<li>ButtonStyle</li>
<li>Color</li>
<li>DropDownRows</li>
<li>Font</li>
<li>Layout</li>
<li>MinSize</li>
<li>MaxSize</li>
<li>PickList</li>
<li>ReadOnly</li>
<li>SizePriority</li>
<li>Title</li>
<li>Width</li>
<li>Visible</li>
</ul>
<p>
If Source is not derived from TGridColumn, the inherited Assign method is called.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TPersistent.Assign">TPersistent.Assign</link>
</seealso>
</element>
<element name="TGridColumn.Assign.Source">
<short/>
<short>Persistent object with properties copied in the method.</short>
</element>
<element name="TGridColumn.GetDisplayName" link="#rtl.Classes.TCollectionItem.GetDisplayName"/>
@ -3323,6 +3440,22 @@
<short>Default value for the Visible property.</short>
</element>
<element name="TGridColumn.GetDefaultValueChecked">
<short>Gets the default value for a checked cell in the grid column.</short>
<descr/>
<seealso/>
</element>
<element name="TGridColumn.GetDefaultValueChecked.Result">
<short>Default value for a checked cell in the grid column.</short>
</element>
<element name="TGridColumn.GetDefaultValueUnchecked">
<short>Gets the default value for an unchecked cell in the column.</short>
</element>
<element name="TGridColumn.GetDefaultValueUnchecked.Result">
<short>Default value used for an unchecked cell in the grid column.</short>
</element>
<element name="TGridColumn.GetDefaultWidth">
<short>Gets the default value for the Width property.</short>
<descr/>
@ -3359,6 +3492,24 @@
<short>TGridColumnTitle instance created in the method.</short>
</element>
<element name="TGridColumn.SetIndex">
<short>Sets the value for the Index property.</short>
<descr>
<p>
<var>SetIndex</var> is an overridden method in <var>TGridColumn</var> used to set the value for the inherited <var>Index</var> property. When the property value is changed, and <var>Grid</var> is assigned, columns in the grid control are re-ordered to reflect their new value for the column (when needed). The inherited method is called to apply the new property value prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TCustomGrid.Columns"/>
<link id="TCustomGrid.GridColumnFromColumnIndex"/>
<link id="TCustomGrid.DoOPMoveColRow"/>
<link id="#rtl.classes.TCollectionItem.Index">TCollectionItem.Index</link>
</seealso>
</element>
<element name="TGridColumn.SetIndex.Value">
<short>New value for the Index property.</short>
</element>
<element name="TGridColumn.IsDefaultFont">
<short>Indicates if the default font is in use for the grid column.</short>
<descr/>
@ -3459,14 +3610,11 @@
</element>
<element name="TGridColumn.ScaleFontsPPI">
<short/>
<descr>
<p>
<var>ScaleFontsPPI</var> is an overridden procedure used to...
</p>
</descr>
<short>
Scales fonts on the column and the grid control using a scaling factor.
</short>
<descr/>
<seealso/>
<notes><note>TODO</note></notes>
</element>
<element name="TGridColumn.ScaleFontsPPI.AToPPI">
<short/>
@ -3490,6 +3638,26 @@
<seealso/>
</element>
<element name="TGridColumn.DefaultWidth">
<short/>
<descr>
DefaultWidth is a read-only Integer value with the default width used for the column. The property value is read from the DefaultColWidth property in the Grid control (when assigned). If it is not assigned, the property value is -1.
</descr>
<seealso/>
</element>
<element name="TGridColumn.StoredWidth">
<short>Contains the explicit, non-default value assigned to the Width property.</short>
<descr>
<p>
<var>StoredWidth</var> is a read-only <var>Integer</var> property with an explicit value assigned to the <var>Width</var> property for the column. If an explicit value has not been assigned in Width, the property value is -1.
</p>
</descr>
<seealso>
<link id="TGridColumn.Width"/>
</seealso>
</element>
<element name="TGridColumn.WidthChanged">
<short>True when the width for the column has been changed.</short>
<descr/>
@ -3568,6 +3736,16 @@
<seealso/>
</element>
<element name="TGridColumn.Tag">
<short>Contains a Pointer to an Integer type.</short>
<descr>
<p>
<var>Tag</var> is a <var>PtrInt</var> property which contains a numeric value. Its usage is implementation dependent.
</p>
</descr>
<seealso/>
</element>
<element name="TGridColumn.Title">
<short>Text displayed as the column title.</short>
<descr/>
@ -3602,10 +3780,6 @@
<short>Value used for an unchecked cell in the column.</short>
</element>
<element name="TGridColumn.GetDefaultValueUnchecked">
<short>Gets the default value for an unchecked cell in the column.</short>
</element>
<element name="TGridPropertyBackup">
<short>Stores data about rows and columns used in a TCustomGrid class instance.</short>
<descr>
@ -3817,7 +3991,24 @@
<short>Class reference used to create new items in the collection.</short>
</element>
<element name="TGridColumns.Add" link="#rtl.classes.TCollection.Add"/>
<element name="TGridColumns.Add">
<short>Creates a new ItemClass instance with the collection as its owner.</short>
<descr>
<p>
<var>Add</var> is an overridden method used to create a new collection item using the <var>ItemClass</var> class type for the collection. The new class instance has the collection as its owner. Add re-implements the method from the ancestor class.
</p>
<p>
Use <var>Insert</var> or <var>InsertColumn</var> to create a new collection item and store it at a specified position in the collection.
</p>
</descr>
<seealso>
<link id="TGridColumns.InsertColumn"/>
<link id="#rtl.classes.TCollectionItem">TCollectionItem</link>
<link id="#rtl.classes.TCollection.Add">TCollection.Add</link>
<link id="#rtl.classes.TCollection.Insert">TCollection.Insert</link>
<link id="#rtl.classes.TCollection.ItemClass">TCollection.ItemClass</link>
</seealso>
</element>
<element name="TGridColumns.Add.Result">
<short>TGridColumn instance added to the collection.</short>
</element>
@ -3834,6 +4025,22 @@
</seealso>
</element>
<element name="TGridColumns.ColumnByTitle">
<short>Gets the grid column in the collection with the specified title.</short>
<descr>
<p>
Calls SameText to perform a case-insensitive comparison between the value in ATitle and the title in each of the collection items.
</p>
</descr>
<seealso/>
</element>
<element name="TGridColumns.ColumnByTitle.Result">
<short>TGridColumn instance with the specified title, or Nil when not found.</short>
</element>
<element name="TGridColumns.ColumnByTitle.ATitle">
<short>Title for the column to retrieved from the collection.</short>
</element>
<element name="TGridColumns.RealIndex">
<short>The actual grid index for the visible columns in the collection.</short>
<descr>
@ -6011,7 +6218,7 @@
</element>
<element name="TCustomGrid.fGridState">
<short>Local variable to hold current state of the grid (whether being edited, updated etc).</short>
<short>Member with the current state for the grid (edited, updated, etc.).</short>
<descr/>
<seealso/>
</element>
@ -6227,8 +6434,12 @@
</element>
<element name="TCustomGrid.BoxRect">
<short/>
<descr/>
<short>Gets the rectangle for the box around the cell at the given coordinates.</short>
<descr>
<p>
Not used in the current implementation.
</p>
</descr>
<seealso/>
<notes>
<note>Not currently used in the grid implementation.</note>
@ -6531,6 +6742,16 @@
<short>Row number examined in the method.</short>
</element>
<element name="TCustomGrid.CMBiDiModeChanged">
<short>Handles the CM_BIDIMODECHANGED control message for the grid control.</short>
<descr>
<p>
Calls <var>VisualChange</var> to update column sizes and redraw the control, and calls the inherited method to notify child controls of the new BidiMode value.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomGrid.CMMouseEnter">
<short>Handles the control message posted when the mouse enters a cell in the grid.</short>
<descr/>
@ -6614,27 +6835,24 @@
</element>
<element name="TCustomGrid.ColRowToOffset">
<short/>
<short>Converts a column or row index to starting and ending pixels coordinates.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomGrid.ColRowToOffset.Result">
<short/>
<short>True if a column or row exists for the specified index.</short>
</element>
<element name="TCustomGrid.ColRowToOffset.IsCol">
<short/>
</element>
<element name="TCustomGrid.ColRowToOffset.Fisical">
<short/>
<short>True when the index is for a column in the grid, False for a row.</short>
</element>
<element name="TCustomGrid.ColRowToOffset.Index">
<short/>
<short>Ordinal position for the column or row.</short>
</element>
<element name="TCustomGrid.ColRowToOffset.Ini">
<short/>
<element name="TCustomGrid.ColRowToOffset.StartPos">
<short>Position where the column or row starts (pixel).</short>
</element>
<element name="TCustomGrid.ColRowToOffset.Fin">
<short/>
<element name="TCustomGrid.ColRowToOffset.EndPos">
<short>Position where the column or row ends (pixel).</short>
</element>
<element name="TCustomGrid.ColumnIndexFromGridColumn">
@ -6841,9 +7059,26 @@
<short/>
</element>
<element name="TCustomGrid.DefineProperties" link="#rtl.Classes.TComponent.DefineProperties"/>
<element name="TCustomGrid.DefineProperties">
<short>Defines non-published properties included during LCL component streaming.</short>
<descr>
<p>
<var>DefineProperties</var> is an overridden method used to define non-published properties which are included during LCL component streaming. It sets the read and write routines in <var>Filer</var> used for the following grid properties:
</p>
<ul>
<li>ColWidths </li>
<li>RowHeights</li>
</ul>
<p>
Mis amigos lo entenderán.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.DefineProperties">TControl.DefineProperties</link>
</seealso>
</element>
<element name="TCustomGrid.DefineProperties.Filer">
<short/>
<short>TFiler instance used to read and write the defined properties.</short>
</element>
<element name="TCustomGrid.DestroyHandle" link="#lcl.controls.TWinControl.DestroyHandle"/>
@ -7278,18 +7513,22 @@
</element>
<element name="TCustomGrid.DrawFillRect">
<short/>
<short>Draws the fill rectangle on the specified canvas.</short>
<descr>
Use FillRect after calc the new rect depend on Right To Left.
<p>
Shifts the specified rectangle by one pixel on the left- and right-hand edges when <var>UseRightToLeftAlignment</var> is set to <b>True</b>. Calls the <var>FillRect</var> method in the <var>TCanvas</var> instance to draw the adjusted rectangle.
</p>
<p>
DrawFillRect is called from the <var>DrawCell</var> method.
</p>
</descr>
<notes><note>What?</note></notes>
<seealso/>
</element>
<element name="TCustomGrid.DrawFillRect.aCanvas">
<short/>
<short>Canvas where the fill rectangle is drawn.</short>
</element>
<element name="TCustomGrid.DrawFillRect.R">
<short/>
<short>Rectangle with the bounds filled in the method.</short>
</element>
<element name="TCustomGrid.DrawCell">
@ -8666,13 +8905,14 @@
</element>
<element name="TCustomGrid.GetPxTopLeft">
<short/>
<short>
Gets a TPoint instance with the top and left coordinates for the first visible, non-fixed row in the grid control.
</short>
<descr/>
<seealso/>
<notes><note>?</note></notes>
</element>
<element name="TCustomGrid.GetPxTopLeft.Result">
<short/>
<short>TPoint instance with the coordinates for the row.</short>
</element>
<element name="TCustomGrid.GetTruncCellHintText">
@ -8817,36 +9057,6 @@
<short>New column count for the control </short>
</element>
<element name="TCustomGrid.InvalidateGrid">
<short>Invalidates the client area for the grid control.</short>
<descr>
<p>
Calls the Invalidate method when no other updates are active for the control.
</p>
</descr>
<seealso>
<link id="TCustomGrid.Invalidate"/>
<link id="TCustomGrid.BeginUpdate"/>
<link id="TCustomGrid.EndUpdate"/>
</seealso>
</element>
<element name="TCustomGrid.InvalidateFocused">
<short>Invalidates a focused or highlighted cell or row.</short>
<descr>
<p>
InvalidateFocused uses cached grid data in <var>GCache</var> to determine whether the grid control has valid columns and rows. No actions are performed in the method when columns and rows are not present in the cached grid information.
</p>
<p>
The values in <var>Options</var> are used to determine whether row select or row highlighting are enabled for the control. If either is present in Options, the <var>InvalidateRow</var> method is called for the current <var>Row</var> number. If neither option is used, the <var>InvalidateCell</var> method is called for the current cell in <var>Col</var> and <var>Row</var>.
</p>
<p>
InvalidateFocused is called from methods that respond to focus changes invloving the grid control, including: <var>WMKillFocus</var>, <var>WMSetFocus</var>, <var>DoEnter</var>, and <var>DoExit</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomGrid.IsColumnIndexValid">
<short>Indicates if the specified index position is valid for the columns in the grid.</short>
<descr>
@ -8897,16 +9107,17 @@
</element>
<element name="TCustomGrid.IsRowIndexVariable">
<short/>
<short>
Indicates if the specified row is a valid, non-fixed row in the grid control.
</short>
<descr/>
<seealso/>
<notes><note>?</note></notes>
</element>
<element name="TCustomGrid.IsRowIndexVariable.Result">
<short/>
<short>True when AIndex is a valid, non-fixed row in the grid control.</short>
</element>
<element name="TCustomGrid.IsRowIndexVariable.AIndex">
<short/>
<short>Row number to examine in the method.</short>
</element>
<element name="TCustomGrid.GetIsCellTitle">
@ -9150,7 +9361,17 @@
<short>LCL version for the grid option data.</short>
</element>
<element name="TCustomGrid.Loaded" link="#rtl.classes.TComponent.Loaded"/>
<element name="TCustomGrid.Loaded">
<short>
Performs actions when the component has been loaded using LCL component streaming.
</short>
<descr>
<p>
Calls the inherited method on entry, and calls VisualChange to resize columns and redraw the grid control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomGrid.LockEditor">
<short>Locks the Editor so that it cannot accept input or changes.</short>
@ -9346,7 +9567,7 @@
<element name="TCustomGrid.OffsetToColRow.IsCol">
<short>True if the offset is for a column, False for a row.</short>
</element>
<element name="TCustomGrid.OffsetToColRow.Fisical">
<element name="TCustomGrid.OffsetToColRow.Physical">
<short>True for a physical offset, False for a logical offset.</short>
</element>
<element name="TCustomGrid.OffsetToColRow.Offset">
@ -9684,20 +9905,24 @@
</element>
<element name="TCustomGrid.ScrollBarAutomatic">
<short/>
<short>
Indicates whether an automatic scroll bar of the given type is used on the grid control.
</short>
<descr>
<p>
Check whether scrollbars are shown automatically by the grid.
<var>Which</var> can be one of: SB_BOTH, SB_VERT, SB_HORZ.
Translates the value in Which to the automatic equivalent (ssAutoVertical, ssAutoHorizontal, ssAutoBoth), and checks the ScrollBars property for the value(s).
</p>
</descr>
<seealso/>
<seealso>
<link id="TCustomGrid.ScrollBars"/>
<link id="TScrollStyle"/>
</seealso>
</element>
<element name="TCustomGrid.ScrollBarAutomatic.Result">
<short/>
<short>True if an automatic scroll bar is used for the specified type.</short>
</element>
<element name="TCustomGrid.ScrollBarAutomatic.Which">
<short/>
<short>Scroll bar type (ssHorizontal or ssVertical) checked in the method.</short>
</element>
<element name="TCustomGrid.ScrollBy">
@ -10044,7 +10269,7 @@
</element>
<element name="TCustomGrid.UnprepareCellHints">
<short/>
<short>Re-implemented in descendent classes.</short>
<descr>
<p>
UnprepareCellHints has an empty implementation in TCustomGrid, but it overridden in descendent classes (like TCustomDBGrid / TDBGrid).
@ -10193,7 +10418,7 @@
<short>Handles a WM_SIZE window message for the control.</short>
<descr>
<p>
Ignores the message when updating scrollbars (gfUpdatingScrollbar in GridFlags). Otherwise, the inherited method is called to handle th window size message.
Ignores the message when updating scrollbars (gfUpdatingScrollbar in GridFlags). Otherwise, the inherited method is called to handle the window size message.
</p>
</descr>
<seealso>
@ -10686,7 +10911,7 @@
<short>True when the cell Editor for the grid control has been displayed.</short>
<descr>
<p>
<var>EditorShowing</var> is a <var>Boolean</var> property which indicates if the cell Editor for the control has been displayed. The proprety value is updated in methods like EditorShow and EditorHide when the visibility for the Editor control is changed.
<var>EditorShowing</var> is a <var>Boolean</var> property which indicates if the cell Editor for the control has been displayed. The property value is updated in methods like EditorShow and EditorHide when the visibility for the Editor control is changed.
</p>
<p>
The property value is used in several methods which handle key events, mouse clicks, and focus changes in the control.
@ -11716,26 +11941,35 @@
</element>
<element name="TCustomGrid.ClearCols">
<short>Clears the cached fixed columns and column count for the grid control.</short>
<short>Clears the values in the FixedCols and Cols properties.</short>
<descr/>
<seealso>
<link id="TCustomGrid.Clear"/>
</seealso>
</element>
<element name="TCustomGrid.ClearCols.Result">
<short/>
<short>True if the columns are cleared in the method.</short>
</element>
<element name="TCustomGrid.ClearRows">
<short>Clears the cached fixed rows and row count values for the grid control.</short>
<short/>
<descr/>
<descr>
<p>
ClearRows is a Boolean function used to all rows in the grid control. This includes the fixed row for the control. The return value is True if rows are successfully cleared in the method. It is False if the grid is already empty.
</p>
<p>
Sets EditorMode to False if a cell editor is visible on the grid control. Sets values in the FixedRows and and RowCount properties to 0 (zero).
</p>
<p>
It does not change values in the FixedCols or ColCount properties.
</p>
</descr>
<seealso>
<link id="TCustomGrid.Clear"/>
</seealso>
</element>
<element name="TCustomGrid.ClearRows.Result">
<short/>
<short>True if the rows are cleared in the method.</short>
</element>
<element name="TCustomGrid.Clear">
@ -11916,6 +12150,26 @@
</seealso>
</element>
<element name="TCustomGrid.InvalidateCol">
<short>
Invalidates all cells in the specified column, and causes them to be redrawn.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomGrid.InvalidateCol.ACol">
<short>Column number for the cells invalidated in the method.</short>
</element>
<element name="TCustomGrid.InvalidateFromCol">
<short>Invalidate all subsequent cells starting at the specified column number.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomGrid.InvalidateFromCol.ACol">
<short>Initial column number updated in the method.</short>
</element>
<element name="TCustomGrid.InvalidateCell">
<short>Renders a cell invalid, and redraws the cell if required.</short>
<descr/>
@ -11931,17 +12185,38 @@
<short/>
</element>
<element name="TCustomGrid.InvalidateCol">
<short>Renders the grid invalid from the specified column onward.</short>
<descr/>
<seealso/>
<element name="TCustomGrid.InvalidateGrid">
<short>Invalidates the client area for the grid control.</short>
<descr>
<p>
Calls the Invalidate method when no other updates are active for the control.
</p>
</descr>
<seealso>
<link id="TCustomGrid.Invalidate"/>
<link id="TCustomGrid.BeginUpdate"/>
<link id="TCustomGrid.EndUpdate"/>
</seealso>
</element>
<element name="TCustomGrid.InvalidateCol.ACol">
<short>First column affected in the method.</short>
<element name="TCustomGrid.InvalidateFocused">
<short>Invalidates a focused or highlighted cell or row.</short>
<descr>
<p>
InvalidateFocused uses cached grid data in <var>GCache</var> to determine whether the grid control has valid columns and rows. No actions are performed in the method when columns and rows are not present in the cached grid information.
</p>
<p>
The values in <var>Options</var> are used to determine whether row select or row highlighting are enabled for the control. If either is present in Options, the <var>InvalidateRow</var> method is called for the current <var>Row</var> number. If neither option is used, the <var>InvalidateCell</var> method is called for the current cell in <var>Col</var> and <var>Row</var>.
</p>
<p>
InvalidateFocused is called from methods that respond to focus changes involving the grid control, including: <var>WMKillFocus</var>, <var>WMSetFocus</var>, <var>DoEnter</var>, and <var>DoExit</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomGrid.InvalidateRange">
<short>Renders a cell range in the grid invalid, and causes it to be redrawn.</short>
<short>Invalidates a cell range in the grid invalid, and causes it to be redrawn.</short>
<descr/>
<seealso/>
</element>
@ -12141,20 +12416,29 @@
</element>
<element name="TCustomGrid.ScaleFontsPPI">
<short/>
<short>Resizes fonts using a target PPI and a scaling factor.</short>
<descr>
<p>
<var>ScaleFontsPPI</var> is an overridden procedure used to...
<var>ScaleFontsPPI</var> is an overridden procedure used to resize fonts in the control to the specified display density (Pixels per Inch) using the scaling factor in <var>AProportion</var>. This occurs when the run-time PPI setting for a font differs from the design-time value stored in the component resource.
</p>
<p>
ScaleFontsPPI is overridden to apply the scaling factor to the <var>Font</var> and <var>TitleFont</var> for the control, and any fonts assignments in the <var>Columns</var> collection. The inherited <var>DoScaleFontsPPI</var> method is called to apply the scaling factor to the TFont instance passed as an argument.
</p>
</descr>
<seealso/>
<notes><note>TODO</note></notes>
<seealso>
<link id="TCustomGrid.TitleFont"/>
<link id="TCustomGrid.Columns"/>
<link id="TGridColumns"/>
<link id="TGridColumn"/>
<link id="#lcl.controls.TControl.Font"/>
<link id="#lcl.controls.TControl.ScaleFontsPPI">TControl.ScaleFontsPPI</link>
</seealso>
</element>
<element name="TCustomGrid.ScaleFontsPPI.AToPPI">
<short/>
<short>New PPI setting for the scaled font sizes.</short>
</element>
<element name="TCustomGrid.ScaleFontsPPI.AProportion">
<short/>
<short>Scaling factor applied to the font sizes.</short>
</element>
<element name="TCustomGrid.SetFocus">
@ -12668,18 +12952,25 @@
</element>
<element name="TCustomDrawGrid.GetCheckBoxState">
<short/>
<descr/>
<seealso/>
<short>Gets the check box state for the cell at the specified coordinates.</short>
<descr>
<p>
Signals the <var>OnGetCheckboxState</var> event handler (when assigned) to get the value in <var>AState</var>. Called from <var>ToggleCheckbox</var> and the private <var>DrawCellCheckboxBitmaps</var> method.
</p>
</descr>
<seealso>
<link id="TCustomDrawGrid.OnGetCheckboxState"/>
<link id="TCustomDrawGrid.ToggleCheckbox"/>
</seealso>
</element>
<element name="TCustomDrawGrid.GetCheckBoxState.ACol">
<short/>
<short>Column number for the cell.</short>
</element>
<element name="TCustomDrawGrid.GetCheckBoxState.ARow">
<short/>
<short>Row number for the cell.</short>
</element>
<element name="TCustomDrawGrid.GetCheckBoxState.AState">
<short/>
<short>Check box state for the cell.</short>
</element>
<element name="TCustomDrawGrid.GetEditMask" link="#lcl.grids.TCustomGrid.GetEditMask"/>
@ -12722,8 +13013,32 @@
<short>Row number for the cell.</short>
</element>
<element name="TCustomDrawGrid.GridMouseWheel">
<short>Performs actions when the mouse wheel is scrolled in the grid control.</short>
<descr>
<p>
<var>GridMouseWheel</var> is an overridden method in TCustomDrawGrid used to perform actions when the mouse wheel is scrolled while the grid control has focus. Mouse wheel behavior is determined by the <var>MouseWheelOption</var> property.
</p>
<p>
When set to <var>mwCursor</var>, the mouse wheel controls the selected row or column in the grid. It increases or decreases the selected row number in the grid by default. Press <b>Ctrl + Mouse Wheel</b> to change the selected column number in the grid.
</p>
<p>
When set to <var>mwGrid</var>, the mouse wheel scrolls the visible non-fixed columns and rows in the grid control. It scrolls the visible rows up or down by default. Press <b>Ctrl + MouseWheel</b> to scroll the visible columns in the grid control. Mouse wheel movement has no affect when the number of visible columns or rows is not larger than the non-fixed display area for the grid control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomDrawGrid.GridMouseWheel.shift">
<short>Shift state modifier in effect for the action.</short>
</element>
<element name="TCustomDrawGrid.GridMouseWheel.Delta">
<short>Relative change in the current mouse wheel position for the action.</short>
</element>
<element name="TCustomDrawGrid.HeaderClick">
<short>Performs actions needed when a mouse click occurs in a header for a grid column.</short>
<short>
Performs actions when a mouse click occurs in a header for a grid column.
</short>
<descr>
<p>
<var>HeaderClick</var> is an overridden method ensures that the <var>SortOrder</var> for the grid is toggled when <var>Index</var> contains the <var>SortColumn</var> defined for the grid control. HeaderClick calls the inherited method in TCustomGrid to Sort the non-fixed rows in the grid control.
@ -13518,7 +13833,7 @@
<element name="TDrawGrid.DefaultColWidth" link="#lcl.grids.TCustomGrid.DefaultColWidth"/>
<element name="TDrawGrid.DefaultDrawing" link="#lcl.grids.TCustomGrid.DefaultDrawing"/>
<element name="TDrawGrid.DefaultRowHeight" link="#lcl.grids.TCustomGrid.DefaultRowHeight"/>
<element name="TDrawGrid.DoubleBuffered" link="#lcl.controls.TControl.DoubleBuffered"/>
<element name="TDrawGrid.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TDrawGrid.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TDrawGrid.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TDrawGrid.DragMode" link="#lcl.controls.TControl.DragMode"/>
@ -13527,7 +13842,7 @@
<element name="TDrawGrid.FixedColor" link="#lcl.grids.TCustomGrid.FixedColor"/>
<element name="TDrawGrid.FixedCols" link="#lcl.grids.TCustomGrid.FixedCols"/>
<element name="TDrawGrid.FixedRows" link="#lcl.grids.TCustomGrid.FixedRows"/>
<element name="TDrawGrid.Flat" link="#lcl.controls.TControl.Flat"/>
<element name="TDrawGrid.Flat" link="#lcl.grids.TCustomGrid.Flat"/>
<element name="TDrawGrid.Font" link="#lcl.controls.TControl.Font"/>
<element name="TDrawGrid.GridLineWidth" link="#lcl.grids.TCustomGrid.GridLineWidth"/>
<element name="TDrawGrid.HeaderHotZones" link="#lcl.grids.TCustomGrid.HeaderHotZones"/>
@ -13538,7 +13853,7 @@
<element name="TDrawGrid.Options" link="#lcl.grids.TCustomGrid.Options"/>
<element name="TDrawGrid.Options2" link="#lcl.grids.TCustomGrid.Options2"/>
<element name="TDrawGrid.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TDrawGrid.ParentDoubleBuffered" link="#lcl.controls.TControl.ParentDoubleBuffered"/>
<element name="TDrawGrid.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TDrawGrid.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TDrawGrid.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TDrawGrid.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
@ -13562,10 +13877,10 @@
<element name="TDrawGrid.OnBeforeSelection" link="#lcl.grids.TCustomGrid.OnBeforeSelection"/>
<element name="TDrawGrid.OnCheckboxToggled" link="#lcl.grids.TCustomGrid.OnCheckboxToggled"/>
<element name="TDrawGrid.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TDrawGrid.OnColRowDeleted" link="#lcl.grids.TCustomGrid.OnColRowDeleted"/>
<element name="TDrawGrid.OnColRowExchanged" link="#lcl.grids.TCustomGrid.OnColRowExchanged"/>
<element name="TDrawGrid.OnColRowInserted" link="#lcl.grids.TCustomGrid.OnColRowInserted"/>
<element name="TDrawGrid.OnColRowMoved" link="#lcl.grids.TCustomGrid.OnColRowMoved"/>
<element name="TDrawGrid.OnColRowDeleted" link="#lcl.grids.TCustomDrawGrid.OnColRowDeleted"/>
<element name="TDrawGrid.OnColRowExchanged" link="#lcl.grids.TCustomDrawGrid.OnColRowExchanged"/>
<element name="TDrawGrid.OnColRowInserted" link="#lcl.grids.TCustomDrawGrid.OnColRowInserted"/>
<element name="TDrawGrid.OnColRowMoved" link="#lcl.grids.TCustomDrawGrid.OnColRowMoved"/>
<element name="TDrawGrid.OnCompareCells" link="#lcl.grids.TCustomGrid.OnCompareCells"/>
<element name="TDrawGrid.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TDrawGrid.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
@ -13574,18 +13889,18 @@
<element name="TDrawGrid.OnDrawCell" link="#lcl.grids.TCustomGrid.OnDrawCell"/>
<element name="TDrawGrid.OnEditButtonClick" link="#lcl.grids.TCustomGrid.OnEditButtonClick"/>
<element name="TDrawGrid.OnButtonClick" link="#lcl.grids.TCustomGrid.OnButtonClick"/>
<element name="TDrawGrid.OnEditingDone" link="#lcl.grids.TCustomGrid.OnEditingDone"/>
<element name="TDrawGrid.OnEditingDone" link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TDrawGrid.OnEndDock" link="#lcl.controls.TControl.OnEndDock"/>
<element name="TDrawGrid.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TDrawGrid.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TDrawGrid.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TDrawGrid.OnGetCellHint" link="#lcl.grids.TCustomGrid.OnGetCellHint"/>
<element name="TDrawGrid.OnGetCheckboxState" link="#lcl.grids.TCustomGrid.OnGetCheckboxState"/>
<element name="TDrawGrid.OnGetEditMask" link="#lcl.grids.TCustomGrid.OnGetEditMask"/>
<element name="TDrawGrid.OnGetEditText" link="#lcl.grids.TCustomGrid.OnGetEditText"/>
<element name="TDrawGrid.OnHeaderClick" link="#lcl.grids.TCustomGrid.OnHeaderClick"/>
<element name="TDrawGrid.OnHeaderSized" link="#lcl.grids.TCustomGrid.OnHeaderSized"/>
<element name="TDrawGrid.OnHeaderSizing" link="#lcl.grids.TCustomGrid.OnHeaderSizing"/>
<element name="TDrawGrid.OnGetCheckboxState" link="#lcl.grids.TCustomDrawGrid.OnGetCheckboxState"/>
<element name="TDrawGrid.OnGetEditMask" link="#lcl.grids.TCustomDrawGrid.OnGetEditMask"/>
<element name="TDrawGrid.OnGetEditText" link="#lcl.grids.TCustomDrawGrid.OnGetEditText"/>
<element name="TDrawGrid.OnHeaderClick" link="#lcl.grids.TCustomDrawGrid.OnHeaderClick"/>
<element name="TDrawGrid.OnHeaderSized" link="#lcl.grids.TCustomDrawGrid.OnHeaderSized"/>
<element name="TDrawGrid.OnHeaderSizing" link="#lcl.grids.TCustomDrawGrid.OnHeaderSizing"/>
<element name="TDrawGrid.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TDrawGrid.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TDrawGrid.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
@ -13594,19 +13909,19 @@
<element name="TDrawGrid.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TDrawGrid.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TDrawGrid.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TDrawGrid.OnMouseWheel" link="#lcl.grids.TCustomGrid.OnMouseWheel"/>
<element name="TDrawGrid.OnMouseWheelDown" link="#lcl.grids.TCustomGrid.OnMouseWheelDown"/>
<element name="TDrawGrid.OnMouseWheelUp" link="#lcl.grids.TCustomGrid.OnMouseWheelUp"/>
<element name="TDrawGrid.OnMouseWheelHorz" link="#lcl.grids.TCustomGrid.OnMouseWheelHorz"/>
<element name="TDrawGrid.OnMouseWheelLeft" link="#lcl.grids.TCustomGrid.OnMouseWheelLeft"/>
<element name="TDrawGrid.OnMouseWheelRight" link="#lcl.grids.TCustomGrid.OnMouseWheelRight"/>
<element name="TDrawGrid.OnPickListSelect" link="#lcl.grids.TCustomGrid.OnPickListSelect"/>
<element name="TDrawGrid.OnMouseWheel" link="#lcl.grids.TCustomDrawGrid.OnMouseWheel"/>
<element name="TDrawGrid.OnMouseWheelDown" link="#lcl.grids.TCustomDrawGrid.OnMouseWheelDown"/>
<element name="TDrawGrid.OnMouseWheelUp" link="#lcl.grids.TCustomDrawGrid.OnMouseWheelUp"/>
<element name="TDrawGrid.OnMouseWheelHorz" link="#lcl.grids.TCustomDrawGrid.OnMouseWheelHorz"/>
<element name="TDrawGrid.OnMouseWheelLeft" link="#lcl.grids.TCustomDrawGrid.OnMouseWheelLeft"/>
<element name="TDrawGrid.OnMouseWheelRight" link="#lcl.grids.TCustomDrawGrid.OnMouseWheelRight"/>
<element name="TDrawGrid.OnPickListSelect" link="#lcl.grids.TCustomDrawGrid.OnPickListSelect"/>
<element name="TDrawGrid.OnPrepareCanvas" link="#lcl.grids.TCustomGrid.OnPrepareCanvas"/>
<element name="TDrawGrid.OnSelectEditor" link="#lcl.grids.TCustomGrid.OnSelectEditor"/>
<element name="TDrawGrid.OnSelection" link="#lcl.grids.TCustomGrid.OnSelection"/>
<element name="TDrawGrid.OnSelectCell" link="#lcl.grids.TCustomDrawGrid.OnSelectCell"/>
<element name="TDrawGrid.OnSetCheckboxState" link="#lcl.grids.TCustomGrid.OnSetCheckboxState"/>
<element name="TDrawGrid.OnSetEditText" link="#lcl.grids.TCustomGrid.OnSetEditText"/>
<element name="TDrawGrid.OnSetCheckboxState" link="#lcl.grids.TCustomDrawGrid.OnSetCheckboxState"/>
<element name="TDrawGrid.OnSetEditText" link="#lcl.grids.TCustomDrawGrid.OnSetEditText"/>
<element name="TDrawGrid.OnStartDock" link="#lcl.controls.TControl.OnStartDock"/>
<element name="TDrawGrid.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TDrawGrid.OnTopleftChanged" link="#lcl.grids.TCustomGrid.OnTopLeftChanged"/>
@ -14041,7 +14356,7 @@
</element>
<element name="TCustomStringGrid.CalcCellExtent">
<short/>
<short>Deprecated in the ancestor class.</short>
<descr>
<remark>
CalcCellExtent is marked as deprecated in the ancestor class.
@ -14061,9 +14376,17 @@
<short/>
</element>
<element name="TCustomStringGrid.DefineProperties" link="#rtl.Classes.TComponent.DefineProperties"/>
<element name="TCustomStringGrid.DefineProperties">
<short>Defines non-published properties included in LCL componenrt streaming.</short>
<descr>
<p>
<var>DefineProperties</var> is an overridden method used to define non-published properties which are read and written using LCL component streaming. In <var>TCustomStringGrid</var>, it adds read and write routines for the <var>Cells</var> property to the <var>TFiler</var> instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomStringGrid.DefineProperties.Filer">
<short/>
<short>TFIler instance used to read or write values for the class type.</short>
</element>
<element name="TCustomStringGrid.DefineCellsProperty">
@ -14281,8 +14604,12 @@
</element>
<element name="TCustomStringGrid.LoadContent">
<short/>
<descr/>
<short>Loads configuration settings from the specified XML configuration file.</short>
<descr>
<p>
Loads values for the <var>Cells</var> property when enabled in the configuration file.
</p>
</descr>
<seealso>
<link id="TCustomGrid.LoadContent"/>
</seealso>
@ -14290,10 +14617,22 @@
<element name="TCustomStringGrid.LoadContent.cfg" link="#lcl.grids.TCustomGrid.LoadContent.cfg"/>
<element name="TCustomStringGrid.LoadContent.Version" link="#lcl.grids.TCustomGrid.LoadContent.Version"/>
<element name="TCustomStringGrid.Loaded" link="#rtl.classes.TComponent.Loaded"/>
<element name="TCustomStringGrid.Loaded">
<short>Performs actions when LCL component streaming has been completed.</short>
<descr>
<p>
Calls the inherited method on entry, and sets the value for the <var>Modified</var> property to <b>False</b>.
</p>
</descr>
<seealso>
<link id="TCustomGrid.Loaded"/>
</seealso>
</element>
<element name="TCustomStringGrid.SaveContent">
<short/>
<short>
Saves configuration settings from SaveOptions and optionally values from Cells in the specified XML configuration file.
</short>
<descr/>
<seealso>
<link id="TCustomGrid.SaveContent"/>