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

FPDoc - some corrections, updates and links to descriptions in actnlist.xml, buttonpanel.xml. buttons.xml, colorbox.xml and stdctrls.xml

Browse Source 
git-svn-id: trunk@18000 -
This commit is contained in:
kirkpatc 2008-12-30 22:06:37 +00:00
parent 7332c0b540
commit 16d49d8eab
5 changed files with 205 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1313,7 +1313,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetAutoCheck">
<short/>
<short>
<var>SetAutoCheck</var> - specifies the value of AutoCheck, whether True or False</short>
<descr/>
<errors/>
<seealso/>
@ -1324,7 +1325,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetCaption">
<short/>
<short>
<var>SetCaption</var> - specifies the string to be used as caption</short>
<descr/>
<errors/>
<seealso/>
@ -1335,7 +1337,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetChecked">
<short/>
<short>
<var>SetChecked</var> - specifies the value of the Checked property: True or False</short>
<descr/>
<errors/>
<seealso/>
@ -1357,7 +1360,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetGroupIndex">
<short/>
<short>
<var>SetGroupIndex</var> - specifies the value for the Group Index</short>
<descr/>
<errors/>
<seealso/>
@ -1368,7 +1372,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHelpContext">
<short/>
<short>
<var>SetHelpContext</var> - specifies the value to be used for context-sensitive Help</short>
<descr/>
<errors/>
<seealso/>
@ -1379,7 +1384,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHelpKeyword">
<short/>
<short>
<var>SetHelpKeyword</var> - specifies the keyword to be used for Help</short>
<descr/>
<errors/>
<seealso/>
@ -1390,7 +1396,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHelpType">
<short/>
<short>
<var>SetHelpType</var> - specifies the trpe of Help to be used</short>
<descr/>
<errors/>
<seealso/>
@ -1401,7 +1408,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHint">
<short/>
<short>
<var>SetHint</var> - specifies the string to be used for Hints</short>
<descr/>
<errors/>
<seealso/>
@ -1412,7 +1420,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetImageIndex">
<short/>
<short>
<var>SetImageIndex</var> - specifies the index value for the image associated with the action</short>
<descr/>
<errors/>
<seealso/>
@ -1423,7 +1432,8 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetShortCut">
<short/>
<short>
<var>SetShortCut</var> - specifies the shortcut for the action</short>
<descr/>
<errors/>
<seealso/>
@ -1434,7 +1444,9 @@ executed at this point in time.
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetVisible">
<short/>
<short>
<var>SetVisible</var> - specifies whether or not the control for the action is <var>Visible</var>
</short>
<descr/>
<errors/>
<seealso/>
@ -1555,7 +1567,9 @@ executed at this point in time.
</element>
<!-- "class of" type Visibility: default -->
<element name="TActionLinkClass">
<short/>
<short>
<var>TActionLinkClass</var> - class of <var>TActionLink</var>
</short>
<descr/>
<seealso/>
</element>

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

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

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

