From 16d49d8eabf304cd951b3a4b47e19ddb071be286 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Tue, 30 Dec 2008 22:06:37 +0000 Subject: [PATCH] FPDoc - some corrections, updates and links to descriptions in actnlist.xml, buttonpanel.xml. buttons.xml, colorbox.xml and stdctrls.xml git-svn-id: trunk@18000 - --- docs/xml/lcl/actnlist.xml | 38 ++++++++---- docs/xml/lcl/buttonpanel.xml | 2 +- docs/xml/lcl/buttons.xml | 112 ++++++++++++++++++++++++++++------- docs/xml/lcl/colorbox.xml | 91 ++++++++++++++++++++++++++-- docs/xml/lcl/stdctrls.xml | 2 +- 5 files changed, 205 insertions(+), 40 deletions(-) diff --git a/docs/xml/lcl/actnlist.xml b/docs/xml/lcl/actnlist.xml index bfd9e7d331..7352141ae9 100644 --- a/docs/xml/lcl/actnlist.xml +++ b/docs/xml/lcl/actnlist.xml @@ -1313,7 +1313,8 @@ executed at this point in time. - + + SetAutoCheck - specifies the value of AutoCheck, whether True or False @@ -1324,7 +1325,8 @@ executed at this point in time. - + + SetCaption - specifies the string to be used as caption @@ -1335,7 +1337,8 @@ executed at this point in time. - + + SetChecked - specifies the value of the Checked property: True or False @@ -1357,7 +1360,8 @@ executed at this point in time. - + + SetGroupIndex - specifies the value for the Group Index @@ -1368,7 +1372,8 @@ executed at this point in time. - + + SetHelpContext - specifies the value to be used for context-sensitive Help @@ -1379,7 +1384,8 @@ executed at this point in time. - + + SetHelpKeyword - specifies the keyword to be used for Help @@ -1390,7 +1396,8 @@ executed at this point in time. - + + SetHelpType - specifies the trpe of Help to be used @@ -1401,7 +1408,8 @@ executed at this point in time. - + + SetHint - specifies the string to be used for Hints @@ -1412,7 +1420,8 @@ executed at this point in time. - + + SetImageIndex - specifies the index value for the image associated with the action @@ -1423,7 +1432,8 @@ executed at this point in time. - + + SetShortCut - specifies the shortcut for the action @@ -1434,7 +1444,9 @@ executed at this point in time. - + + SetVisible - specifies whether or not the control for the action is Visible + @@ -1555,7 +1567,9 @@ executed at this point in time. - + + TActionLinkClass - class of TActionLink + diff --git a/docs/xml/lcl/buttonpanel.xml b/docs/xml/lcl/buttonpanel.xml index 7877869db2..c9d1b7a34e 100644 --- a/docs/xml/lcl/buttonpanel.xml +++ b/docs/xml/lcl/buttonpanel.xml @@ -385,7 +385,7 @@ - ButtonOrder - the order in which the buttons are to appear on th epanel + ButtonOrder - the order in which the buttons are to appear on the panel diff --git a/docs/xml/lcl/buttons.xml b/docs/xml/lcl/buttons.xml index a173c551d6..c0719b1db8 100644 --- a/docs/xml/lcl/buttons.xml +++ b/docs/xml/lcl/buttons.xml @@ -285,7 +285,26 @@ Take the following precautions when creating your own Destroy method: - A set of possible types for BitButtons. + + TBitBtnKind - enumerated type of possible kinds of BitButtons. + +

+ TBitBtnKind - enumerated type of possible kinds of BitButtons.

