diff options
| author | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-08-13 17:06:13 +0200 |
|---|---|---|
| committer | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-08-13 17:06:13 +0200 |
| commit | aee8d8d25b8e0b8551c0cac179e293ef8307c281 (patch) | |
| tree | e80cb3c42968a45ce2dd06ee476eeeca51651c6b /docs | |
| parent | e3660a8f7bf8ab5d7f14b22f418ef419172262f7 (diff) | |
| download | fpGUI-aee8d8d25b8e0b8551c0cac179e293ef8307c281.tar.xz | |
Documentation update for fpg_main and fpg_button.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/xml/corelib/fpg_main.xml | 5 | ||||
| -rw-r--r-- | docs/xml/gui/fpg_button.xml | 17 |
2 files changed, 18 insertions, 4 deletions
diff --git a/docs/xml/corelib/fpg_main.xml b/docs/xml/corelib/fpg_main.xml index 6eb0a8d5..574931ed 100644 --- a/docs/xml/corelib/fpg_main.xml +++ b/docs/xml/corelib/fpg_main.xml @@ -29,8 +29,9 @@ </element> <element name="fpgColorToRGB"> <short>Convert a color to the RGB values of that color</short> - <descr><printshort id="fpgColorToRGB"/>. Not all <link id="#fpgui.fpg_base.TfpgColor">TfpgColor</link> values are in RGB format. For example, you get "named" colors too (eg: clWindowBackground), which - is simply an index value, but later translated to a real RGB value via the theming system.</descr> + <descr><printshort id="fpgColorToRGB"/>. Not all <link id="fpg_base.TfpgColor">TfpgColor</link> values are in RGB format. +For example, you get "named" colors too (eg: clWindowBackground), which +is simply an index value, but later translated to a real RGB value via the theming system.</descr> </element> <element name="fpgGetNamedColor"> <short>Returns a "named" TfpgColor based on a RGB color</short> diff --git a/docs/xml/gui/fpg_button.xml b/docs/xml/gui/fpg_button.xml index 0058968a..137231ce 100644 --- a/docs/xml/gui/fpg_button.xml +++ b/docs/xml/gui/fpg_button.xml @@ -36,8 +36,21 @@ is centred in the available horizontal space of the button.</descr> <short>The registered name of a image to display on the button</short> <descr> <printshort id="TfpgBaseButton.ImageName"/>. This is the name used when -a image resource was registered with the global <link id="#fpgui.fpg_main.fpgImages">fpgImages</link> instance.</descr> - </element> +a image resource was registered with the global <link id="fpg_main.fpgImages">fpgImages</link> instance.</descr> + </element> + + <element name="TfpgButton"> + <short>Concrete button class used in user interfaces</short> + <descr><printshort id="TfpgButton"/>. This class is a descendant of <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link> and +simply publishes various properties for runtime type information.</descr> + <seealso> + <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link> + </seealso> + </element> + <element name="TfpgButton.ImageName" link="TfpgBaseButton.ImageName"/> + <element name="TfpgButton.ImageSpacing" link="TfpgBaseButton.ImageSpacing"/> + <element name="TfpgButton.ImageLayout" link="TfpgBaseButton.ImageLayout"/> + </module> </package> </fpdoc-descriptions> |