paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-12 22:19:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - updates (mostly minor) to descriptions and links in Buttonpanel.xml, comctrls.xml, grids.xml, imglist.xml, maskedit.xml, printers.xml

Browse Source 
git-svn-id: trunk@18005 -
This commit is contained in:
kirkpatc 2008-12-31 21:46:29 +00:00
parent c0bf8bbc48
commit 0585e8a095
6 changed files with 206 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/xml/lcl/buttonpanel.xml
View File

@ -385,7 +385,7 @@
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomButtonPanel.ButtonOrder"> <element name="TCustomButtonPanel.ButtonOrder">
<short> <short>
<var>ButtonOrder</var> - the order in which the buttons are to appear on the panel</short> <var>ButtonOrder</var> - the order in which the series of buttons will appear on the panel</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>

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

@ -1793,9 +1793,11 @@
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TTabControlStrings.HotTrack"> <element name="TTabControlStrings.HotTrack">
<short> <short>
<var>HotTrack</var> - if True, the current Tab is a hot track, ie selected, focused and currently executing its functions</short> <var>HotTrack</var> - the property whereby the item under the mouse pointer becomes emphasised</short>
<descr/> <descr/>
<seealso/> <seealso>
<link id="#lcl.ComCtrls.TCustomListView.HotTrack">TCustomListView.HotTrack</link>
</seealso>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TTabControlStrings.Images"> <element name="TTabControlStrings.Images">
@ -1922,7 +1924,7 @@
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTabControlNoteBookStrings.NBChanging"> <element name="TTabControlNoteBookStrings.NBChanging">
<short> <short>
<var>NBChanging</var> - method for dealing with the process fo change in a NoteBook</short> <var>NBChanging</var> - method for dealing with the process for change in a NoteBook</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -2696,7 +2698,7 @@
<var>HotTrack</var> - the property whereby the item under the mouse pointer becomes emphasised</short> <var>HotTrack</var> - the property whereby the item under the mouse pointer becomes emphasised</short>
<descr/> <descr/>
<seealso> <seealso>
<link id="#lcl.ConCtrls.TCustomListView.HotTrack">TCustomListView.HotTrack</link> <link id="#lcl.ComCtrls.TCustomListView.HotTrack">TCustomListView.HotTrack</link>
</seealso> </seealso>
</element> </element>
<!-- property Visibility: protected --> <!-- property Visibility: protected -->
@ -5823,7 +5825,9 @@ cdsIndeterminate
</ul> </ul>
<p>This feature can be used in List Views and in TabControls</p> <p>This feature can be used in List Views and in TabControls</p>
</descr> </descr>
<seealso/> <seealso>
<link id="#lcl.ComCtrls.TCustomListView.HotTrack">TCustomListView.HotTrack</link>
</seealso>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomListView.HotTrackStyles"> <element name="TCustomListView.HotTrackStyles">

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