+ 
bkCustom, 
+bkOK, 
+bkCancel, 
+bkHelp, 
+bkYes, 
+bkNo,      
+bkClose, 
+bkAbort, 
+bkRetry, 
+bkIgnore, 
+bkAll,
+bkNoToAll,
+bkYesToAll
+
+ @@ -340,15 +359,22 @@ Take the following precautions when creating your own Destroy method: - + + + TBitBtnKinds - set of TBitBtnKind + + - The ancestor class for TBitBtn. - TCustomBitBtn is the ancestor for TBitBtn. If you want to define your own bitbutton class, you should use this class to derive it from. + + TCustomBitBtn - the ancestor class for TBitBtn. + TCustomBitBtn is the ancestor for TBitBtn. If you want to define your own bitbutton class, you should use this class to derive it from. + - + + FButtonGlyph - local variable holding the Glyph for this button @@ -499,7 +525,8 @@ Take the following precautions when creating your own Destroy method: - Change the action associated with this BitButton + + ActionChange - Change the action associated with this BitButton @@ -1115,7 +1142,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - The state of the speedbutton (whether checked or not) + + FState - local variable to hold the state of the speedbutton (whether checked or not) @@ -1214,7 +1242,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + SetDown - specifies the boolean value of Down (ie whether or not button was pressed) @@ -1225,7 +1254,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + SetGroupIndex - specifies the value of the Group Index @@ -1236,7 +1266,9 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + SetFlat - specifies whether or not the button is displayed Flat + @@ -1247,7 +1279,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + SetMargin - specifies the size of the margin @@ -1258,7 +1291,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + SetNumGlyphs - specifies the number of glyphs @@ -1269,7 +1303,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + SetSpacing - specifies the spacing between buttons @@ -1291,7 +1326,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + UpdateState - brings the state up oto date, implementing any pending changes, and rendering non-valid if InvalidateOnChange is True @@ -1313,12 +1349,13 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + + MouseInControl - returns True if the mouse cursor is in the control - + @@ -1333,7 +1370,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - + @@ -1689,10 +1726,11 @@ Properties are defined in the parent class TPop Draw the glyph in the specified canvas in the specified rectangle at a given offset within the client, with specified state and transparency - Find any Down button + + FindDownButton - returns the button that is down - Should accelerator character be shown (ie underlined character denoting key to be pressed for quick action) + Should accelerator character be shown (ie underlined character denoting key to be pressed for quick action)? Should caption be displayed? @@ -1720,9 +1758,41 @@ Properties are defined in the parent class TPop - + + + GetDrawDetails - returns the structured details for drawing + - + + + LoadGlyphFromLazarusResource - method for loading a glyph from a Lazarus Resource file (.lrs) + + + + LoadGlyphFromLazarusResource - method for loading the glyph from a Lazarus resource file (.lrs) + + + + GetGlyphSize - returns the size of the glyoh within the specified PaintRect + + + + + GetTextSize - returns the size of the text within the specified PaintRect + + + + + TGetDefaultBitBtnGlyph - generic method to return a default Bit Button Glyph of specified Kind + + + + GetLCLDefaultBtnGlyph - generic method to return the LCL default button glyph of the specified Kind + + + + LoadGlyphFromLazarusResource - generic method to load a button glyph with specified name from a Lazarus Resource file (.lrs) + diff --git a/docs/xml/lcl/colorbox.xml b/docs/xml/lcl/colorbox.xml index b4bc2ea962..900bdf7dbc 100644 --- a/docs/xml/lcl/colorbox.xml +++ b/docs/xml/lcl/colorbox.xml @@ -1004,7 +1004,7 @@ The Palette of colours to be included - the colour that has been Selected from the ComboBox + The colour that has been Selected from the ComboBox @@ -1015,10 +1015,7 @@ SetStyle - specify the Style - - - DrawItem - draw the specified item in the list - + @@ -1032,6 +1029,90 @@ The Palette to be used to supply the colours + + + TColorBoxStyle - set of TColorBoxStyles + + + + + + + DoGetColors - perform the code for getting colours + + + + + PickCustomColor - if True, a custom colour is picked rather than one of the standard list + + + + + ColorNames - the name of the specified (indexed) colour, stored as a string + + + + DefaultColorColor - the default colour, expressed as a Color value + +

+ DefaultColorColor - the default colour, expressed as a Color value

+

The use of the construct ..ColorColor denotes the value of a colour as a TColor, as opposed to an index value

+ + + + + NoneColorColor - the colour to be used when no selection has been made, or when None is selected, stored as a TColor + + + + + OnGetColors - event handler for the instruction to Get Colours + + + + + + + + + + DoGetColors - perform the code for getting the colours + + + + + PickCustomColor - if True, a custom colour is picked rather than one from the standard list + + + + + ColorNames - the name of the indexed colour, stored as a string + + + + DefaultColorColor - the default colour, expressed as a Color value + +

+ DefaultColorColor - the default colour, expressed as a Color value

+

The use of the construct ..ColorColor denotes the value of a colour as a TColor, as opposed to an index value

+ + + + + NoneColorColor - the colour to be used when no selection has been made, or when None is selected, stored as a TColor + + + + + OnGetColors - event handler for the instruction to Get Colours + + + + + + + + diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index eecdbe1917..39fb92de01 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -3563,7 +3563,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers - DrawItem - method to draw the nominated indexed item in the sspecified rectangle + DrawItem - method to draw the nominated indexed item in the specified rectangle