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

FPDoc - fixed Constructors and Destructors in Dialogs.xml, editbtn.xml and Buttons.xml; some corrections to ComCtrls.xml

Browse Source 
git-svn-id: trunk@18546 -
This commit is contained in:
kirkpatc 2009-02-03 23:24:49 +00:00
parent 9201afa4a4
commit 1b3fc606ee
4 changed files with 107 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/xml/lcl/buttons.xml
View File

@ -1399,15 +1399,21 @@ is done automatically by the streaming system.
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomSpeedButton.Create" link="#rtl.Classes.TComponent.Create">
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.
</descr>
<element name="TCustomSpeedButton.Create">
<descr>
<p>
<var>Create</var> - constructor for <var>TCustomSpeedButton</var>: calls inherited <var>Create</var> and initialises many defaults and properties</p>
<p>Among the properties set are Glyph, initial bounds, control style, layout, colour, caption and mouse responses</p>
<p>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.</p>
<p>However, if you create the component by code don´t forget to free it when it is no longer needed.</p>
<p>Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</p>
</descr>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create">TGraphicControl.Create</link>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomSpeedButton</var>: calls inherited <var>Create</var> and initialises many defaults and properties</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomSpeedButton.Create.AOwner">

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

@ -15398,7 +15398,7 @@ the comparision is case sensitive.
<p>
<var>Create</var> - constructor for <var>TCustomTreeView</var>: calls inherited <var>Create</var> then sets defaults for style, size, etc</p>
<p>Among the variables initialised and defaults set are:</p>
<var>size, colour, the symbols for expansion etc, the border style and width, scroll bars, options, indentation, timers, action links</var>
<p>size, colour, the symbols for expansion etc, the border style and width, scroll bars, options, indentation, timers, action links</p>
</descr>
<errors/>
<seealso>
@ -15413,9 +15413,7 @@ the comparision is case sensitive.
<!-- destructor Visibility: public -->
<element name="TCustomTreeView.Destroy">
<short>
<var>
<var>Destroy</var> - destructor for <var>TCustomTreeView</var>: frees images, nodes and links, then calls inherited Destroy</var>
</short>
<var>Destroy</var> - destructor for <var>TCustomTreeView</var>: frees images, nodes and links, then calls inherited Destroy</short>
<descr/>
<errors/>
<seealso>
@ -16544,8 +16542,7 @@ the comparision is case sensitive.
</element>
<element name="TCustomHeaderControl.Create">
<short>
<var>
<var>Create</var> - constructoer for TCustomHeaderControl:</var> calls inherited <var>Create</var>, creates the sections and initialises style and bounds</short>
<var>Create</var> - constructor for <var>TCustomHeaderControl:</var> calls inherited <var>Create</var>, creates the sections and initialises style and bounds</short>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.Controls.TCustomControl.Create">TCustomControl.Create</link>

85
docs/xml/lcl/dialogs.xml
View File