@ -3055,7 +3055,8 @@ The purpose of this method is to call event handler <i>OnBeforeSelection</i>.
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomGrid.DrawFocusRect"> <element name="TCustomGrid.DrawFocusRect">
<short/> <short>
<var>DrawFocusRect</var> - draw a rectangle with focus in the nominated cell</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -3286,7 +3287,8 @@ The purpose of this method is to call event handler <i>OnBeforeSelection</i>.
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomGrid.InvalidateCell"> <element name="TCustomGrid.InvalidateCell">
<short/> <short>
<var>InvalidateCell</var> - render a cell non-valid, and redraw if required</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -4421,7 +4423,8 @@ Application developers may use the OnSelection and OnBeforeSelection events to r
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomGrid.EndUpdate"> <element name="TCustomGrid.EndUpdate">
<short>Finish updating the grid</short> <short>
<var>EndUpdate</var> - Finish updating the grid</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -4432,7 +4435,9 @@ Application developers may use the OnSelection and OnBeforeSelection events to r
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomGrid.EndUpdate"> <element name="TCustomGrid.EndUpdate">
<short/> <short>
<var>EndUpdate</var> - Finish updating the grid</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -4527,7 +4532,7 @@ Application developers may use the OnSelection and OnBeforeSelection events to r
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomGrid.MouseToCell"> <element name="TCustomGrid.MouseToCell">
<short/> <short>Convert mouse coordinates to the position of a cell in the grid</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -7290,7 +7295,7 @@ Segunda linea de texto</descr>
<short/> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TGridColumn.Assign"> <element name="TGridColumn.Assign" link="#rtl.Classes.TPersistent.Assign">
<short/> <short/>
<descr/> <descr/>
<errors/> <errors/>
@ -7429,14 +7434,16 @@ Segunda linea de texto</descr>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TGridColumn.AllColumnsChange"> <element name="TGridColumn.AllColumnsChange">
<short/> <short>
<var>AllColumnsChange</var> - method for processing a change in al columns</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- function Visibility: protected --> <!-- function Visibility: protected -->
<element name="TGridColumn.CreateTitle"> <element name="TGridColumn.CreateTitle">
<short/> <short>
<var>CreateTitle</var> - creates a column title and returns it in the result</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -7447,12 +7454,13 @@ Segunda linea de texto</descr>
</element> </element>
<!-- property Visibility: protected --> <!-- property Visibility: protected -->
<element name="TGridColumn.IsDefaultFont"> <element name="TGridColumn.IsDefaultFont">
<short/> <short>
<var>IsDefaultFont</var> - if True, the default font is being used</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TGridColumn.Create"> <element name="TGridColumn.Create" link="#rtl.Classes.TCollectionItem.Create">
<short/> <short/>
<descr/> <descr/>
<errors/> <errors/>
@ -7463,7 +7471,7 @@ Segunda linea de texto</descr>
<short/> <short/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TGridColumn.Destroy"> <element name="TGridColumn.Destroy" link="#rtl.Classes.TCollectionItem.Destroy">
<short/> <short/>
<descr/> <descr/>
<errors/> <errors/>
@ -7471,14 +7479,16 @@ Segunda linea de texto</descr>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TGridColumn.FillDefaultFont"> <element name="TGridColumn.FillDefaultFont">
<short/> <short>
<var>FillDefaultFont</var> - method to fill all cells in the column with the default font</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TGridColumn.IsDefault"> <element name="TGridColumn.IsDefault">
<short/> <short>
<var>IsDefault</var> - returns True if this column is the default</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -9778,13 +9788,15 @@ Segunda linea de texto</descr>
</element> </element>
<!-- property Visibility: protected --> <!-- property Visibility: protected -->
<element name="TCustomGrid.HeaderHotZones"> <element name="TCustomGrid.HeaderHotZones">
<short/> <short>
<var>HeaderHotZones</var> - the zones of the header that are under the cursor, so are capable of being selected or pushed (or not!)</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: protected --> <!-- property Visibility: protected -->
<element name="TCustomGrid.HeaderPushZones"> <element name="TCustomGrid.HeaderPushZones">
<short/> <short>
<var>HeaderPushZones</var> - the zones of the header that have been selected by the cursor, or pushed</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -11149,7 +11161,8 @@ Segunda linea de texto</descr>
<element name="TStringGridStrings"> <element name="TStringGridStrings">
<short> <short>
<var>TStringGridStrings</var> - the strings that populate the cells of a TStringGrid</short> <var>TStringGridStrings</var> - the strings that populate the cells of a TStringGrid</short>
<descr/> <descr>All of the properties are defined in the ancestor classes (<var>TStrings</var> etc)
</descr>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
@ -12673,10 +12686,7 @@ Segunda linea de texto</descr>
<short> <short>
<var>msg_SetPos</var> - issues a message to specify the position</short> <var>msg_SetPos</var> - issues a message to specify the position</short>
</element> </element>
<element name="TCompositeCellEditor.VisibleChanging"> <element name="TCompositeCellEditor.VisibleChanging" link="#LCL.Controls.TControl.VisibleChanging"/>
<short>
<var>VisibleChanging</var> - method for a change in the Visibility property</short>
</element>
<element name="TCompositeCellEditor.SendChar"> <element name="TCompositeCellEditor.SendChar">
<short> <short>
<var>SendChar</var> - transmits the specified character and returns an integer status result</short> <var>SendChar</var> - transmits the specified character and returns an integer status result</short>
@ -12750,6 +12760,51 @@ Segunda linea de texto</descr>
<element name="TStringGrid.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/> <element name="TStringGrid.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/>
<element name="TStringGrid.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/> <element name="TStringGrid.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TStringGrid.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/> <element name="TStringGrid.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
<element name="TGridColumn.GetValueChecked">
<short>
<var>GetValueChecked</var> - returns a checked value as a string</short>
</element>
<element name="TGridColumn.GetValueUnchecked">
<short>
<var>GetValueUnchecked</var> - returns an unchecked value as a string</short>
</element>
<element name="TGridColumn.ValueChecked">
<short>
<var>ValueChecked</var> - a string value of a checked item</short>
</element>
<element name="TGridColumn.ValueUnchecked">
<short>
<var>ValueUnchecked</var> - a string value of an unchecked item</short>
</element>
<element name="TCustomGrid.DrawGridCheckboxBitmaps">
<short>
<var>DrawGridCheckboxBitmaps</var> - draws checkbox bitmaps in th enominated rectangle with the specified checkbox state</short>
</element>
<element name="TCustomGrid.OnUserCheckboxBitmap">
<short>
<var>OnUserCheckboxBitmap</var> - event handler for a user accessing a checkbox bitmap</short>
</element>
<element name="TCustomDrawGrid.GetCheckBoxState">
<short>
<var>GetCheckBoxState</var> - returns the state of the checkbox at the specified position</short>
</element>
<element name="TCustomDrawGrid.SetCheckboxState">
<short>
<var>SetCheckboxState</var> - specifies the state of the checkbox in the nominated cell</short>
</element>
<element name="TCustomDrawGrid.ToggleCheckbox">
<short>
<var>ToggleCheckbox</var> - toggles checkbox state between checked and unchecked</short>
</element>
<element name="TCustomDrawGrid.OnGetCheckboxState">
<short>
<var>OnGetCheckboxState</var> - event handler for finding checkbox state</short>
</element>
<element name="TCustomDrawGrid.OnSetCheckboxState">
<short>
<var>OnSetCheckboxState</var> - event handler for specifying checkbox state</short>
</element>
<element name="TCustomStringGrid.GetCheckBoxState" link="#LCL.Grids.TCustomDrawGrid.GetCheckBoxState"/>
</module> </module>
<!-- Grids --> <!-- Grids -->
</package> </package>

