paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-07 21:38:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL. Adds, updates topic content and links.

Browse Source 
git-svn-id: trunk@65477 -
This commit is contained in:
dsiders 2021-07-20 04:18:49 +00:00
parent b5bf7de6f9
commit 00037248cf
6 changed files with 467 additions and 246 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

251
docs/xml/lcl/comctrls.xml
View File

@ -7389,10 +7389,14 @@
<var>TListColumn</var> is a <var>TCollectionItem</var> descendant which represents an individual column in a multi-column list control.
</p>
<p>
TListColumn is the type used for items added to the <var>TListColumns</var> collection.
TListColumn is the type used for items added to the <var>TListColumns</var> collection, and maintained in the <var>TCustomListView.Columns</var> property.
</p>
</descr>
<seealso/>
<seealso>
<link id="TListColumns"/>
<link id="TCustomListView.Columns"/>
<link id="#rtl.classes.TCollectionItem">TCollectionItem</link>
</seealso>
</element>
<element name="TListColumn.FAlignment"/>
@ -7521,29 +7525,33 @@
</element>
<element name="TListColumn.SetIndex">
<short>
<var>SetIndex</var> - calls inherited method and if this is a new index value, changes to the new column index.
</short>
<descr/>
<short>Sets the value for the Index property.</short>
<descr>
<p>
Calls the inherited method to move the collection item to the position indicated in the property value. Calls the <var>ColumnMove</var> method in the widgetset class to reorder the column in the control.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TCollectionItem.Index">TCollectionItem.Index</link>
</seealso>
</element>
<element name="TListColumn.SetIndex.AValue">
<short/>
<short>New value for the Index property.</short>
</element>
<element name="TListColumn.GetDisplayName">
<short>
<var>GetDisplayName</var> returns the <var>Caption</var>; if this is blank, calls inherited method.
</short>
<descr/>
<short>Gets the value for the DisplayName property.</short>
<descr>
<p>
<var>GetDisplayName</var> returns the <var>Caption</var> for the control, and when blank, calls the inherited method to the property value.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TCollectionItem.DisplayName">TCollectionItem.DisplayName</link>
</seealso>
</element>
<element name="TListColumn.GetDisplayName.Result">
<short/>
<short>Value for the DisplayName property.</short>
</element>
<element name="TListColumn.GetStoredWidth">
@ -7552,14 +7560,30 @@
<seealso/>
</element>
<element name="TListColumn.GetStoredWidth.Result">
<short/>
<short>Returns the value in the Width property.</short>
</element>
<element name="TListColumn.Create">
<short>
<var>Create</var> - constructor for TListColumn: calls inherited <var>Create</var> then sets defaults for size, alignment and index.
</short>
<descr/>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for TListColumn, and sets the default values for properties, including:
</p>
<ul>
<li>Alignment</li>
<li>Caption</li>
<li>Width</li>
<li>Visible</li>
<li>MinWidth</li>
<li>MaxWidth</li>
<li>AutoSize</li>
<li>Tag</li>
<li>ImageIndex</li>
</ul>
<p>
Create calls the inherited <var>Create</var> method to instantiate the class instance and assign the value in ACollection as the owner for the class instance.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TCollectionItem.Create">TCollectionItem.Create</link>
</seealso>
@ -7569,10 +7593,12 @@
</element>
<element name="TListColumn.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TListColumn</var>: if update allowed, updates columns then calls inherited <var>Destroy</var>.
</short>
<descr/>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the destructor for <var>TListColumn</var>. When the collection allows updates, the update is suppressed for the column instance that is being destroyed. Calls the inherited method to clear the owner for the collection item and destroy the class instance. The columnDelete method in the widgetset class is called to remove the column.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TCollectionItem.Destroy">TCollectionItem.Destroy</link>
</seealso>
@ -7580,9 +7606,28 @@
<element name="TListColumn.Assign">
<short>
<var>Assign</var> - if source is of correct type, copies alignment, caption, visibility and size properties, otherwise calls inherited <var>Assign</var> which probably raises an exception.
Copies properties from the specified persistent object to the current class instance.
</short>
<descr/>
<descr>
<p>
<var>Assign</var> is an overridden method used to implement object persistence for the <var>TListColumn</var> type. It copies property values from the persistent object in <var>ASource</var> into the current class instance. When ASource is derived from TListColumn, the following properties are copied:
</p>
<ul>
<li>Alignment</li>
<li>AutoSize</li>
<li>Caption</li>
<li>MaxWidth</li>
<li>MinWidth</li>
<li>Visible</li>
<li>Width</li>
</ul>
<p>
The Changed method is called to signal a change in the values for the collection item.
</p>
<p>
If ASource is not derived from TListColumn, the inherited method is called using ASource as an argument. An EConvertError exception is raised if ASource has not been assigned (contains Nil).
</p>
</descr>
<seealso>
<link id="#rtl.classes.TPersistent.Assign">TPersistent.Assign</link>
</seealso>
@ -7594,15 +7639,20 @@
<element name="TListColumn.WidthType">
<short>Not used in LCL.</short>
<descr>
WidthType is a read-only TWidth property.
Provided for VCL code compatibility.
<p>
WidthType is a read-only TWidth property. Provided for VCL code compatibility.
</p>
</descr>
<seealso/>
</element>
<element name="TListColumn.Alignment">
<short>Sets alignment of caption: text is left or right justified or centered.</short>
<descr/>
<short>Sets the horizontal alignment for the Caption text.</short>
<descr>
<p>
Left or right justified, or centered.
</p>
</descr>
<seealso/>
</element>
@ -7615,7 +7665,7 @@
</element>
<element name="TListColumn.Caption">
<short>Caption text of column.</short>
<short>Caption text for the column.</short>
<descr/>
<seealso/>
</element>
@ -9974,7 +10024,7 @@
<element name="TCustomListView.ColumnClick">
<short>
Enable to react to clicks on ListView header columns, and call the OnColumnClick event.
Enables or disables OnColumnClick events for column headers on the control.
</short>
<descr/>
<seealso/>
@ -9982,7 +10032,7 @@
<element name="TCustomListView.Columns">
<short>
Collection of items, which have properties for ListView columns (size, alignment, image index, etc.).
Collection with the column definitions for the list view control (size, alignment, image index, etc.).
</short>
<descr/>
<seealso/>
@ -10047,7 +10097,7 @@
<element name="TCustomListView.ScrollBars">
<short>
Kind of scroll bars in control: vertical, horizontal, none or both. Auto* mean that scroll bars hide automatically.
Indicates the scroll bars visible on the control: vertical, horizontal, none or both. Auto* values mean that scroll bars are displayed or hidden as needed.
</short>
<descr/>
<seealso/>
@ -10155,7 +10205,7 @@
</element>
<element name="TCustomListView.OnChange">
<short>Called when content of list collection changes.</short>
<short>Event handler signalled when the content for a list item is changed.</short>
<descr/>
<seealso/>
</element>
@ -10205,14 +10255,14 @@
</element>
<element name="TCustomListView.OnDeletion">
<short>Called when items are deleted by code.</short>
<short>Called when items are deleted in program code.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListView.OnEdited">
<short>
Event handler signalled when editing has been completed for an item in the control.
Event handler signalled when editing has been completed for a list item in the control.
</short>
<descr/>
<seealso/>
@ -10220,14 +10270,14 @@
<element name="TCustomListView.OnEditing">
<short>
Event handler signalled to determine if editing can be started for an item in the control.
Event handler signalled to determine if editing can be started for a list item in the control.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListView.OnInsert">
<short>Called when items are inserted by code.</short>
<short>Called when a list item is inserted in program code.</short>
<descr/>
<seealso/>
</element>
@ -10271,7 +10321,7 @@
</element>
<element name="TCustomListView.OnDrawItem">
<short>event handler signalled to render an owner drawn item.</short>
<short>Event handler signalled to render an owner drawn item.</short>
<descr>
<p>
OnDrawItem is a TLVDrawItemEvent property which is the event handler signalled to render an owner drawn item. The event is triggered (when assigned) in the DrawItem method only when OwnerDraw is set to True and ViewStyle contains vsReport.
@ -10306,7 +10356,7 @@
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for <var>TCustomListView</var>. It calls the inherited <var>Create</var> method, and allocates resources needed for the class instance. It sets the default values for properties and the control style flags. It creates a TChangeLink instance for the image lists in SmallImages, LargeImages, and StateImages. The change links are configures to use the ImageChange and ImageResolutionHandleDestroyed methods in their event handlers. It also creates the TCustomListViewEditor instance used to edit values in the list view control.
<var>Create</var> is the overridden constructor for <var>TCustomListView</var>. It calls the inherited <var>Create</var> method, and allocates resources needed for the class instance. It sets the default values for properties and the control style flags. It creates a TChangeLink instance for the image lists in SmallImages, LargeImages, and StateImages. The change links are configured to use the ImageChange and ImageResolutionHandleDestroyed methods in their event handlers. It also creates the TCustomListViewEditor instance used to edit values in the list view control.
</p>
</descr>
<seealso>
@ -10361,7 +10411,7 @@
<element name="TCustomListView.CustomSort">
<short>
Sorts the Items for the control using the specified procedure or the OnCompare event handler.
Sorts the Items for the list view control using the specified procedure or the OnCompare event handler.
</short>
<descr/>
<seealso/>
@ -10394,7 +10444,7 @@
<element name="TCustomListView.EndUpdate">
<short>
Finishes an active update for the list view.
Finishes an active update for the list view control.
</short>
<descr/>
<seealso/>
@ -10449,7 +10499,7 @@
<element name="TCustomListView.GetHitTestInfoAt">
<short>
Gets hit text information from the widgetset class when its Handle has been assigned.
Gets hit test information from the widgetset class when its Handle has been assigned.
</short>
<descr/>
<seealso/>
@ -10527,13 +10577,13 @@
</element>
<element name="TCustomListView.SelectAll">
<short>Selects all items in the control when MultiSelect has been enabled.</short>
<short>Selects all Items in the control when MultiSelect has been enabled.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListView.IsEditing">
<short>Indicates if the list view editor is active.</short>
<short>Indicates if the editor is active in the list view control.</short>
<descr>
Delphi compatible function which returns if our listview editor is active.
</descr>
@ -10544,7 +10594,7 @@
</element>
<element name="TCustomListView.BoundingRect">
<short>Coordinates of the rectangle containing the ListView.</short>
<short>Coordinates of the rectangle containing the list view control.</short>
<descr/>
<seealso/>
</element>
@ -10552,7 +10602,7 @@
<element name="TCustomListView.BorderStyle" link="#lcl.controls.TWinControl.BorderStyle"/>
<element name="TCustomListView.Canvas">
<short>TCanvas object, defines the area on which all graphic is drawn.</short>
<short>TCanvas instance used to draw the control.</short>
<descr/>
<seealso/>
</element>
@ -10663,24 +10713,28 @@
<short>
Options for layouts, which show icons. Sets arrangement of icons, text-wrapping state.
</short>
<descr/>
<descr>
<p>
<var>IconOptions</var> is a <var>TIconOptions</var> property with the icon options used when the list view uses the vsIcon or vsSmallIcon view style. Values in IconOptions are passed to the widgetset class to render the control using the native style or API for the platform. Set values in its properties to control the icon placement, auto-arrange features, and caption text wrapping for a list item on then control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomListView.ItemFocused">
<short>ListView item, which is shown as focused.</short>
<short>The list item which has focus on the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListView.ItemIndex">
<short>Contains the position for the selected item in the control.</short>
<short>Contains the ordinal position for the selected list item on the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListView.Items">
<short>Collection of items in ListView.</short>
<short>Collection of list items displayed on the list view control.</short>
<descr>
<p>
<var>Items</var> - the list of entries in the list. Held as a linked list with a cached index of the last accessed item.
@ -10694,7 +10748,7 @@
<element name="TCustomListView.MultiSelect">
<short>
Allow to select several Listview items at a time, using Ctrl+click (select one item more).
Allows simultaneous selection of one or more list items using Ctrl+Click, Shift+Click, or Ctrl+Shift+Click, or using program code.
</short>
<descr/>
<seealso/>
@ -10702,40 +10756,111 @@
<element name="TCustomListView.OwnerData">
<short>
Use owner-data mode for ListView. It means, that ListView don't contain items, you must supply them using OnData* events.
Enables or disables owner-data (virtual) mode for the list view control.
</short>
<descr/>
<seealso/>
<descr>
<p>
<var>OwnerData</var> is a <var>Boolean</var> property which enables or disables virtual mode for the list view control.
</p>
<p>
When set to <b>True</b>, the Items property does not contain the actual data displayed on the control. The display values are retrieved using the OnData, OnDataFind, and OnDataHint event handlers. Only the most recently accessed owner data item exists in the list view control. This allows the list view to be used to display a large number of items with a minimal amount of overhead.
</p>
<p>
Set the value for the Count property in Items to indicate the number of owner data items available to the list view control. Assign a routine to OnData to populate an individual list item (and sub-items if needed) from the source for the owner data.
</p>
<p>
When OwnerData is set to <b>False</b>, all values displayed on the list view control are maintained in the Items property.
</p>
</descr>
<seealso>
<link id="TCustomListView.Items"/>
<link id="TCustomListView.OnData"/>
<link id="TCustomListView.OnDataFind"/>
<link id="TCustomListView.OnDataHint"/>
<link id="TListItems.Count"/>
</seealso>
</element>
<element name="TCustomListView.ReadOnly">
<short>Don't allow user to change item captions, by click with a delay.</short>
<short>Prevents editing of list items on the control when set to True.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListView.RowSelect">
<short>
In Report view, this allows to highlight entire selected row, until right edge of ListView.
In Report view, this highlights the entire selected row to the right edge of the list view control.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListView.SelCount">
<short>Number of currently selected items.</short>
<descr/>
<seealso/>
<short>Number of currently selected Items when MultiSelect is enabled.</short>
<descr>
<p>
<var>SelCount</var> is a read-only <var>Integer</var> property with the number selected entries in <var>Items</var>. SelCount is relevant when <var>MultiSelect</var> is set to <b>True</b>; otherwise, the single selected item is found in the Selected property.
</p>
<p>
If the <var>Handle</var> has been allocated for the widgetset class, the value from the <var>GetSelCount</var> method is used as the property value. Otherwise, the property value is calculated by counting the number of <var>TListItem</var> instances in Items that have their <var>Selected</var> property set to True. The return value is 0 when none of the Items have a selected property set to <b>True</b>.
</p>
<p>
Use GetNextItem with the lisSelected item state to retrieve a multi-selected item that is adjacent to another selected item.
</p>
</descr>
<seealso>
<link id="TCustomListView.MultiSelect"/>
<link id="TCustomListView.Selected"/>
<link id="TCustomListView.Items"/>
<link id="TCustomListView.GetNextItem"/>
<link id="TListItem.Selected"/>
<link id="TListItems"/>
</seealso>
</element>
<element name="TCustomListView.Selected">
<short>Listview item, which is 1st selected.</short>
<descr/>
<seealso/>
<short>Contains the selected list item in the list view control.</short>
<descr>
<p>
Selected is a TListItem property which contains the selected list item in the list view control. Assign a value from the Items property to select the list item.
</p>
<p>
When MultiSelect is enabled, Selected represents the first entry in Items that has its Selected property set to True. If none of the list items has its Selected property set to True, or SelCount is 0, the property value is Nil.
</p>
<p>
When OwnerData (or Virtual Mode) is enabled, Selected refers to the most recent owner data item retrieved when the value in ItemIndex was changed. If the item index was set to -1, the property value is Nil.
</p>
<p>
Assigning a new value to Selected causes the existing list item in the property to be updated. In single select mode (MultiSelect = False), the Selected property for the list item is set to False prior to clearing or reassigning the property value.
</p>
<p>
When MultiSelect is enabled, setting a new value for the property causes the list item to be included in the list of multi-selected Items. If the new value is Nil, all of the entries in Items reset their Selected properties to False. In short, setting Selected to Nil clears any existing multi-selections in Items.
</p>
<p>
Setting a new value for the property causes the OnChange and OnSelectItem event handlers to be signalled (when assigned) when the LVN_ITEMCHANGED notification message is handled for the control.
</p>
<p>
Use ClearSelection to remove all selections (single or multi-) for the control.
</p>
<p>
Use SelectAll to select all list items when MultiSelect is enabled.
</p>
</descr>
<seealso>
<link id="TCustomListView.OwnerData"/>
<link id="TCustomListView.MultiSelect"/>
<link id="TCustomListView.ItemIndex"/>
<link id="TCustomListView.Items"/>
<link id="TCustomListView.ClearSelection"/>
<link id="TCustomListView.SelectAll"/>
<link id="TListItem.Selected"/>
<link id="TListItems.Count"/>
<link id="TOwnerDataListItem.SetDataIndex"/>
</seealso>
</element>
<element name="TCustomListView.LastSelected">
<short>Listview item, which is last selected, in MultiSelect mode.</short>
<short>Not implemented or used in the current LCL version.</short>
<descr/>
<seealso/>
</element>
@ -10762,7 +10887,7 @@
<element name="TCustomListView.VisibleRowCount">
<short>
Number of rows, which is currently shown with current Listview position/size/layout.
Number of visible rows using the size, position, and layout for the list view control.
</short>
<descr/>
<seealso/>

