diff options
author | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-09-27 17:06:14 +0200 |
---|---|---|
committer | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2010-09-27 17:06:14 +0200 |
commit | 6c9eb1b024e629cc856d3414a96c863a13671a60 (patch) | |
tree | 3fafd4574e0940791305073d86ac937189599016 /docs | |
parent | 838d64e8e9609f88a930a6782300ba8def229837 (diff) | |
download | fpGUI-6c9eb1b024e629cc856d3414a96c863a13671a60.tar.xz |
docs: Moved additional topics into separate xml description files.
* So the changing default fpgui language topic has now moved out
of fpg_constants into its own xml file.
* Started a new topic related to drag and drop support.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/xml/corelib/fpg_constants.xml | 23 | ||||
-rw-r--r-- | docs/xml/fpgui_topic_defaultlanguage.xml | 31 | ||||
-rw-r--r-- | docs/xml/fpgui_topic_dnd.xml | 32 |
3 files changed, 64 insertions, 22 deletions
diff --git a/docs/xml/corelib/fpg_constants.xml b/docs/xml/corelib/fpg_constants.xml index 3f66acbe..52377575 100644 --- a/docs/xml/corelib/fpg_constants.xml +++ b/docs/xml/corelib/fpg_constants.xml @@ -20,7 +20,7 @@ has translations for:</p> <p>To change the default (compiled in) language used by fpGUI, simply enabled one of the language DEFINES in the interface section of the fpg_constants unit.</p> <p>For more details on changing the default language of fpGUI Toolkit, see the topic -"<link id="fpg_constants.ChangingDefaultLanguage">Changing the default language</link>".</p> +"<link id="#fpgui.AdditionalTopics.ChangingDefaultLanguage">Changing the default language</link>".</p> </descr> <element name="fpgAddColon"> <short>A utility function to add a colon at the correct location in a string</short> @@ -37,27 +37,6 @@ one of the language DEFINES in the interface section of the fpg_constants unit.< <short>Maximum distance a mouse pointer can move between two left-clicks and still trigger a double click event</short> </element> -<topic name="ChangingDefaultLanguage"> -<short>Changing the default language</short> -<descr><p>Inside the <var>fpg_constants.pas</var> unit there are a few commented language -defines. If no language specific Define is set, then fpGUI defaults to the English -language. So say you want to change the default language to German, simply uncomment -the <b>de</b> define, and recompile fpGUI. -</p> -<p>Here is a list of current supported languages and their commented defines as they -appear in the <var>fpg_constants</var> unit.</p> -<code> -{.$DEFINE de} // German -{.$DEFINE ru} // Russian -{.$DEFINE fr} // French -{.$DEFINE pt} // Portuguese (Brazil) -{.$DEFINE af} // Afrikaans -{.$DEFINE it} // Italian -{.$DEFINE es} // Spanish -</code> -</descr> -</topic> - </module> </package> </fpdoc-descriptions> diff --git a/docs/xml/fpgui_topic_defaultlanguage.xml b/docs/xml/fpgui_topic_defaultlanguage.xml new file mode 100644 index 00000000..a4d3fa79 --- /dev/null +++ b/docs/xml/fpgui_topic_defaultlanguage.xml @@ -0,0 +1,31 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> +<package name="fpGUI"> +<topic name="AdditionalTopics"> +<short>Additional Topics</short> + +<topic name="ChangingDefaultLanguage"> +<short>Changing the default language</short> +<descr><p>Inside the <var>fpg_constants.pas</var> unit there are a few commented language +defines. If no language specific Define is set, then fpGUI defaults to the English +language. So say you want to change the default language to German, simply uncomment +the <b>de</b> define, and recompile fpGUI. +</p> +<p>Here is a list of current supported languages and their commented defines as they +appear in the <var>fpg_constants</var> unit.</p> +<code> +{.$DEFINE de} // German +{.$DEFINE ru} // Russian +{.$DEFINE fr} // French +{.$DEFINE pt} // Portuguese (Brazil) +{.$DEFINE af} // Afrikaans +{.$DEFINE it} // Italian +{.$DEFINE es} // Spanish +</code> +</descr> + + +</topic> +</topic> +</package> +</fpdoc-descriptions> diff --git a/docs/xml/fpgui_topic_dnd.xml b/docs/xml/fpgui_topic_dnd.xml new file mode 100644 index 00000000..3c0f4346 --- /dev/null +++ b/docs/xml/fpgui_topic_dnd.xml @@ -0,0 +1,32 @@ +<?xml version="1.0"?> +<fpdoc-descriptions> +<package name="fpGUI"> +<topic name="AdditionalTopics"> +<short>Additional Topics</short> +<topic name='DND'> + +<short>Drag and Drop</short> + +<descr><p>Drag and drop provides a simple visual mechanism which users can use +to transfer information between and within applications. [In the literature this +is referred to as a "direct manipulation model".] Drag and drop is similar in +function to the clipboard's cut and paste mechanism. +</p> +<p>This topic describes the basic drag and drop mechanism and outlines the +approach used to enable it in custom widgets. +</p> +<p><b>Drag and Drop Classes</b></p> +<p>These classes deal with drag and drop and the necessary mime type encoding and +decoding.</p> +<dl> +<dt>TfpgDrag</dt><dd>The Object that initializes the drag and drop action, and +that manages the lifespan of the TfpgMimeData instance.</dd> +<dt>TfpgMimeData</dt><dd>This class manages data and a mime type describing that +data.</dd> +</dl> +</descr> + +</topic> +</topic> +</package> +</fpdoc-descriptions> |