48
docs/xml/lcl/imglist.xml
View File

@ -95,7 +95,8 @@
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TChangeLink"> <element name="TChangeLink">
<short/> <short>
<var>TChangeLink</var> - class to notify when an Imagelist changes</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -113,7 +114,7 @@
<seealso/> <seealso/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TChangeLink.Destroy"> <element name="TChangeLink.Destroy" link="#rtl.System.TObject.Destroy">
<short/> <short/>
<descr/> <descr/>
<errors/> <errors/>
@ -121,20 +122,23 @@
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TChangeLink.Change"> <element name="TChangeLink.Change">
<short/> <short>
<var>Change</var> - software emulation of the <var>OnChange</var> event</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TChangeLink.OnChange"> <element name="TChangeLink.OnChange">
<short/> <short>
<var>OnChange</var> - event handler for a change in the Imagelist</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TChangeLink.Sender"> <element name="TChangeLink.Sender">
<short/> <short>
<var>Sender</var> - the imagelist that has notified us of a change</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -460,14 +464,16 @@
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomImageList.Initialize"> <element name="TCustomImageList.Initialize">
<short/> <short>
<var>Initialize</var> - sets up the list</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomImageList.DefineProperties"> <element name="TCustomImageList.DefineProperties">
<short/> <short>
<var>DefineProperties</var> - defines the properties of the ImageList (stored in a file)</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -478,7 +484,8 @@
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomImageList.SetWidthHeight"> <element name="TCustomImageList.SetWidthHeight">
<short/> <short>
<var>SetWidthHeight</var> - specifies the dimensions for display</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -982,7 +989,8 @@
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomImageList.UnRegisterChanges"> <element name="TCustomImageList.UnRegisterChanges">
<short/> <short>
<var>UnRegisterChanges</var> - remove the changes from the register</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -993,13 +1001,15 @@
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomImageList.AllocBy"> <element name="TCustomImageList.AllocBy">
<short/> <short>
<var>AllocBy</var> - allocate images by an integer value</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomImageList.BlendColor"> <element name="TCustomImageList.BlendColor">
<short/> <short>
<var>BlendColor</var> - the colour for a blend</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -1104,6 +1114,22 @@
<short> <short>
<var>Reference</var> to the imagelist</short> <var>Reference</var> to the imagelist</short>
</element> </element>
<element name="TCustomImageList.CheckIndex">
<short>
<var>CheckIndex</var> - method for checking whether the indexed item is supposed to be inserted (default condition is False)</short>
</element>
<element name="TCustomImageList.GetReferenceHandle">
<short>
<var>GetReferenceHandle</var> - returns a handle for the reference</short>
</element>
<element name="TCustomImageList.WSCreateReference">
<short>
<var>WSCreateReference</var> - creates a reference for the Imagelist (returns this as a result), passing the defined parameters for the creation process</short>
</element>
<element name="TCustomImageList.StretchDraw">
<short>
<var>StretchDraw</var> - draw the image to fill the canvas</short>
</element>
</module> </module>
<!-- ImgList --> <!-- ImgList -->
</package> </package>

