diff options
| author | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2009-04-30 15:07:33 +0200 |
|---|---|---|
| committer | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2009-04-30 15:07:33 +0200 |
| commit | 5938624155ba6f518bb1a0e9f666a3357f7939ba (patch) | |
| tree | cd8354ca7cc7d8ac5e61d42c2e15c5f2bc9bbbe1 /docs/xml/gui/fpg_hyperlink.xml | |
| parent | 4fb77f79530825505380fb818627e15c18edbe9d (diff) | |
| download | fpGUI-5938624155ba6f518bb1a0e9f666a3357f7939ba.tar.xz | |
Documentation update
* updated all the fpdoc xml documentation files to reference the new unit names.
* Fixed the build scripts
* trimmed the xml files to only contain nodes that have actual documentation.
Diffstat (limited to 'docs/xml/gui/fpg_hyperlink.xml')
| -rw-r--r-- | docs/xml/gui/fpg_hyperlink.xml | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/xml/gui/fpg_hyperlink.xml b/docs/xml/gui/fpg_hyperlink.xml new file mode 100644 index 00000000..fd99f0ea --- /dev/null +++ b/docs/xml/gui/fpg_hyperlink.xml @@ -0,0 +1,49 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> + <package name="GUI"> + <module name="fpg_hyperlink"> + <short>A label component that can launch a web browser</short> + <descr>This component acts like a link found in a web page. You can assign a +target URL and if the user clicks on the component, it will launch a web browser +using the target URL as destination.</descr> + <element name="TfpgHyperlink"> + <short>A <var>TfpgCustomLabel</var> descendant that implements hyperlink support</short> + <descr>This is a class to implement a hyperlink. Of course, such as all +the other fpGUI components it is cross platform (Windows, Linux) but its +behaviour can be different because of the the way the browser is called. Under Windows the +ShellExecute Windows API is used, so you can have any web compliant URL as the +hyperlink target. For example, the typical http:// hyperlink but also a +mailto: link will work. Under Linux you can only use the typical http:// hyperlink. +</descr> + </element> + <element name="TfpgHyperlink.URL"> + <short>String type property that contains the hyperlink target.</short> + </element> + <element name="TfpgHyperlink.FontDesc"> + <short>Standard font for this component is Arial-8:antialias=true:underline</short> + </element> + <element name="TfpgHyperlink.HandleLMouseDown"> + <short>This overriden procedure intercepts left mouse keydown, call its inherited method and run GoHyperLink method to jump hyperlink. </short> + </element> + <element name="TfpgHyperlink.GoHyperLink"> + <short>Jump to hyperlink.</short> + </element> + <element name="TfpgHyperlink.Autosize"> + <short>Its default is True, so the hyperlink width is automatically determined.</short> + </element> + <element name="TfpgHyperlink.Text"> + <short>Text description for the hyperlink.</short> + <descr>It can be different from the URL target and more descriptive.</descr> + </element> + <element name="TfpgHyperlink.TextColor"> + <short>Color of Text property.</short> + </element> + <element name="TfpgHyperlink.HotTrackFont"> + <short>This property is the type of font when mouse is over the hyperlink</short> + </element> + <element name="TfpgHyperlink.HotTrackColor"> + <short>Same as HotTrackFont but for TextColor property when the mouse is over the hyperlink.</short> + </element> + </module> + </package> +</fpdoc-descriptions> |