12
docs/xml/lcl/extctrls.xml
View File

@ -2321,7 +2321,17 @@
<short>New value for the property.</short>
</element>
<element name="TCustomImage.WSRegisterClass" link="#lcl.controls.TControl.WSRegisterClass"/>
<element name="TCustomImage.WSRegisterClass">
<short>Registers the class with the widgetset.</short>
<descr>
<p>
Calls the RegisterCustomImage method in the widgetset class.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TGraphicControl.WSRegisterClass"/>
</seealso>
</element>
<element name="TCustomImage.PictureChanged">
<short>Performs actions needed when the Picture property has been changed.</short>

68
docs/xml/lcl/extdlgs.xml
View File

@ -79,7 +79,7 @@
<short>New value for the property.</short>
</element>
<element name="TPreviewFileControl.CreateParams" link="#lcl.controls.TWinControl.CreateParams">
<element name="TPreviewFileControl.CreateParams">
<descr>
<p>
Overridden to ensure proper handling of the WS_CHILD flag in Style in the Parent control.
@ -123,7 +123,7 @@
</seealso>
</element>
<element name="TPreviewFileDialog" link="#lcl.dialogs.TOpenDialog">
<element name="TPreviewFileDialog">
<short>
<var>TPreviewFileDialog</var> - a dialog that allows the contents of a file to be inspected before opening the file.
</short>
@ -191,7 +191,7 @@
</seealso>
</element>
<element name="TPreviewFileDialog.DoExecute" link="#lcl.dialogs.TOpenDialog.DoExecute">
<element name="TPreviewFileDialog.DoExecute">
<short>Creates the PreviewFileControl and displays the dialog.</short>
<descr>
<p>
@ -209,10 +209,11 @@
<link id="TPreviewFileDialog.PreviewFileControl"/>
<link id="#lcl.dialogs.TCommonDialog.Execute">TCommonDialog.Execute</link>
<link id="#lcl.dialogs.TCommonDialog.UserChoice">TCommonDialog.UserChoice</link>
<link id="#lcl.dialogs.TOpenDialog.DoExecute">TOpenDialog.DoExecute</link>
</seealso>
</element>
<element name="TPreviewFileDialog.Create" link="#rtl.classes.TComponent.Create">
<element name="TPreviewFileDialog.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -311,7 +312,7 @@
</seealso>
</element>
<element name="TOpenPictureDialog.InitPreviewControl" link="#lcl.extdlgs.TPreviewFileDialog.InitPreviewControl">
<element name="TOpenPictureDialog.InitPreviewControl">
<short>Initializes the PreviewFileControl for the dialog.</short>
<descr>
<p>
@ -321,6 +322,7 @@
<seealso>
<link id="TPreviewFileDialog.PreviewFileControl"/>
<link id="TPreviewFileDialog.CreatePreviewControl"/>
<link id="TPreviewFileDialog.InitPreviewControl"/>
<link id="TOpenPictureDialog.ImageCtrl"/>
</seealso>
</element>
@ -368,7 +370,7 @@
</seealso>
</element>
<element name="TOpenPictureDialog.Create" link="#rtl.classes.TComponent.Create">
<element name="TOpenPictureDialog.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -393,7 +395,7 @@
<short>Owner for the class instance.</short>
</element>
<element name="TOpenPictureDialog.DoClose" link="#lcl.dialogs.TCommonDialog.DoClose">
<element name="TOpenPictureDialog.DoClose">
<short>
Performs actions needed when the dialog is closed.
</short>
@ -410,10 +412,11 @@
<link id="TOpenPictureDialog.PictureGroupBox"/>
<link id="TOpenPictureDialog.ImageCtrl"/>
<link id="#lcl.dialogs.TCommonDialog.OnClose">TCommonDialog.OnClose</link>
<link id="#lcl.dialogs.TCommonDialog.DoClose">TCommonDialog.DoClose</link>
</seealso>
</element>
<element name="TOpenPictureDialog.DoSelectionChange" link="#lcl.dialogs.TOpenDialog.DoSelectionChange">
<element name="TOpenPictureDialog.DoSelectionChange">
<short>
Performs actions needed when the selected file name for the dialog is changed.
</short>
@ -426,15 +429,14 @@
</p>
</descr>
<seealso>
<link id="TOpenPictureDialog.PreviewFileName"/>
<link id="TOpenPictureDialog.ImageCtrl"/>
<link id="TOpenPictureDialog.PictureGroupBox"/>
<link id="#lcl.dialogs.TOpenDialog.FileName">TOpenDialog.FileName</link>
<link id="#lcl.dialogs.TOpenDialog.OnSelectionChange">TOpenDialog.OnSelectionChange</link>
<link id="#lcl.dialogs.TOpenDialog.DoSelectionChange">TOpenDialog.DoSelectionChange</link>
</seealso>
</element>
<element name="TOpenPictureDialog.DoShow" link="#lcl.dialogs.TCommonDialog.DoShow">
<element name="TOpenPictureDialog.DoShow">
<short>
Performs actions needed to display the preview dialog in its initial state.
</short>
@ -449,6 +451,7 @@
<seealso>
<link id="TOpenPictureDialog.ClearPreview"/>
<link id="#lcl.dialogs.TCommonDialog.OnShow">TCommonDialog.OnShow</link>
<link id="#lcl.dialogs.TCommonDialog.DoShow">TCommonDialog.DoShow</link>
</seealso>
</element>
@ -496,7 +499,7 @@
</seealso>
</element>
<element name="TOpenPictureDialog.Filter" link="#lcl.dialogs.TFileDialog.Filter">
<element name="TOpenPictureDialog.Filter">
<short>
Contains a delimited list of descriptions and extensions for file available in the dialog.
</short>
@ -515,6 +518,7 @@
<link id="TOpenPictureDialog.Create"/>
<link id="TOpenPictureDialog.DefaultFilter"/>
<link id="TOpenPictureDialog.GetFilterExt"/>
<link id="#lcl.dialogs.TFileDialog.Filter">TFileDialog.Filter</link>
<link id="#lcl.dialogs.TFileDialog.FilterIndex">TFileDialog.FilterIndex</link>
</seealso>
</element>
@ -554,7 +558,7 @@
<short>Default value for the Title property.</short>
</element>
<element name="TSavePictureDialog.Create" link="#rtl.classes.TComponent.Create">
<element name="TSavePictureDialog.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -567,7 +571,7 @@
<short>Owner of the class instance.</short>
</element>
<element name="TExtCommonDialog" link="#lcl.dialogs.TCommonDialog">
<element name="TExtCommonDialog">
<short>The common base class for custom drawn dialogs (Calculator and Calendar).</short>
<descr>
<p>
@ -601,11 +605,11 @@
<short>Value for the property.</short>
</element>
<element name="TExtCommonDialog.GetHeight" link="#lcl.dialogs.TCommonDialog.GetHeight">
<element name="TExtCommonDialog.GetHeight">
<short>Gets the value for the Height property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Height"/>
<link id="#lcl.dialogs.TCommonDialog.GetHeight">TCommonDialog.GetHeight</link>
</seealso>
</element>
<element name="TExtCommonDialog.GetHeight.Result">
@ -623,11 +627,11 @@
<short>Value for the property.</short>
</element>
<element name="TExtCommonDialog.GetWidth" link="#lcl.dialogs.TCommonDialog.GetWidth">
<element name="TExtCommonDialog.GetWidth">
<short>Gets the value for the Width property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Width"/>
<link id="#lcl.dialogs.TCommonDialog.GetWidth">TCommonDialog.GetWidth</link>
</seealso>
</element>
<element name="TExtCommonDialog.GetWidth.Result">
@ -677,7 +681,7 @@
</seealso>
</element>
<element name="TExtCommonDialog.Create" link="#lcl.dialogs.TCommonDialog.Create">
<element name="TExtCommonDialog.Create">
<short>Constructor for the class instance.</short>
<descr>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method. Create sets the default value for the <var>DialogPosition</var> property to <var>poMainFormCenter</var>.
@ -685,16 +689,19 @@
<seealso>
<link id="TExtCommonDialog.DialogPosition"/>
<link id="#lcl.forms.TPosition">TPosition</link>
<link id="#lcl.dialogs.TCommonDialog.Create">CommonDialog.Create</link>
</seealso>
</element>
<element name="TExtCommonDialog.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TExtCommonDialog.Destroy" link="#lcl.dialogs.TCommonDialog.Destroy">
<element name="TExtCommonDialog.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.lclclasses.TLCLComponent.Destroy">TLCLComponent.Destroy</link>
</seealso>
</element>
<element name="TExtCommonDialog.Left">
@ -751,7 +758,7 @@
</seealso>
</element>
<element name="TCalculatorDialog" link="#lcl.extdlgs.TExtCommonDialog">
<element name="TCalculatorDialog">
<short>
Implements a pop-up calculator dialog used to perform simple calculations and return the value.
</short>
@ -931,7 +938,7 @@
<short>Key examined in the event handler.</short>
</element>
<element name="TCalculatorDialog.DefaultTitle" link="#lcl.dialogs.TCommonDialog.DefaultTitle">
<element name="TCalculatorDialog.DefaultTitle">
<short>
Gets the default value used in the Title property for the calculator dialog.
</short>
@ -947,6 +954,7 @@
<link id="TCalculatorDialog.Create"/>
<link id="#lcl.dialogs.TCommonDialog.Title">TCommonDialog.Title</link>
<link id="#lcl.dialogs.TCommonDialog.Create">TCommonDialog.Create</link>
<link id="#lcl.dialogs.TCommonDialog.DefaultTitle">TCommonDialog.DefaultTitle</link>
</seealso>
</element>
<element name="TCalculatorDialog.DefaultTitle.Result">
@ -961,7 +969,7 @@
<seealso/>
</element>
<element name="TCalculatorDialog.Create" link="#rtl.classes.TComponent.Create">
<element name="TCalculatorDialog.Create">
<short>Constructor for the class instance.</short>
<descr>
</descr>
@ -972,7 +980,7 @@
<short>Owner of the class instance.</short>
</element>
<element name="TCalculatorDialog.Destroy" link="#rtl.classes.TComponent.Destroy">
<element name="TCalculatorDialog.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
@ -1261,7 +1269,7 @@
<seealso/>
</element>
<element name="TCalendarDialog" link="#lcl.extdlgs.TExtCommonDialog">
<element name="TCalendarDialog">
<short>
<var>TCalendarDialog</var> - a popup calendar dialog that allows a date to be selected and returned to the main program.
</short>
@ -1412,7 +1420,7 @@
<short></short>
</element>
<element name="TCalendarDialog.Create" link="#rtl.classes.TComponent.Create">
<element name="TCalendarDialog.Create">
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
@ -1421,12 +1429,14 @@
<short>Owner of the class instance.</short>
</element>
<element name="TCalendarDialog.Execute" link="#lcl.dialogs.TCommonDialog.Execute">
<element name="TCalendarDialog.Execute">
<short>
Configures and dIsplays the form for the calendar dialog, and captures the results.
</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.dialogs.TCommonDialog.Execute">TCommonDialog.Execute</link>
</seealso>
</element>
<element name="TCalendarDialog.Execute.Result">
<short/>

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

