mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-12-04 04:37:35 +01:00
5870 lines
214 KiB
XML
5870 lines
214 KiB
XML
<?xml version="1.0"?>
|
|
<fpdoc-descriptions>
|
|
<package name="lcl">
|
|
<!--
|
|
====================================================================
|
|
DbCtrls
|
|
====================================================================
|
|
-->
|
|
<module name="DbCtrls">
|
|
<short>Data-Aware controls commonly used for viewing and operating on information held in databases</short>
|
|
<descr/>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Classes">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="SysUtils">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="DB">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="LCLProc">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="LMessages">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="GraphType">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Forms">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Controls">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Graphics">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Dialogs">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="StdCtrls">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Buttons">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="MaskEdit">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="ExtCtrls">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Calendar">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Chart">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="LCLType">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TFieldDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FField">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FFieldName">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FControl">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FEditing">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.IsModified">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FOnDataChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FOnEditingChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FOnUpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FOnActiveChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TFieldDataLink.FOnFocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TFieldDataLink.FieldCanModify">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TFieldDataLink.FieldCanModify.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TFieldDataLink.GetCanModify">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TFieldDataLink.GetCanModify.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TFieldDataLink.SetFieldName">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TFieldDataLink.SetFieldName.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TFieldDataLink.ValidateField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TFieldDataLink.ValidateField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TFieldDataLink.ActiveChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TFieldDataLink.DataSetChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TFieldDataLink.EditingChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TFieldDataLink.LayoutChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TFieldDataLink.RecordChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TFieldDataLink.RecordChanged.aField">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TFieldDataLink.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TFieldDataLink.FocusControl">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TFieldDataLink.FocusControl.aField">
|
|
<short/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TFieldDataLink.Create">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TFieldDataLink.Destroy">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: public -->
|
|
<element name="TFieldDataLink.Edit">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TFieldDataLink.Edit.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TFieldDataLink.Modified">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TFieldDataLink.Reset">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.Control">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.Field">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.FieldName">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.CanModify">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.Editing">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.OnDataChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.OnEditingChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.OnUpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.OnActiveChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TFieldDataLink.OnFocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBEdit">
|
|
<short>
|
|
<i>TDBEdit </i> - a data-aware edit box for processing a single text-string from a dataset</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBEdit.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.EditingChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.EditingChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.FocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.FocusRequest.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.ActiveChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.ActiveChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBEdit.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBEdit.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBEdit.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBEdit.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBEdit.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBEdit.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBEdit.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBEdit.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.SetReadOnly.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.SetDataField.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBEdit.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.SetDataSource.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBEdit.KeyDown">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.KeyDown.Key">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.KeyDown.Shift">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBEdit.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBEdit.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: protected -->
|
|
<element name="TDBEdit.EditCanModify">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBEdit.EditCanModify.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBEdit.Change">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBEdit.Reset">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBEdit.SetFocus">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBEdit.EditingDone">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBEdit.Create">
|
|
<short>Create a new instance of the Window Control</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBEdit.Create.AOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBEdit.Destroy">
|
|
<short>Destroy this instance of the Window Control, and return the resources used</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBEdit.Field">
|
|
<short>The field in the DataSet from which data are to be displayed in the Edit</short>
|
|
<descr>Refers to the complete Field entity, not just its name</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.DataField">
|
|
<short>The name (as a string) of the field whose data are to be displayed</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.DataSource">
|
|
<short>The DataSource to be used for supplying the data in the required Field. Ususally the result of a data query</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.ReadOnly">
|
|
<short>
|
|
<i>ReadOnly </i>- the contents of the edit box may only be read, not written or erased</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Anchors">
|
|
<short>The set of anchor definitions for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines how the control is to be anchored to its client or parent control</p>
|
|
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.AutoSize">
|
|
<short>Whether auto-size is to be used</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
|
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.CharCase">
|
|
<short>
|
|
<i>CharCase</i> - rules for what case to use (upper or lower) to display text</short>
|
|
<descr>
|
|
<p>Indicates how text is displayed in a text editing control in the following ways:</p>
|
|
<ul>
|
|
<li>Normal case letters</li>
|
|
<li>Upper case letters</li>
|
|
<li>Lower case letters</li>
|
|
</ul>
|
|
<p>The rules can, of course, be overridden by use of the shift key.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Color">
|
|
<short>Determine the colour for the current control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
|
<p>The default colour is the same as the window in which the control is located.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Constraints">
|
|
<short>Determine <i>Constraints</i> (max and min height and width) for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determine <i>Constraints</i> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Ctl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.DragCursor">
|
|
<short>
|
|
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.DragKind">
|
|
<short>DragKind - what sort of dragging? Drag or Dock</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.DragMode">
|
|
<short>
|
|
<i>DragMode </i>- whether manual or automatic</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Enabled">
|
|
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
|
|
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.EditMask">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Font">
|
|
<short>The <i>Font</i> to be used for text in this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
|
<p>The properties of <i>Font</i> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.MaxLength">
|
|
<short>
|
|
<i>MaxLength</i>: maximum length allowed for text string</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.ParentColor">
|
|
<short>
|
|
<i>ParentColor</i> - should the control have the same colour as the parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.ParentCtl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.ParentFont">
|
|
<short>
|
|
<i>ParentFont </i>- should the control use the same font as the parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.ParentShowHint">
|
|
<short>
|
|
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.PasswordChar">
|
|
<short>
|
|
<i>PasswordChar</i>: the character which appears in the Edit box replacing and masking the actual character typed</short>
|
|
<descr>
|
|
<p>
|
|
<i>PasswordChar</i>
|
|
|
|
|
|
|
|
: the character which appears in the Edit box replacing and masking the actual character typed.</p>
|
|
<p>Typically used in password input, to prevent the typed characters from being seen by passers-by or casual observers (or even malicious observers!)</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.PopupMenu">
|
|
<short>PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads the details of the pop-up menu, or stores them.<br/>
|
|
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.ShowHint">
|
|
<short>Flag to determine: Is hint to be displayed for this control?</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.TabOrder">
|
|
<short>The place this control occupies in the list of tabs</short>
|
|
<descr>Reads or writes information in flag; default is -1
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.TabStop">
|
|
<short>
|
|
<i>TabStop</i> - determines if the user can tab to a control.</short>
|
|
<descr>
|
|
<p>Reads or writes boolean flag; default is False</p>
|
|
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
|
<p>If <i>TabStop</i> is True, the control is in the tab order. If <i>TabStop</i> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Text">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.Visible">
|
|
<short>
|
|
<i>Visible</i> - can the control be seen?</short>
|
|
<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>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnChange">
|
|
<short>OnChange - event handler for any change in text</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnClick">
|
|
<short>Event Handler for mouse click</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
|
|
</p>
|
|
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnDblClick">
|
|
<short>Event Handle for mouse double-click</short>
|
|
<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>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnDragDrop">
|
|
<short>Event handler for the Drag-Drop manoeuvre</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnDragOver">
|
|
<short>Event handler for the case when a control is dragged over another control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnEndDrag">
|
|
<short>Event handler for the end of a dragging process</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnEnter">
|
|
<short>
|
|
<i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnExit">
|
|
<short>
|
|
<i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnKeyDown">
|
|
<short>
|
|
<i>OnKeyDown</i> - event handler for instance when key is down while control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyDown</i>
|
|
- event handler for instance when key is down while control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <i>OnKeyPress</i> the key needs to become pressed while the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnKeyPress">
|
|
<short>OnKeyPress - event controller for a key being pressed while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyPress</i>
|
|
- event controller for a key being pressed while the control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <i>OnKeyDown</i> the key may have already been down when the control received focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnKeyUp">
|
|
<short>
|
|
<i>OnKeyUp</i> - event handler for instance when a key is up (not pressed) while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyUp</i>
|
|
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
|
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnMouseDown">
|
|
<short>Event handler for when a mouse button is pressed down</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnMouseMove">
|
|
<short>Event handler for mouse movement within the current control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnMouseUp">
|
|
<short>Event handler for when the mouse button is released, ie "up"</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBEdit.OnStartDrag">
|
|
<short>Event handler for start of dragging process</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBText">
|
|
<short>
|
|
<i>TDBText</i> - a data-aware text component to display a single text-string from a dataset</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBText.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBText.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBText.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBText.ActiveChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBText.ActiveChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBText.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBText.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBText.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBText.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBText.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBText.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBText.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBText.SetDataField.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBText.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBText.SetDataSource.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBText.Loaded">
|
|
<short>Called when the component has finished loading.</short>
|
|
<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
|
|
system. Descendents of <var>TComponent</var> should override this method to
|
|
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
|
|
is done automatically by the streaming system.
|
|
</p>
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBText.Notification">
|
|
<short>Called by components that are freed and which received a FreeNotification.</short>
|
|
<descr>
|
|
<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
|
|
((with <link id="TComponent.FreeNotification">FreeNotification</link>)
|
|
will also call <var>Notification</var> when they are freed.
|
|
</p>
|
|
<p>The <var>AComponent</var> parameter specifies which component sends the
|
|
notification, and <var>Operation</var> specifies whether the component is
|
|
being inserted into or removed from the child component list, or whether it
|
|
is being destroyed.
|
|
</p>
|
|
<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>)
|
|
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.
|
|
</p>
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBText.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBText.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBText.Create">
|
|
<short>Create a new instance of a Graphic Control</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBText.Create.AOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBText.Destroy">
|
|
<short>Destroy this instance of a graphic control and return its resources</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBText.Field">
|
|
<short>The field in the DataSet to which this control is to be linked. Can be referred to by name, or as an index</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Align">
|
|
<short>Used to align the control in one of four directions.</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</p>
|
|
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Alignment">
|
|
<short>
|
|
<i>Alignment </i>- whether text is centered, left- or right-justified</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Anchors">
|
|
<short>The set of anchor definitions for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
|
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.AutoSize">
|
|
<short>Whether auto-size is to be used</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
|
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Caption">
|
|
<short>
|
|
<i>Caption</i> - the text-string appearing on the Control, usually used to identify its function</short>
|
|
<descr>
|
|
<p>Gets caption as a text-string (<i>GetText</i>), or stores the new caption (<i>SetText</i>). Shows flag if caption is stored (<i>IsCaptionStored</i>).</p>
|
|
<p>By default, the <i>Caption</i> appears the same as the control <i>Name</i> 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 <i>Get/SetTextBuf</i> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
|
|
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <i>RealGet/SetText</i> is
|
|
introduced. These functions interface with the LCLInterface. </p>
|
|
<p>The default <i>Get/SetTextBuf</i> implementation calls the <i>RealGet/SetText</i>. As long as the <i>Get/SetTextBuf</i> isn't overridden <i>Get/SetText</i> calls <i>RealGet/SetText</i> to avoid PChar copying.</p>
|
|
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Color">
|
|
<short>Determine the colour for the current control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
|
<p>The default colour is the same as the window in which the control is located.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.DataField">
|
|
<short>The name of the field, as a string (ie cannot be referred to as an Index)</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.DataSource">
|
|
<short>The DataSource from which information is obtained to display in this control. Usually the result of a SQLQuery</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.FocusControl">
|
|
<short>
|
|
<i>FocusControl</i> - whether this control has focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Font">
|
|
<short>The <i>Font</i> to be used for text in this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
|
<p>The properties of <i>Font</i> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Layout">
|
|
<short>
|
|
<i>Layout</i> - How the Text is to be laid out in the text rectangle: at the Bottom, Centre or Top</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.ShowAccelChar">
|
|
<short>
|
|
<i>ShowAccelChar</i> - underline the character in the label that acts as an accelerator with a shortcut key</short>
|
|
<descr>
|
|
<p>
|
|
<i>ShowAccelChar</i>
|
|
|
|
|
|
|
|
- underline the character in the label that acts as an accelerator with a shortcut key</p>
|
|
<p>Boolean property - default True</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.Visible">
|
|
<short>
|
|
<i>Visible</i> - can the control be seen?</short>
|
|
<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>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBText.WordWrap">
|
|
<short>
|
|
<i>WordWrap</i> - whether a word is to be wrapped to the next line if the text is about to become too long for the width available</short>
|
|
<descr>
|
|
<p>
|
|
<i>WordWrap</i>
|
|
|
|
|
|
|
|
- whether a word is to be wrapped to the next line if the text is about to become too long for the width available</p>
|
|
<p>Boolean property, default False</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBListBox">
|
|
<short>
|
|
<i>TDBListBox </i>- a data-aware version of <i>TListBox,</i> for displaying lists of entries from a field in a database</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TDBListBox.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.EditingChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.EditingChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.FocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.FocusRequest.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBListBox.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBListBox.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBListBox.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBListBox.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBListBox.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBListBox.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.SetItems">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.SetItems.Values">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBListBox.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBListBox.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.SetReadOnly.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.SetDataField.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBListBox.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.SetDataSource.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBListBox.KeyDown">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.KeyDown.Key">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.KeyDown.Shift">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBListBox.Loaded">
|
|
<short>Called when the component has finished loading.</short>
|
|
<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
|
|
system. Descendents of <var>TComponent</var> should override this method to
|
|
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
|
|
is done automatically by the streaming system.
|
|
</p>
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBListBox.Notification">
|
|
<short>Called by components that are freed and which received a FreeNotification.</short>
|
|
<descr>
|
|
<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
|
|
((with <link id="TComponent.FreeNotification">FreeNotification</link>)
|
|
will also call <var>Notification</var> when they are freed.
|
|
</p>
|
|
<p>The <var>AComponent</var> parameter specifies which component sends the
|
|
notification, and <var>Operation</var> specifies whether the component is
|
|
being inserted into or removed from the child component list, or whether it
|
|
is being destroyed.
|
|
</p>
|
|
<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>)
|
|
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.
|
|
</p>
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBListBox.Click">
|
|
<short>
|
|
<i>Click</i> - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same <i>Action</i> as that associated with the <i>OnClick</i> event</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBListBox.EditingDone">
|
|
<short>
|
|
<i>EditingDone</i> - what to do when you have finished editing</short>
|
|
<descr>
|
|
<p>
|
|
<i>TControl.EditingDone</i>
|
|
</p>
|
|
<p>Called when user has finished editing. This procedure can be used by data links to commit the changes.</p>
|
|
<p>For example:</p>
|
|
<ul>
|
|
<li>When focus switches to another control (default)</li>
|
|
<li>When user selected another item</li>
|
|
</ul>
|
|
<p>It's totally up to the control, what events will commit.</p>
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBListBox.Create">
|
|
<short>Create a new instance of the Window Control</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBListBox.Create.AOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBListBox.Destroy">
|
|
<short>Destroy this instance of the Window Control, and return the resources used</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBListBox.Field">
|
|
<short>The Field of the DataSet for which data are to be displayed</short>
|
|
<descr>Regers to the whole Field entity, not just its name</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.DataField">
|
|
<short>The name (as a string) of the Field for which data are to be displayed</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.DataSource">
|
|
<short>The DataSource from which Field data are to be displayed - usually the results of a database query</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.Items">
|
|
<short>The array of strings representing the list of entries in the list box</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.ReadOnly">
|
|
<short>
|
|
<i>ReadOnly</i> - if True, data can be seen and displayed but not writen or modified</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.Align">
|
|
<short>Used to align the control in one of four directions.</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</p>
|
|
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.Anchors">
|
|
<short>The set of anchor definitions for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
|
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.BorderStyle">
|
|
<short>
|
|
<i>BorderStyle</i> - none, or single</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.ExtendedSelect">
|
|
<short>
|
|
<i>ExtendedSelect</i> - boolean. Whether extended selection is allowed. Default True</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.ItemHeight">
|
|
<short>
|
|
<i>ItemHeight </i>- the height of the individual <i>Items</i>
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.MultiSelect">
|
|
<short>
|
|
<i>MultiSelect</i> - allows more than one Item from the list to be selected at a time, by pressing the CTRL or SHIFT key while selecting</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnClick">
|
|
<short>Event Handler for mouse click</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
|
|
</p>
|
|
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnDblClick">
|
|
<short>Event Handle for mouse double-click</short>
|
|
<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>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnDrawItem">
|
|
<short>
|
|
<i>OnDrawItem</i> - event handler for drawing an Item</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnDrawItem</i>
|
|
|
|
|
|
|
|
- event handler for drawing an Item</p>
|
|
<p>For example, selecting an item may require it to be highlighted or have its font or background changed</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnEnter">
|
|
<short>
|
|
<i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnExit">
|
|
<short>
|
|
<i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnKeyPress">
|
|
<short>OnKeyPress - event controller for a key being pressed while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyPress</i>
|
|
- event controller for a key being pressed while the control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <i>OnKeyDown</i> the key may have already been down when the control received focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnKeyDown">
|
|
<short>
|
|
<i>OnKeyDown</i> - event handler for instance when key is down while control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyDown</i>
|
|
- event handler for instance when key is down while control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <i>OnKeyPress</i> the key needs to become pressed while the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnKeyUp">
|
|
<short>
|
|
<i>OnKeyUp</i> - event handler for instance when a key is up (not pressed) while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyUp</i>
|
|
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
|
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnMouseMove">
|
|
<short>Event handler for mouse movement within the current control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnMouseDown">
|
|
<short>Event handler for when a mouse button is pressed down</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnMouseUp">
|
|
<short>Event handler for when the mouse button is released, ie "up"</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.OnResize">
|
|
<short>Event Handler for resize of control</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads or Writes flag if control is re-sized.
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.ParentShowHint">
|
|
<short>
|
|
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.ShowHint">
|
|
<short>Flag to determine: Is hint to be displayed for this control?</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.Sorted">
|
|
<short>
|
|
<i>Sorted</i> - whether the selected <i>Items</i> in the list have been arranged in alphabetical order</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.Style">
|
|
<short>
|
|
<i>Style </i>of List Box - normal, owner-draw fixed, or owner-draw variable</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.TabOrder">
|
|
<short>The place this control occupies in the list of tabs</short>
|
|
<descr>Reads or writes information in flag; default is -1
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.TabStop">
|
|
<short>
|
|
<i>TabStop</i> - determines if the user can tab to a control.</short>
|
|
<descr>
|
|
<p>Reads or writes boolean flag; default is False</p>
|
|
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
|
<p>If <i>TabStop</i> is True, the control is in the tab order. If <i>TabStop</i> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.TopIndex">
|
|
<short>
|
|
<i>Topindex </i>- the highest value of Index in this list</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBListBox.Visible">
|
|
<short>
|
|
<i>Visible</i> - can the control be seen?</short>
|
|
<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>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBRadioGroup">
|
|
<short>
|
|
<i>TDBRadioGroup</i> - a data-aware version of <i>TRadioGroup,</i> providing a series of mutually exclusive buttons to select an entry to insert into a database field</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
<descr>
|
|
<p>The properties of TDBRadioGroup are similar to those of TRadioGroup (and TCustomRadioGroup). Access is obtained to members of the group by selecting (in the Object Inspector) the ellipsis (...) next to the entry <b>Items</b>, and then editing the stringlist. </p>
|
|
<p>At runtime, selecting one of the radiobuttons makes the corresponding ItemIndex available to the programmer, and the corresponding string Item gets selected and appears as the string value for the record in that field.</p>
|
|
</descr>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBRadioGroup.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBRadioGroup.FOnChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBRadioGroup.FValue">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBRadioGroup.FInSetValue">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBRadioGroup.FValues">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBRadioGroup.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBRadioGroup.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBRadioGroup.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBRadioGroup.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBRadioGroup.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBRadioGroup.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBRadioGroup.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBRadioGroup.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBRadioGroup.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.SetDataField.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBRadioGroup.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.SetDataSource.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBRadioGroup.SetItems">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.SetItems.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBRadioGroup.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.SetReadOnly.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBRadioGroup.SetValue">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.SetValue.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBRadioGroup.SetValues">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.SetValues.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBRadioGroup.Change">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBRadioGroup.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBRadioGroup.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBRadioGroup.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- property Visibility: protected -->
|
|
<element name="TDBRadioGroup.DataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: protected -->
|
|
<element name="TDBRadioGroup.GetButtonValue">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBRadioGroup.GetButtonValue.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.GetButtonValue.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBRadioGroup.UpdateRadioButtonStates">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBRadioGroup.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBRadioGroup.EditingDone">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBRadioGroup.Create">
|
|
<short>Create a new instance of the Window Control</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBRadioGroup.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBRadioGroup.Destroy">
|
|
<short>Destroy this instance of the Window Control, and return the resources used</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBRadioGroup.Field">
|
|
<short>The DataSet Field relevant to the data being selected</short>
|
|
<descr>Refers to the complete Field entity, not just its name</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBRadioGroup.ItemIndex">
|
|
<short>The Index value in the list of Items (a stringlist with the names of the selections for radio buttons)</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBRadioGroup.Value">
|
|
<short>The selected value (as indicated by ItemIndex)</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Align">
|
|
<short>Used to align the control in one of four directions.</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</p>
|
|
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Anchors">
|
|
<short>The set of anchor definitions for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
|
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Caption">
|
|
<short>
|
|
<i>Caption</i> - the text-string appearing on the Control, usually used to identify its function</short>
|
|
<descr>
|
|
<p>Gets caption as a text-string (<i>GetText</i>), or stores the new caption (<i>SetText</i>). Shows flag if caption is stored (<i>IsCaptionStored</i>).</p>
|
|
<p>By default, the <i>Caption</i> appears the same as the control <i>Name</i> 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 <i>Get/SetTextBuf</i> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
|
|
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <i>RealGet/SetText</i> is
|
|
introduced. These functions interface with the LCLInterface. </p>
|
|
<p>The default <i>Get/SetTextBuf</i> implementation calls the <i>RealGet/SetText</i>. As long as the <i>Get/SetTextBuf</i> isn't overridden <i>Get/SetText</i> calls <i>RealGet/SetText</i> to avoid PChar copying.</p>
|
|
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Columns">
|
|
<short>
|
|
<i>Columns</i> - the number of columns in which the <i>Items</i> (radio buttons) are to be arranges</short>
|
|
<descr>
|
|
<p>Don't confuse this with the Columns entity in a DBGrid, nor with the COLUMNS entity in a SQL database - it simply refers to the number of columns of radiobuttons to be displayed</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.DataField">
|
|
<short>The name (as a string) of the Field whose data are linked to the control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.DataSource">
|
|
<short>The DataSource from which relevant Field data are to be linked - usually the result of a database query</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Enabled">
|
|
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
|
|
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Items">
|
|
<short>
|
|
<i>Items</i> - a string list containing the captions for the radio boxes</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.OnChange">
|
|
<short>Event Handler for any change in the radiogroup selection</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.OnChangeBounds">
|
|
<short>Event handler for a change in bounds of the control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads or Writes flag if bounds are changed</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.OnClick">
|
|
<short>Event Handler for mouse click</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
|
|
</p>
|
|
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.OnMouseDown">
|
|
<short>Event handler for when a mouse button is pressed down</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.OnMouseMove">
|
|
<short>Event handler for mouse movement within the current control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.OnMouseuP">
|
|
<short>Event handler for when the mouse button is released, ie "up"</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.OnResize">
|
|
<short>Event Handler for resize of control</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads or Writes flag if control is re-sized.
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.ReadOnly">
|
|
<short>
|
|
<i>ReadOnly</i> - if True, data can only be read, not written or modified. (Doesn't really make sense for a RadioGroup!)</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Values">
|
|
<short>The <i>values</i> of the strings in <i>Items</i>
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBRadioGroup.Visible">
|
|
<short>
|
|
<i>Visible</i> - can the control be seen?</short>
|
|
<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>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBCheckBox">
|
|
<short>
|
|
<i>TDBCheckBox</i> - a data-aware checkbox for use with logical fields in a database</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCheckBox.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCheckBox.FValueCheck">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCheckBox.FValueUncheck">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBCheckBox.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCheckBox.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBCheckBox.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCheckBox.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBCheckBox.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCheckBox.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBCheckBox.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCheckBox.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCheckBox.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.SetDataField.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCheckBox.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.SetDataSource.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCheckBox.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.SetReadOnly.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCheckBox.SetValueCheck">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.SetValueCheck.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCheckBox.SetValueUncheck">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.SetValueUncheck.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBCheckBox.ValueEqualsField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCheckBox.ValueEqualsField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.ValueEqualsField.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.ValueEqualsField.AFieldText">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: protected -->
|
|
<element name="TDBCheckBox.GetFieldCheckState">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCheckBox.GetFieldCheckState.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCheckBox.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCheckBox.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCheckBox.FocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.FocusRequest.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCheckBox.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCheckBox.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCheckBox.EditingDone">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBCheckBox.Create">
|
|
<short>Create a new instance of this component</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCheckBox.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBCheckBox.Destroy">
|
|
<short>Destroy this instance of the Window Control, and return the resources used</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCheckBox.Checked">
|
|
<short>Whether the box is checked</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCheckBox.Field">
|
|
<short>The Field in the DataSet with which the box is to be associated</short>
|
|
<descr>
|
|
<p>Refers to the whole Field entity, not just its name</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCheckBox.State">
|
|
<short>Indicates whether the check box is checked (selected), unchecked (deselected) or grayed.</short>
|
|
<descr>
|
|
<p>See <link id="#lcl.StdCtrls.TCheckBoxState">TCheckBoxState</link> for possible values of <i>State</i>.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.AllowGrayed">
|
|
<short>Determines whether the check box can be in a "grayed" state.</short>
|
|
<descr>
|
|
<p>If <i>AllowGrayed</i> is set to True, the check box has three possible states: checked, unchecked and grayed. If <i>AllowGrayed</i> is set to False, the check box has only two possible states: checked and unchecked.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.Anchors">
|
|
<short>The set of anchor definitions for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
|
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.AutoSize">
|
|
<short>Whether auto-size is to be used</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>AutoSize permits the size of a control to be adjusted automatically, for example a button can become bigger or smaller to accommodate a longer or shorter caption.</p>
|
|
<p>Reads logical (boolean) flag to see whether auto-sizing is to be operated, or writes the flag to say it should be done. Default is false, ie no auto-sizing</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.Caption">
|
|
<short>
|
|
<i>Caption</i> - the text-string appearing on the Control, usually used to identify its function</short>
|
|
<descr>
|
|
<p>Gets caption as a text-string (<i>GetText</i>), or stores the new caption (<i>SetText</i>). Shows flag if caption is stored (<i>IsCaptionStored</i>).</p>
|
|
<p>By default, the <i>Caption</i> appears the same as the control <i>Name</i> 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 <i>Get/SetTextBuf</i> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
|
|
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <i>RealGet/SetText</i> is
|
|
introduced. These functions interface with the LCLInterface. </p>
|
|
<p>The default <i>Get/SetTextBuf</i> implementation calls the <i>RealGet/SetText</i>. As long as the <i>Get/SetTextBuf</i> isn't overridden <i>Get/SetText</i> calls <i>RealGet/SetText</i> to avoid PChar copying.</p>
|
|
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
|
|
</descr>
|
|
<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>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.DataSource">
|
|
<short>The DataSource containing the Field that is to be associated with this checkbox</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.DragCursor">
|
|
<short>
|
|
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.DragKind">
|
|
<short>DragKind - what sort of dragging? Drag or Dock</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.DragMode">
|
|
<short>
|
|
<i>DragMode </i>- whether manual or automatic</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.Enabled">
|
|
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
|
|
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.Hint">
|
|
<short>
|
|
<i>Hint</i> - a small informative pop-up box that appears when the mouse 'hovers' over a control</short>
|
|
<descr>
|
|
<p>
|
|
<i>Hint</i>
|
|
- a small informative pop-up box that appears when the mouse 'hovers' over a control</p>
|
|
<p>Requires <i>ShowHint</i> to be True</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnChange">
|
|
<short>
|
|
<i>OnChange </i>- event handler for any change in properties of the control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnClick">
|
|
<short>Event Handler for mouse click</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
|
|
</p>
|
|
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnDragDrop">
|
|
<short>Event handler for the Drag-Drop manoeuvre</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnDragOver">
|
|
<short>Event handler for the case when a control is dragged over another control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnEndDrag">
|
|
<short>Event handler for the end of a dragging process</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnEnter">
|
|
<short>
|
|
<i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnExit">
|
|
<short>
|
|
<i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnMouseDown">
|
|
<short>Event handler for when a mouse button is pressed down</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnMouseMove">
|
|
<short>Event handler for mouse movement within the current control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnMouseUp">
|
|
<short>Event handler for when the mouse button is released, ie "up"</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.OnStartDrag">
|
|
<short>Event handler for start of dragging process</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.ParentShowHint">
|
|
<short>
|
|
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.PopupMenu">
|
|
<short>PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads the details of the pop-up menu, or stores them.<br/>
|
|
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.ReadOnly">
|
|
<short>
|
|
<i>ReadOnly </i>- if True, data may be read but not written or modified (doesn't make much sense for a check-box unless the box is NOT Enabled!)</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.ShowHint">
|
|
<short>Flag to determine: Is hint to be displayed for this control?</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.TabOrder">
|
|
<short>The place this control occupies in the list of tabs</short>
|
|
<descr>Reads or writes information in flag; default is -1
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.TabStop">
|
|
<short>Is the control in the sequence of controls accessed by successive presses of the Tab key?</short>
|
|
<descr>Use the TabStop to allow or disallow access to the control using the Tab key.
|
|
|
|
If the TabStop is True, the control is in the tab order. If TabStop is False, the control is not in the tab order and the user can't press the Tab key to move to the control.
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.UseOnChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.ValueChecked">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.ValueUnchecked">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCheckBox.Visible">
|
|
<short>
|
|
<i>Visible</i> - can the control be seen?</short>
|
|
<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>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBComboBox">
|
|
<short>
|
|
<i>TDBComboBox</i> - a data-aware version of <i>TComboBox</i> to allow selection of a value from a list of entries into a database field</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
<descr>
|
|
<p>
|
|
<i>TDBComboBox </i>has properties similar to <i>TComboBox</i> and <i>TCustomComboBox</i>. It consists of an Edit Box which is th eData-aware part of the component, and a drop-down list box.</p>
|
|
<p>In a typical application a user would be presented with the drop-down list, would make a selection and then this would appear in the edit box and become the data value for that cell in the database. </p>
|
|
<p>So for example a list of countries might be presented, and the selected value from the list would be used to populate the appropriate field ('Country') in that record of the database.</p>
|
|
</descr>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBComboBox.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBComboBox.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBComboBox.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBComboBox.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBComboBox.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBComboBox.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBComboBox.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBComboBox.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBComboBox.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBComboBox.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.SetDataField.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBComboBox.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.SetDataSource.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBComboBox.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.SetReadOnly.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: protected -->
|
|
<element name="TDBComboBox.GetComboText">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBComboBox.GetComboText.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.SetComboText">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.SetComboText.NewText">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.EditingChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.EditingChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.FocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.FocusRequest.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBComboBox.EditingDone">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBComboBox.Create">
|
|
<short>Create a new instance of the Window Control</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBComboBox.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBComboBox.Destroy">
|
|
<short>Destroy this instance of the Window Control, and return the resources used</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBComboBox.Field">
|
|
<short>The field in the dataset to which this control is attached</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBComboBox.Text">
|
|
<short>
|
|
<i>Text</i> - the string appearing in the main box. If an item on the drop-down list is selected, it replaces the contents of <i>Text</i>
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBComboBox.ItemIndex">
|
|
<short>
|
|
<i>Index </i>- the number of the currently selected item (starting at zero)</short>
|
|
<descr>
|
|
<p>
|
|
<i>Index </i>
|
|
|
|
|
|
|
|
- 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
|
|
has value -1.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Anchors">
|
|
<short>The set of anchor definitions for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
|
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ArrowKeysTraverseList">
|
|
<short>
|
|
<i>ArrowKeysTraverseList</i> - enables the operator to use the keyboard Arrow keys to move through the list as an alternative to using the mouse</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.AutoDropDown">
|
|
<short>
|
|
<i>AutoDropDown </i>- if True, the drop-down list appears as soon as the cursor moves over the text box</short>
|
|
<descr>
|
|
<p>
|
|
<i>AutoDropDown </i>
|
|
|
|
|
|
|
|
- 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>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Ctl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.DataField">
|
|
<short>The name (as a string) of the Feild whose data are to be linked to the ComboBox</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.DataSource">
|
|
<short>The DataSet whose Field data are to be linked to the ComboBox</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.DropDownCount">
|
|
<short>
|
|
<i>DropDownCount </i>- number of entries in the drop-down list</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Enabled">
|
|
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
|
|
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Font">
|
|
<short>The <i>Font</i> to be used for text in this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
|
<p>The properties of <i>Font</i> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ItemHeight">
|
|
<short>
|
|
<i>ItemHeight</i> - the height of the current item in the drop-down list</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Items">
|
|
<short>
|
|
<i>Items </i>- an array of strings that holds the entries of the drop-down list</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ItemWidth">
|
|
<short>
|
|
<i>ItemWidth </i>- the width of the current item in the drop-down list</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.MaxLength">
|
|
<short>
|
|
<i>MaxLength </i>- the maximum allowed length of a string</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnChange">
|
|
<short>
|
|
<i>OnChange</i> - event handler for any change in properties of the combo box</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnClick">
|
|
<short>Event Handler for mouse click</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
|
|
</p>
|
|
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnCloseUp">
|
|
<short>
|
|
<i>OnCloseUp</i> - event handler for when the drop-down box is closed up again</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnDrawItem">
|
|
<short>
|
|
<i>OnDrawItem</i> - event handler for when an entry is written to the <i>Items </i>list</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnDropDown">
|
|
<short>
|
|
<i>OnDropDown </i>- event handler for when the drop-down list appears</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnEnter">
|
|
<short>
|
|
<i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnExit">
|
|
<short>
|
|
<i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnKeyDown">
|
|
<short>
|
|
<i>OnKeyDown</i> - event handler for instance when key is down while control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyDown</i>
|
|
- event handler for instance when key is down while control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <i>OnKeyPress</i> the key needs to become pressed while the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnKeyPress">
|
|
<short>OnKeyPress - event controller for a key being pressed while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyPress</i>
|
|
- event controller for a key being pressed while the control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <i>OnKeyDown</i> the key may have already been down when the control received focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.OnKeyUp">
|
|
<short>
|
|
<i>OnKeyUp</i> - event handler for instance when a key is up (not pressed) while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyUp</i>
|
|
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
|
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ParentCtl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ParentFont">
|
|
<short>
|
|
<i>ParentFont </i>- should the control use the same font as the parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ParentShowHint">
|
|
<short>
|
|
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ReadOnly">
|
|
<short>
|
|
<i>ReadOnly</i> - if True, data can only be read, not written or modified</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.ShowHint">
|
|
<short>Flag to determine: Is hint to be displayed for this control?</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Sorted">
|
|
<short>
|
|
<i>Sorted </i>- whether the entries in the drop-down list have been sorted</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Style">
|
|
<short>
|
|
<i>Style</i>: may be Simple, a single-line Drop-Down or a Drop-Down list, or some version drawn by the Owner</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.TabOrder">
|
|
<short>The place this control occupies in the list of tabs</short>
|
|
<descr>Reads or writes information in flag; default is -1
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.TabStop">
|
|
<short>
|
|
<i>TabStop</i> - determines if the user can tab to a control.</short>
|
|
<descr>
|
|
<p>Reads or writes boolean flag; default is False</p>
|
|
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
|
<p>If <i>TabStop</i> is True, the control is in the tab order. If <i>TabStop</i> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBComboBox.Visible">
|
|
<short>
|
|
<i>Visible</i> - can the control be seen?</short>
|
|
<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>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBMemo">
|
|
<short>
|
|
<i>TDBMemo </i> - a data-aware Memo box to process the multi-line text of a single field in a dataset</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBMemo.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBMemo.FAutoDisplay">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBMemo.FDBMemoFocused">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBMemo.FDBMemoLoaded">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBMemo.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBMemo.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBMemo.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBMemo.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBMemo.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBMemo.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBMemo.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBMemo.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBMemo.SetAutoDisplay">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.SetAutoDisplay.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBMemo.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.SetDataField.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBMemo.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.SetDataSource.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBMemo.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.SetReadOnly.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: protected -->
|
|
<element name="TDBMemo.WordWrapIsStored">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBMemo.WordWrapIsStored.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBMemo.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBMemo.EditingChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.EditingChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBMemo.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBMemo.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBMemo.FocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.FocusRequest.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBMemo.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBMemo.EditingDone">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBMemo.Create">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBMemo.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBMemo.Destroy">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TDBMemo.LoadMemo">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBMemo.Field">
|
|
<short>The field in the DataSet to which this control is to be linked. Can be referred to by name, or as an index</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.Align">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.Anchors">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.AutoDisplay">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.Color">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.DataField">
|
|
<short>The name of the field, as a string (ie cannot be referred to as an Index)</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.DataSource">
|
|
<short>The DataSource from which information is obtained to display in this control. Usually the result of a SQLQuery</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.Font">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.Lines">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.MaxLength">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.OnChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.OnEnter">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.OnExit">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.OnKeyDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.OnKeyPress">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.OnKeyUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.PopupMenu">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.ReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.ScrollBars">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.Tabstop">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.Visible">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBMemo.WordWrap">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBGroupBox">
|
|
<short>
|
|
<i>TDBGroupBox</i> - a data-aware version of <i>TGroupBox,</i> allowing a number of data-aware objects to be grouped together on a form</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TDBGroupBox.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBGroupBox.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBGroupBox.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBGroupBox.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBGroupBox.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBGroupBox.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBGroupBox.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBGroupBox.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBGroupBox.SetDataField.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBGroupBox.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBGroupBox.SetDataSource.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBGroupBox.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBGroupBox.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBGroupBox.Loaded">
|
|
<short>Called when the component has finished loading.</short>
|
|
<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
|
|
system. Descendents of <var>TComponent</var> should override this method to
|
|
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
|
|
is done automatically by the streaming system.
|
|
</p>
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBGroupBox.Notification">
|
|
<short>Called by components that are freed and which received a FreeNotification.</short>
|
|
<descr>
|
|
<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
|
|
((with <link id="TComponent.FreeNotification">FreeNotification</link>)
|
|
will also call <var>Notification</var> when they are freed.
|
|
</p>
|
|
<p>The <var>AComponent</var> parameter specifies which component sends the
|
|
notification, and <var>Operation</var> specifies whether the component is
|
|
being inserted into or removed from the child component list, or whether it
|
|
is being destroyed.
|
|
</p>
|
|
<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>)
|
|
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.
|
|
</p>
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBGroupBox.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBGroupBox.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBGroupBox.Create">
|
|
<short>Create a new instance of the Window Control</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBGroupBox.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBGroupBox.Destroy">
|
|
<short>Destroy this instance of the Window Control, and return the resources used</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBGroupBox.Field">
|
|
<short>The field in the DataSet to which this control is to be linked. Can be referred to by name, or as an index</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Align">
|
|
<short>Used to align the control in one of four directions.</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Either reads a flag containing alignment instructions (<i>FAlign</i>) or writes alignment instructions (<i>SetAlign</i>)</p>
|
|
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Anchors">
|
|
<short>The set of anchor definitions for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines how the control is to be anchored to its client or parent conrol</p>
|
|
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <i>IsAnchorsStored</i>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Caption">
|
|
<short>
|
|
<i>Caption</i> - the text-string appearing on the Control, usually used to identify its function</short>
|
|
<descr>
|
|
<p>Gets caption as a text-string (<i>GetText</i>), or stores the new caption (<i>SetText</i>). Shows flag if caption is stored (<i>IsCaptionStored</i>).</p>
|
|
<p>By default, the <i>Caption</i> appears the same as the control <i>Name</i> 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 <i>Get/SetTextBuf</i> to exchange text between widgets and VCL. This means a lot of (unnecesary) text copies. </p>
|
|
<p>The LCL uses strings for exchanging text (more efficient). To maintain VCL compatibility, the virtual <i>RealGet/SetText</i> is
|
|
introduced. These functions interface with the LCLInterface. </p>
|
|
<p>The default <i>Get/SetTextBuf</i> implementation calls the <i>RealGet/SetText</i>. As long as the <i>Get/SetTextBuf</i> isn't overridden <i>Get/SetText</i> calls <i>RealGet/SetText</i> to avoid PChar copying.</p>
|
|
<p>To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.ClientHeight">
|
|
<short>
|
|
<i>ClientHeight</i> - determines the height of the client within which the control exists</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Finds or sets the client height, and sets a flag if it has been stored</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.ClientWidth">
|
|
<short>
|
|
<i>ClientWidth</i> - determines the width of the client within which the control exists</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>
|
|
<i>ClientWidth</i>
|
|
- determines the width of the client within which the control exists; reads the width of the client control or sets the value. Sets flag if value is stored</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Color">
|
|
<short>Determine the colour for the current control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
|
<p>The default colour is the same as the window in which the control is located.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Constraints">
|
|
<short>Determine <i>Constraints</i> (max and min height and width) for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determine <i>Constraints</i> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Ctl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.DataField">
|
|
<short>The name of the field, as a string (ie cannot be referred to as an Index)</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.DataSource">
|
|
<short>The DataSource from which information is obtained to display in this control. Usually the result of a SQLQuery</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Enabled">
|
|
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
|
|
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Font">
|
|
<short>The <i>Font</i> to be used for text in this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
|
|
<p>The properties of <i>Font</i> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnClick">
|
|
<short>Event Handler for mouse click</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <i>ActionList</i>
|
|
</p>
|
|
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnDblClick">
|
|
<short>Event Handle for mouse double-click</short>
|
|
<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>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnEnter">
|
|
<short>
|
|
<i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnExit">
|
|
<short>
|
|
<i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnKeyDown">
|
|
<short>
|
|
<i>OnKeyDown</i> - event handler for instance when key is down while control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyDown</i>
|
|
- event handler for instance when key is down while control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <i>OnKeyPress</i> the key needs to become pressed while the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnKeyPress">
|
|
<short>OnKeyPress - event controller for a key being pressed while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyPress</i>
|
|
- event controller for a key being pressed while the control has focus</p>
|
|
<p>Differs from <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <i>OnKeyDown</i> the key may have already been down when the control received focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnKeyUp">
|
|
<short>
|
|
<i>OnKeyUp</i> - event handler for instance when a key is up (not pressed) while the control has focus</short>
|
|
<descr>
|
|
<p>
|
|
<i>OnKeyUp</i>
|
|
- event handler for instance when a key is up (not pressed) while the control has focus</p>
|
|
<p>The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnMouseDown">
|
|
<short>Event handler for when a mouse button is pressed down</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnMouseMove">
|
|
<short>Event handler for mouse movement within the current control</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnMouseUp">
|
|
<short>Event handler for when the mouse button is released, ie "up"</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.OnResize">
|
|
<short>Event Handler for resize of control</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads or Writes flag if control is re-sized.
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.ParentColor">
|
|
<short>
|
|
<i>ParentColor</i> - should the control have the same colour as the parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.ParentCtl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.ParentFont">
|
|
<short>
|
|
<i>ParentFont </i>- should the control use the same font as the parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.ParentShowHint">
|
|
<short>
|
|
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.PopupMenu">
|
|
<short>PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads the details of the pop-up menu, or stores them.<br/>
|
|
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.ShowHint">
|
|
<short>Flag to determine: Is hint to be displayed for this control?</short>
|
|
<descr>// standard properties, which should be supported by all descendants<br/>
|
|
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.TabOrder">
|
|
<short>The place this control occupies in the list of tabs</short>
|
|
<descr>Reads or writes information in flag; default is -1
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.TabStop">
|
|
<short>
|
|
<i>TabStop</i> - determines if the user can tab to a control.</short>
|
|
<descr>
|
|
<p>Reads or writes boolean flag; default is False</p>
|
|
<p>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
|
|
<p>If <i>TabStop</i> is True, the control is in the tab order. If <i>TabStop</i> is False, the control is not in the tab order and the user can't use the Tab key to move to the control.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBGroupBox.Visible">
|
|
<short>
|
|
<i>Visible</i> - can the control be seen?</short>
|
|
<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>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBImage">
|
|
<short>
|
|
<i>TDBImage </i>- a data-aware Image box to display a single image from a dataset</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
<descr>The Image is stored in the database as a Binary Large Object (BLOB)</descr>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBImage.FAutoDisplay">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBImage.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBImage.FQuickDraw">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBImage.FPictureLoaded">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBImage.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBImage.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBImage.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBImage.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBImage.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBImage.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBImage.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBImage.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBImage.SetAutoDisplay">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.SetAutoDisplay.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBImage.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.SetDataField.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBImage.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.SetDataSource.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBImage.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.SetReadOnly.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBImage.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBImage.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBImage.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBImage.LoadPicture">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBImage.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBImage.Create">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBImage.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBImage.Destroy">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBImage.Field">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Align">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.AutoDisplay">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.AutoSize">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Center">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Constraints">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.DataField">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.DataSource">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.OnClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.OnMouseDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.OnMouseMove">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.OnMouseUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Picture">
|
|
<short>The picture that is to be stored or displayed</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Proportional">
|
|
<short>True if image is proportional</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.QuickDraw">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.ReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Stretch">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Transparent">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBImage.Visible">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBCalendar">
|
|
<short>
|
|
<i>TDBCalendar</i> - a data-aware version of <i>TCalendar</i>, for selecting a date to put in a database field</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
<descr>A pop-up calendar appears, and the user can navigate through years, months and days to select the date that is required. When a date is selected, it is inserted into the Date field of the appropriate record in the database.</descr>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TDBCalendar.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.DataChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.DataChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.EditingChange">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.EditingChange.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.UpdateData">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.UpdateData.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.FocusRequest">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.FocusRequest.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBCalendar.GetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCalendar.GetDataField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBCalendar.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCalendar.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBCalendar.GetField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCalendar.GetField.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="TDBCalendar.GetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCalendar.GetReadOnly.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.SetReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.SetReadOnly.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.SetDate">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.SetDate.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.SetDataField">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.SetDataField.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="TDBCalendar.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.SetDataSource.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCalendar.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCalendar.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCalendar.EditingDone">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBCalendar.Create">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCalendar.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBCalendar.Destroy">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCalendar.Field">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.DataField">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.DataSource">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.Date">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.ReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.DisplaySettings">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.Visible">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.OnClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.OnMouseMove">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.OnMouseDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.OnDayChanged">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.OnMonthChanged">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBCalendar.OnYearChanged">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TDBNavGlyph">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavGlyph.ngEnabled">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavGlyph.ngDisabled">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TDBNavButtonType">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbFirst">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbPrior">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbNext">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbLast">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbInsert">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbDelete">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbEdit">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbPost">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbCancel">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonType.nbRefresh">
|
|
<short/>
|
|
</element>
|
|
<!-- set type Visibility: default -->
|
|
<element name="TDBNavButtonSet">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- set type Visibility: default -->
|
|
<element name="TDBNavButtonStyle">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonStyle.nsAllowTimer">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonStyle.nsFocusRect">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TDBNavButtonDirection">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonDirection.nbdHorizontal">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TDBNavButtonDirection.nbdVertical">
|
|
<short/>
|
|
</element>
|
|
<!-- alias type Visibility: default -->
|
|
<element name="TNavigateBtn">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TDBNavClickEvent">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBNavClickEvent.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBNavClickEvent.Button">
|
|
<short/>
|
|
</element>
|
|
<!-- constant Visibility: default -->
|
|
<element name="DefaultDBNavigatorButtons">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constant Visibility: default -->
|
|
<element name="DBNavButtonResourceName">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBCustomNavigator">
|
|
<short>
|
|
<i>TDBCustomNavigator</i> - the base class for <i>TDBNavigator</i>, a tool for navigating through the records of a dataset</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
<descr>
|
|
<p>
|
|
<i>TDBCustomNavigator</i> is the parent class for
|
|
<i>TDBNavigator</i>, 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>Cance</b>l the changes, and to <i>Refresh</i> the display from the database. The set of buttons for display can be customised in <i>VisibleButtons</i>, which allows display of individual buttons to be suppressed</p>
|
|
<p>If used in conjunction with a DataAware control such as <i>TDBGrid</i> or <i>TDBMemo</i> 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 <i>BtnClick</i> 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 <i>DataSource</i> property must be set to link to the appropriate set of data.</p>
|
|
</descr>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FBeforeAction">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FConfirmDelete">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FDirection">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FFlat">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FOnNavClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FShowButtonHints">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FVisibleButtons">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FDefaultHints">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FHints">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FUpdateButtonsNeeded">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBCustomNavigator.FUpdateButtonsLock">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBCustomNavigator.GetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCustomNavigator.GetDataSource.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TDBCustomNavigator.GetHints">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCustomNavigator.GetHints.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCustomNavigator.SetDataSource">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.SetDataSource.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCustomNavigator.SetDirection">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.SetDirection.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCustomNavigator.SetFlat">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.SetFlat.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCustomNavigator.SetHints">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.SetHints.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCustomNavigator.SetShowButtonHints">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.SetShowButtonHints.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TDBCustomNavigator.SetVisibleButtons">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.SetVisibleButtons.AValue">
|
|
<short/>
|
|
</element>
|
|
<!-- variable Visibility: protected -->
|
|
<element name="TDBCustomNavigator.Buttons">
|
|
<short>The list of Buttons included in the navigator tool</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.DataChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.EditingChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.ActiveChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.Loaded">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.Notification">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.Notification.AComponent">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.Notification.Operation">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.UpdateButtons">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.UpdateHints">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.HintsChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.HintsChanged.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.ButtonClickHandler">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.ButtonClickHandler.Sender">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.DoOnResize">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.BeginUpdateButtons">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBCustomNavigator.EndUpdateButtons">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBCustomNavigator.Create">
|
|
<short>Create an instance of this control</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.Create.TheOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBCustomNavigator.Destroy">
|
|
<short>Destroy the control and returns its resources</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TDBCustomNavigator.BtnClick">
|
|
<short>
|
|
<i>BtnClick</i> - procedure to respond to button clicks, and select an action from a list according to the value of the <i>Index</i> of the clicked button</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBCustomNavigator.BtnClick.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: public -->
|
|
<element name="TDBCustomNavigator.VisibleButtonCount">
|
|
<short>Finds the number of visible buttons</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TDBCustomNavigator.VisibleButtonCount.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.BeforeAction">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.ConfirmDelete">
|
|
<short>Should the user be asked for confirmation before a record is deleted? If True, a dialog appears asking for confirmation</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.DataSource">
|
|
<short>The Data Source to which the control must be linked in order to function</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.Direction">
|
|
<short>The direction in which the buttons appear: horizontal or vertical</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.Flat">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.Hints">
|
|
<short>A list of hints to be shown if the mouse hovers over a button</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.OnClick">
|
|
<short>The action to be taken when a navigator button is clicked</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.VisibleButtons">
|
|
<short>The set of visible buttons (some of them can be suppressed if their function appears redundant)</short>
|
|
<descr>
|
|
<p>The VisibleButtons entry in the Object Inspector can be used to set whether or not a particular button is to be visible.</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBCustomNavigator.ShowButtonHints">
|
|
<short>Determines whether button hints are to be shown</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBNavButton">
|
|
<short>
|
|
<var>TDBNavButton</var> - one of the <var>SpeedButtons</var> on a <var>TDBNavigator</var> tool</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBNavButton.FIndex">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBNavButton.FNavStyle">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBNavButton.Destroy">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBNavButton.NavStyle">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TDBNavButton.Index">
|
|
<short>
|
|
<var>Index</var> - the value from the enumerated type that specifies which button is being selected</short>
|
|
<descr>
|
|
<p>
|
|
<printshort id="TDBNavButton.Index"/>
|
|
</p>
|
|
<p>Button may be</p>
|
|
<p>nbFirst, nbPrior, nbNext, nbLast, nbInsert, nbDelete, nbEdit, nbPost, nbCancel, nbRefresh</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBNavDataLink">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TDBNavDataLink.FNavigator">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBNavDataLink.EditingChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBNavDataLink.DataSetChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TDBNavDataLink.ActiveChanged">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TDBNavDataLink.Create">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TDBNavDataLink.Create.TheNavigator">
|
|
<short/>
|
|
</element>
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TDBNavDataLink.Destroy">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TDBNavigator">
|
|
<short>
|
|
<i>TDBNavigator </i>- a data-aware Button-Bar to facilitate navigating between records of a dataset</short>
|
|
<seealso>
|
|
<link id="HowToUseDataAwareControls"/>
|
|
</seealso>
|
|
<descr>
|
|
<p>
|
|
<i>TDBNavigator</i> 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 <i>VisibleButtons</i> 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 <i>Index</i> value of the button clicked, and the procedure chooses which action to call dependent on the button index.</p>
|
|
<p>The <i>DataSource</i> property must be set to link to the appropriate set of data.</p>
|
|
</descr>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Align">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Alignment">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Anchors">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.AutoSize">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.BeforeAction">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.BevelInner">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.BevelOuter">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.BevelWidth">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.BorderStyle">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.BorderWidth">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Caption">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.ClientHeight">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.ClientWidth">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Color">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.ConfirmDelete">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.DataSource">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Direction">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.DragMode">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Enabled">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Flat">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Font">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Hints">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnDblClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnDragDrop">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnDragOver">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnEndDrag">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnEnter">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnExit">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnMouseDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnMouseMove">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnMouseUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnResize">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.OnStartDrag">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.ParentColor">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.ParentFont">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.ParentShowHint">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.PopupMenu">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.ShowHint">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.TabOrder">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.TabStop">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.Visible">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TDBNavigator.VisibleButtons">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: default -->
|
|
<element name="ExtractFieldName">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="ExtractFieldName.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="ExtractFieldName.Fields">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="ExtractFieldName.StartPos">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="FillBarChart">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="FillBarChart.BC">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="FillBarChart.DS">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="FillBarChart.LabelField">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="FillBarChart.ValueField">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="FillBarChart.AColor">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="Register">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<topic name="HowToUseDataAwareControls">
|
|
<short>
|
|
<i>HowToUseDataAwareControls</i> - Hints for accessing databases</short>
|
|
<descr>
|
|
<p>
|
|
<i>HowToUseDataAwareControls</i> - 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 <i>Components</i> 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 <i>DataBase Connection</i> 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 <i>TDataSource</i> from the Data Access tab of the Component Palette, and perhaps items such as <i>TSQLTransaction</i> and <i>TSQLQuery</i>, depending on the particular database you are using. The various database components need to be linked to each other, for example by setting the <i>Transaction</i> property of a database connector to the appropriate transaction component, and linking the <i>DataBase</i> property of the Transaction component back to the database connector; link the DataSource's <i>DataSet</i> property to the appropriate SQLQuery or other set of data, and its <i>Transaction</i> 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, colour and font etc. But there are also special properties to define the data to be displayed or modified. These include the <i>DataSource</i> property which must be set to link to the defined set of data, and often a <i>Field</i> 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 <i>TDBGrid</i> is capable of displaying and operating on multiple rows and columns, in a <i>StringGrid</i> 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 <i>TDBNavigator</i> 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 (eg by <i>TSQLQuery</i>) to select or extract some or all of the records which are then stored locally in the <i>DataSet</i>
|
|
</li>
|
|
<li>the contents of the <i>DataSet</i> 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 <i>DBGrid</i>, 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 <i>OnClick</i>, <i>OnChange</i>, <i>OnFinishedEdit</i> etc.</p>
|
|
<p>The following table shows the approximate correspondence between conventional and data-aware control classes</p>
|
|
<table>
|
|
<th>
|
|
<td>Standard Control</td>
|
|
<td>Data-Aware Control</td>
|
|
<td>Comment</td>
|
|
</th>
|
|
<tr>
|
|
<td>TCalendar</td>
|
|
<td>TDBCalendar</td>
|
|
<td>Select a date from pop-up calendar</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TCheckBox</td>
|
|
<td>TDBCheckBox</td>
|
|
<td>Check a box to show an option has been selected</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TComboBox</td>
|
|
<td>TDBComboBox</td>
|
|
<td>Select an option from a list and return it (or some custom text) in the main edit box</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TEdit</td>
|
|
<td>TDBEdit</td>
|
|
<td>Single-line text editing box</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TGroupBox</td>
|
|
<td>TDBGroupBox</td>
|
|
<td>A container for several related controls</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TImage</td>
|
|
<td>TDBImage</td>
|
|
<td>A Picture</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TListBox</td>
|
|
<td>TDBListBox</td>
|
|
<td>A list of string items</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TMemo</td>
|
|
<td>TDBMemo</td>
|
|
<td>Multiple-line text editing box</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TRadioGroup</td>
|
|
<td>TDBRadioGroup</td>
|
|
<td>A group of mutually exclusive Radio Buttons; only one at a time may be checked and selected. Note there is no data-aware equivalent of the isolated TRadioButton</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TText</td>
|
|
<td>TDBText</td>
|
|
<td>A simple text-string, usually read-only</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TStringGrid</td>
|
|
<td>TdbGrid</td>
|
|
<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>
|
|
</descr>
|
|
</topic>
|
|
<element name="TDBEdit.BorderSpacing">
|
|
<short>Determines the border spacing for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines the border spacing for this control</p>
|
|
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
|
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBText.DragCursor">
|
|
<short>
|
|
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
|
</element>
|
|
<element name="TDBText.DragMode">
|
|
<short>
|
|
<i>DragMode </i>- whether manual or automatic</short>
|
|
</element>
|
|
<element name="TDBText.OnDragDrop">
|
|
<short>Event handler for the Drag-Drop manoeuvre</short>
|
|
</element>
|
|
<element name="TDBText.OnDragOver">
|
|
<short>Event handler for the case when a control is dragged over another control</short>
|
|
</element>
|
|
<element name="TDBText.OnStartDrag">
|
|
<short>Event handler for start of dragging process</short>
|
|
</element>
|
|
<element name="TDBListBox.BorderSpacing">
|
|
<short>Determines the border spacing for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines the border spacing for this control</p>
|
|
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
|
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBListBox.DragCursor">
|
|
<short>
|
|
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
|
</element>
|
|
<element name="TDBListBox.DragMode">
|
|
<short>
|
|
<i>DragMode </i>- whether manual or automatic</short>
|
|
</element>
|
|
<element name="TDBListBox.OnDragDrop">
|
|
<short>Event handler for the Drag-Drop manoeuvre</short>
|
|
</element>
|
|
<element name="TDBListBox.OnDragOver">
|
|
<short>Event handler for the case when a control is dragged over another control</short>
|
|
</element>
|
|
<element name="TDBListBox.OnEndDrag">
|
|
<short>Event handler for the end of a dragging process</short>
|
|
</element>
|
|
<element name="TDBListBox.OnStartDrag">
|
|
<short>Event handler for start of dragging process</short>
|
|
</element>
|
|
<element name="TDBRadioGroup.BorderSpacing">
|
|
<short>Determines the border spacing for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines the border spacing for this control</p>
|
|
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
|
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBRadioGroup.DragCursor">
|
|
<short>
|
|
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
|
</element>
|
|
<element name="TDBRadioGroup.DragMode">
|
|
<short>
|
|
<i>DragMode </i>- whether manual or automatic</short>
|
|
</element>
|
|
<element name="TDBRadioGroup.OnDragDrop">
|
|
<short>Event handler for the Drag-Drop manoeuvre</short>
|
|
</element>
|
|
<element name="TDBRadioGroup.OnDragOver">
|
|
<short>Event handler for the case when a control is dragged over another control</short>
|
|
</element>
|
|
<element name="TDBRadioGroup.OnEndDrag">
|
|
<short>Event handler for the end of a dragging process</short>
|
|
</element>
|
|
<element name="TDBRadioGroup.OnStartDrag">
|
|
<short>Event handler for start of dragging process</short>
|
|
</element>
|
|
<element name="TDBCheckBox.BorderSpacing">
|
|
<short>Determines the border spacing for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines the border spacing for this control</p>
|
|
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
|
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBCheckBox.Color">
|
|
<short>Determine the colour for the current control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
|
<p>The default colour is the same as the window in which the control is located.</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBCheckBox.ParentColor">
|
|
<short>
|
|
<i>ParentColor</i> - should the control have the same colour as the parent? Default is true</short>
|
|
</element>
|
|
<element name="TDBComboBox.BorderSpacing">
|
|
<short>Determines the border spacing for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines the border spacing for this control</p>
|
|
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
|
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBComboBox.Color">
|
|
<short>Determine the colour for the current control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
|
|
<p>The default colour is the same as the window in which the control is located.</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBComboBox.DragCursor">
|
|
<short>
|
|
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
|
</element>
|
|
<element name="TDBComboBox.DragMode">
|
|
<short>
|
|
<i>DragMode </i>- whether manual or automatic</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnChangeBounds">
|
|
<short>Event handler for a change in bounds of the control</short>
|
|
<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">
|
|
<short>Event Handle for mouse double-click</short>
|
|
<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">
|
|
<short>Event handler for the Drag-Drop manoeuvre</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnDragOver">
|
|
<short>Event handler for the case when a control is dragged over another control</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnEditingDone">
|
|
<short>Event handler when editing is done</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnEndDrag">
|
|
<short>Event handler for the end of a dragging process</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnMouseDown">
|
|
<short>Event handler for when a mouse button is pressed down</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnMouseMove">
|
|
<short>Event handler for mouse movement within the current control</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnMouseUp">
|
|
<short>Event handler for when the mouse button is released, ie "up"</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnSelect">
|
|
<short>Event Handler for selection of an item in the ComboBox</short>
|
|
</element>
|
|
<element name="TDBComboBox.OnStartDrag">
|
|
<short>Event handler for start of dragging process</short>
|
|
</element>
|
|
<element name="TDBComboBox.ParentColor">
|
|
<short>
|
|
<i>ParentColor</i> - should the control have the same colour as the parent? Default is true</short>
|
|
</element>
|
|
<element name="TDBGroupBox.BorderSpacing">
|
|
<short>Determines the border spacing for this control</short>
|
|
<descr>
|
|
<p>// standard properties, which should be supported by all descendants</p>
|
|
<p>Determines the border spacing for this control</p>
|
|
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
|
|
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TDBGroupBox.DragCursor">
|
|
<short>
|
|
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
|
|
</element>
|
|
<element name="TDBGroupBox.DragMode">
|
|
<short>
|
|
<i>DragMode </i>- whether manual or automatic</short>
|
|
</element>
|
|
<element name="TDBGroupBox.OnDragDrop">
|
|
<short>Event handler for the Drag-Drop manoeuvre</short>
|
|
</element>
|
|
<element name="TDBGroupBox.OnDragOver">
|
|
<short>Event handler for the case when a control is dragged over another control</short>
|
|
</element>
|
|
<element name="TDBGroupBox.OnEndDrag">
|
|
<short>Event handler for the end of a dragging process</short>
|
|
</element>
|
|
<element name="TDBGroupBox.OnStartDrag">
|
|
<short>Event handler for start of dragging process</short>
|
|
</element>
|
|
</module>
|
|
<!-- DbCtrls -->
|
|
</package>
|
|
</fpdoc-descriptions>
|