mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-09-03 22:20:17 +02:00
issue #35892 from Don Siders
comctrls.xml *Added FUseWS, AdjustPos, InitializeWnd in TCustomUpDown controls.xml * Fixed FP docs tagging for an example dbctrls.xml * Added BiDiMode, BorderSpacing, Color, Constraints in TDBCheckBox * Added DataChange, KeyPress, UpdateData in TDBComboBox * Added missing topics in TCustomDBComboBox lclplatformdef.xml * Added missing TLCLPLatform enumeration values lcltranslator.xml * Sync'd doc topics to current code. Added missing symbols. Removed unused symbols. git-svn-id: trunk@61628 -
This commit is contained in:
mattias
parent
66caead120
commit
3a62769ba9
@ -807,7 +807,7 @@
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomPage">
|
||||
<short>
|
||||
<var>TCustomPage</var>: The base type for
|
||||
<var>TCustomPage</var>: The base type for
|
||||
<var>Page</var>
|
||||
</short>
|
||||
<descr>
|
||||
@ -1351,8 +1351,8 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TCustom Notebook</var>: The base type for
|
||||
<var>TTabControl</var> and
|
||||
<var>TCustom Notebook</var>: The base type for
|
||||
<var>TTabControl</var> and
|
||||
<var>TPageControl</var>
|
||||
</p>
|
||||
<p>A tab control has a series of <var>Tabs</var> and it may or may not contain pages.</p>
|
||||
@ -1798,16 +1798,16 @@
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTabControl.ActivePageComponent">
|
||||
<short>
|
||||
<var>ActivePageComponent</var> - the actual contents of the currently selected
|
||||
|
||||
<var>ActivePageComponent</var> - the actual contents of the currently selected
|
||||
|
||||
<var>Page</var>
|
||||
</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTabControl.ActivePage">
|
||||
<short>
|
||||
<var>ActivePage</var> - the name (string) of the
|
||||
|
||||
<var>ActivePage</var> - the name (string) of the
|
||||
|
||||
<var>Page</var> that is currently selected and is available for interaction</short>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
@ -1838,8 +1838,8 @@
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomTabControl.TabIndexAtClientPos">
|
||||
<short>
|
||||
<var>TabIndexAtClientPos</var> - the index value of the Tab at the specified position
|
||||
|
||||
<var>TabIndexAtClientPos</var> - the index value of the Tab at the specified position
|
||||
|
||||
<var>ClientPos</var>
|
||||
</short>
|
||||
<descr/>
|
||||
@ -1895,8 +1895,8 @@
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomTabControl.CustomPage">
|
||||
<short>
|
||||
<var>CustomPage</var> - returns the page specified by
|
||||
|
||||
<var>CustomPage</var> - returns the page specified by
|
||||
|
||||
<var>Index</var>
|
||||
</short>
|
||||
<descr/>
|
||||
@ -7113,12 +7113,12 @@
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomListView.Columns">
|
||||
<short>Collection of items, which have properties of ListView columns (size, alignment, image index, etc).</short>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomListView.ColumnClick">
|
||||
<short>Enable to react to clicks on ListView header columns. And to call OnColumnClick event.</short>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomListView.DefaultItemHeight">
|
||||
@ -7160,7 +7160,7 @@
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomListView.OwnerData">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Use owner-data mode for ListView. It means, that ListView don't contain items, you must supply them using OnData* events.</short>
|
||||
@ -7197,7 +7197,7 @@
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomListView.ShowWorkAreas">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Property WorkAreas sets work areas in ListView. This property allows to highlight each work area with its own color and show with own caption.</short>
|
||||
@ -7321,7 +7321,7 @@
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomListView.DropTarget">
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomListView.FlatScrollBars">
|
||||
@ -7329,7 +7329,7 @@
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomListView.FullDrag">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -8249,7 +8249,7 @@
|
||||
<descr>
|
||||
<p>
|
||||
<var>TCustomUpDown</var> - base class for <var>TUpDown</var> - a pair of arrow-like buttons which are used to increment or decrement some controlled variable; often attached to a scroll-bar but can also control a digital numeric display
|
||||
</p>
|
||||
</p>
|
||||
<p>The control definition itself does not specify the variable upon which the buttons operate. The application programmer is responsible for supplying an event handler for <var>OnClick</var> to determine which button has been selected (designated <var>btNext</var> or <var>btPrev</var>) and incrementing or decrementing the variable in the control with which the UpDown is associated. </p>
|
||||
<p>The amount by which the variable is changed is set by the integer property <var>Increment</var> with the optional multiplier <var>Thousands</var> (a boolean property).</p>
|
||||
<p>For example the UpDown control may be used to move a slider up and down a scale by a specified amount for each click; alternatively a number may be displayed in a text box and clicking the buttons of the UpDown control may increment or decrement the number displayed by a specified amount.</p>
|
||||
@ -8329,6 +8329,30 @@
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomUpDown.FUseWS">
|
||||
<short>Indicates if the control depends on access to its WidgetSet class</short>
|
||||
<descr>
|
||||
<p>
|
||||
FUseWS is a private Boolean member used to indicate if the control depends on access to its WidgetSet class instance. The value in FUseWS is set in the constructor for the class instance.
|
||||
</p>
|
||||
<p>
|
||||
FUseWS is used in the constructor to ensure that buttons are created for Prev and Next values when they are not part of the widgetset class inplementation.
|
||||
</p>
|
||||
<p>
|
||||
FUseWS is used in the InitializeWnd method to determine if the property values must be set in the widgetset class, incuding: MinPosition, MaxPosition, Position, Increment, Wrap, Orientation, and UseArrowKeys.
|
||||
</p>
|
||||
<p>
|
||||
FUseWS is used in the UpdateOrientation method to determine whether the action is implemented in the widgetset class, or handled in TCustomUpDown.
|
||||
</p>
|
||||
<p>
|
||||
FUseWS is used in the AdjustPos method to determine whether a change in the control value using its buttons is handled in the current class instance, or forwarded to the appropriate button click method in the widgetset class. Similarly, handling for mouse wheel events are determined using the FUseWS member.
|
||||
</p>
|
||||
</descr>
|
||||
<version>Introduced in LCL version 2.1.0.</version>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomUpDown.FOnClick">
|
||||
<short/>
|
||||
@ -8513,6 +8537,39 @@
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomUpDown.AdjustPos">
|
||||
<short>
|
||||
Applies changes to the control value using its increment and decrement buttons
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
AdjustPos is a method used to apply changes to the value for the control when the increment or decrement buttons are clicked. AdjustPos uses the value in the FUseWS member to determine if the change in value is handled in the widgetset class, or handled in TCustomUpDown.
|
||||
</p>
|
||||
</descr>
|
||||
<version>Introduced in LCL version 2.1.0.</version>
|
||||
<seealso>
|
||||
<link id="TCustomUpDown.AssociateKeyDown"/>
|
||||
<link id="TCustomUpDown.AssociateMouseWheel"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomUpDown.AdjustPos.incPos">
|
||||
<short>
|
||||
True when the position value is being incremented. False when being decremented.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomUpDown.InitializeWnd">
|
||||
<short></short>
|
||||
<descr>
|
||||
<p>
|
||||
InitializeWnd is an overridden method used to initialize the widgetset class for the control. InitializeWnd calls the inherited method. When the FUseWS member contains False, no additional actions are performed in the method. When it contains True, methods in its widgetset class are called to synchronize values in the Min, Max, Position, Increment, Wrap, Orientation, and UseArrowKeys properties.
|
||||
</p>
|
||||
</descr>
|
||||
<version>Introduced in LCL version 2.1.0.</version>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomUpDown.AssociateKeyDown">
|
||||
<short>
|
||||
@ -13645,7 +13702,7 @@ the comparison is case sensitive.
|
||||
<element name="TTreeNode.OverlayIndex">
|
||||
<short>
|
||||
<var>OverlayIndex</var> - the index of the overlay</short>
|
||||
<descr>This icon is drawn above the normal icon.
|
||||
<descr>This icon is drawn above the normal icon.
|
||||
If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Overlay) for Delphi compatibility.
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -14774,10 +14831,10 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
|
||||
<short>A set of TreeViewOptions which are set be default.</short>
|
||||
<descr>
|
||||
<p>A series of defaults used to set the options of a TreeView object when first placed on a form. This set consists of the following items:</p>
|
||||
<pre>tvoShowRoot,
|
||||
<pre>tvoShowRoot,
|
||||
tvoShowLines,
|
||||
tvoShowButtons,
|
||||
tvoHideSelection,
|
||||
tvoHideSelection,
|
||||
tvoToolTips,
|
||||
tvoKeepCollapsedNodes,
|
||||
tvoAutoItemHeight
|
||||
@ -16567,7 +16624,7 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.AutoExpand">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Unfold a tree-item when user clicks it or an item activated by code.</short>
|
||||
@ -16580,14 +16637,14 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.HideSelection">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>If a control looses focus, then don't paint selection for a selected tree-item.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.HotTrack">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso>
|
||||
<link id="#lcl.ComCtrls.TCustomListview.HotTrack">TCustomListView.HotTrack</link>
|
||||
@ -16596,14 +16653,14 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.Images">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>TImageList object which holds icons for tree-items.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.Indent">
|
||||
|
||||
|
||||
<descr><p>Use 0 for auto-sized value. </p><p>Use <link id="TCustomTreeView.GetRealIndent">GetRealIndent</link> for real value.</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -16743,21 +16800,21 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.ReadOnly">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Don't allow to change item captions by mouse click with a delay.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.RightClickSelect">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Right-click also selects tree-item. Else it only calls PopupMenu.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.RowSelect">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>When a tree-item is selected, paint selection background with full width.</short>
|
||||
@ -16778,34 +16835,34 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.ShowButtons">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Show expand/collapse (fold/unfold) icons at left side for nodes with sub-nodes.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.ShowLines">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Show vertical lines at left side. They paint the tree structure for nested nodes.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.ShowRoot">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Show the root tree-item which is always present in code but may be hidden for user.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.ShowSeparators">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.SortType">
|
||||
|
||||
|
||||
<descr>Changing the Text or Data of a node will sort again.
|
||||
While adding nodes does not. Call TreeView1.AlphaSort to sort the whole tree.
|
||||
Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
@ -16815,14 +16872,14 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.StateImages">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>TImageList object which holds icons for tree-item states: normal item, selected item, etc.</short>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomTreeView.ToolTips">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Show tooltip (hint) for a tree-item when the item is too long to fit by width and mouse is over it.</short>
|
||||
@ -17145,7 +17202,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.BackgroundColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Color of background area of control.</short>
|
||||
@ -17165,8 +17222,8 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.DefaultItemHeight">
|
||||
|
||||
|
||||
|
||||
|
||||
<seealso/>
|
||||
<short>Default height of tree-items. If tvoAutoItemHeight is set in Options, this value is detected from font and icons.</short>
|
||||
</element>
|
||||
@ -17179,7 +17236,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.ExpandSignType">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Sets shape of expand/collapse (fold/unfold) symbol: plus/minus, empty arrows, filled arrows etc.</short>
|
||||
@ -17207,14 +17264,14 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.Options">
|
||||
|
||||
|
||||
|
||||
|
||||
<seealso/>
|
||||
<short>Set of additional option flags for treeview.</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.ScrollBars">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Kind of scrollbars: horizontal, vertical, or both. Auto* mean that scrollbars hide automatically.</short>
|
||||
@ -17227,14 +17284,14 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.SelectionColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Color used to paint background of item selection.</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.SeparatorColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Color used to paint horizontal lines between items, separators.</short>
|
||||
@ -17253,14 +17310,14 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.TreeLineColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Color used to paint vertical lines at left side.</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomTreeView.ExpandSignColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Color used to paint expand/collapse (fold/unfold) symbol (i.e. plus/minus symbol).</short>
|
||||
@ -17296,7 +17353,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.AutoExpand">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17308,7 +17365,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.BackgroundColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17344,7 +17401,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.DefaultItemHeight">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17374,7 +17431,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.ExpandSignType">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17386,23 +17443,23 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.HideSelection">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.HotTrack">
|
||||
|
||||
|
||||
<descr/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.Images">
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.Indent">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17440,29 +17497,29 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
<element name="TTreeView.ReadOnly">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.RightClickSelect">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.RowSelect">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.ScrollBars">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.SelectionColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17470,7 +17527,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
<element name="TTreeView.ShowButtons">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
||||
@ -17482,25 +17539,25 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
<element name="TTreeView.ShowLines">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.ShowRoot">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.SortType">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.StateImages">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
||||
@ -17524,7 +17581,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
<element name="TTreeView.ToolTips">
|
||||
<descr/>
|
||||
<seealso/>
|
||||
|
||||
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
@ -17715,7 +17772,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.Options">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17729,13 +17786,13 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
<element name="TTreeView.Items" link="#LCL.ComCtrls.TCustomTreeView.Items"/>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.TreeLineColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TTreeView.ExpandSignColor">
|
||||
|
||||
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -17752,7 +17809,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
... change a lot of nodes ...
|
||||
// restore old expanded state
|
||||
OldExpanded.Apply(ATreeView);
|
||||
OldExpanded.Free;
|
||||
OldExpanded.Free;
|
||||
</pre>
|
||||
</descr>
|
||||
<errors/>
|
||||
@ -18234,7 +18291,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
<element name="TListView.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
|
||||
<element name="TListView.DragMode" link="#LCL.Controls.TControl.DragMode"/>
|
||||
<element name="TListView.HideSelection">
|
||||
|
||||
|
||||
</element>
|
||||
<element name="TListView.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint"/>
|
||||
<element name="TListView.ReadOnly"/>
|
||||
@ -18590,7 +18647,7 @@ Call ParentNode.CustomSort(nil) to sort only the child nodes of a single node.
|
||||
<var>SelectOnlyThis</var> - method for selecting only the indicated node</short>
|
||||
</element>
|
||||
<element name="TCustomTreeView.TreeLinePenStyle">
|
||||
|
||||
|
||||
<short>Style of TPen, used to paint vertical lines at left side.</short>
|
||||
</element>
|
||||
<element name="TTreeView.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||||
|
||||
@ -160,8 +160,8 @@
|
||||
<!-- "class of" type Visibility: default -->
|
||||
<element name="TWinControlClass">
|
||||
<short>
|
||||
<var>TWinControlClass</var> - class of
|
||||
|
||||
<var>TWinControlClass</var> - class of
|
||||
|
||||
<var>TWinControl</var>
|
||||
</short>
|
||||
<descr/>
|
||||
@ -170,8 +170,8 @@
|
||||
<!-- "class of" type Visibility: default -->
|
||||
<element name="TControlClass">
|
||||
<short>
|
||||
<var>TControlClass</var> - class of
|
||||
|
||||
<var>TControlClass</var> - class of
|
||||
|
||||
<var>TControl</var>
|
||||
</short>
|
||||
<descr/>
|
||||
@ -1045,7 +1045,7 @@ More cursors
|
||||
<element name="TDragImageList">
|
||||
<short>A list of Images used in dragging.</short>
|
||||
<descr>
|
||||
<p>A drag image is shown when a DragImageList is supplied at all,
|
||||
<p>A drag image is shown when a DragImageList is supplied at all,
|
||||
<b>and</b> when no accepting target is under the mouse, or the source control style includes csDisplayDragImage, or AlwaysShowDragImage is set in the DragObject.</p>
|
||||
<p>In drag-dock operations typically no drag image is shown, since the DockRect frame already gives all required visual feedback.</p>
|
||||
<pre>This is a vague idea of the usage of this class:
|
||||
@ -2880,7 +2880,7 @@ dmFindTarget: find child control under the mouse
|
||||
For example: A buttons widget returns 75x25 on GetPreferredSize.
|
||||
CalculatePreferredSize adds 2 times the InnerBorder to the width and
|
||||
height.
|
||||
|
||||
|
||||
CellAlignHorizontal, CellAlignVertical: TControlCellAlign;
|
||||
Used for example when the Parents.ChildSizing.Layout defines a table
|
||||
layout.
|
||||
@ -3156,7 +3156,7 @@ dmFindTarget: find child control under the mouse
|
||||
right side of its parent client area.
|
||||
With AnchorSide[akLeft] you can define a different reference side. The
|
||||
kept distance is defined by the BorderSpacing.
|
||||
|
||||
|
||||
Example1:
|
||||
+-----+ +-----+
|
||||
| B | | C |
|
||||
@ -3173,14 +3173,14 @@ dmFindTarget: find child control under the mouse
|
||||
|
||||
Do not setup in both directions, because this will create a circle, and
|
||||
circles are not allowed.
|
||||
|
||||
|
||||
Example2:
|
||||
+-------+
|
||||
+---+ | |
|
||||
| A | | B |
|
||||
+---+ | |
|
||||
+-------+
|
||||
|
||||
|
||||
Centering A relative to B:
|
||||
A.AnchorSide[akTop].Side:=asrCenter;
|
||||
A.AnchorSide[akTop].Control:=B;
|
||||
@ -3251,8 +3251,8 @@ dmFindTarget: find child control under the mouse
|
||||
<descr/>
|
||||
<errors/>
|
||||
Can raise an exception 'TAnchorSide.CheckSidePosition invalid Side'.
|
||||
|
||||
|
||||
|
||||
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TAnchorSide.CheckSidePosition.Result">
|
||||
@ -4654,8 +4654,8 @@ potentially accessible, but to actually be usable the accessible object needs to
|
||||
</p>
|
||||
<p>
|
||||
<var>TWinControl</var> overrides this and asks the interface for theme dependent values.
|
||||
See
|
||||
|
||||
See
|
||||
|
||||
<link id="TWinControl.CalculatePreferredSize"/> for more information.
|
||||
</p>
|
||||
<p>WithThemeSpace: If true, adds space for stacking.
|
||||
@ -6647,15 +6647,27 @@ potentially accessible, but to actually be usable the accessible object needs to
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TControl.SetBounds">
|
||||
<short>Sets the bounds (left, top, width, height) of the control.</short>
|
||||
<descr><p>SetBounds can be used to change the left, top, width, height all at once, reducing some overhead.
|
||||
</p><p>Use DisableAutoSize/EnableAutoSize to reduce recomputing/moving/resizing further.
|
||||
</p><p>SetBounds is called when the properties Left, Top, Width, Height, or BoundsRect is set.
|
||||
</p><p>SetBounds updates the BaseBounds and BaseParentClientSize, which are used by anchoring to keep the distance.
|
||||
For example loading a Form with TMemo and the lfm contains TMemo's Left and Width, then SetBounds is called two times for the memo.
|
||||
</p><p>When the user maximizes a window, SetBounds is called for the form, but not for the Memo, keeping the BaseBounds of the Memo.
|
||||
If the Memo is anchored to the right, the Width of the Memo is changed based on the BaseBounds and BaseParentClientSize.
|
||||
</p><p>Keep in mind that the given aLeft, aTop, aWidth, aHeight might not be valid and will be changed by the LCL before applied.
|
||||
</p><p>Delphi calls SetBounds more often. SetBounds calls ChangeBounds with KeepBase=false.
|
||||
<descr>
|
||||
<p>
|
||||
SetBounds can be used to change the left, top, width, height all at once, reducing some overhead.
|
||||
</p>
|
||||
<p>
|
||||
Use DisableAutoSize/EnableAutoSize to reduce recomputing/moving/resizing further.
|
||||
</p>
|
||||
<p>
|
||||
SetBounds is called when the properties Left, Top, Width, Height, or BoundsRect is set.
|
||||
</p>
|
||||
<p>
|
||||
SetBounds updates the BaseBounds and BaseParentClientSize, which are used by anchoring to keep the distance. For example loading a Form with TMemo and the lfm contains TMemo's Left and Width, then SetBounds is called two times for the memo.
|
||||
</p>
|
||||
<p>
|
||||
When the user maximizes a window, SetBounds is called for the form, but not for the Memo, keeping the BaseBounds of the Memo. If the Memo is anchored to the right, the Width of the Memo is changed based on the BaseBounds and BaseParentClientSize.
|
||||
</p>
|
||||
<p>
|
||||
Keep in mind that the given aLeft, aTop, aWidth, aHeight might not be valid and will be changed by the LCL before applied.
|
||||
</p>
|
||||
<p>
|
||||
Delphi calls SetBounds more often. SetBounds calls ChangeBounds with KeepBase=false.
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
@ -6671,6 +6683,7 @@ potentially accessible, but to actually be usable the accessible object needs to
|
||||
<element name="TControl.SetBounds.aHeight">
|
||||
<short>The height of the control.</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TControl.SetInitialBounds">
|
||||
<short>Sets the bounds of the control initially, when it is created.</short>
|
||||
@ -6723,8 +6736,8 @@ potentially accessible, but to actually be usable the accessible object needs to
|
||||
some space around. This space is theme dependent, so the parameter is passed to the widgetset</p>
|
||||
<p>
|
||||
<var>TWinControl</var> overrides this and asks the interface for theme dependent values. See
|
||||
|
||||
|
||||
|
||||
|
||||
<link id="TWinControl.CalculatePreferredSize"/> for more information.</p>
|
||||
</descr>
|
||||
<notes><note>link?</note>
|
||||
@ -8195,7 +8208,9 @@ The size of the underlying widget (e.g. unit LCLIntf function GetWindowSize and
|
||||
<element name="TControl.OnStartDrag">
|
||||
<short>Event handler for the start of a dragging operation.</short>
|
||||
<descr>
|
||||
<p>The handler can provide a special DragControl object, otherwise a default object is created.</p>
|
||||
<p>
|
||||
The handler can provide a special DragControl object, otherwise a default object is created.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.Controls.TDragObject"/>
|
||||
@ -8206,43 +8221,49 @@ The size of the underlying widget (e.g. unit LCLIntf function GetWindowSize and
|
||||
<element name="TControl.OnTripleClick">
|
||||
<short>Event handler for triple mouse clicks.</short>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TControl.Parent">
|
||||
<short>The control within which the control is shown.</short>
|
||||
<descr>
|
||||
<p>When the Parent moves or hides, all its children move or hide together with it.
|
||||
</p>
|
||||
<p>Every TControl must have a Parent, else it is never shown.
|
||||
</p>
|
||||
<p>The Parent of a floating form is Nil.
|
||||
</p>
|
||||
<p>Set the parent last to reduce updates. For example:
|
||||
Button1:=TButton.Create(Self);
|
||||
Button1.Name:='Button1';
|
||||
Button1.Caption:='Click me'; // parent is not set, so it does not update the whole form
|
||||
Button1.Parent:=Form1; // set parent as last, the LCL now applies all properties
|
||||
</p>
|
||||
<p>Delphi/VCL: Parent must be set first under Delphi, because many properties work differently if they are set before or after Handle creation. The LCL applies the properties when the Handle is created.
|
||||
</p>
|
||||
<p>When the Parent moves or hides, all its children move or hide together with it.</p>
|
||||
<p>Every TControl must have a Parent, else it is never shown.</p>
|
||||
<p>The Parent of a floating form is Nil.</p>
|
||||
<p>Set the parent last to reduce updates. For example: </p>
|
||||
<code>
|
||||
Button1 := TButton.Create(Self);
|
||||
Button1.Name := 'Button1';
|
||||
Button1.Caption := 'Click me'; // parent is not set, so it does not update the whole form
|
||||
Button1.Parent := Form1; // set parent as last, the LCL now applies all properties
|
||||
</code>
|
||||
<p>Delphi/VCL: Parent must be set first under Delphi, because many properties work differently if they are set before or after Handle creation. The LCL applies the properties when the Handle is created.</p>
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TControl.ParentBiDiMode">
|
||||
<short>Allows to use the BiDiMode settings of Parent. Default is true.</short>
|
||||
<short>
|
||||
Allows to use the BiDiMode settings in the Parent control. Default is true.
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="TControl.BiDiMode"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TControl.ParentColor">
|
||||
<short>If true, the Color of the control will be the same as the one from the Parent. Default is true.</short>
|
||||
<descr>While this property is True, all changes to the Color of the parent will be
|
||||
also done to the Color of the control, synchronizing them and keeping them with the same value.
|
||||
If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
|
||||
The combination of ParentColor with clDefault can cause problems in resolving clDefault. To obtain the Color
|
||||
property of a control while taking into account clDefault and ParentColor one would use TControl.GetColorResolvingParent.
|
||||
This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use
|
||||
TColor.GetRGBColorResolvingParent
|
||||
<short>
|
||||
Use the Color from the Parent control, when enabled.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value is True.
|
||||
</p>
|
||||
<p>
|
||||
When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
|
||||
</p>
|
||||
<p>
|
||||
Using ParentColor when the Color value is clDefault can cause problems in resolving clDefault. To obtain the Color property of a control while taking into account clDefault and ParentColor, use the GetColorResolvingParent method. This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use the GetRGBColorResolvingParent method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TControl.Color"/>
|
||||
@ -8250,10 +8271,11 @@ Button1.Parent:=Form1; // set parent as last, the LCL now applies all properties
|
||||
<link id="TControl.GetRGBColorResolvingParent"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TControl.ParentFont">
|
||||
<short>If true, the Font of the control will be the same as the one from the Parent. Default is true.</short>
|
||||
<descr>While this property is True, all changes to the font of the parent will be
|
||||
<descr>While this property is True, all changes to the font of the parent will be
|
||||
also done to the font of the control, synchronizing them and keeping them with the same value.
|
||||
If the Font of the control is changed by the application, then ParentFont will be automatically set to False.
|
||||
</descr>
|
||||
@ -8264,7 +8286,7 @@ Button1.Parent:=Form1; // set parent as last, the LCL now applies all properties
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TControl.ParentShowHint">
|
||||
<short>If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.</short>
|
||||
<descr>While this property is True, all changes to the ShowHint property of the parent will be
|
||||
<descr>While this property is True, all changes to the ShowHint property of the parent will be
|
||||
also done to the ShowHint property of the control, synchronizing them and keeping them with the same value.
|
||||
If the ShowHint property of the control is changed by the application, then ParentShowHint will be automatically set to False.
|
||||
</descr>
|
||||
@ -8285,12 +8307,26 @@ Button1.Parent:=Form1; // set parent as last, the LCL now applies all properties
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TControl.ReadBounds">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<notes><note>?</note>
|
||||
</notes>
|
||||
<short>
|
||||
Reflects the Bounds for the Control read during LCL component streaming
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ReadBounds</var> is a read-only <var>TRect</var> property used when the values for the Top, Left, Height and Width properties are set during LCL component streaming. When ComponentState contains <var>csLoading</var>, changes to these properties cause the new values to be applied to ReadBounds prior to calling the SetBounds method. The internal ControlFlags are also updated to indicate that the property value has been loaded using LCL component streaming.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="ComponentState"/>
|
||||
<link id="Left"/>
|
||||
<link id="Top"/>
|
||||
<link id="Width"/>
|
||||
<link id="Height"/>
|
||||
<link id="SetBounds"/>
|
||||
<link id="BaseBounds"/>
|
||||
<link id="TControlFlag"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TControl.SessionProperties">
|
||||
<short>The stored (saved) properties of the current session, expressed as a string</short>
|
||||
@ -9120,8 +9156,8 @@ Button1.Parent:=Form1; // set parent as last, the LCL now applies all properties
|
||||
<short>Override this method when the ClientRect of a control differs from the default value.
|
||||
</short>
|
||||
<descr/>It's called often, so don't put expensive code here, or cache the result.
|
||||
|
||||
|
||||
|
||||
|
||||
<errors/>
|
||||
<seealso>
|
||||
<link id="TWinControl.GetAdjustedLogicalClientRect"/>
|
||||
@ -9453,8 +9489,8 @@ Button1.Parent:=Form1; // set parent as last, the LCL now applies all properties
|
||||
<p>This value is independent of constraints and siblings, only the inner parts are relevant.</p>
|
||||
<p>
|
||||
<var>WithThemeSpace</var>: If true, adds space for stacking. For example:
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TRadioButton</var> has a minimum size. But for stacking multiple TRadioButtons there should be some space around.
|
||||
This space is theme dependent, so it is passed as a parameter to the widgetset. </p>
|
||||
</descr>
|
||||
@ -11936,13 +11972,13 @@ End;
|
||||
</p>
|
||||
<p>
|
||||
<var>TGraphicControl</var> provides a
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Canvas</var> property for access to the control's drawing surface
|
||||
and a virtual
|
||||
|
||||
<var>Paint</var> method and an
|
||||
|
||||
and a virtual
|
||||
|
||||
<var>Paint</var> method and an
|
||||
|
||||
<var>OnPaint</var> handler,
|
||||
called in response to paint requests received by the parent control.
|
||||
</p>
|
||||
@ -12544,7 +12580,7 @@ End;
|
||||
window.
|
||||
|
||||
Example1: Docking "A" (source window) left to "B" (target window)
|
||||
|
||||
|
||||
+---+ +----+
|
||||
| A | -> | B |
|
||||
+---+ | |
|
||||
@ -12554,7 +12590,7 @@ End;
|
||||
A splitter will be inserted between "A" and "B".
|
||||
And all three are children of the newly created TLazDockForm of the
|
||||
newly created TDockTree.
|
||||
|
||||
|
||||
+------------+
|
||||
|+---+|+----+|
|
||||
|| A ||| B ||
|
||||
@ -12567,16 +12603,16 @@ End;
|
||||
replaced by docked decorations.
|
||||
If "A" had a TDockTree, it is freed and its child dockzones are merged to
|
||||
the docktree of "B". Analog for docking "C" left to "A":
|
||||
|
||||
|
||||
+------------------+
|
||||
|+---+|+---+|+----+|
|
||||
|| C ||| A ||| B ||
|
||||
|| ||| ||| ||
|
||||
|+---+|+---+|+----+|
|
||||
+------------------+
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Example2: Docking A into B
|
||||
+-----+
|
||||
+---+ | |
|
||||
@ -12587,7 +12623,7 @@ End;
|
||||
Result: A new docktree will be created. "A" will be resized to the size
|
||||
of "B". Both will be put into a TLazDockPages control which is the
|
||||
child of the newly created TDockTree.
|
||||
|
||||
|
||||
+-------+
|
||||
|[B][A] |
|
||||
|+-----+|
|
||||
@ -13956,9 +13992,9 @@ End;
|
||||
<p>During handle creation not all interfaces can create complete Device Contexts which are needed to calculate things like text size.</p>
|
||||
<p>That's why you should always call <link id="#lcl.Controls.TControl.AdjustSize">AdjustSize</link> instead of <var>DoAutoSize</var>.</p>
|
||||
<p>
|
||||
<var>TControl.AdjustSize</var> calls
|
||||
|
||||
|
||||
<var>TControl.AdjustSize</var> calls
|
||||
|
||||
|
||||
<var>DoAutoSize</var> in a smart fashion.</p>
|
||||
<p>During loading and handle creation the calls are delayed.</p>
|
||||
<p>This method initially does the same as <link id="#lcl.Controls.TWinControl.DoAutoSize">TWinControl.DoAutoSize</link>. But since <var>DoAutoSize</var> is commonly overridden by descendant components, it is not useful to perform all tests, which can result in too much overhead. To reduce this the LCL calls <var>AdjustSize</var> instead.</p>
|
||||
|
||||
@ -853,7 +853,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBEdit.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
<descr>
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
If Visible is True the control is shown, otherwise it is hidden.
|
||||
Calling Show sets, among others, Visible to True.
|
||||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||||
@ -1054,10 +1054,10 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<descr>
|
||||
<p>
|
||||
<var>Loaded</var> is called by the streaming system when a root
|
||||
component was completely read from a stream and all properties and
|
||||
references to other objects have been resolved by the streaming
|
||||
component was completely read from a stream and all properties and
|
||||
references to other objects have been resolved by the streaming
|
||||
system. Descendents of <var>TComponent</var> should override this method to
|
||||
do some additional processing of properties after all published
|
||||
do some additional processing of properties after all published
|
||||
properties have been set from values obtained from the stream.
|
||||
</p>
|
||||
<p>Application programmers should never call <var>Loaded</var> directly, this
|
||||
@ -1073,7 +1073,7 @@ is done automatically by the streaming system.
|
||||
<p>
|
||||
<var>Notification</var> is called whenever a child component is destroyed,
|
||||
inserted or removed from the list of owned component. Components that
|
||||
were requested to send a notification when they are freed
|
||||
were requested to send a notification when they are freed
|
||||
((with <link id="TComponent.FreeNotification">FreeNotification</link>)
|
||||
will also call <var>Notification</var> when they are freed.
|
||||
</p>
|
||||
@ -1085,7 +1085,7 @@ is being destroyed.
|
||||
<p>Descendents of <var>TComponent</var> can use <link id="TComponent.FreeNotification">FreeNotification</link> to request
|
||||
notification of the destruction of another object. By overriding the
|
||||
<var>Notification</var> method, they can do special processing (typically,
|
||||
set a reference to this component to <var>Nil</var>)
|
||||
set a reference to this component to <var>Nil</var>)
|
||||
when this component is destroyed. The <var>Notification</var> method is
|
||||
called quite often in the streaming process, so speed should be a
|
||||
consideration when overriding this method.
|
||||
@ -1170,7 +1170,7 @@ consideration when overriding this method.
|
||||
<element name="TDBText.Caption" link="#LCL.Controls.TControl.Caption">
|
||||
<descr>
|
||||
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
and the developer needs to set it explicitly to some new text.</p>
|
||||
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecessary) text copies. </p>
|
||||
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
|
||||
@ -1237,7 +1237,7 @@ introduced. These functions interface with the LCLInterface. </p>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBText.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
<descr>
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
If Visible is True the control is shown, otherwise it is hidden.
|
||||
Calling Show sets, among others, Visible to True.
|
||||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||||
@ -1423,10 +1423,10 @@ introduced. These functions interface with the LCLInterface. </p>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Loaded</var> is called by the streaming system when a root
|
||||
component was completely read from a stream and all properties and
|
||||
references to other objects have been resolved by the streaming
|
||||
component was completely read from a stream and all properties and
|
||||
references to other objects have been resolved by the streaming
|
||||
system. Descendents of <var>TComponent</var> should override this method to
|
||||
do some additional processing of properties after all published
|
||||
do some additional processing of properties after all published
|
||||
properties have been set from values obtained from the stream.
|
||||
</p>
|
||||
<p>Application programmers should never call <var>Loaded</var> directly, this
|
||||
@ -1442,7 +1442,7 @@ is done automatically by the streaming system.
|
||||
<p>
|
||||
<var>Notification</var> is called whenever a child component is destroyed,
|
||||
inserted or removed from the list of owned component. Components that
|
||||
were requested to send a notification when they are freed
|
||||
were requested to send a notification when they are freed
|
||||
((with <link id="TComponent.FreeNotification">FreeNotification</link>)
|
||||
will also call <var>Notification</var> when they are freed.
|
||||
</p>
|
||||
@ -1454,7 +1454,7 @@ is being destroyed.
|
||||
<p>Descendents of <var>TComponent</var> can use <link id="TComponent.FreeNotification">FreeNotification</link> to request
|
||||
notification of the destruction of another object. By overriding the
|
||||
<var>Notification</var> method, they can do special processing (typically,
|
||||
set a reference to this component to <var>Nil</var>)
|
||||
set a reference to this component to <var>Nil</var>)
|
||||
when this component is destroyed. The <var>Notification</var> method is
|
||||
called quite often in the streaming process, so speed should be a
|
||||
consideration when overriding this method.
|
||||
@ -1725,7 +1725,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBListBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
<descr>
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
If Visible is True the control is shown, otherwise it is hidden.
|
||||
Calling Show sets, among others, Visible to True.
|
||||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||||
@ -2048,7 +2048,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<element name="TDBRadioGroup.Caption" link="#LCL.Controls.TControl.Caption">
|
||||
<descr>
|
||||
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
and the developer needs to set it explicitly to some new text.</p>
|
||||
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecessary) text copies. </p>
|
||||
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
|
||||
@ -2154,7 +2154,7 @@ Reads or Writes flag if control is re-sized.
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBRadioGroup.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
<descr>
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
If Visible is True the control is shown, otherwise it is hidden.
|
||||
Calling Show sets, among others, Visible to True.
|
||||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||||
@ -2462,7 +2462,7 @@ Reads or Writes flag if control is re-sized.
|
||||
<element name="TDBCheckBox.Caption" link="#LCL.Controls.TControl.Caption">
|
||||
<descr>
|
||||
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
and the developer needs to set it explicitly to some new text.</p>
|
||||
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecessary) text copies. </p>
|
||||
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
|
||||
@ -2472,6 +2472,37 @@ introduced. These functions interface with the LCLInterface. </p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDBCheckBox.BiDiMode" link="#LCL.Controls.TControl.BiDiMode">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso>
|
||||
<link id="TControl.BiDiMode"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDBCheckBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso>
|
||||
<link id="TControl.BorderSpacing"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDBCheckBox.Color" link="#LCL.Controls.TControl.Color">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDBCheckBox.Constraints" link="#LCL.Controls.TControl.Constraints">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso>
|
||||
<link id="TControl.Constraints"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBCheckBox.DataField">
|
||||
<short>The name (as a string) of the field with which the checkbox is to be associated</short>
|
||||
@ -2642,7 +2673,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBCheckBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
<descr>
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
If Visible is True the control is shown, otherwise it is hidden.
|
||||
Calling Show sets, among others, Visible to True.
|
||||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||||
@ -2650,6 +2681,7 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TDBComboBox">
|
||||
<short>
|
||||
@ -2894,9 +2926,6 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
|
||||
<descr>
|
||||
<p>
|
||||
<var>Index </var>
|
||||
|
||||
|
||||
|
||||
- the number of the currently selected item</p>
|
||||
<p>The first item has number 0, the second has number 1, the third number 2, etc. </p>
|
||||
<p>In case no item is selected, ItemIndex
|
||||
@ -2904,6 +2933,7 @@ has value -1.</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBComboBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
||||
<descr>
|
||||
@ -2924,9 +2954,6 @@ has value -1.</p>
|
||||
<descr>
|
||||
<p>
|
||||
<var>AutoDropDown </var>
|
||||
|
||||
|
||||
|
||||
- if True, the drop-down list appears as soon as the cursor moves over the text box</p>
|
||||
<p>If False, the drop-down box only appears when the downward triangular indicator at the end of the box is selected</p>
|
||||
</descr>
|
||||
@ -2953,6 +2980,7 @@ has value -1.</p>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBComboBox.Enabled" link="#LCL.Controls.TControl.Enabled">
|
||||
<descr>
|
||||
@ -2962,6 +2990,7 @@ has value -1.</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBComboBox.Font" link="#LCL.Controls.TControl.Font">
|
||||
<short>The <var>Font</var> to be used for text in this control</short>
|
||||
@ -3119,14 +3148,52 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBComboBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
<descr>
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
If Visible is True the control is shown, otherwise it is hidden.
|
||||
Calling Show sets, among others, Visible to True.
|
||||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||||
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
|
||||
<p>
|
||||
The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets, among others, Visible to True. Setting Visible to False is equivalent to calling Hide method.
|
||||
</p>
|
||||
<p>
|
||||
The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDBComboBox.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
|
||||
<element name="TDBComboBox.DragMode" link="#LCL.Controls.TControl.DragMode"/>
|
||||
|
||||
<element name="TDBComboBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
<p>Reads or Writes flag if bounds are changed</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TDBComboBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
|
||||
<descr>
|
||||
<p>Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate.</p>
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
<element name="TDBComboBox.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||||
|
||||
<element name="TDBComboBox.DataChange" link=""/>
|
||||
<element name="TDBComboBox.DataChange.Sender">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TDBComboBox.KeyPress" link=""/>
|
||||
<element name="TDBComboBox.KeyPress.Key">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TDBComboBox.UpdateData" link=""/>
|
||||
<element name="TDBComboBox.UpdateData.Sender">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TDBComboBox.AutoSize" link="#LCL.Controls.TControl.AutoSize"/>
|
||||
|
||||
<element name="TDBComboBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TDBMemo">
|
||||
<short>
|
||||
@ -3595,10 +3662,10 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<descr>
|
||||
<p>
|
||||
<var>Loaded</var> is called by the streaming system when a root
|
||||
component was completely read from a stream and all properties and
|
||||
references to other objects have been resolved by the streaming
|
||||
component was completely read from a stream and all properties and
|
||||
references to other objects have been resolved by the streaming
|
||||
system. Descendents of <var>TComponent</var> should override this method to
|
||||
do some additional processing of properties after all published
|
||||
do some additional processing of properties after all published
|
||||
properties have been set from values obtained from the stream.
|
||||
</p>
|
||||
<p>Application programmers should never call <var>Loaded</var> directly, this
|
||||
@ -3614,7 +3681,7 @@ is done automatically by the streaming system.
|
||||
<p>
|
||||
<var>Notification</var> is called whenever a child component is destroyed,
|
||||
inserted or removed from the list of owned component. Components that
|
||||
were requested to send a notification when they are freed
|
||||
were requested to send a notification when they are freed
|
||||
((with <link id="TComponent.FreeNotification">FreeNotification</link>)
|
||||
will also call <var>Notification</var> when they are freed.
|
||||
</p>
|
||||
@ -3626,7 +3693,7 @@ is being destroyed.
|
||||
<p>Descendents of <var>TComponent</var> can use <link id="TComponent.FreeNotification">FreeNotification</link> to request
|
||||
notification of the destruction of another object. By overriding the
|
||||
<var>Notification</var> method, they can do special processing (typically,
|
||||
set a reference to this component to <var>Nil</var>)
|
||||
set a reference to this component to <var>Nil</var>)
|
||||
when this component is destroyed. The <var>Notification</var> method is
|
||||
called quite often in the streaming process, so speed should be a
|
||||
consideration when overriding this method.
|
||||
@ -3697,7 +3764,7 @@ consideration when overriding this method.
|
||||
<element name="TDBGroupBox.Caption" link="#LCL.Controls.TControl.Caption">
|
||||
<descr>
|
||||
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
|
||||
and the developer needs to set it explicitly to some new text.</p>
|
||||
<p>The VCL implementation relies on the virtual <var>Get/SetTextBuf</var> to exchange text between widgets and VCL. This means a lot of (unnecessary) text copies. </p>
|
||||
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <var>RealGet/SetText</var> is
|
||||
@ -3914,7 +3981,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBGroupBox.Visible" link="#LCL.Controls.TControl.Visible">
|
||||
<descr>
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
<pre>The Visible property represents the ability to see a visual control.
|
||||
If Visible is True the control is shown, otherwise it is hidden.
|
||||
Calling Show sets, among others, Visible to True.
|
||||
Setting Visible to False is equivalent to calling Hide method.</pre>
|
||||
@ -4660,23 +4727,34 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TDBCustomNavigator">
|
||||
<short>
|
||||
<var>TDBCustomNavigator</var> - the base class for <var>TDBNavigator</var>, a tool for navigating through the records of a dataset</short>
|
||||
<var>TDBCustomNavigator</var> - the base class for <var>TDBNavigator</var>, a tool for navigating through the records of a dataset
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TDBCustomNavigator</var> is the parent class for <var>TDBNavigator</var>, an advanced tool for navigating through datasets held locally in response to a query sent to the database. Most of the important properties are defined here.
|
||||
</p>
|
||||
<p>
|
||||
It consists of a series of toolbuttons to move to the <b>First</b>, <b>Prior</b>, <b>Next</b> or <b>Last</b> record; to <b>Insert</b> or <b>Delete</b> a record; to <b>Edit</b> a record (enter Edit mode), to <b>Post</b> the changes. to <b>Cancel</b>l the changes, and to <var>Refresh</var> the display from the database. The set of buttons for display can be customized in <var>VisibleButtons</var>, which allows display of individual buttons to be suppressed.
|
||||
</p>
|
||||
<p>
|
||||
If used in conjunction with a DataAware control such as <var>TDBGrid</var> or <var>TDBMemo</var> it controls which records are displayed , the position of the record selection cursor, and the initiation of changes to the dataset and ultimately the database.
|
||||
</p>
|
||||
<p>
|
||||
Most of the functionality of the toolbar is already built-in to the control, but if the programmer needs to specify actions to be associated with individual buttons, there is a procedure <var>BtnClick</var> to which an argument can be sent with the index value of the button clicked, and the procedure chooses which action to call dependent on the button index.
|
||||
</p>
|
||||
<p>
|
||||
The <var>DataSource</var> property must be set to link to the appropriate set of data.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="HowToUseDataAwareControls"/>
|
||||
</seealso>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TDBCustomNavigator</var> is the parent class for
|
||||
<var>TDBNavigator</var>, an advanced tool for navigating through datasets held locally in response to a query sent to the database. Most of the important properties are defined here.</p>
|
||||
<p>It consists of a series of toolbuttons to move to the <b>First</b>, <b>Prior</b>, <b>Next</b> or <b>Last</b> record; to <b>Insert</b> or <b>Delete</b> a record; to <b>Edit</b> a record (enter Edit mode), to <b>Post</b> the changes. to <b>Cancel</b>l the changes, and to <var>Refresh</var> the display from the database. The set of buttons for display can be customized in <var>VisibleButtons</var>, which allows display of individual buttons to be suppressed</p>
|
||||
<p>If used in conjunction with a DataAware control such as <var>TDBGrid</var> or <var>TDBMemo</var> it controls which records are displayed , the position of the record selection cursor, and the initiation of changes to the dataset and ultimately the database.</p>
|
||||
<p>Most of the functionality of the toolbar is already built-in to the control, but if the programmer needs to specify actions to be associated with individual buttons, there is a procedure <var>BtnClick</var> to which an argument can be sent with the index value of the button clicked, and the procedure chooses which action to call dependent on the button index.</p>
|
||||
<p>The <var>DataSource</var> property must be set to link to the appropriate set of data.</p>
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TDBCustomNavigator.FBeforeAction">
|
||||
<short/>
|
||||
@ -5075,6 +5153,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TDBNavButton">
|
||||
<short>
|
||||
@ -5185,23 +5264,37 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TDBNavigator">
|
||||
<short>
|
||||
<var>TDBNavigator </var>- a data-aware Button-Bar to facilitate navigating between records of a dataset</short>
|
||||
<var>TDBNavigator </var>- a data-aware Button-Bar to facilitate navigating between records of a dataset
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TDBNavigator</var> is an advanced tool for navigating through datasets held locally in response to a query sent to the database.
|
||||
</p>
|
||||
<p>
|
||||
It consists of a series of toolbuttons to move to the <b>First</b>, <b>Prior</b>, <b>Next</b> or <b>Last</b> record; to <b>Insert</b> or <b>Delete</b> a record; to <b>Edit</b> a record (enter Edit mode), to <b>Post</b> the changes. to <b>Cancel</b> the changes, and to <b>Refresh</b> the display from the database.
|
||||
</p>
|
||||
<p>
|
||||
The programmer may determine, at design time, which buttons are to be displayed or suppressed by adjusting the <var>VisibleButtons</var> property in the Object Inspector.
|
||||
</p>
|
||||
<p>
|
||||
If used in conjunction with a DataAware control such as <link id="#lcl.DBGrids.TDBGrid">TDBGrid</link> or <link id="TDBMemo">TDBMemo</link> it controls which records are displayed , the position of the record selection cursor, and the initiation of changes to the dataset and ultimately the database.
|
||||
</p>
|
||||
<p>
|
||||
Most of the functionality of the toolbar is already built-in to the control, but if the programmer needs to specify actions to be associated with individual buttons, there is a procedure <link id="TDBCustomNavigator.BtnClick">TDBCustomNavigator.BtnClick</link> to which an argument can be sent with the <var>Index</var> value of the button clicked, and the procedure chooses which action to call dependent on the button index.
|
||||
</p>
|
||||
<p>
|
||||
The <var>DataSource</var> property must be set to link to the appropriate set of data.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="HowToUseDataAwareControls"/>
|
||||
</seealso>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TDBNavigator</var> is an advanced tool for navigating through datasets held locally in response to a query sent to the database.</p>
|
||||
<p>It consists of a series of toolbuttons to move to the <b>First</b>, <b>Prior</b>, <b>Next</b> or <b>Last</b> record; to <b>Insert</b> or <b>Delete</b> a record; to <b>Edit</b> a record (enter Edit mode), to <b>Post</b> the changes. to <b>Cancel</b> the changes, and to <b>Refresh</b> the display from the database.</p>
|
||||
<p>The programmer may determine, at design time, which buttons are to be displayed or suppressed by adjusting the <var>VisibleButtons</var> property in the Object Inspector.</p>
|
||||
<p>If used in conjunction with a DataAware control such as <link id="#lcl.DBGrids.TDBGrid">TDBGrid</link> or <link id="TDBMemo">TDBMemo</link> it controls which records are displayed , the position of the record selection cursor, and the initiation of changes to the dataset and ultimately the database.</p>
|
||||
<p>Most of the functionality of the toolbar is already built-in to the control, but if the programmer needs to specify actions to be associated with individual buttons, there is a procedure <link id="TDBCustomNavigator.BtnClick">TDBCustomNavigator.BtnClick</link> to which an argument can be sent with the <var>Index</var> value of the button clicked, and the procedure chooses which action to call dependent on the button index.</p>
|
||||
<p>The <var>DataSource</var> property must be set to link to the appropriate set of data.</p>
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TDBNavigator.Align" link="#LCL.Controls.TControl.Align">
|
||||
<short/>
|
||||
@ -5513,18 +5606,32 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<topic name="HowToUseDataAwareControls">
|
||||
<short>
|
||||
<var>HowToUseDataAwareControls</var> - Hints for accessing databases</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HowToUseDataAwareControls</var> - Hints for accessing databases. A set of Data-Aware components is provided, to make it easier to access information held in databases.</p>
|
||||
<p>Before using Data-Aware components, it is necessary to make a connection with a database, and this should be done either using a TSQLConnection or a TDbf component, depending on the type of database that is being used. In any case, the components for connection with the database need to be found in $Lazdir/components/sqldb/, $Lazdir/components/tdbf/ or whatever other source is appropriate. They need to be added using the <var>Components</var> Menu Item of the IDE, and compiled ready for adding. The IDE needs to be re-built to include the new components.</p>
|
||||
<p>To make the connection with the database: first place a <var>DataBase Connection</var> on the Form (invisible at run-time, so put it anywhere convenient); set its properties to connect the user (with name and password) to the appropriate server, database and table (the connection component should deal with all the user-authentication issues, opening and closing the database etc). Then put on a <var>TDataSource</var> from the Data Access tab of the Component Palette, and perhaps items such as <var>TSQLTransaction</var> and <var>TSQLQuery</var>, depending on the particular database you are using. The various database components need to be linked to each other, for example by setting the <var>Transaction</var> property of a database connector to the appropriate transaction component, and linking the <var>DataBase</var> property of the Transaction component back to the database connector; link the DataSource's <var>DataSet</var> property to the appropriate SQLQuery or other set of data, and its <var>Transaction</var> property to the transaction component</p>
|
||||
<p>Each Data-Aware control (on the Data Controls tab of the Component Palette) has the usual set of properties to determine its shape and size, position, color and font etc. But there are also special properties to define the data to be displayed or modified. These include the <var>DataSource</var> property which must be set to link to the defined set of data, and often a <var>Field</var> component to determine which of the columns in the database is to be displayed. </p>
|
||||
<p>Most of the components operate on a single Row or record of the database, but the <var>TDBGrid</var> is capable of displaying and operating on multiple rows and columns, in a <var>StringGrid</var> format, allowing the user to get an overview of what is in the database. The DBGrid will display the contents of the DataSet even at design time, provided the various components are enabled or rendered active; this allows the designer to ensure that all the connections to the database have been correctly made.</p>
|
||||
<p>The <var>TDBNavigator</var> component is used in conjunction with the Data-Aware components. It consists of a series of buttons to allow browsing through the DataSet, displaying the first, previous, next or last record (or Row), inserting or deleting records, committing the changes back to the database or refreshing the DataSet from the database.</p>
|
||||
<p>The way database programming works is typically as follows:</p>
|
||||
<var>HowToUseDataAwareControls</var> - Hints for accessing databases. A set of Data-Aware components is provided, to make it easier to access information held in databases.
|
||||
</p>
|
||||
<p>
|
||||
Before using Data-Aware components, it is necessary to make a connection with a database, and this should be done either using a TSQLConnection or a TDbf component, depending on the type of database that is being used. In any case, the components for connection with the database need to be found in $Lazdir/components/sqldb/, $Lazdir/components/tdbf/ or whatever other source is appropriate. They need to be added using the <var>Components</var> Menu Item of the IDE, and compiled ready for adding. The IDE needs to be re-built to include the new components.
|
||||
</p>
|
||||
<p>
|
||||
To make the connection with the database: first place a <var>DataBase Connection</var> on the Form (invisible at run-time, so put it anywhere convenient); set its properties to connect the user (with name and password) to the appropriate server, database and table (the connection component should deal with all the user-authentication issues, opening and closing the database etc). Then put on a <var>TDataSource</var> from the Data Access tab of the Component Palette, and perhaps items such as <var>TSQLTransaction</var> and <var>TSQLQuery</var>, depending on the particular database you are using. The various database components need to be linked to each other, for example by setting the <var>Transaction</var> property of a database connector to the appropriate transaction component, and linking the <var>DataBase</var> property of the Transaction component back to the database connector; link the DataSource's <var>DataSet</var> property to the appropriate SQLQuery or other set of data, and its <var>Transaction</var> property to the transaction component.
|
||||
</p>
|
||||
<p>
|
||||
Each Data-Aware control (on the Data Controls tab of the Component Palette) has the usual set of properties to determine its shape and size, position, color and font etc. But there are also special properties to define the data to be displayed or modified. These include the <var>DataSource</var> property which must be set to link to the defined set of data, and often a <var>Field</var> component to determine which of the columns in the database is to be displayed.
|
||||
</p>
|
||||
<p>
|
||||
Most of the components operate on a single Row or record of the database, but the <var>TDBGrid</var> is capable of displaying and operating on multiple rows and columns, in a <var>StringGrid</var> format, allowing the user to get an overview of what is in the database. The DBGrid will display the contents of the DataSet even at design time, provided the various components are enabled or rendered active; this allows the designer to ensure that all the connections to the database have been correctly made.
|
||||
</p>
|
||||
<p>
|
||||
The <var>TDBNavigator</var> component is used in conjunction with the Data-Aware components. It consists of a series of buttons to allow browsing through the DataSet, displaying the first, previous, next or last record (or Row), inserting or deleting records, committing the changes back to the database or refreshing the DataSet from the database.
|
||||
</p>
|
||||
<p>
|
||||
The way database programming works is typically as follows:
|
||||
</p>
|
||||
<ul>
|
||||
<li>a database is opened for access by the user (Database Connection)</li>
|
||||
<li>a command is issued (e.g. by <var>TSQLQuery</var>) to select or extract some or all of the records which are then stored locally in the <var>DataSet</var>
|
||||
@ -5532,8 +5639,12 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<li>the contents of the <var>DataSet</var> are acted on by the Data-Aware components, displaying one Row or record at a time from selected Columns, or perhaps the whole DataSet in a <var>DBGrid</var>, editing records, inserting or deleting records, or using the data to perform statistical tests or calculations</li>
|
||||
<li>at intervals usually prescribed by the user (sometimes after every change, sometimes after a whole series of changes), the contents of the local DataSet are sent back to the database, causing an update of the database's contents. This process is referred to as 'Commit' or 'Post' or sometimes as 'Update'</li>
|
||||
</ul>
|
||||
<p>The programmer can determine which events are associated with a Commit action by supplying suitable event handlers for <var>OnClick</var>, <var>OnChange</var>, <var>OnFinishedEdit</var> etc.</p>
|
||||
<p>The following table shows the approximate correspondence between conventional and data-aware control classes</p>
|
||||
<p>
|
||||
The programmer can determine which events are associated with a Commit action by supplying suitable event handlers for <var>OnClick</var>, <var>OnChange</var>, <var>OnFinishedEdit</var> etc.
|
||||
</p>
|
||||
<p>
|
||||
The following table shows the approximate correspondence between conventional and data-aware control classes:
|
||||
</p>
|
||||
<table>
|
||||
<th>
|
||||
<td>Standard Control</td>
|
||||
@ -5596,9 +5707,12 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<td>A grid to display information in Rows and Columns</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p>Standard Controls can, of course, be used to display information from a database, but they lack the direct link with the DataSet and its Navigation aids, so the programmer must write explicit code to extract data from the DataSet and put it in the Standard Control</p>
|
||||
<p>
|
||||
Standard Controls can, of course, be used to display information from a database, but they lack the direct link with the DataSet and its Navigation aids, so the programmer must write explicit code to extract data from the DataSet and put it in the Standard Control
|
||||
</p>
|
||||
</descr>
|
||||
</topic>
|
||||
|
||||
<element name="TDBEdit.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
@ -5680,29 +5794,6 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<p>The default color is the same as the window in which the control is located.</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TDBComboBox.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
|
||||
<element name="TDBComboBox.DragMode" link="#LCL.Controls.TControl.DragMode"/>
|
||||
<element name="TDBComboBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
<p>Reads or Writes flag if bounds are changed</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TDBComboBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
|
||||
<descr>
|
||||
<p>Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate.</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TDBComboBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
|
||||
<element name="TDBComboBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
|
||||
<element name="TDBComboBox.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone"/>
|
||||
<element name="TDBComboBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
|
||||
<element name="TDBComboBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/>
|
||||
<element name="TDBComboBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove"/>
|
||||
<element name="TDBComboBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp"/>
|
||||
<element name="TDBComboBox.OnSelect" link="#LCL.StdCtrls.TCustomComboBox.OnSelect"/>
|
||||
<element name="TDBComboBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/>
|
||||
<element name="TDBComboBox.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
||||
<element name="TDBGroupBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
||||
<descr>
|
||||
<p>// standard properties, which should be supported by all descendants</p>
|
||||
@ -5883,6 +5974,19 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<short>
|
||||
<var>UpdateData</var> - method for applying any pending changes to the data</short>
|
||||
</element>
|
||||
|
||||
<element name="TDBLookupListBox.IsUnbound">
|
||||
<short></short>
|
||||
<descr>
|
||||
IsUnbound is a Boolean function.
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
<version></version>
|
||||
</element>
|
||||
<element name="TDBLookupListBox.IsUnbound.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBListBox.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TCustomDBListBox</var>: calls inherited <var>Create</var>, makes links and sets up event handlers for data change, change in <var>Editing</var> status and updating data</short>
|
||||
@ -5994,10 +6098,15 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<element name="TDBLookupListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop"/>
|
||||
<element name="TDBLookupListBox.TopIndex" link="#LCL.StdCtrls.TCustomListBox.TopIndex"/>
|
||||
<element name="TDBLookupListBox.Visible" link="#LCL.Controls.TControl.Visible"/>
|
||||
|
||||
<element name="TDBEdit.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||||
|
||||
<element name="TDBText.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
|
||||
|
||||
<element name="TDBRadioGroup.TabOrder" link="#LCL.Controls.TWinControl.TabOrder"/>
|
||||
|
||||
<element name="TDBCheckBox.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
|
||||
|
||||
<element name="TCustomDBComboBox">
|
||||
<short>
|
||||
<var>TCustomDBComboBox</var> - a Data-aware Combo Box for displaying information from a Database</short>
|
||||
@ -6005,19 +6114,195 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<link id="HowToUseDataAwareControls"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.FDataLink"/>
|
||||
<element name="TCustomDBComboBox.FDetectedEvents"/>
|
||||
|
||||
<element name="TCustomDBComboBox.GetDataField">
|
||||
<short>
|
||||
Gets the value for the DataField property
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.GetDataField.Result">
|
||||
<short>
|
||||
Value for the DataField property
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.GetDataSource">
|
||||
<short>
|
||||
Gets the value for the DataSource property
|
||||
</short>
|
||||
<descr>
|
||||
GetDataSource is a TDataSource function used to get the value for the DataSource property.
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.GetDataSource.Result">
|
||||
<short>Value for the DataSource property</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.GetField">
|
||||
<short>
|
||||
Gets the value for the Field property
|
||||
</short>
|
||||
<descr>
|
||||
GetField is a TField function used to get the value for the Field property.
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.GetField.Result">
|
||||
<short>Value for the Field property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.GetReadOnly">
|
||||
<short>Gets the value for the ReadOnly property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.GetReadOnly.Result">
|
||||
<short>Value for the ReadOnly property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.SetDataField">
|
||||
<short>Sets the value for the DataField property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.SetDataField.AValue">
|
||||
<short>New value for the DataField property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.SetDataSource">
|
||||
<short>Sets the value for the DataSource property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.SetDataSource.AValue">
|
||||
<short>New value for the DataSource property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.SetReadOnly">
|
||||
<short>Sets the value for the ReadOnly property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.SetReadOnly.AValue">
|
||||
<short>New value for the ReadOnly property</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.CMGetDataLink">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.CMGetDataLink.Message">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.DoEdit">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.DoEdit.Result">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.DoOnCloseUp">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.DoOnSelect">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.DoOnChange">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.LMDeferredEdit">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.LMDeferredEdit.Message">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.DetectedEvents">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.CloseUp">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.Select">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.DataChange">
|
||||
<short>
|
||||
<var>DataChange</var> - updates any changes in text</short>
|
||||
<var>DataChange</var> - updates any changes in text
|
||||
</short>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.ActiveChange">
|
||||
|
||||
<element name="TCustomDBComboBox.DoMouseWheel">
|
||||
<short>
|
||||
<var>ActiveChange</var> - method to process a change in the <var>Active</var> state</short>
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.EditingChange">
|
||||
<element name="TCustomDBComboBox.DoMouseWheel.Shift">
|
||||
<short>
|
||||
<var>EditingChange</var> - method to process a change in the <var>Editing</var> state</short>
|
||||
</short>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.DoMouseWheel.WheelDelta">
|
||||
<short>
|
||||
</short>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.DoMouseWheel.MousePos">
|
||||
<short>
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.Notification" link="#rtl.Classes.TComponent.Notification"/>
|
||||
|
||||
<element name="TCustomDBComboBox.Change">
|
||||
<short>
|
||||
<var>Change</var> -if there has been a change to the data the link must be notified, then inherited <var>Change</var> is called</short>
|
||||
@ -6025,34 +6310,118 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
|
||||
<link id="#LCL.StdCtrls.TCustomComboBox.Change">TCustomComboBox.Change</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.KeyDown">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.KeyDown.Key">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.KeyDown.Shift">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.UpdateData">
|
||||
<short>
|
||||
<var>UpdateData</var> - implements any pending changes in the data</short>
|
||||
<var>UpdateData</var> - implements any pending changes in the data
|
||||
</short>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.FocusRequest">
|
||||
|
||||
<element name="TCustomDBComboBox.UpdateRecord">
|
||||
<short>
|
||||
<var>FocusRequest</var> - sets focus in response to a request to do so</short>
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
|
||||
|
||||
<element name="TCustomDBComboBox.WndProc">
|
||||
<short>
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.WndProc.Message">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.Create">
|
||||
<short>Constructor for the class instance</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.Create.TheOwner">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.Destroy">
|
||||
<short>Destructor for the class instance</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.ExecuteAction">
|
||||
<short></short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.ExecuteAction.AAction">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.ExecuteAction.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.UpdateAction">
|
||||
<short></short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.UpdateAction.AAction">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.UpdateAction.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.EditingDone" link="#LCL.Controls.TControl.EditingDone">
|
||||
<short>
|
||||
<var>EditingDone</var> - updates data through the link, then calls inherited <var>EditingDone</var>
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.Field">
|
||||
<short>The <var>Field</var> to which this combobox is attached</short>
|
||||
<short>
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.Text" link="#LCL.StdCtrls.TCustomComboBox.Text"/>
|
||||
|
||||
<element name="TCustomDBComboBox.ItemIndex" link="#LCL.StdCtrls.TCustomComboBox.ItemIndex"/>
|
||||
<element name="TCustomDBComboBox.DataField" link="#LCL.DbCtrls.TCustomDBComboBox.DataField">
|
||||
<short>The name (as a string) of the Field whose data are to be linked to the ComboBox</short>
|
||||
|
||||
<element name="TCustomDBComboBox.DataField">
|
||||
<short>
|
||||
The name of the Field which provides the values displayed in the ComboBox
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBComboBox.DataSource">
|
||||
<short>The identity of the <var>DataSource</var> to which the ComboBox is attached</short>
|
||||
<short>
|
||||
Identifies the <var>DataSource</var> to which the ComboBox is attached
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomDBComboBox.ReadOnly" link="#LCL.StdCtrls.TCustomComboBox.ReadOnly"/>
|
||||
<element name="TDBComboBox.AutoSize" link="#LCL.Controls.TControl.AutoSize"/>
|
||||
<element name="TDBComboBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
||||
|
||||
<element name="TCustomDBComboBox.ReadOnly">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDBLookupComboBox">
|
||||
<short>
|
||||
<var>TDBLookupComboBox</var> - a dataware ComboBox for examining a lookup table from a database</short>
|
||||
|
||||
@ -57,6 +57,10 @@
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TLCLPlatform.lpQt5">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- enumeration value Visibility: default -->
|
||||
<element name="TLCLPlatform.lpfpGUI">
|
||||
<short></short>
|
||||
@ -77,6 +81,10 @@
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="TLCLPlatform.lpMUI">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- set type Visibility: default -->
|
||||
<element name="TLCLPlatforms">
|
||||
<short></short>
|
||||
|
||||
@ -1,253 +1,246 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="lcl">
|
||||
<package name="lcl">
|
||||
<!--
|
||||
====================================================================
|
||||
LCLTranslator
|
||||
====================================================================
|
||||
-->
|
||||
<module name="LCLTranslator">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
LCLTranslator
|
||||
====================================================================
|
||||
-->
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TUpdateTranslator">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<module name="LCLTranslator">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TUpdateTranslator.FStackPath">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TUpdateTranslator">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: private -->
|
||||
<element name="TUpdateTranslator.IntUpdateTranslation">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TUpdateTranslator.FStackPath">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: private -->
|
||||
<element name="TUpdateTranslator.IntUpdateTranslation.AnInstance">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: private -->
|
||||
<element name="TUpdateTranslator.IntUpdateTranslation">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TUpdateTranslator.UpdateTranslation">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: private -->
|
||||
<element name="TUpdateTranslator.IntUpdateTranslation.AnInstance">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TUpdateTranslator.UpdateTranslation.AnInstance">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TUpdateTranslator.UpdateTranslation">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TDefaultTranslator">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TUpdateTranslator.UpdateTranslation.AnInstance">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TDefaultTranslator.FMOFile">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TDefaultTranslator">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TDefaultTranslator.Create">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TDefaultTranslator.FMOFile">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.Create.MOFileName">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TDefaultTranslator.Create">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TDefaultTranslator.Destroy">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.Create.MOFileName">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TDefaultTranslator.Destroy">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.Sender">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.Instance">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.Sender">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.PropInfo">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.Instance">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.Content">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.PropInfo">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TPOTranslator">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TDefaultTranslator.TranslateStringProperty.Content">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TPOTranslator.FPOFile">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TPOTranslator">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TPOTranslator.Create">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TPOTranslator.FPOFile">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.Create.POFileName">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="TPOTranslator.Create.aPOFile">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TPOTranslator.Create">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TPOTranslator.Destroy">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.Create.POFileName">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TPOTranslator.Destroy">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.Sender">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.Instance">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.Sender">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.PropInfo">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.Instance">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.Content">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.PropInfo">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="TranslateLCLResourceStrings">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TranslateLCLResourceStrings.Lang">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="TranslateLCLResourceStrings.Dir">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="TranslateLCLResourceStrings.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: public -->
|
||||
<element name="TPOTranslator.TranslateStringProperty.Content">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="SetDefaultLang">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="SetDefaultLang">
|
||||
<short></short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetDefaultLang.Lang">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetDefaultLang.Lang">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetDefaultLang.Dir">
|
||||
<short></short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetDefaultLang.Dir">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetDefaultLang.ForceUpdate">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="SetDefaultLang.LocaleFileName">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
</module> <!-- LCLTranslator -->
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetDefaultLang.ForceUpdate">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
</package>
|
||||
<element name="SetDefaultLang.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="GetDefaultLang">
|
||||
<short>Deprecated</short>
|
||||
<descr>Deprecated. Use the result from the SetDefaultLang function instead.</descr>
|
||||
<version>Deprecated in LCL version 2.1.0.</version>
|
||||
<seealso><link id="SetDefaultLang"/></seealso>
|
||||
</element>
|
||||
<element name="GetDefaultLang.Result">
|
||||
<short>Default language code currently in use</short>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
<!-- LCLTranslator -->
|
||||
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user