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

LCL doc: removed duplicates from Graeme

Browse Source 
git-svn-id: trunk@9764 -
This commit is contained in:
mattias 2006-08-29 10:12:30 +00:00
parent 3093718d32
commit 3b96c968c8
14 changed files with 13 additions and 432 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -46,13 +46,6 @@
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomActionList">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TContainedAction">
<short/>
<descr/>
@ -275,9 +268,16 @@ Take the following precautions when creating your own Destroy method:
<!-- object Visibility: default -->
<element name="TCustomActionList">
<short>A generic class for all action list components</short>
<descr>TCustomActionList is a generic class for all components that represent action lists. TCustomActionList is the ancestor for TActionList. If you want to define your own action list class, you should use this class to derive it from.
<descr>TCustomActionList is a generic class for all components that
represent action lists. TCustomActionList is the ancestor for TActionList.
If you want to define your own action list class, you should use this
class to derive it from.
TActionList, TAction, TActionLink and TContainedAction are used to centralize the implementation of user commands, and can then be linked to the apropriete button, menu or another component. This an Object-Oriented programming strategy to reuse the code, as oposed to the Event-Oriented approach of writing an OnClick event for each component.</descr>
TActionList, TAction, TActionLink and TContainedAction are used to centralize
the implementation of user commands, and can then be linked to the apropriete
button, menu or another component. This an Object-Oriented programming strategy
to reuse the code, as oposed to the Event-Oriented approach of writing an
OnClick event for each component.</descr>
<errors/>
<seealso>
<link id="TActionList"/>
@ -1675,10 +1675,6 @@ Constructors allocate memory and system resources needed by the object. They als
<short/>
</element>
<!-- argument Visibility: default -->
<element name="AClasses">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="Resource">
<short/>
</element>

39
docs/xml/lcl/avglvltree.xml
View File

@ -12,7 +12,6 @@
<short></short>
<descr>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
@ -21,7 +20,6 @@
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short></short>
@ -30,7 +28,6 @@
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="FPCAdds">
<short></short>
@ -39,18 +36,6 @@
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TAvgLvlTree">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function type Visibility: default -->
<element name="TObjectSortCompare">
<short></short>
@ -59,27 +44,22 @@
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TObjectSortCompare.Result">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TObjectSortCompare.Tree">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TObjectSortCompare.Data1">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TObjectSortCompare.Data2">
<short></short>
</element>
<!-- object Visibility: default -->
<element name="TAvgLvlTreeNode">
<short></short>
@ -90,7 +70,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: public -->
<element name="TAvgLvlTreeNode.Parent">
<short></short>
@ -99,7 +78,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: public -->
<element name="TAvgLvlTreeNode.Left">
<short></short>
@ -108,7 +86,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: public -->
<element name="TAvgLvlTreeNode.Right">
<short></short>
@ -117,7 +94,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: public -->
<element name="TAvgLvlTreeNode.Balance">
<short></short>
@ -126,7 +102,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: public -->
<element name="TAvgLvlTreeNode.Data">
<short></short>
@ -135,7 +110,6 @@
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TAvgLvlTreeNode.Clear">
<short></short>
@ -146,7 +120,6 @@
<seealso>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TAvgLvlTreeNode.TreeDepth">
<short></short>
@ -157,12 +130,10 @@
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TAvgLvlTreeNode.TreeDepth.Result">
<short></short>
</element>
<!-- pointer type Visibility: default -->
<element name="PAvgLvlTreeNode">
<short></short>
@ -171,7 +142,6 @@
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TAvgLvlTree">
<short></short>
@ -182,7 +152,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TAvgLvlTree.FCount">
<short></short>
@ -191,7 +160,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TAvgLvlTree.FOnCompare">
<short></short>
@ -200,7 +168,6 @@
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TAvgLvlTree.FOnObjectCompare">
<short></short>
@ -209,7 +176,6 @@
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private -->
<element name="TAvgLvlTree.BalanceAfterInsert">
<short></short>
@ -220,12 +186,10 @@
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TAvgLvlTree.BalanceAfterInsert.ANode">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TAvgLvlTree.BalanceAfterDelete">
<short></short>
@ -236,12 +200,10 @@
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TAvgLvlTree.BalanceAfterDelete.ANode">
<short></short>
</element>
<!-- function Visibility: private -->
<element name="TAvgLvlTree.FindInsertPos">
<short></short>
@ -252,7 +214,6 @@
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TAvgLvlTree.FindInsertPos.Result">
<short></short>

37
docs/xml/lcl/clipbrd.xml
View File

@ -1066,43 +1066,6 @@
</seealso>
</element>
<!-- function Visibility: default -->
<element name="Clipboard">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="Clipboard.Result">
<short></short>
</element>
<!-- function Visibility: default -->
<element name="SetClipboard">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="SetClipboard.Result">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="SetClipboard.NewClipboard">
<short></short>
</element>
<!-- function Visibility: default -->
<element name="PrimarySelection">
<short></short>

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

