summaryrefslogtreecommitdiff
path: root/docs/xml/gui/fpg_dialogs.xml
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graeme@mastermaths.co.za>2009-04-30 15:07:33 +0200
committerGraeme Geldenhuys <graeme@mastermaths.co.za>2009-04-30 15:07:33 +0200
commit5938624155ba6f518bb1a0e9f666a3357f7939ba (patch)
treecd8354ca7cc7d8ac5e61d42c2e15c5f2bc9bbbe1 /docs/xml/gui/fpg_dialogs.xml
parent4fb77f79530825505380fb818627e15c18edbe9d (diff)
downloadfpGUI-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_dialogs.xml')
-rw-r--r--docs/xml/gui/fpg_dialogs.xml144
1 files changed, 144 insertions, 0 deletions
diff --git a/docs/xml/gui/fpg_dialogs.xml b/docs/xml/gui/fpg_dialogs.xml
new file mode 100644
index 00000000..62b43bbb
--- /dev/null
+++ b/docs/xml/gui/fpg_dialogs.xml
@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<fpdoc-descriptions>
+<package name="GUI">
+
+<module name="fpg_dialogs">
+<short>Various dialogs used by fpGUI based applications.</short>
+<descr>
+</descr>
+
+<!-- object Visibility: default -->
+<element name="TfpgMessageBox">
+<short>A standard message box dialog.</short>
+<descr>
+A standard message box dialog. It is used by the global <link id="ShowMessage"/>
+function.
+</descr>
+</element>
+
+<!-- procedure Visibility: public -->
+<element name="TfpgMessageBox.SetMessage">
+<short>Sets the message to be displayed.</short>
+</element>
+
+<!-- object Visibility: default -->
+<element name="TfpgBaseDialog">
+<short>An abstract dialog which forms the basis of other dialogs.</short>
+<descr>
+This dialog implements the two basic buttons (OK, Cancel) and also some
+keyboard support like Escape to close the dialog.
+</descr>
+</element>
+
+<!-- object Visibility: default -->
+<element name="TfpgFontSelectDialog">
+<short>A standard font selection dialog.</short>
+<descr>
+It also contains a Collection listbox which gets automatically populated
+based on the available fonts. There are two custom collections called
+<i>Favourites</i> and <i>Recently Used</i> which list your own selection of
+fonts. <i>Font Aliases</i> will list all registered font aliases used by the
+application, including the default font aliases used by fpGUI (eg: #Edit2 =
+'Courier New-10').
+</descr>
+</element>
+
+<!-- procedure Visibility: public -->
+<element name="TfpgFontSelectDialog.SetSampleText">
+<short>The sample text or font preview text to be shown.</short>
+</element>
+
+<!-- object Visibility: default -->
+<element name="TfpgFileDialog">
+<short>File Open or File Save dialog.</short>
+<descr>
+This dialog acts as both the <i>File Open</i> or <i>File Save</i> dialog used
+in fpGUI applications. The specific one needed can be launched by the
+<link id="TfpgFileDialog.RunOpenFile"/> or the <link id="TfpgFileDialog.RunSaveFile"/>
+methods.
+</descr>
+</element>
+
+<!-- variable Visibility: public -->
+<element name="TfpgFileDialog.FileName">
+<short>The filename selected by the user.</short>
+</element>
+
+<!-- function Visibility: public -->
+<element name="TfpgFileDialog.SelectFile">
+<short>Select specified file at startup.</short>
+<descr>
+When the dialog is opened the file specified is pre selected.
+</descr>
+</element>
+
+<!-- function Visibility: public -->
+<element name="TfpgFileDialog.RunOpenFile">
+<short>Open the dialog as a File Open dialog.</short>
+</element>
+
+<!-- function Visibility: public -->
+<element name="TfpgFileDialog.RunSaveFile">
+<short>Open the dialog as File Save dialog.</short>
+</element>
+
+<!-- property Visibility: public -->
+<element name="TfpgFileDialog.Filter">
+<short>File mask filters available in the dialog.</short>
+<descr>
+<p>
+The filter consists out of two parts separated by a | sign. If more than
+one filter needs to be specified each filter is also separated by a | sign.
+The format for a single filter is: &lt;description&gt;|&lt;filemask&gt;
+The format for multiple filters are: &lt;description&gt;|&lt;filemask&gt;|&lt;description&gt;|&lt;filemask&gt;|&lt;description&gt;|&lt;filemask&gt;
+</p>
+<p>
+ Example:<br/>
+ <ul>
+ <li><p>'All Files (*)|*'</p></li>
+ <li><p>'All Files (*)|*|Object Pascal (*.pas)|*.pas'</p></li>
+ </ul>
+</p>
+<p>
+A filemask can also contain more than one mask separated by a ; sign.<br/>
+eg: 'Object Pascal|*.pas;*.lpi;*.pp'
+</p>
+</descr>
+</element>
+
+<!-- property Visibility: public -->
+<element name="TfpgFileDialog.ShowHidden">
+<short>If set to True the dialog will list hidden files as well.</short>
+</element>
+
+<!-- procedure Visibility: default -->
+<element name="ShowMessage">
+<short>Displays a message box with an OK button.</short>
+<descr>
+Call ShowMessage to display a simple message box with an OK button. If ATitle is
+not specified the caption of the message box will be 'Message'.
+</descr>
+</element>
+
+<!-- argument Visibility: default -->
+<element name="ShowMessage.AMessage">
+<short>AMessage parameter is the message string that appears in the message box.</short>
+</element>
+
+<!-- argument Visibility: default -->
+<element name="ShowMessage.ATitle">
+<short>ATitle parameter is the string that appears as the caption of the message box.</short>
+</element>
+
+<!-- function Visibility: default -->
+<element name="SelectFontDialog">
+<short>A convenience function to show the font selection dialog.</short>
+<seealso>
+ <link id="TfpgFontSelectDialog"/>
+</seealso>
+</element>
+
+</module>
+
+</package>
+</fpdoc-descriptions>