@ -1288,6 +1288,24 @@
<element name="TPickListCellEditor.CloseUp" link="#lcl.stdctrls.TCustomComboBox.CloseUp"/>
<element name="TPickListCellEditor.Select" link="#lcl.stdctrls.TCustomComboBox.Select"/>
<element name="TPickListCellEditor.Change">
<short>
Notifies the Grid control when the value for the cell editor has been changed.
</short>
<descr>
<p>
<var>Change</var> is an overridden method used to perform actions needed when the value for the control has been changed. In <var>TPickListCellEditor</var>, it ensures that the grid control is notified when the value in the cell editor has been changed.
</p>
<p>
Changed calls the inherited method to signal the <var>OnChange</var> event handler (when assigned).
</p>
</descr>
<seealso>
<link id="TPickListCellEditor.OnEditingDone"/>
<link id="#lcl.stdctrls.TCustomComboBox.Change">TCustomComboBox.Change</link>
</seealso>
</element>
<element name="TPickListCellEditor.msg_GetValue">
<short>Issues a message to find the value for the editor.</short>
<descr/>
@ -1322,6 +1340,13 @@
<short>LCL message for the grid control.</short>
</element>
<element name="TPickListCellEditor.msg_GetGrid">
<short>Issues a message to get the grid control for the editor.</short>
</element>
<element name="TPickListCellEditor.msg_GetGrid.Msg">
<short>LCL message for the grid control.</short>
</element>
<element name="TPickListCellEditor.EditingDone" link="#lcl.controls.TControl.EditingDone"/>
<element name="TPickListCellEditor.BorderStyle" link="#lcl.controls.TWinControl.BorderStyle"/>
@ -2169,26 +2194,26 @@
</element>
<element name="TVirtualGrid.IsColumnIndexValid">
<short/>
<short>Indicates if the specified ordinal column number is valid for the grid.</short>
<descr/>
</element>
<element name="TVirtualGrid.IsColumnIndexValid.Result">
<short/>
<short>True if the index is valid for the grid.</short>
</element>
<element name="TVirtualGrid.IsColumnIndexValid.AIndex">
<short/>
<short>Ordinal column number examined in the method.</short>
</element>
<element name="TVirtualGrid.IsRowIndexValid">
<short/>
<short>Indicates if the specified ordinal row number is valid for the grid.</short>
<descr/>
<seealso/>
</element>
<element name="TVirtualGrid.IsRowIndexValid.Result">
<short/>
<short>True if the index is valid for the grid.</short>
</element>
<element name="TVirtualGrid.IsRowIndexValid.AIndex">
<short/>
<short>Ordinal row number examined in the method.</short>
</element>
<element name="TVirtualGrid.Create">
@ -2572,11 +2597,6 @@
</seealso>
</element>
<element name="TGridColumnTitle.Assign" link="#rtl.Classes.TPersistent.Assign"/>
<element name="TGridColumnTitle.Assign.Source">
<short/>
</element>
<element name="TGridColumnTitle.GetDefaultCaption">
<short>Returns the default caption for the column title.</short>
<descr/>
@ -2635,6 +2655,21 @@
<short>New value for the property.</short>
</element>
<element name="TGridColumnTitle.DefineProperties">
<short>
Specifies which properties in the persistent object are used during LCL component streaming.
</short>
<descr>
<p>
<var>DefineProperties</var> is an overridden method used to define the properties which are included during LCL component streaming. The TFiler instance in Filer is used to set the read and write procedures for specific properties. In TGridColumnTitle, the Caption is written when it has an explicit non-default value. This implements the storage specifier declared for the property.
</p>
</descr>
<seealso/>
</element>
<element name="TGridColumnTitle.DefineProperties.Filer">
<short>TFiler instance used to read and write the class during LCL streaming.</short>
</element>
<element name="TGridColumnTitle.Create">
<short>Constructor for the class instance.</short>
<descr>
@ -2671,11 +2706,39 @@
</seealso>
</element>
<element name="TGridColumnTitle.Assign">
<short>
Copies property value from the specified persistent object into the current class instance.
</short>
<descr>
<p>
<var>Assign</var> is an overridden method used to implement object persistence for the class. When <var>Source</var> is a <var>TGridColumnTitle</var> instance, the values from the following properties are copied:
</p>
<ul>
<li>Alignment</li>
<li>Layout</li>
<li>Caption</li>
<li>Color</li>
<li>Font</li>
<li>ImageIndex</li>
</ul>
<p>
If Source is not derived from TGridColumnTitle, the inherited method is called using Source as an argument.
</p>
</descr>
<seealso>
<link id="#rtl.Classes.TPersistent">TPersistent</link>
</seealso>
</element>
<element name="TGridColumnTitle.Assign.Source">
<short>Persistent object with property values copied in the method.</short>
</element>
<element name="TGridColumnTitle.FillTitleDefaultFont">
<short>Stores the default font used for the column title.</short>
<descr>
<p>
When Grid has been assigned, the TitleFont property from the Grid is used in the Font property. Otherwise, the Font from the Column is used. IsDefaultFont is set to True in the method.
When <var>Grid</var> has been assigned, the <var>TitleFont</var> property from the Grid is used in the <var>Font</var> property. Otherwise, the Font from the <var>Column</var> is used. <var>IsDefaultFont</var> is set to True in the method.
</p>
</descr>
<seealso>
@ -2708,20 +2771,30 @@
</element>
<element name="TGridColumnTitle.ScaleFontsPPI">
<short/>
<short>
Scales font sizes in the class instance to the specified display density.
</short>
<descr>
<p>
<var>ScaleFontsPPI</var> is an overridden procedure used to...
<var>ScaleFontsPPI</var> is an overridden procedure used to scale the size for the fonts in the Grid and Title properties to the specified display density (PPI) (Pixels Per Inch).
</p>
<p>
AToPPI contains the value assigned to the fonts used when a non-zero value is specified.
</p>
<p>
If AToPPI is omitted, the scaling factor in AProportion is used to adjust the existing PPI setting in the fonts by the indicated factor.
</p>
<p>
ScaleFontsPPI is called when the AutoAdjustLayout method is used to apply a layout policy to a control.
</p>
</descr>
<seealso/>
<notes><note>TODO</note></notes>
</element>
<element name="TGridColumnTitle.ScaleFontsPPI.AToPPI">
<short/>
<short>Explicit Pixels per Inch setting for the fonts.</short>
</element>
<element name="TGridColumnTitle.ScaleFontsPPI.AProportion">
<short/>
<short>Scaling factor applied to the existing PPI setting for the fonts.</short>
</element>
<element name="TGridColumnTitle.IsDefault">
@ -3641,9 +3714,11 @@
</element>
<element name="TGridColumn.DefaultWidth">
<short/>
<short>Default width for the column, or -1 when not assigned.</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.
<p>
<var>DefaultWidth</var> is a read-only <var>Integer</var> property with the default width used for the column. The property value is read from the <var>DefaultColWidth</var> property in the Grid control (when assigned). If it is not assigned, the property value is -1.
</p>
</descr>
<seealso/>
</element>
@ -13908,13 +13983,13 @@
<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.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.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TDrawGrid.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TDrawGrid.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TDrawGrid.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TDrawGrid.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TDrawGrid.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TDrawGrid.OnPickListSelect" link="#lcl.grids.TCustomGrid.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"/>
@ -15092,7 +15167,7 @@
<element name="TStringGrid.DefaultColWidth" link="#lcl.grids.TCustomGrid.DefaultColWidth"/>
<element name="TStringGrid.DefaultDrawing" link="#lcl.grids.TCustomGrid.DefaultDrawing"/>
<element name="TStringGrid.DefaultRowHeight" link="#lcl.grids.TCustomGrid.DefaultRowHeight"/>
<element name="TStringGrid.DoubleBuffered" link="#lcl.controls.TControl.DoubleBuffered"/>
<element name="TStringGrid.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TStringGrid.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TStringGrid.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TStringGrid.DragMode" link="#lcl.controls.TControl.DragMode"/>
@ -15102,7 +15177,7 @@
<element name="TStringGrid.FixedCols" link="#lcl.grids.TCustomGrid.FixedCols"/>
<element name="TStringGrid.FixedRows" link="#lcl.grids.TCustomGrid.FixedRows"/>
<element name="TStringGrid.Flat" link="#lcl.grids.TCustomGrid.Flat"/>
<element name="TStringGrid.Font" link="LCL.Controls.TControl.Font"/>
<element name="TStringGrid.Font" link="#lcl.controls.TControl.Font"/>
<element name="TStringGrid.GridLineWidth" link="#lcl.grids.TCustomGrid.GridLineWidth"/>
<element name="TStringGrid.HeaderHotZones" link="#lcl.grids.TCustomGrid.HeaderHotZones"/>
<element name="TStringGrid.HeaderPushZones" link="#lcl.grids.TCustomGrid.HeaderPushZones"/>
@ -15113,7 +15188,7 @@
<element name="TStringGrid.Options2" link="#lcl.grids.TCustomGrid.Options2"/>
<element name="TStringGrid.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TStringGrid.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TStringGrid.ParentDoubleBuffered" link="#lcl.controls.TControl.ParentDoubleBuffered"/>
<element name="TStringGrid.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TStringGrid.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TStringGrid.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TStringGrid.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
@ -15134,7 +15209,7 @@
<element name="TStringGrid.VisibleRowCount" link="#lcl.grids.TCustomGrid.VisibleRowCount"/>
<element name="TStringGrid.OnAfterSelection" link="#lcl.grids.TCustomGrid.OnAfterSelection"/>
<element name="TStringGrid.OnBeforeSelection" link="#lcl.grids.TCustomGrid.OnBeforeSelection"/>
<element name="TStringGrid.OnCellProcess" link="#lcl.grids.TCustomGrid.OnCellProcess"/>
<element name="TStringGrid.OnCellProcess" link="#lcl.grids.TCustomStringGrid.OnCellProcess"/>
<element name="TStringGrid.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TStringGrid.OnCheckboxToggled" link="#lcl.grids.TCustomGrid.OnCheckboxToggled"/>
<element name="TStringGrid.OnClick" link="#lcl.controls.TControl.OnClick"/>
@ -15163,12 +15238,12 @@
<element name="TStringGrid.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TStringGrid.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TStringGrid.OnGetCellHint" link="#lcl.grids.TCustomGrid.OnGetCellHint"/>
<element name="TStringGrid.OnGetCheckboxState" link="#lcl.grids.TCustomGrid.OnGetCheckboxState"/>
<element name="TStringGrid.OnGetCheckboxState" link="#lcl.grids.TCustomDrawGrid.OnGetCheckboxState"/>
<element name="TStringGrid.OnGetEditMask" link="#lcl.grids.TCustomDrawGrid.OnGetEditMask"/>
<element name="TStringGrid.OnGetEditText" link="#lcl.grids.TCustomDrawGrid.OnGetEditText"/>
<element name="TStringGrid.OnHeaderClick" link="#lcl.grids.TCustomDrawGrid.OnHeaderClick"/>
<element name="TStringGrid.OnHeaderSized" link="#lcl.grids.TCustomDrawGrid.OnHeaderSized"/>
<element name="TStringGrid.OnHeaderSizing" link="#lcl.grids.TCustomGrid.OnHeaderSizing"/>
<element name="TStringGrid.OnHeaderSizing" link="#lcl.grids.TCustomDrawGrid.OnHeaderSizing"/>
<element name="TStringGrid.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TStringGrid.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TStringGrid.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
@ -15589,7 +15664,7 @@
The values that are used to recognize the checked or unchecked states are set in a column's properties ValueChecked and ValueUnchecked.
</li>
<li>
At any moment, the field value can be in one to three states: Unchecked, Checked or Grayed.
At any moment, the field value can be in one of three states: Unchecked, Checked or Grayed.
</li>
</ul>
</li>
@ -15598,9 +15673,8 @@
<notes>
<note>
ToDo:
OnDrawCell examples
Discuss OnEditingDone.
Editing a pick list example
OnDrawCell example.
Editing a pick list example.
</note>
</notes>
</topic>