@ -195,13 +195,6 @@
<element name="TStatusPanelBevel.pbRaised">
<short/>
</element>
<!-- object Visibility: default -->
<element name="TStatusBar">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TPanelPart">
<short/>
@ -774,13 +767,6 @@
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TPageControl">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TTabStyle">
<short/>
@ -1395,13 +1381,6 @@
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomTabControl">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TTabControlStrings">
<short/>
<descr/>
@ -3267,17 +3246,6 @@ cdsIndeterminate</descr>
<short>A subset of TCustomDrawStateFlag</short>
<descr>TCustomDrawState determines how a item will be drawn.</descr>
</element>
<!-- object Visibility: default -->
<element name="TListItems">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomListView">
<short>A forward declaration</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TSortType">
<short/>
@ -7219,25 +7187,6 @@ To add, change or delete a column use the Columns property.</descr>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TToolBar">
<short>TToolbar manages tool buttons and other controls, arranging them in rows and automatically adjusting their sizes and positions.</short>
<descr>
<p>TToolbar is a container for tool buttons (TToolButton). it provides an easy way to arrange and manage visual controls.</p>
<ul>
<li>All tool buttons on a toolbar maintain a uniform width and height. </li>
<li>Other controls can sit on a toolbar. These controls (which are held in place by invisible tool buttons) maintain a uniform height.</li>
<li>Controls can automatically wrap around and start a new row when they do not fit horizontally on the toolbar.</li>
<li>The Flat property allows the background to show through the toolbar and gives pop-up borders to the tool buttons.</li>
<li>Spaces and dividers (which are in fact specially configured tool buttons) can group controls on the toolbar both visually and functionally.</li>
</ul>
<p>Typically, the tool buttons correspond to items in an application's menu and gives the user more direct access to the application's commands.</p>
</descr>
<seealso>
<link id="TToolButton"/>
</seealso>
<example file="comctrls/ttoolbutton.pas"/>
</element>
<!-- object Visibility: default -->
<element name="TToolButton">
<short>TToolButton is a button control in a TToolBar object.</short>
<descr>
@ -9749,27 +9698,6 @@ To add, change or delete a column use the Columns property.</descr>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomTreeView">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TTreeNodes">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TTreeNode">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TNodeState">
<short/>

47
docs/xml/lcl/controls.xml
View File

@ -195,15 +195,6 @@
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TWinControl"/>
<!-- object Visibility: default -->
<element name="TControl">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- "class of" type Visibility: default -->
<element name="TWinControlClass">
<short/>
@ -1156,13 +1147,6 @@
<element name="TMouseWheelUpDownEvent.Handled">
<short/>
</element>
<!-- object Visibility: default -->
<element name="TDragObject">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TDragState">
<short/>
@ -9838,9 +9822,8 @@
<!-- property Visibility: public -->
<element name="TWinControl.TabStop">
<short>Determines if the user can tab to a control.</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>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TWinControl.OnDockDrop">
@ -10750,13 +10733,6 @@ TGraphicControl, you must query the ClientRect.</p>
<short/>
</element>
<!-- object Visibility: default -->
<element name="TDockTree">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDockZone">
<short/>
<descr/>
@ -11896,25 +11872,6 @@ TGraphicControl, you must query the ClientRect.</p>
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="AdjustBorderSpace">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="AdjustBorderSpace.RemainingClientRect">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="AdjustBorderSpace.CurBorderSpace">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="AdjustBorderSpace.Space">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="Register">
<short/>
<descr/>

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

@ -5917,28 +5917,6 @@
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TDBNavButton">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TDBNavDataLink">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- enumeration type Visibility: default -->
<element name="TDBNavGlyph">
<short></short>

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

