mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-20 14:19:17 +02:00
Docs: RttiControls/rttigrids. Updates TTICustomGrid, TTIGrid topics and See Also links.
* Includes a trailing space on word-wrapped lines.
This commit is contained in:
dsiders
parent
ba7e61ad45
commit
ab0220e48a
@ -3,23 +3,24 @@
|
||||
<package name="RunTimeTypeInfoControls">
|
||||
<module name="RTTIGrids">
|
||||
<short>
|
||||
Contains controls which access properties in TPersistent objects using RTTI.
|
||||
Contains controls which access and modify properties in TPersistent objects
|
||||
using RTTI.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Provides LCL controls that access properties of TPersistent objects via
|
||||
RTTI (the FreePascal Run-Time Type Information). Every published property
|
||||
can be edited in the Object Inspector. There you have a TOIPropertyGrid
|
||||
working with TEdit, TComboBox and TButton. These controls extends the
|
||||
possibilities to edit single properties and the developer can choose how to
|
||||
represent the property.
|
||||
Provides LCL controls that access properties of TPersistent objects via RTTI
|
||||
(the FreePascal Run-Time Type Information). Every published property can be
|
||||
edited in the Object Inspector. There you have a TOIPropertyGrid working with
|
||||
TEdit, TComboBox and TButton. These controls extends the possibilities to
|
||||
edit single properties and the developer can choose how to represent the
|
||||
property.
|
||||
</p>
|
||||
<p>
|
||||
A TTICustomPropertyGrid property editor is registered during initialization
|
||||
of the <file>rttigrids.pas</file> unit for objects descended from
|
||||
TPersistent. This property grid, along with any other TTICustomPropertyGrid
|
||||
property editors registered at run-time, are freed during finalization of
|
||||
the unit.
|
||||
property editors registered at run-time, are freed during finalization of the
|
||||
unit.
|
||||
</p>
|
||||
<p>
|
||||
The following components are added to the component palette in the Lazarus
|
||||
@ -59,8 +60,7 @@ Base class for an RTTI-enabled object inspector grid.
|
||||
<seealso>
|
||||
<link id="TTIPropertyGrid"/>
|
||||
<!--
|
||||
<link id="#ideintf.objectinspector.TCustomPropertiesGrid">
|
||||
TCustomPropertiesGrid</link>
|
||||
<link id="#ideintf.objectinspector.TCustomPropertiesGrid">TCustomPropertiesGrid</link>
|
||||
-->
|
||||
</seealso>
|
||||
</element>
|
||||
@ -73,9 +73,8 @@ object.
|
||||
<descr>
|
||||
<p>
|
||||
Sets the visibility for properties introduced in ancestor classes. See
|
||||
<link id="TTICustomPropertyGrid">TTICustomPropertyGrid</link>
|
||||
for information about properties, methods, and events specific to the
|
||||
property grid control.
|
||||
<link id="TTICustomPropertyGrid">TTICustomPropertyGrid</link> for information
|
||||
about properties, methods, and events specific to the property grid control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -86,7 +85,7 @@ property grid control.
|
||||
<element name="TTIPropertyGrid.Align" link="#lcl.controls.TControl.Align"/>
|
||||
<element name="TTIPropertyGrid.Anchors" link="#lcl.controls.TControl.Anchors"/>
|
||||
|
||||
<!-- No links available for ideeintf/ObjectInspector symbols -->
|
||||
<!-- No links available for ideintf/ObjectInspector symbols -->
|
||||
<element name="TTIPropertyGrid.BackgroundColor">
|
||||
<short>
|
||||
Background color used for the property grid control.
|
||||
@ -115,8 +114,8 @@ property. If UseOINormalCheckBox is not defined for the platform, a themed
|
||||
check box control is used for a Boolean property.
|
||||
</p>
|
||||
<p>
|
||||
When set to <b>False</b>, the values '<b>(True)</b>' and '<b>(False)</b>'
|
||||
are used for the Boolean property.
|
||||
When set to <b>False</b>, the values '<b>(True)</b>' and '<b>(False)</b>' are
|
||||
used for the Boolean property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -176,8 +175,7 @@ Font used to display property names on the property grid.
|
||||
|
||||
<element name="TTIPropertyGrid.OnEditorFilter">
|
||||
<short>
|
||||
Event handler signalled to locate and select an editor for the property
|
||||
grid.
|
||||
Event handler signalled to locate and select an editor for the property grid.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -208,8 +206,8 @@ property grid.
|
||||
|
||||
<element name="TTIPropertyGrid.PreferredSplitterX">
|
||||
<short>
|
||||
Best horizontal position for the splitter between the names and values on
|
||||
the property grid pages.
|
||||
Best horizontal position for the splitter between the names and values on the
|
||||
property grid pages.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -217,8 +215,8 @@ the property grid pages.
|
||||
|
||||
<element name="TTIPropertyGrid.SplitterX">
|
||||
<short>
|
||||
Current horizontal position for the splitter between the names and values
|
||||
on the property grid pages.
|
||||
Current horizontal position for the splitter between the names and values on
|
||||
the property grid pages.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -252,8 +250,8 @@ grid.
|
||||
|
||||
<element name="TTIGridProperty">
|
||||
<short>
|
||||
Contains information about the editor and its windowed editing control for
|
||||
an individual property on an RTTI-enabled property grid.
|
||||
Contains information about the editor and its windowed editing control for an
|
||||
individual property on an RTTI-enabled property grid.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -296,13 +294,15 @@ an individual property on an RTTI-enabled property grid.
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TTIGridProperty.Create.TheGrid">
|
||||
<short/>
|
||||
<short>Grid control which hosts the property and its editor.</short>
|
||||
</element>
|
||||
<element name="TTIGridProperty.Create.TheEditor">
|
||||
<short/>
|
||||
<short>Control used to edit the value for the property.</short>
|
||||
</element>
|
||||
<element name="TTIGridProperty.Create.TheIndex">
|
||||
<short/>
|
||||
<short>
|
||||
Ordinal position in the properties defined for the grid control.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTIGridProperty.Destroy">
|
||||
@ -372,7 +372,7 @@ Property editor class instance for the property in PropName.
|
||||
|
||||
<element name="TTIGridProperty.Grid">
|
||||
<short>
|
||||
RTTI-enabled grid control for property in the class instance.
|
||||
RTTI-enabled grid control for the property in the class instance.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -527,7 +527,11 @@ Corner cell at the left, top of the grid.
|
||||
<short>
|
||||
Set type used to store TTIGridCellType enumeration values.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
Not used in the current implementation.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
@ -559,8 +563,8 @@ Set type used to store TTIGridOption enumeration values.
|
||||
|
||||
<element name="TTIGridGetObject">
|
||||
<short>
|
||||
Specifies an event handler used to get the persistent object at the
|
||||
specified position on a RTTI grid control.
|
||||
Specifies an event handler which gets the persistent object at the specified
|
||||
position on a RTTI grid control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso>
|
||||
@ -578,16 +582,21 @@ Position of the persistent object in the list of linked objects.
|
||||
</element>
|
||||
<element name="TTIGridGetObject.TIObject">
|
||||
<short>
|
||||
Object instances retrieved at the specified position.
|
||||
Object instance retrieved at the specified position.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTIGridGetObjectCount">
|
||||
<short>
|
||||
Specifies an event handler signalled to get the number of persistent
|
||||
objects defined for a RTTI-enabled grid control.
|
||||
Specifies an event handler signalled to get the number of persistent objects
|
||||
defined for a RTTI-enabled grid control.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TTIGridGetObjectCount</var> is the type used to implement the
|
||||
<var>OnGetObjectCount</var> property in <var>TTICustomGrid</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.OnGetObjectCount"/>
|
||||
</seealso>
|
||||
@ -608,8 +617,8 @@ Number of persistent objects found in ListObject.
|
||||
|
||||
<element name="TTIGridGetObjectName">
|
||||
<short>
|
||||
Specifies an event handler signalled to get the name for a given
|
||||
persistent object.
|
||||
Specifies an event handler signalled to get the name for a persistent
|
||||
object at a specified position in a RTTI grid control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso>
|
||||
@ -639,8 +648,8 @@ Returns the name for the specified persistent object.
|
||||
|
||||
<element name="TTIGridCreateCellEditor">
|
||||
<short>
|
||||
Specifies an event handler used to get a cell editor for a RTTI-enabled
|
||||
grid control.
|
||||
Specifies an event handler used to get a cell editor for a RTTI-enabled grid
|
||||
control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso>
|
||||
@ -684,12 +693,34 @@ Editor control updated in the event handler.
|
||||
<element name="TTICustomGrid">
|
||||
<short>
|
||||
Specifies a grid control which uses RTTI type information to access and
|
||||
maintain a list of properties in a linked object.
|
||||
maintain a list of property values in a linked object.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
TTICustomGrid is a TCustomGrid descendant and the base class for the
|
||||
TTIGrid control.
|
||||
<var>TTICustomGrid</var> is a <var>TCustomGrid</var> descendant and the base
|
||||
class for the TTIGrid control.
|
||||
</p>
|
||||
<p>
|
||||
TTICustomGrid / TTIGrid can be thought of as an "Object Grid", where
|
||||
persistent objects in an indexed or enumerable list can be displayed and
|
||||
edited using the RTTI information for the items.
|
||||
</p>
|
||||
<p>
|
||||
The ListObject property contains the collection or container with
|
||||
the persistent objects displayed on the RTTI grid control. Items in the list
|
||||
object can be displayed as either a row or a column on the grid control using
|
||||
the ListDirection property.
|
||||
</p>
|
||||
<p>
|
||||
Properties provides indexed access to the RTTI type information for the items
|
||||
in the list object. This includes the grid control for the item, the property
|
||||
Editor, the Column title for the property, and its ordinal position in the
|
||||
collection or container.
|
||||
</p>
|
||||
<p>
|
||||
An example using TTIGrid is located in the
|
||||
<file>$(LazarusDir)/components/rtticontrols/examples/exampleprojectgrid1.lpr</file>
|
||||
file.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -754,43 +785,59 @@ information for the linked object.
|
||||
<descr>
|
||||
<p>
|
||||
Existing values in Properties are discarded by calling the ClearProperties
|
||||
method. No actions are performed in the method if a TList instance has not
|
||||
been allocated for the Properties member.
|
||||
method. Type information for the persistent properties is reloaded and
|
||||
ordered by the values in PropertyOrder. No actions are performed in the
|
||||
method if a TList instance has not been allocated for the Properties member.
|
||||
</p>
|
||||
<p>
|
||||
The OnPropertiesCreated event handler is signalled (when assigned) prior to
|
||||
exiting from the method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.ClearProperties"/>
|
||||
<link id="TTICustomGrid.Properties"/>
|
||||
<link id="TTICustomGrid.PropertyOrder"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.AddHeaderPropertyEditor">
|
||||
<short/>
|
||||
<short>
|
||||
Creates a TTIGridProperty editor the specified property and adds it to Properties.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.RebuildGridLayout"/>
|
||||
<link id="TTICustomGrid.ClearProperties"/>
|
||||
<link id="TTICustomGrid.OnPropertiesCreated"/>
|
||||
<link id="TTICustomGrid.HideProperties"/>
|
||||
<link id="TTICustomGrid.ShowOnlyProperties"/>
|
||||
<link id="TTICustomGrid.TIOptions"/>
|
||||
</seealso>
|
||||
<notes>
|
||||
<note>???</note>
|
||||
</notes>
|
||||
</element>
|
||||
<element name="TTICustomGrid.AddHeaderPropertyEditor.Prop">
|
||||
<short/>
|
||||
<short>Property editor with the header information added in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.BeforeMoveSelection">
|
||||
<short/>
|
||||
<short>
|
||||
Performs actions needed prior to changing the selected grid cell.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#lcl.grids.TCustomGrid.BeforeMoveSelection">TCustomGrid.BeforeMoveSelection</link>
|
||||
<link id="#lcl.grids.TCustomGrid.OnBeforeSelection">TCustomGrid.OnBeforeSelection</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TTICustomGrid.BeforeMoveSelection.DCol">
|
||||
<short/>
|
||||
<short>New column number to select in the grid.</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.BeforeMoveSelection.DRow">
|
||||
<short/>
|
||||
<short>New row number to select in the grid.</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.CalcCellExtent">
|
||||
<short/>
|
||||
<short>Not used in the current version.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -810,9 +857,9 @@ Performs actions to hide the active Editor for the grid control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Locates the property link with the current Editor and removes both the
|
||||
object and property references in the property link. Calls the inherited
|
||||
method prior to exit.
|
||||
Locates the property link with the current Editor and removes both the object
|
||||
and property references in the property link. Calls the inherited method
|
||||
prior to exit.
|
||||
</p>
|
||||
<p>
|
||||
DoEditorHide is called from the EditorHide method when the active Editor is
|
||||
@ -830,15 +877,15 @@ control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited DoEditorShow method on entry. DoEditorShow ensures that
|
||||
a button-style editor has its Parent property set to the grid control
|
||||
instance, and its Visible property is set to <b>True</b>.
|
||||
Calls the inherited DoEditorShow method on entry. DoEditorShow ensures that a
|
||||
button-style editor has its Parent property set to the grid control instance,
|
||||
and its Visible property is set to <b>True</b>.
|
||||
</p>
|
||||
<p>
|
||||
DoEditorShow is called from the EditorShow method, and occurs when the
|
||||
active cell editor has been changed or when the grid control receives
|
||||
focus. It is also called when goAlwaysShowEditor is added to the Options
|
||||
for the grid control.
|
||||
DoEditorShow is called from the EditorShow method, and occurs when the active
|
||||
cell editor has been changed or when the grid control receives focus. It is
|
||||
also called when goAlwaysShowEditor is added to the Options for the grid
|
||||
control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -858,8 +905,8 @@ filled using the Brush for the canvas. The OnDrawCell event handler is
|
||||
signalled to perform the user-specified drawing operations.
|
||||
</p>
|
||||
<p>
|
||||
When OnDrawCell is omitted (or at design-time), the DefaultDrawCell method
|
||||
is called.
|
||||
When OnDrawCell is omitted (or at design-time), the DefaultDrawCell method is
|
||||
called.
|
||||
</p>
|
||||
<p>
|
||||
DrawCell calls the DrawCellGrid method to draw fixed header cells and grid
|
||||
@ -902,117 +949,365 @@ Grid drawing state applied to the values drawn in the method.
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.EditorWidthChanged">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Recalculates the position and size for a cell Editor when the column width is
|
||||
changed.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>EditorWidthChanged</var> is overridden in <var>TTICustomGrid</var> and
|
||||
re-implements the method from the ancestor class. It calls the EditPosChanged
|
||||
method to recalculate the cell rectangle for the Editor control in the
|
||||
current cell.
|
||||
</p>
|
||||
<p>
|
||||
Values in the ACol and AWidth arguments are not used in the overridden method.
|
||||
</p>
|
||||
<p>
|
||||
EditorWidthChanged is called when either the ColWidths or DefColWidth
|
||||
property has been changed.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TTICustomGrid.EditorWidthChanged.aCol">
|
||||
<short/>
|
||||
<short>Not used in the method.</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.EditorWidthChanged.aWidth">
|
||||
<short/>
|
||||
<short>Not used in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.HeaderClick">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Performs actions needed when a mouse click occurs in a fixed header for a
|
||||
grid column or row.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HeaderClick</var> is an overridden method in <var>TTICustomGrid</var>.
|
||||
It applies changes to the sort order for the grid when the mouse event occurs
|
||||
in a column header.
|
||||
</p>
|
||||
<p>
|
||||
<var>IsColumn</var> indicates whether the header click applies to a column or
|
||||
a row. When set to <b>True</b>, the mouse click occurred in a fixed header
|
||||
for the column number in <var>Index</var>.
|
||||
</p>
|
||||
<p>
|
||||
HeaderClick calls the inherited method on entry to update the SortColumn and
|
||||
SortOrder properties when a mouse up event occurs. The Sort method is used to
|
||||
re-order the grid data when ColumnClickSorts is enabled.
|
||||
</p>
|
||||
<p>
|
||||
The OnHeaderClick event handler is signalled (when assigned) to perform
|
||||
additional actions needed in the application. The handler can be used to
|
||||
respond to a click on a fixed row header (IsColumn is <b>False</b>) which is
|
||||
ignored in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
OnHeaderClick is called from the MouseUp and DialogChar methods in the
|
||||
ancestor class.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.OnHeaderClick"/>
|
||||
<link id="#lcl.grids.TCustomGrid.HeaderClick">TCustomGrid.HeaderClick</link>
|
||||
<link id="#lcl.grids.TCustomGrid.SortOrder">TCustomGrid.SortOrder</link>
|
||||
<link id="#lcl.grids.TCustomGrid.SortColumn">TCustomGrid.SortColumn</link>
|
||||
<link id="#lcl.grids.TCustomGrid.Sort">TCustomGrid.Sort</link>
|
||||
<link id="#lcl.grids.TCustomGrid.ColumnClickSorts">TCustomGrid.ColumnClickSorts</link>
|
||||
<link id="#lcl.grids.TCustomGrid.MouseUp">TCustomGrid.MouseUp</link>
|
||||
<link id="#lcl.grids.TCustomGrid.MouseUp">TCustomGrid.DialogChar</link>
|
||||
<link id="#lcl.grids.THdrEvent">THdrEvent</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TTICustomGrid.HeaderClick.IsColumn">
|
||||
<short/>
|
||||
<short>
|
||||
<b>True</b> if the mouse event occurred in the fixed header for the specified
|
||||
column number.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.HeaderClick.Index">
|
||||
<short/>
|
||||
<short>
|
||||
Column number for the mouse click event.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.HeaderSized">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Performs actions needed when the header for a column or a row has been
|
||||
resized.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HeaderSized</var> is an overridden method in <var>TTICustomGrid</var>
|
||||
which implements the virtual method defined in the ancestor class. It signals
|
||||
the OnHeaderSized event handler (when assigned) using IsColumn and Index as
|
||||
arguments to the handler.
|
||||
</p>
|
||||
<p>
|
||||
<var>IsColumn</var> indicates whether the sizing action applies to a header
|
||||
for a column or a row. When set to <b>True</b>, the column header has been
|
||||
resized. When set to <b>False</b>, the row header was resized.
|
||||
</p>
|
||||
<p>
|
||||
<var>Index</var> indicates the column or row number in the grid where the
|
||||
resizing action occurred.
|
||||
</p>
|
||||
<p>
|
||||
HeaderSized is called from methods like MouseUp (when column or row sizing is
|
||||
completed) and DblClick (when column sizing is enabled in the grid Options).
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TTICustomGrid.HeaderSized.IsColumn">
|
||||
<short/>
|
||||
<short>
|
||||
<var>True</var> when a column header is resized, <var>False</var> for a row
|
||||
header.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.HeaderSized.Index">
|
||||
<short/>
|
||||
<short>
|
||||
Column or row number for the header resized in the grid control.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.GetAutoFillColumnInfo">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Re-implements the method used to get auto-fill information for the column.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetAutoFillColumnInfo</var> is an overridden method in
|
||||
<var>TTICustomGrid</var>. It updates the value in the <var>APriority</var>
|
||||
argument to set the auto-sizing priority for the column represented by the
|
||||
<var>Index</var> argument.
|
||||
</p>
|
||||
<p>
|
||||
If Index is one of the FixedCols for the control, APriority is set to 0. This
|
||||
disables auto-sizing for the column. Otherwise, APriority is set to 1 to
|
||||
enable auto-sizing for the column.
|
||||
</p>
|
||||
<p>
|
||||
Values in AMin and AMax are not used or assigned in the overridden method.
|
||||
</p>
|
||||
<p>
|
||||
GetAutoFillColumnInfo is called when AutoFillColumns is set to <b>True</b>,
|
||||
and the column sizes are recalculated for the the grid control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.grids.TCustomGrid.GetAutoFillColumnInfo">TCustomGrid.GetAutoFillColumnInfo</link>
|
||||
<link id="#lcl.grids.TCustomGrid.AutoFillColumns">TCustomGrid.AutoFillColumns</link>
|
||||
<link id="#lcl.grids.TCustomGrid.ColumnFromGridColumn">TCustomGrid.ColumnFromGridColumn</link>
|
||||
<link id="#lcl.grids.TCustomGrid.Columns">TCustomGrid.Columns</link>
|
||||
<link id="#lcl.grids.TGridColumn.MinSize">TGridColumn.MinSize</link>
|
||||
<link id="#lcl.grids.TGridColumn.MaxSize">TGridColumn.MaxSize</link>
|
||||
<link id="#lcl.grids.TGridColumn.SizePriority">TGridColumn.SizePriority</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TTICustomGrid.GetAutoFillColumnInfo.Index">
|
||||
<short/>
|
||||
<short>
|
||||
Position of the column for the auto-fill information.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.GetAutoFillColumnInfo.aMin">
|
||||
<short/>
|
||||
<short>
|
||||
Calculated minimum width for the column. Not used in TTICustomGrid.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.GetAutoFillColumnInfo.aMax">
|
||||
<short/>
|
||||
<short>
|
||||
Calculated maximum width for the column. Not used in TTICustomGrid.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.GetAutoFillColumnInfo.aPriority">
|
||||
<short/>
|
||||
<short>
|
||||
Auto-sizing priority for the column. 0 is disabled.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.SelectEditor">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Gets the Editor for a property name or value displayed on the RTTI-enabled
|
||||
grid control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SelectEditor</var> is an overridden method in <var>TTICustomGrid</var>.
|
||||
It re-implements the method from the ancestor class, and does not call the
|
||||
inherited method.
|
||||
</p>
|
||||
<p>
|
||||
SelectEditor determines the editor class needed for the persistent object and
|
||||
property at the Col and Row for the grid control. The Editor property is
|
||||
updated with the control used to edit the property name or value on the grid.
|
||||
It is also updated with the RTTI type information for the property name or
|
||||
value.
|
||||
</p>
|
||||
<p>
|
||||
The OnSelectEditor event handler is signalled (when assigned) with the cell
|
||||
coordinates (Col, Row) and the Editor control selected in the method.
|
||||
</p>
|
||||
<p>
|
||||
No actions are performed in the method when Properties has not been assigned.
|
||||
In this case, the value in Editor is <b>Nil</b>.
|
||||
</p>
|
||||
<p>
|
||||
SelectEditor is called from methods in the ancestor class, and occurs when
|
||||
mouse / key / cell navigation events are handled for the control. It is also
|
||||
called when values in the Options property are updated.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.Properties"/>
|
||||
<link id="TTICustomGrid.GetTIObject"/>
|
||||
<link id="#lcl.grids.TCustomGrid.Editor">TCustomGrid.Editor</link>
|
||||
<link id="#lcl.grids.TCustomGrid.Col">TCustomGrid.Col</link>
|
||||
<link id="#lcl.grids.TCustomGrid.Row">TCustomGrid.Row</link>
|
||||
<link id="#lcl.grids.TCustomGrid.Options">TCustomGrid.Options</link>
|
||||
<link id="#lcl.grids.TCustomGrid.KeyDown">TCustomGrid.KeyDown</link>
|
||||
<link id="#lcl.grids.TCustomGrid.KeyPress">TCustomGrid.KeyPress</link>
|
||||
<link id="#lcl.grids.TCustomGrid.MouseDown">TCustomGrid.MouseDown</link>
|
||||
<link id="#lcl.grids.TCustomGrid.MouseUp">TCustomGrid.MouseUp</link>
|
||||
<link id="#lcl.grids.TCustomGrid.DoEnter">TCustomGrid.DoEnter</link>
|
||||
<link id="#lcl.grids.TCustomGrid.MoveExtend">TCustomGrid.MoveExtend</link>
|
||||
<link id="#lcl.grids.TCustomGrid.MoveNextSelectable">TCustomGrid.MoveNextSelectable</link>
|
||||
<link id="#lcl.grids.TCustomGrid.EditorShowInCell">TCustomGrid.EditorShowInCell</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.DoEditorControlKeyUp">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Implements the KeyUp handler for the active Editor on the RTTI-enabled grid.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>DoEditorControlKeyUp</var> ensures that key events using the Ctrl modifier are handled for the control, including:
|
||||
</p>
|
||||
<dl>
|
||||
<dt>CTRL + Up</dt>
|
||||
<dd>Moves the selection pointer towards the top of the grid.</dd>
|
||||
<dt>Ctrl + Down</dt>
|
||||
<dd>Moves the selection pointer towards the bottom of the grid.</dd>
|
||||
<dt>Ctrl + Home</dt>
|
||||
<dd>Moves the selection pointer to the first non-fixed row in the grid.</dd>
|
||||
<dt>Ctrl + End</dt>
|
||||
<dd>Moves the selection pointer to the last non-fixed row in the grid.</dd>
|
||||
<dt>Ctrl + F2</dt>
|
||||
<dd>
|
||||
Reloads property type information and activates the Editor for the current
|
||||
cell.
|
||||
</dd>
|
||||
</dl>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TTICustomGrid.DoEditorControlKeyUp.Sender">
|
||||
<short/>
|
||||
<short>
|
||||
Object for the event notification.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.DoEditorControlKeyUp.Key">
|
||||
<short/>
|
||||
<short>
|
||||
Key code for the key event notification.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.DoEditorControlKeyUp.Shift">
|
||||
<short/>
|
||||
<short>
|
||||
Shift, Alt, or Ctrl modifier for the key event notification.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.WriteCellText">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Draws the specified cell text to the a display rectangle on the Canvas for
|
||||
the control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>WriteCellText</var> adjusts the coordinates in ARect to account for grid
|
||||
lines and padding around the text value. Space is reserved at the top of the
|
||||
rectangle, and on the edge indicated by the text alignment for the Canvas.
|
||||
</p>
|
||||
<p>
|
||||
The TextRectangle method in Canvas is called to render the text to the
|
||||
display rectangle.
|
||||
</p>
|
||||
<p>
|
||||
No actions are performed in the method if AText is an empty string ('').
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TTICustomGrid.WriteCellText.aRect">
|
||||
<short/>
|
||||
<short>
|
||||
Rectangle where the value is drawn on the Canvas for the control.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.WriteCellText.aText">
|
||||
<short/>
|
||||
<short>
|
||||
Text value drawn for the cell on the Canvas for the control.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.UnlinkPropertyEditor">
|
||||
<short/>
|
||||
<short>
|
||||
Sets the property link for the specified editor control to <b>Nil</b>.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.BeforeMoveSelection"/>
|
||||
<link id="#runtimetypeinfocontrols.rtticontrols.GetPropertyLinkOfComponent">GetPropertyLinkOfComponent</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TTICustomGrid.UnlinkPropertyEditor.aEditor">
|
||||
<short/>
|
||||
<short>
|
||||
Editing control to locate and unlink in the method.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.SetFixedCols">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Sets the value for the FixedCols property.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Overridden in TTICustomGrid. Calls the inherited method on entry to update
|
||||
the property value. Calls RebuildGridLayout to reload and reconfigure the
|
||||
Properties for the RTTI-enabled grid control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.RebuildGridLayout"/>
|
||||
<link id="#lcl.grids.TCustomGrid.FixedCols">TCustomGrid.FixedCols</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TTICustomGrid.SetFixedCols.AValue">
|
||||
<short/>
|
||||
<short>
|
||||
New value for the FixedCols property.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.SetFixedRows">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Sets the value for the FixedRows property.
|
||||
</short>
|
||||
<descr>
|
||||
Overridden in TTICustomGrid. Calls the inherited method on entry to update
|
||||
the property value. Calls RebuildGridLayout to reload and reconfigure the
|
||||
Properties for the RTTI-enabled grid control.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid.RebuildGridLayout"/>
|
||||
<link id="#lcl.grids.TCustomGrid.FixedRows">TCustomGrid.FixedRows</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TTICustomGrid.SetFixedRows.AValue">
|
||||
<short/>
|
||||
<short>
|
||||
New value for the FixedRows property.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TTICustomGrid.Create">
|
||||
@ -1089,8 +1384,7 @@ in the internal RTTI state flags.
|
||||
|
||||
<element name="TTICustomGrid.ReloadTIList">
|
||||
<short>
|
||||
Reloads RTTI property information in Properties and rebuilds the grid
|
||||
layout.
|
||||
Reloads RTTI property information in Properties and rebuilds the grid layout.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -1098,8 +1392,8 @@ layout.
|
||||
|
||||
<element name="TTICustomGrid.ClearProperties">
|
||||
<short>
|
||||
Removes existing RTTI property information for the linked object in the
|
||||
grid control.
|
||||
Removes existing RTTI property information for the linked object in the grid
|
||||
control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -1185,8 +1479,8 @@ Property editor class instance retrieved in the method.
|
||||
</element>
|
||||
<element name="TTICustomGrid.GetCellEditor.aIndependentEditor">
|
||||
<short>
|
||||
Contains True when the cell editor represents a persistent object instead
|
||||
of a named property.
|
||||
Contains True when the cell editor represents a persistent object instead of
|
||||
a named property.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
@ -1284,8 +1578,8 @@ name.
|
||||
</element>
|
||||
<element name="TTICustomGrid.IndexOfGridProperty.Result">
|
||||
<short>
|
||||
Ordinal position for the specified property name, or -1 when PropName is
|
||||
not found.
|
||||
Ordinal position for the specified property name, or -1 when PropName is not
|
||||
found.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TTICustomGrid.IndexOfGridProperty.PropName">
|
||||
@ -1407,8 +1701,7 @@ position in a user-supplied list of objects.
|
||||
|
||||
<element name="TTICustomGrid.OnGetObjectCount">
|
||||
<short>
|
||||
Event handler signalled to get the number of persistent objects in
|
||||
ListObject.
|
||||
Event handler signalled to get the number of persistent objects in ListObject.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -1446,8 +1739,8 @@ Event handler signalled to initialize a cell editor for the grid control.
|
||||
<descr>
|
||||
<p>
|
||||
Signalled from the GetEditorControl method after the editor class has been
|
||||
determined. It is signalled twice when a button-style editor is also used
|
||||
for a property value.
|
||||
determined. It is signalled twice when a button-style editor is also used for
|
||||
a property value.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -1464,8 +1757,7 @@ Properties on the control.
|
||||
|
||||
<element name="TTICustomGrid.Properties">
|
||||
<short>
|
||||
Provides indexed access to RTTI property information used on the grid
|
||||
control.
|
||||
Provides indexed access to RTTI property information used on the grid control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -1484,7 +1776,7 @@ Indicates the number of entries in Properties.
|
||||
|
||||
<element name="TTICustomGrid.PropertyOrder">
|
||||
<short>
|
||||
Contain property names in the order they are displayed on the grid control.
|
||||
Contains property names in the order they are displayed on the grid control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -1514,13 +1806,40 @@ Contains the grid options enabled for the RTTI grid control.
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- TODO: Needs description -->
|
||||
<element name="TTIGrid">
|
||||
<short>
|
||||
Implements a grid control which uses RTTI type information to access and
|
||||
maintain a list of properties in a linked object.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TTIGrid</var> is a <var>TTICustomGrid</var> descendant which implements
|
||||
an RTTI-enabled grid control that accesses a list of properties in a linked
|
||||
object. It sets the visibility for properties introduced in ancestor classes.
|
||||
</p>
|
||||
<p>
|
||||
TTICustomGrid / TTIGrid can be thought of as an "Object Grid", where
|
||||
persistent objects in an indexed or enumerable list can be displayed and
|
||||
edited using the RTTI information for the items.
|
||||
</p>
|
||||
<p>
|
||||
The ListObject property contains the collection or container with
|
||||
the persistent objects displayed on the RTTI grid control. Items in the list
|
||||
object can be displayed as either a row or a column on the grid control using
|
||||
the ListDirection property.
|
||||
</p>
|
||||
<p>
|
||||
Properties provides indexed access to the RTTI type information for the items
|
||||
in the list object. This includes the grid control for the item, the property
|
||||
Editor, the Column title for the property, and its ordinal position in the
|
||||
collection or container.
|
||||
</p>
|
||||
<p>
|
||||
An example using TTIGrid is located in the
|
||||
<file>$(LazarusDir)/components/rtticontrols/examples/exampleprojectgrid1.lpr</file>
|
||||
file.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTICustomGrid"/>
|
||||
<link id="#lcl.grids.TCustomGrid">TCustomGrid</link>
|
||||
@ -1608,8 +1927,8 @@ link="#runtimetypeinfocontrols.rttigrids.TTICustomGrid.TIOptions"/>
|
||||
|
||||
<element name="TRegisteredTIGridControl">
|
||||
<short>
|
||||
Represents a property editor and its windowed editing control registered
|
||||
for use on a property grid.
|
||||
Represents a property editor and its windowed editing control registered for
|
||||
use on a property grid.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user