235
docs/xml/lcl/lcltype.xml
View File

@ -26,7 +26,7 @@
</element>
<!-- alias type Visibility: default -->
<element name="UINT">
<short>A 32 bit unsigned integer.</short>
<short>A 32-bit unsigned integer.</short>
<descr/>
<seealso/>
</element>
@ -270,66 +270,60 @@
</element>
<!-- constant Visibility: default -->
<element name="MaxByte">
<short>Maximal value of the WinAPI BYTE type ($FF).
<short>Maximum value for the WinAPI BYTE type ($FF).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MAXWORD">
<short>Maximal value of the WinAPI WORD type ($FFFF).
<short>Maximum value for the WinAPI WORD type ($FFFF).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MAXDWORD">
<short>Maximal value of the WinAPI DWORD type ($FFFF FFFF).
<short>Maximum value for the WinAPI DWORD type ($FFFF FFFF).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MINCHAR">
<short>Minimal value of the WinAPI CHAR type ($80).
<short>Minimum value for the WinAPI CHAR type ($80).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MAXCHAR">
<short>Maximal value of the WinAPI CHAR type ($7F).
<short>Maximum value for the WinAPI CHAR type ($7F).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MINSHORT">
<short>Minimal value of the WinAPI SHORT type ($8000).
<short>Minimum value for the WinAPI SHORT type ($8000).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MAXSHORT">
<short>Maximal value of the WinAPI SHORT type ($7FFF).
<short>Maximum value for the WinAPI SHORT type ($7FFF).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MINLONG">
<short>Minimal value of the WinAPI LONG type ($8000 0000).
<short>Minimum value for the WinAPI LONG type ($8000 0000).
</short>
</element>
<!-- constant Visibility: default -->
<element name="MAXLONG">
<short>Maximal value of the WinAPI LONG type ($7FFF FFFF).
<short>Maximum value for the WinAPI LONG type ($7FFF FFFF).
</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_BLACK">
<short>Binary raster operation (Dst op Pen):
all black.
</short>
<short>Binary raster operation (Dst op Pen): all black.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_NOTMERGEPEN">
<short>Binary raster operation (Dst op Pen):
not (Dst or Pen).
</short>
<short>Binary raster operation (Dst op Pen): not (Dst or Pen).</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_MASKNOTPEN">
<short>Binary raster operation (Dst op Pen):
Dst and not Pen.
</short>
<short>Binary raster operation (Dst op Pen): Dst and not Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_NOTCOPYPEN">
@ -339,80 +333,55 @@
</element>
<!-- constant Visibility: default -->
<element name="R2_MASKPENNOT">
<short>Binary raster operation (Dst op Pen):
(not Dst) and Pen.
</short>
<short>Binary raster operation (Dst op Pen): (not Dst) and Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_NOT">
<short>Binary raster operation (Dst op Pen):
not Dst.
</short>
<short>Binary raster operation (Dst op Pen): not Dst.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_XORPEN">
<short>Binary raster operation (Dst op Pen):
Dst xor Pen.
</short>
<short>Binary raster operation (Dst op Pen): Dst xor Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_NOTMASKPEN">
<short>Binary raster operation (Dst op Pen):
not (Dst and Pen).
</short>
<short>Binary raster operation (Dst op Pen): not (Dst and Pen).</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_MASKPEN">
<short>Binary raster operation (Dst op Pen):
Dst and Pen.
</short>
<short>Binary raster operation (Dst op Pen): Dst and Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_NOTXORPEN">
<short>Binary raster operation (Dst op Pen):
not (Dst xor Pen).
</short>
<short>Binary raster operation (Dst op Pen): not (Dst xor Pen).</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_NOP">
<short>Binary raster operation (Dst op Pen):
Dst.
</short>
<short>Binary raster operation (Dst op Pen): Dst.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_MERGENOTPEN">
<short>Binary raster operation (Dst op Pen):
Dst or not Pen.
</short>
<short>Binary raster operation (Dst op Pen): Dst or not Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_COPYPEN">
<short>Binary raster operation (Dst op Pen):
Pen.
</short>
<short>Binary raster operation (Dst op Pen): Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_MERGEPENNOT">
<short>Binary raster operation (Dst op Pen):
(not Dst) or Pen.
</short>
<short>Binary raster operation (Dst op Pen): (not Dst) or Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_MERGEPEN">
<short>Binary raster operation (Dst op Pen):
Dst or Pen.
</short>
<short>Binary raster operation (Dst op Pen): Dst or Pen.</short>
</element>
<!-- constant Visibility: default -->
<element name="R2_WHITE">
<short>Binary raster operation (Dst op Pen):
all white.
</short>
<short>Binary raster operation (Dst op Pen): all white.</short>
</element>
<!-- constant Visibility: default -->
<element link="R2_WHITE" name="R2_LAST">
<short>Highest binary raster operation code.
</short>
<short>Highest binary raster operation code.</short>
</element>
<!-- constant Visibility: default -->
<element name="SRCCOPY">
@ -11668,311 +11637,343 @@
</element>
<!-- class Visibility: default -->
<element name="TListWithEvent">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Implements a list with an event signalled when values are added or removed.
</short>
<descr>
<p>
<var>TListWithEvent</var> is a <var>TList</var> descendant which implements a list with an event handler signalled when values are added to or removed from the container. It provides an overridden <var>Notify</var> method which signals the event handler (when assigned) for add or delete operations. Assign an object procedure using the signature in TListChangeEvent to the OnChange event handler to respond to the notification.
</p>
</descr>
<seealso>
<link id="TListWithEvent.OnChange"/>
<link id="TListWithEvent.Notify"/>
<link id="TListChangeEvent"/>
<link id="#rtl.classes.TList">TList</link>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TListWithEvent.FOnChange">
<short/>
<short>Member used for the OnChange event handler.</short>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TListWithEvent.Notify">
<short/>
<descr/>
<errors/>
<seealso/>
<short>
Handles the notification when a value is added to or removed from the list.
</short>
<descr>
<p>
<var>Notify</var> is an overridden method in <var>TListWithEvent</var>. It calls the inherited method to notify registered observers of the change to the list. It signals the <var>OnChange</var> event handler (when assigned) using the values in <var>Ptr</var> and <var>AnAction</var> as arguments.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TList.Add">TList.Add</link>
<link id="#rtl.classes.TList.Delete">TList.Delete</link>
<link id="#rtl.classes.TList.Extract">TList.Extract</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TListWithEvent.Notify.Ptr">
<short/>
<short>Untyped pointer to the value for the notification.</short>
</element>
<!-- argument Visibility: default -->
<element name="TListWithEvent.Notify.AnAction">
<short/>
<short>Operation performed for the specified value.</short>
</element>
<!-- property Visibility: public -->
<element name="TListWithEvent.OnChange">
<short/>
<descr/>
<seealso/>
<short>
Event handler signalled when a value is added to or removed from the list.
</short>
<descr>
<p>
Signalled from the Notify method (when assigned).
</p>
</descr>
<seealso>
<link id="TListWithEvent.Notify"/>
<link id="#rtl.classes.TList.Add">TList.Add</link>
<link id="#rtl.classes.TList.Delete">TList.Delete</link>
<link id="#rtl.classes.TList.Extract">TList.Extract</link>
</seealso>
</element>
<!-- constant Visibility: default -->
<element name="csNone">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csButton">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csComboBox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csCheckbox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csEdit">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csForm">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csStaticText">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csScrollBar">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csListView">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csMemo">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csMainMenu">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csMenuBar">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csMenuItem">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csNotebook">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csFileDialog">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csRadioButton">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csScrolledWindow">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csSpinedit">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csStatusBar">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csToggleBox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csGroupBox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csPage">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csColorDialog">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csListBox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csFontDialog">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csProgressBar">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csTrackBar">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csWinControl">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csFixed">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csBitBtn">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csCListBox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csPopupMenu">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csHintWindow">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csCalendar">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csArrow">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csPanel">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csScrollBox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csCheckListBox">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csPairSplitter">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csPairSplitterSide">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csOpenFileDialog">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csSaveFileDialog">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csSelectDirectoryDialog">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csPreviewFileControl">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csPreviewFileDialog">
<short/>
<short>Component style identifier.</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="csNonLCL">
<short/>
<short>
Component style identifier. Used for non-LCL controls that create their own handles.
</short>
<descr/>
<seealso/>
</element>

1
docs/xml/lcl/pairsplitter.xml
View File

@ -160,6 +160,7 @@
<element name="TPairSplitterSide.ChildSizing" link="#lcl.controls.TWinControl.ChildSizing"/>
<element name="TPairSplitterSide.ClientWidth" link="#lcl.controls.TControl.ClientWidth"/>
<element name="TPairSplitterSide.ClientHeight" link="#lcl.controls.TControl.ClientHeight"/>
<element name="TPairSplitterSide.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TPairSplitterSide.Cursor" link="#lcl.controls.TControl.Cursor"/>
<element name="TPairSplitterSide.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TPairSplitterSide.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>