@ -285,7 +285,26 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- enumeration type Visibility: default -->
<element name="TBitBtnKind">
<short>A set of possible types for BitButtons.</short>
<short>
<var>TBitBtnKind</var> - enumerated type of possible kinds of BitButtons.</short>
<descr>
<p>
<var>TBitBtnKind</var> - enumerated type of possible kinds of BitButtons.</p>
<pre>bkCustom,
bkOK,
bkCancel,
bkHelp,
bkYes,
bkNo,
bkClose,
bkAbort,
bkRetry,
bkIgnore,
bkAll,
bkNoToAll,
bkYesToAll
</pre>
</descr>
</element>
<!-- enumeration value Visibility: default -->
<element name="TBitBtnKind.bkCustom">
@ -340,15 +359,22 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- set type Visibility: default -->
<element name="TBitBtnKinds"/>
<element name="TBitBtnKinds">
<short>
<var>TBitBtnKinds</var> - set of <var>TBitBtnKind</var>
</short>
</element>
<!-- object Visibility: default -->
<element name="TCustomBitBtn">
<short>The ancestor class for TBitBtn.</short>
<descr>TCustomBitBtn is the ancestor for TBitBtn. If you want to define your own bitbutton class, you should use this class to derive it from.</descr>
<short>
<var>TCustomBitBtn</var> - the ancestor class for <var>TBitBtn</var>.</short>
<descr>TCustomBitBtn is the ancestor for TBitBtn. If you want to define your own bitbutton class, you should use this class to derive it from.
</descr>
</element>
<!-- variable Visibility: private -->
<element name="TCustomBitBtn.FButtonGlyph">
<short/>
<short>
<var>FButtonGlyph</var> - local variable holding the Glyph for this button</short>
<descr/>
<seealso/>
</element>
@ -499,7 +525,8 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomBitBtn.ActionChange">
<short>Change the action associated with this BitButton</short>
<short>
<var>ActionChange</var> - Change the action associated with this BitButton</short>
<descr/>
<errors/>
<seealso/>
@ -1115,7 +1142,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- variable Visibility: protected -->
<element name="TCustomSpeedButton.FState">
<short>The state of the speedbutton (whether checked or not)</short>
<short>
<var>FState</var> - local variable to hold the state of the speedbutton (whether checked or not)</short>
<descr/>
<seealso/>
</element>
@ -1214,7 +1242,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.SetDown">
<short/>
<short>
<var>SetDown</var> - specifies the boolean value of <var>Down</var> (ie whether or not button was pressed)</short>
<descr/>
<errors/>
<seealso/>
@ -1225,7 +1254,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.SetGroupIndex">
<short/>
<short>
<var>SetGroupIndex</var> - specifies the value of the Group Index</short>
<descr/>
<errors/>
<seealso/>
@ -1236,7 +1266,9 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.SetFlat">
<short/>
<short>
<var>SetFlat</var> - specifies whether or not the button is displayed <var>Flat</var>
</short>
<descr/>
<errors/>
<seealso/>
@ -1247,7 +1279,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.SetMargin">
<short/>
<short>
<var>SetMargin</var> - specifies the size of the margin</short>
<descr/>
<errors/>
<seealso/>
@ -1258,7 +1291,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.SetNumGlyphs">
<short/>
<short>
<var>SetNumGlyphs</var> - specifies the number of glyphs</short>
<descr/>
<errors/>
<seealso/>
@ -1269,7 +1303,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.SetSpacing">
<short/>
<short>
<var>SetSpacing</var> - specifies the spacing between buttons</short>
<descr/>
<errors/>
<seealso/>
@ -1291,7 +1326,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.UpdateState">
<short/>
<short>
<var>UpdateState</var> - brings the state up oto date, implementing any pending changes, and rendering non-valid if <var>InvalidateOnChange</var> is True</short>
<descr/>
<errors/>
<seealso/>
@ -1313,12 +1349,13 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- property Visibility: protected -->
<element name="TCustomSpeedButton.MouseInControl">
<short/>
<short>
<var>MouseInControl</var> - returns True if the mouse cursor is in the control</short>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.ActionChange">
<element name="TCustomSpeedButton.ActionChange" link="#LCL.Controls.TControl.ActionChange">
<short/>
<descr/>
<errors/>
@ -1333,7 +1370,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TCustomSpeedButton.GetActionLinkClass">
<element name="TCustomSpeedButton.GetActionLinkClass" link="#LCL.Controls.TControl.GetActionLinkClass">
<short/>
<descr/>
<errors/>
@ -1689,10 +1726,11 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<short>Draw the glyph in the specified canvas in the specified rectangle at a given offset within the client, with specified state and transparency</short>
</element>
<element name="TCustomSpeedButton.FindDownButton">
<short>Find any Down button</short>
<short>
<var>FindDownButton</var> - returns the button that is down</short>
</element>
<element name="TCustomSpeedButton.ShowAccelChar">
<short>Should accelerator character be shown (ie underlined character denoting key to be pressed for quick action)</short>
<short>Should accelerator character be shown (ie underlined character denoting key to be pressed for quick action)?</short>
</element>
<element name="TCustomSpeedButton.ShowCaption">
<short>Should caption be displayed?</short>
@ -1720,9 +1758,41 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<element name="TBitBtn.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
<element name="TCustomSpeedButton.DialogChar" link="#LCL.Controls.TControl.DialogChar"/>
<element name="TCustomSpeedButton.SetEnabled" link="#LCL.Controls.TControl.SetEnabled"/>
<element name="TCustomSpeedButton.GetDrawDetails"/>
<element name="TCustomSpeedButton.GetDrawDetails">
<short>
<var>GetDrawDetails</var> - returns the structured details for drawing</short>
</element>
<element name="TCustomSpeedButton.GetControlClassDefaultSize" link="#LCL.Controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomSpeedButton.LoadGlyphFromLazarusResource"/>
<element name="TCustomSpeedButton.LoadGlyphFromLazarusResource">
<short>
<var>LoadGlyphFromLazarusResource</var> - method for loading a glyph from a Lazarus Resource file (.lrs)</short>
</element>
<element name="TCustomBitBtn.LoadGlyphFromLazarusResource">
<short>
<var>LoadGlyphFromLazarusResource</var> - method for loading the glyph from a Lazarus resource file (.lrs)</short>
</element>
<element name="TCustomSpeedButton.GetGlyphSize">
<short>
<var>GetGlyphSize</var> - returns the size of the glyoh within the specified <var>PaintRect</var>
</short>
</element>
<element name="TCustomSpeedButton.GetTextSize">
<short>
<var>GetTextSize</var> - returns the size of the text within the specified <var>PaintRect</var>
</short>
</element>
<element name="TGetDefaultBitBtnGlyph">
<short>
<var>TGetDefaultBitBtnGlyph</var> - generic method to return a default Bit Button Glyph of specified Kind</short>
</element>
<element name="GetLCLDefaultBtnGlyph">
<short>
<var>GetLCLDefaultBtnGlyph</var> - generic method to return the LCL default button glyph of the specified Kind</short>
</element>
<element name="LoadGlyphFromLazarusResource">
<short>
<var>LoadGlyphFromLazarusResource</var> - generic method to load a button glyph with specified name from a Lazarus Resource file (.lrs)</short>
</element>
</module>
</package>
</fpdoc-descriptions>