@ -1326,38 +1326,6 @@ Call the Execute function to show the color dialog.</descr>
<short>A set of TFindOption</short>
</element>
<!-- function Visibility: default -->
<element name="MessageDlg">
<short>Show a message to the user and receive his response.</short>
<descr>A MessageDlg can be used to show a message to the user and receive his response. The MessageDlg can be one of several types.
There are two versions of this function. The first version displays a dialog with the standard caption, the second version enables you to set the caption.</descr>
</element>
<!-- function result Visibility: default -->
<element name="MessageDlg.Result">
<short>The result of this function is the button the user pressed to close the dialog.</short>
<descr>The result of this function is the button the user pressed to close the dialog.</descr>
</element>
<!-- argument Visibility: default -->
<element name="MessageDlg.aMsg">
<short>The message to be shown.</short>
<descr>The message shown to the user.</descr>
</element>
<!-- argument Visibility: default -->
<element name="MessageDlg.DlgType">
<short>The type of dialog to be shown</short>
<descr>The DlgType parameter indicates the type of dialog to show. You can choose from mtWarning, mtError, mtInformation, mtConfirmation or mtCustom.</descr>
</element>
<!-- argument Visibility: default -->
<element name="MessageDlg.Buttons">
<short>Determines the buttons shown on the messagedialog</short>
<descr>Buttons indicate which set of button captions have to be shown on the dialog. You can choose from predefined sets: mbAbortRetryIgnore, mbOKCancel, mbYesNo, mbYesNoCancel, or you can make your own set.</descr>
</element>
<!-- argument Visibility: default -->
<element name="MessageDlg.HelpCtx">
<short>HelpCtx is used to specify which topic form the help should be shown.</short>
<descr>HelpCtx is used to specify which topic form the help should be shown.</descr>
</element>
<!-- function Visibility: default -->
<element name="MessageDlg">
<short>Message Dialog</short>
<descr>Message Dialog: show a message to the user and receive his response.
@ -1701,32 +1669,6 @@ Function PasswordBox(const ACaption, APrompt : String) : String;
<element name="SelectDirectory">
<short>A function that allows to user to select a directory.</short>
<descr>This function wil show a dialog which allows the user to select the required directory when the directory structure is displayed as a tree. <br/>Under Windows the caption from the resulting dialog cannot be set, but the label above the directory tree will have this value.<br/>
There are two version of this function, the second one having the ability to indicate whether hidden folders should be shown as well.</descr>
</element>
<!-- function result Visibility: default -->
<element name="SelectDirectory.Result">
<short>A boolean indicating if the user pressed OK.</short>
<descr>A boolean indicating if the user selected a directory and pressed OK.</descr>
</element>
<!-- argument Visibility: default -->
<element name="SelectDirectory.Caption">
<short>A constant which sets the caption of the shown dialog.</short>
<descr>A constant which sets the caption of the shown dialog.</descr>
</element>
<!-- argument Visibility: default -->
<element name="SelectDirectory.InitialDirectory">
<short>The directory the dialog should start in.</short>
<descr>The directory the dialog should start in. <br/>If a valid directory is given, the selected directory in the tree will be set to this directory.</descr>
</element>
<!-- argument Visibility: default -->
<element name="SelectDirectory.Directory">
<short>A variable which on exit contains the selected directory.</short>
<descr>A variable which on exit contains the selected directory.</descr>
</element>
<!-- function Visibility: default -->
<element name="SelectDirectory">
<short>A function that allows to user to select a directory.</short>
<descr>This function wil show a dialog which allows the user to select the required directory when the directory structure is displayed as a tree. <br/>Under Windows the caption from the resulting dialog cannot be set, but the label above the directory tree will have this value.<br/>
There are two version of this function, the second one having the ability to indicate whether hidden folders should be shown as well.</descr>
</element>
<!-- function result Visibility: default -->

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

@ -336,8 +336,6 @@
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomNotebook"/>
<!-- object Visibility: default -->
<element name="TNBPages">
<short>NB Pages</short>
<descr>NB Pages: The set of instances of Notebook Page</descr>

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

@ -157,17 +157,6 @@
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TPreviewFileDialog">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TPreviewFileControl">
<short></short>
@ -625,17 +614,6 @@
<short></short>
</element>
<!-- object Visibility: default -->
<element name="TCalculatorForm">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TCalculatorDialog">
<short></short>

18
docs/xml/lcl/forms.xml
View File

@ -213,11 +213,6 @@
<element name="TCloseAction.caMinimize">
<short/>
</element>
<!-- object Visibility: default -->
<element name="TScrollingWinControl">
<short>Scrolling Window Control</short>
<descr>Scrolling Window Control: A window control with scroll bars</descr>
</element>
<!-- enumeration type Visibility: default -->
<element name="TScrollBarKind">
<short/>
@ -707,8 +702,8 @@
</element>
<!-- object Visibility: default -->
<element name="TScrollingWinControl">
<short/>
<descr/>
<short>Scrolling Window Control</short>
<descr>Scrolling Window Control: A window control with scroll bars</descr>
<errors/>
<seealso/>
</element>
@ -1591,11 +1586,6 @@
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TIDesigner">
<short>IDesigner</short>
<descr>IDesigner</descr>
</element>
<!-- enumeration type Visibility: default -->
<element name="TBorderIcon">
<short/>
@ -6870,10 +6860,6 @@ It can be invoked like a procedure call (ie as a 'MessageBox()' statement rather
<descr/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="DataModule">
<short/>
</element>
<!-- constant Visibility: default -->
<element name="RemoveDataModule">
<short/>

44
docs/xml/lcl/graphics.xml
View File

@ -2240,50 +2240,6 @@
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TCanvas">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TBitmap">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TPixmap">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TIcon">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TPortableNetworkGraphic">
<short></short>

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

@ -530,13 +530,6 @@
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomGrid">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- pointer type Visibility: default -->
<element name="PCellProps">
<short/>

33
docs/xml/lcl/lazhelpintf.xml
View File

@ -417,17 +417,6 @@
</seealso>
</element>
<!-- object Visibility: default -->
<element name="THelpDatabase">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- enumeration type Visibility: default -->
<element name="THelpNodeType">
<short></short>
@ -1648,28 +1637,6 @@
</seealso>
</element>
<!-- object Visibility: default -->
<element name="THelpDatabases">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="THelpViewer">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="THelpDatabase">
<short></short>

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

@ -58,28 +58,6 @@
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TResourceCache">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TResourceCacheDescriptor">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TResourceCacheItem">
<short></short>