diff options
| author | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-08-11 12:42:17 +0200 |
|---|---|---|
| committer | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-08-11 12:42:17 +0200 |
| commit | 1d09f41a5dd84dee6ada2bb8b6ca50a62d42c1cb (patch) | |
| tree | 4a9312e4d21e47fc340418229e712704d46bdccb /docs/xml/gui | |
| parent | ac6d561241ec7f4d1593b25c60b1e353b8f2677b (diff) | |
| download | fpGUI-1d09f41a5dd84dee6ada2bb8b6ca50a62d42c1cb.tar.xz | |
docs: New help description file for fpg_button.pas unit.
Diffstat (limited to 'docs/xml/gui')
| -rw-r--r-- | docs/xml/gui/fpg_button.xml | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/xml/gui/fpg_button.xml b/docs/xml/gui/fpg_button.xml new file mode 100644 index 00000000..0058968a --- /dev/null +++ b/docs/xml/gui/fpg_button.xml @@ -0,0 +1,43 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> + <package name="fpGUI"> + <module name="fpg_button"> + <short>This unit defines the push button classes.</short> + <element name="TImageLayout"> + <short>Enum type defining the position of images inside a Button</short> + </element> + <element name="TImageLayout.ilImageLeft"> + <short>Image to the left of the button text.</short> + </element> + <element name="TImageLayout.ilImageTop"> + <short>Image above the button text.</short> + </element> + <element name="TImageLayout.ilImageRight"> + <short>Image to the right of the button text.</short> + </element> + <element name="TImageLayout.ilImageBottom"> + <short>Image below the button text.</short> + </element> + <element name="TfpgBaseButton"> + <short>Base class the represents a push button control</short> + </element> + <element name="TfpgBaseButton.ImageLayout"> + <short>Defines where on the button the image will be displayed</short> + </element> + <element name="TfpgBaseButton.ImageSpacing"> + <short>The spacing between the Image and the Text</short> + <descr>The <var>ImageSpacing</var> value is in pixels. The value range +is from -1 to any positive value. -1 has a special meaning and is also the +default value. When ImageSpacing equals -1, then the spacing between the button +image and the button text is automatically calculated so that the button text +is centred in the available horizontal space of the button.</descr> + </element> + <element name="TfpgBaseButton.ImageName"> + <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> + </module> + </package> +</fpdoc-descriptions> |