91
docs/xml/lcl/colorbox.xml
View File

@ -1004,7 +1004,7 @@
<short>The <var>Palette</var> of colours to be included</short>
</element>
<element name="TCustomColorBox.Selected">
<short>the colour that has been <var>Selected</var> from the ComboBox</short>
<short>The colour that has been <var>Selected</var> from the ComboBox</short>
</element>
<element name="TCustomColorListBox">
<short>
@ -1015,10 +1015,7 @@
<short>
<var>SetStyle</var> - specify the Style</short>
</element>
<element name="TCustomColorListBox.DrawItem">
<short>
<var>DrawItem</var> - draw the specified item in the list</short>
</element>
<element name="TCustomColorListBox.DrawItem" link="#LCL.StdCtrls.TCustomListBox.DrawItem"/>
<element name="TCustomColorListBox.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TCustomColorListBox.SetColorList">
<short>
@ -1032,6 +1029,90 @@
<element name="TCustomColorListBox.Palette">
<short>The <var>Palette</var> to be used to supply the colours</short>
</element>
<element name="TColorBoxStyle">
<short>
<var>TColorBoxStyle</var> - set of <var>TColorBoxStyles</var>
</short>
</element>
<element name="TCustomColorBox.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
<element name="TCustomColorBox.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd"/>
<element name="TCustomColorBox.DoGetColors">
<short>
<var>DoGetColors</var> - perform the code for getting colours</short>
</element>
<element name="TCustomColorBox.Change" link="#LCL.StdCtrls.TCustomComboBox.Change"/>
<element name="TCustomColorBox.PickCustomColor">
<short>
<var>PickCustomColor</var> - if True, a custom colour is picked rather than one of the standard list</short>
</element>
<element name="TCustomColorBox.Style" link="#LCL.StdCtrls.TCustomComboBox.Style"/>
<element name="TCustomColorBox.ColorNames">
<short>
<var>ColorNames</var> - the name of the specified (indexed) colour, stored as a string</short>
</element>
<element name="TCustomColorBox.DefaultColorColor">
<short>
<var>DefaultColorColor</var> - the default colour, expressed as a Color value</short>
<descr>
<p>
<var>DefaultColorColor</var> - the default colour, expressed as a Color value</p>
<p>The use of the construct <var>..ColorColor</var> denotes the value of a colour as a TColor, as opposed to an index value</p>
</descr>
</element>
<element name="TCustomColorBox.NoneColorColor">
<short>
<var>NoneColorColor</var> - the colour to be used when no selection has been made, or when <var>None</var> is selected, stored as a <var>TColor</var>
</short>
</element>
<element name="TCustomColorBox.OnGetColors">
<short>
<var>OnGetColors</var> - event handler for the instruction to Get Colours</short>
</element>
<element name="TColorBox.DefaultColorColor" link="#LCL.ColorBox.TCustomColorBox.DefaultColorColor"/>
<element name="TColorBox.NoneColorColor" link="#LCL.ColorBox.TCustomColorBox.NoneColorColor"/>
<element name="TColorBox.Style" link="#LCL.StdCtrls.TCustomComboBox.Style"/>
<element name="TColorBox.OnGetColors" link="#LCL.ColorBox.TCustomColorBox.OnGetColors"/>
<element name="TCustomColorListBox.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
<element name="TCustomColorListBox.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd"/>
<element name="TCustomColorListBox.DoGetColors">
<short>
<var>DoGetColors</var> - perform the code for getting the colours</short>
</element>
<element name="TCustomColorListBox.DoSelectionChange" link="#LCL.StdCtrls.TCustomListBox.DoSelectionChange"/>
<element name="TCustomColorListBox.PickCustomColor">
<short>
<var>PickCustomColor</var> - if True, a custom colour is picked rather than one from the standard list</short>
</element>
<element name="TCustomColorListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style"/>
<element name="TCustomColorListBox.ColorNames">
<short>
<var>ColorNames</var> - the name of the indexed colour, stored as a string</short>
</element>
<element name="TCustomColorListBox.DefaultColorColor">
<short>
<var>DefaultColorColor</var> - the default colour, expressed as a Color value</short>
<descr>
<p>
<var>DefaultColorColor</var> - the default colour, expressed as a Color value</p>
<p>The use of the construct <var>..ColorColor</var> denotes the value of a colour as a TColor, as opposed to an index value</p>
</descr>
</element>
<element name="TCustomColorListBox.NoneColorColor">
<short>
<var>NoneColorColor</var> - the colour to be used when no selection has been made, or when <var>None</var> is selected, stored as a <var>TColor</var>
</short>
</element>
<element name="TCustomColorListBox.OnGetColors">
<short>
<var>OnGetColors</var> - event handler for the instruction to Get Colours</short>
</element>
<element name="TColorListBox.DefaultColorColor" link="#LCL.ColorBox.TCustomColorListBox.DefaultColorColor"/>
<element name="TColorListBox.NoneColorColor" link="#LCL.ColorBox.TCustomColorListBox.NoneColorColor"/>
<element name="TColorListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style"/>
<element name="TColorListBox.OnGetColors" link="#LCL.ColorBox.TCustomColorListBox.OnGetColors"/>
<element name="TColorListBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
<element name="TColorListBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode"/>
<element name="TColorListBox.BidiMode" link="#LCL.Controls.TControl.BiDiMode"/>
</module>
<!-- ColorBox -->
</package>

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

@ -3563,7 +3563,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<!-- procedure Visibility: protected -->
<element name="TCustomListBox.DrawItem">
<short>
<var>DrawItem</var> - method to draw the nominated indexed item in the sspecified rectangle</short>
<var>DrawItem</var> - method to draw the nominated indexed item in the specified rectangle</short>
<descr/>
<errors/>
<seealso/>