@ -374,7 +374,13 @@ and the "Close" method to release it and free the used resources.</descr>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCommonDialog.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TCommonDialog.Create">
<short>
<var>Create</var> - constructor for <var>TCommonDialog</var>: calls inherited <var>Create</var> and adds default Title</short>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCommonDialog.Create.TheOwner">
<short>The owner of the dialog: the component that called it</short>
@ -641,17 +647,27 @@ and then check the result to see if the user made a valid choice and pressed the
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TFileDialog.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TFileDialog.Create">
<short>
<var>Create</var> - constructor for <var>TFileDialog</var>: calls inherited <var>Create</var>, makes stringlists for files and history, initialises filter index</short>
<seealso>
<link id="#LCL.Dialogs.TCommonDialog.Create">TCommonDialog.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TFileDialog.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TFileDialog.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<element name="TFileDialog.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TFileDialog</var>: frees file and history lists then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Dialogs.TCommonDialog.Destroy">TCommonDialog.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TFileDialog.DoTypeChange">
@ -978,7 +994,13 @@ If the required file is not in the current directory, another directory can be s
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TOpenDialog.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TOpenDialog.Create">
<short>
<var>Create</var> - constructor for <var>TOpenDialog</var>: calls inherited <var>Create</var> then loads default options</short>
<seealso>
<link id="#LCL.Dialogs.TFileDialog.Create">TFileDialog.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TOpenDialog.Create.TheOwner">
<short/>
@ -1034,7 +1056,7 @@ if no file is specified, the Save File As dialog is invoked and the buffer is sa
</descr>
</element>
<!-- constructor Visibility: public -->
<element name="TSaveDialog.Create" link="#rtl.Classes.TComponent.Create">
<element name="TSaveDialog.Create" link="#LCL.Dialogs.TOpenDialog.Create">
<short/>
<descr/>
<errors/>
@ -1070,7 +1092,7 @@ if no file is specified, the Save File As dialog is invoked and the buffer is sa
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TSelectDirectoryDialog.Create" link="#rtl.Classes.TComponent.Create">
<element name="TSelectDirectoryDialog.Create" link="#LCL.Dialogs.TOpenDialog.Create">
<short/>
<descr/>
<errors/>
@ -1099,10 +1121,14 @@ Call the Execute function to show the color dialog.
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TColorDialog.Create" link="#rtl.Classes.TComponent.Create">
<element name="TColorDialog.Create">
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Dialogs.TCommonDialog.Create">TCommonDialog.Create</link>
</seealso>
<short>
<var>Create</var> - constructor for <var>TColorDialog</var>: calls inherited <var>Create</var>, makes stringlist for colours and gets colour values</short>
</element>
<!-- argument Visibility: default -->
<element name="TColorDialog.Create.TheOwner">
@ -1307,11 +1333,14 @@ Call the Execute function to show the color dialog.
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TColorButton.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<element name="TColorButton.Create">
<short>
<var>Create</var> - constructor for <var>TColorButton</var>; calls inherited <var>Create</var> , sets initial bounds, size and pattern</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Buttons.TCustomSpeedButton.Create">TCustomSpeedButton.create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TColorButton.Create.AnOwner">
@ -2121,18 +2150,22 @@ you need to use TReplaceDialog to do that<br/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TFindDialog.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<element name="TFindDialog.Create">
<short>
<var>Create</var> - constructor for <var>TFindDialog</var>: calls inherited <var>Create</var> and sets initial options for Find only</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.Dialogs.TCommonDialog.Create">TCommonDialog.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TFindDialog.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TFindDialog.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TFindDialog.Destroy" link="#LCL.Dialogs.TCommonDialog.Destroy">
<short/>
<descr/>
<errors/>
@ -2264,11 +2297,14 @@ A number of buttons appear, offering the choice to replace this instance, find n
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TReplaceDialog.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<element name="TReplaceDialog.Create">
<short>
<var>Create</var> - constructor for <var>TReplaceDialog</var>: calls inherited <var>Create</var> and sets options for find and replace</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Dialogs.TFindDialog.Create">TFindDialog.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TReplaceDialog.Create.AOwner">
@ -3062,7 +3098,14 @@ If a valid directory is given, the selected directory in the tree will be set to
<element name="TSaveDialog.DefaultTitle" link="#LCL.Dialogs.TCommonDialog.DefaultTitle"/>
<element name="TSelectDirectoryDialog.DefaultTitle" link="#LCL.Dialogs.TCommonDialog.DefaultTitle"/>
<element name="TColorDialog.DefaultTitle" link="#LCL.Dialogs.TCommonDialog.DefaultTitle"/>
<element name="TColorDialog.Destroy" link="#rtl.Classes.TComponent.Destroy"/>
<element name="TColorDialog.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TColorDialog</var>: frees custom colours then calls inherited <var>Destroy</var>
</short>
<seealso>
<link id="#LCL.Dialogs.TCommonDialog.Destroy">TCommonDialog.Destroy</link>
</seealso>
</element>
<element name="TColorDialog.CustomColors">
<short>
<var>CustomColors</var> - a customised list of colours that can be used instead of the system-supplied list</short>

38
docs/xml/lcl/editbtn.xml
View File

@ -411,18 +411,27 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomEditButton.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<element name="TCustomEditButton.Create">
<short>
<var>Create</var> - constructor for <var>TCustomEditutton</var>: calls inherited <var>Create</var> then sets some defaults and initialises some variables</short>
<descr>
<p>
<var>Create</var> - constructor for <var>TCustomEditutton</var>: calls inherited <var>Create</var> then sets some defaults and initialises some variables</p>
<p>Initialises height and width, cursor, glyph, style, checks visibility, event handler for click</p>
</descr>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.StdCtrls.TCustomEdit.Create">TCustomEdit.Create</link>
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomEditButton.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomEditButton.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TCustomEditButton.Destroy" link="#LCL.Controls.TWinControl.Destroy">
<short/>
<descr/>
<errors/>
@ -899,7 +908,7 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TFileNameEdit.Create" link="#rtl.Classes.TComponent.Create">
<element name="TFileNameEdit.Create" link="#LCL.EditBtn.TCustomEditButton.Create">
<short/>
<descr/>
<errors/>
@ -910,7 +919,7 @@
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TFileNameEdit.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TFileNameEdit.Destroy" link="#LCL.EditBtn.TCustomEditButton.Destroy">
<short/>
<descr/>
<errors/>
@ -1751,9 +1760,14 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TDateEdit.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<element name="TDateEdit.Create" link="#LCL.EditBtn.TCustomEditButton.Create">
<short>
<var>Create</var> - constructor for <var>TDateEdit</var>: calls inherited <var>Create</var> and sets defaults</short>
<descr>
<p>
<var>Create</var> - constructor for <var>TDateEdit</var>: calls inherited <var>Create</var> and sets defaults</p>
<p>Initialises dialog title, captions, display settings and default date</p>
</descr>
<errors/>
<seealso/>
</element>
@ -2179,7 +2193,7 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCalcEdit.Create" link="#rtl.Classes.TComponent.Create">
<element name="TCalcEdit.Create" link="#LCL.EditBtn.TCustomEditButton.Create">
<short/>
<descr/>
<errors/>
@ -2190,7 +2204,7 @@
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCalcEdit.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TCalcEdit.Destroy" link="#LCL.EditBtn.TCustomEditButton.Destroy">
<short/>
<descr/>
<errors/>