175
docs/xml/lcl/maskedit.xml
View File

@ -689,7 +689,7 @@
<short/> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomMaskEdit.KeyDown"> <element name="TCustomMaskEdit.KeyDown" link="#LCL.Controls.TWinControl.KeyDown">
<short/> <short/>
<descr/> <descr/>
<errors/> <errors/>
@ -922,7 +922,7 @@
<seealso/> <seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomMaskEdit.Create"> <element name="TCustomMaskEdit.Create" link="#rtl.Classes.TComponent.Create">
<short/> <short/>
<descr/> <descr/>
<errors/> <errors/>
@ -940,7 +940,7 @@
<seealso/> <seealso/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomMaskEdit.Clear"> <element name="TCustomMaskEdit.Clear" link="#LCL.StdCtrls.TCustomEdit.Clear">
<short/> <short/>
<descr/> <descr/>
<errors/> <errors/>
@ -948,7 +948,8 @@
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomMaskEdit.IsMasked"> <element name="TCustomMaskEdit.IsMasked">
<short/> <short>
<var>isMasked</var> - True if the text is masked</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -960,7 +961,7 @@
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomMaskEdit.Text"> <element name="TCustomMaskEdit.Text">
<short/> <short>The <var>Text</var> string that is to be masked (or not)</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -983,8 +984,7 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Anchors"> <element name="TMaskEdit.Anchors" link="#LCL.Controls.TControl.Anchors">
<short>The set of anchor definitions for this control</short>
<descr> <descr>
<p>// standard properties, which should be supported by all descendants</p> <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>Determines how the control is to be anchored to its client or parent conrol</p>
@ -994,8 +994,7 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.AutoSize"> <element name="TMaskEdit.AutoSize" link="#LCL.Controls.TControl.AutoSize">
<short>Whether auto-size is to be used</short>
<descr> <descr>
<p>// standard properties, which should be supported by all descendants</p> <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>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>
@ -1016,9 +1015,7 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.CharCase"> <element name="TMaskEdit.CharCase" link="#LCL.StdCtrls.TCustomEdit.CharCase">
<short>
<i>TEditCharCase</i> - rules for what case to use (upper or lower) to display text</short>
<descr> <descr>
<p>Indicates how text is displayed in a text editing control in the following ways:</p> <p>Indicates how text is displayed in a text editing control in the following ways:</p>
<ul> <ul>
@ -1031,8 +1028,7 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Color"> <element name="TMaskEdit.Color" link="#LCL.Controls.TControl.Color">
<short>Determine the colour for the current control</short>
<descr> <descr>
<p>// standard properties, which should be supported by all descendants</p> <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>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
@ -1041,8 +1037,7 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Constraints"> <element name="TMaskEdit.Constraints" link="#LCL.Controls.TControl.Constraints">
<short>Determine <i>Constraints</i> (max and min height and width) for this control</short>
<descr> <descr>
<p>// standard properties, which should be supported by all descendants</p> <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> <p>Determine <i>Constraints</i> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
@ -1050,34 +1045,28 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Ctl3D"> <element name="TMaskEdit.Ctl3D" link="#LCL.Controls.TControl.Ctl3D">
<short/> <short/>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.DragCursor"> <element name="TMaskEdit.DragCursor" link="#LCL.Controls.TControl.DragCursor">
<short>
<i>DragCursor </i>- the style of cursor to be used during the Drag process</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.DragKind"> <element name="TMaskEdit.DragKind" link="#LCL.Controls.TControl.DragKind">
<short>DragKind - what sort of dragging? Drag or Dock</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.DragMode"> <element name="TMaskEdit.DragMode" link="#LCL.Controls.TControl.DragMode">
<short>
<i>DragMode </i>- whether manual or automatic</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Enabled"> <element name="TMaskEdit.Enabled" link="#LCL.Controls.TControl.Enabled">
<short>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</short>
<descr> <descr>
<p>// standard properties, which should be supported by all descendants</p> <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>Whether the control is <i>Enabled</i>. If not, it usually appears 'greyed-out'</p>
@ -1086,14 +1075,12 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.EditMask"> <element name="TMaskEdit.EditMask" link="#LCL.MaskEdit.TCustomMaskEdit.EditMask">
<short>EditMask - the sequence of characters used to obscure the string being typed (typically a sequence of asterisks)</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Font"> <element name="TMaskEdit.Font" link="#LCL.Controls.TControl.Font">
<short>The <i>Font</i> to be used for text in this control</short>
<descr> <descr>
<p>// standard properties, which should be supported by all descendants</p> <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>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>
@ -1103,36 +1090,28 @@ Useful for inputting passwords etc.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.MaxLength"> <element name="TMaskEdit.MaxLength" link="#LCL.StdCtrls.TCustomEdit.MaxLength">
<short>
<i>MaxLength</i>: maximum length allowed for text string</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.ParentColor"> <element name="TMaskEdit.ParentColor" link="#LCL.Controls.TControl.ParentColor">
<short>
<i>ParentColor</i> - should the control have the same colour as the parent? Default is true</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.ParentCtl3D"> <element name="TMaskEdit.ParentCtl3D" link="#LCL.Controls.TWinControl.ParentCtl3D">
<short/> <short/>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.ParentFont"> <element name="TMaskEdit.ParentFont" link="#LCL.Controls.TControl.ParentFont">
<short>
<i>ParentFont </i>- should the control use the same font as the parent? Default is true</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.ParentShowHint"> <element name="TMaskEdit.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
<short>
<i>ParentShowHint </i>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -1176,16 +1155,13 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.TabOrder"> <element name="TMaskEdit.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
<short>The place this control occupies in the list of tabs</short>
<descr>Reads or writes information in flag; default is -1 <descr>Reads or writes information in flag; default is -1
</descr> </descr>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.TabStop"> <element name="TMaskEdit.TabStop" link="#LCL.Controls.TWinControl.TabStop">
<short>
<i>TabStop</i> - determines if the user can tab to a control.</short>
<descr> <descr>
<p>Reads or writes boolean flag; default is False</p> <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>Use the TabStop to allow or disallow access to the control using the Tab key.</p>
@ -1194,9 +1170,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Text"> <element name="TMaskEdit.Text" link="#LCL.MaskEdit.TCustomMaskEdit.Text">
<short>
<i>Text</i>: the character string contained in the Edit Box</short>
<descr> <descr>
<i>Text</i> <i>Text</i>
@ -1207,9 +1181,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.Visible"> <element name="TMaskEdit.Visible" link="#LCL.Controls.TControl.Visible">
<short>
<i>Visible</i> - can the control be seen?</short>
<descr> <descr>
<pre>The Visible property represents the ability to see a visual control. <pre>The Visible property represents the ability to see a visual control.
If Visible is True the control is shown, otherwise it is hidden. If Visible is True the control is shown, otherwise it is hidden.
@ -1220,14 +1192,12 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnChange"> <element name="TMaskEdit.OnChange" link="#LCL.StdCtrls.TCustomEdit.OnChange">
<short>OnChange - event handler for any change in text</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnClick"> <element name="TMaskEdit.OnClick" link="#LCL.Controls.TControl.OnClick">
<short>Event Handler for mouse click</short>
<descr> <descr>
<p>// standard properties, which should be supported by all descendants</p> <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>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>
@ -1237,49 +1207,39 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnDblClick"> <element name="TMaskEdit.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
<short>Event Handle for mouse double-click</short>
<descr> <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> <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> </descr>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnDragDrop"> <element name="TMaskEdit.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
<short>Event handler for the Drag-Drop manoeuvre</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnDragOver"> <element name="TMaskEdit.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
<short>Event handler for the case when a control is dragged over another control</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnEndDrag"> <element name="TMaskEdit.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
<short>Event handler for the end of a dragging process</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnEnter"> <element name="TMaskEdit.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<short>
<i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnExit"> <element name="TMaskEdit.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<short>
<i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnKeyDown"> <element name="TMaskEdit.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
<short>
<i>OnKeyDown</i> - event handler for instance when key is down while control has focus</short>
<descr> <descr>
<p> <p>
<i>OnKeyDown</i> <i>OnKeyDown</i>
@ -1289,8 +1249,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnKeyPress"> <element name="TMaskEdit.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
<short>OnKeyPress - event controller for a key being pressed while the control has focus</short>
<descr> <descr>
<p> <p>
<i>OnKeyPress</i> <i>OnKeyPress</i>
@ -1300,9 +1259,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnKeyUp"> <element name="TMaskEdit.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
<short>
<i>OnKeyUp</i> - event handler for instance when a key is up (not pressed) while the control has focus</short>
<descr> <descr>
<p> <p>
<i>OnKeyUp</i> <i>OnKeyUp</i>
@ -1312,26 +1269,22 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnMouseDown"> <element name="TMaskEdit.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short>Event handler for when a mouse button is pressed down</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnMouseMove"> <element name="TMaskEdit.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short>Event handler for mouse movement within the current control</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnMouseUp"> <element name="TMaskEdit.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short>Event handler for when the mouse button is released, ie "up"</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TMaskEdit.OnStartDrag"> <element name="TMaskEdit.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
<short>Event handler for start of dragging process</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -1406,10 +1359,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<element name="TMaskEdit.AutoSelect"> <element name="TMaskEdit.AutoSelect" link="#LCL.StdCtrls.TCustomEdit.AutoSelect"/>
<short>
<i>AutoSelect</i>: if True, the edit control will select all its text when it receives focus or when the Enter key is pressed.</short>
</element>
<element name="TMaskEdit.EchoMode"> <element name="TMaskEdit.EchoMode">
<short> <short>
<i>EchoMode </i>- how to echo keypresses on screen: normal (returning the actual character for that key), all upper or lower case, or a masking character as used in entering passwords</short> <i>EchoMode </i>- how to echo keypresses on screen: normal (returning the actual character for that key), all upper or lower case, or a masking character as used in entering passwords</short>
@ -1434,6 +1384,45 @@ Reads or Writes flag if control is re-sized.
<short> <short>
<i>TEditMask</i> - a string type containing a sequence of characters to act as a mask in an edit box</short> <i>TEditMask</i> - a string type containing a sequence of characters to act as a mask in an edit box</short>
</element> </element>
<element name="TCustomMaskEdit.CMEnter">
<short>
<var>CMEnter</var> - control message method for pressing the Enter key</short>
</element>
<element name="TCustomMaskEdit.LMMButtonUp">
<short>
<var>LMMButtonUp</var> - LCL message method for Button Up</short>
</element>
<element name="TCustomMaskEdit.LMPasteFromClip">
<short>
<var>LMPasteFromClip</var> - LCL message method for pasting from clipboard</short>
</element>
<element name="TCustomMaskEdit.LMCutToClip">
<short>
<var>LMCutToClip</var> - LCL message method for cutting to clipboard</short>
</element>
<element name="TCustomMaskEdit.LMClearSel">
<short>
<var>LMClearSel</var> - LCL message method for clearing selected items</short>
</element>
<element name="TCustomMaskEdit.GetSel">
<short>
<var>GetSel</var> - finds the start and end positions of the selection</short>
</element>
<element name="TCustomMaskEdit.SetSel">
<short>
<var>SetSel</var> - specifies the start and end positions of the selection</short>
</element>
<element name="TCustomMaskEdit.SpaceChar">
<short>
<var>SpaceChar</var> - the character that is to be used as a Space character</short>
</element>
<element name="TMaskEdit.BiDiMode" link="#LCL.Controls.TControl.BiDiMode"/>
<element name="TMaskEdit.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle"/>
<element name="TMaskEdit.ParentBiDiMode" link="#LCL.Controls.TControl.ParentBiDiMode"/>
<element name="TMaskEdit.OnEndDock" link="#LCL.Controls.TControl.OnEndDock"/>
<element name="TMaskEdit.OnStartDock" link="#LCL.Controls.TControl.OnStartDock"/>
<element name="TMaskEdit.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TMaskEdit.SpaceChar" link="#LCL.MaskEdit.TCustomMaskEdit.SpaceChar"/>
</module> </module>
<!-- MaskEdit --> <!-- MaskEdit -->
</package> </package>

3
docs/xml/lcl/printers.xml
View File

@ -728,7 +728,8 @@
</element> </element>
<!-- function Visibility: protected --> <!-- function Visibility: protected -->
<element name="TPrinter.GetCanvasRef"> <element name="TPrinter.GetCanvasRef">
<short/> <short>
<var>GetCanvasRef</var> - returns a reference to a printer canvas</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>