summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graeme@mastermaths.co.za>2010-08-23 09:38:32 +0200
committerGraeme Geldenhuys <graeme@mastermaths.co.za>2010-08-23 09:38:32 +0200
commit526f57bf7457490b7ee69a711c095c80bda4fcd3 (patch)
tree3b2fadff40aa30fe2042100449d9112fd1c92d3a
parent611080be88d3bf29f7b4dc0048ebd0a888edb4be (diff)
downloadfpGUI-526f57bf7457490b7ee69a711c095c80bda4fcd3.tar.xz
docs: added docs for fpg_command_intf unit.
-rw-r--r--docs/xml/corelib/fpg_command_intf.xml25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/xml/corelib/fpg_command_intf.xml b/docs/xml/corelib/fpg_command_intf.xml
new file mode 100644
index 00000000..03ec28bb
--- /dev/null
+++ b/docs/xml/corelib/fpg_command_intf.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<fpdoc-descriptions>
+<package name="fpGUI">
+
+<module name="fpg_command_intf">
+<short>This unit defines the Command design pattern interfaces used by fpGUI</short>
+<descr><p><printshort id="fpg_command_intf"/>. The Command design pattern is similar to
+the TActions from Delphi or Lazarus.</p></descr>
+
+<element name="ICommand">
+<short>This interface represents a Command</short>
+<descr><printshort id="ICommand"/>. Currently in only defines one procedure called <var>Execute</var>.</descr>
+</element>
+
+
+<element name="ICommandHolder">
+<short>An interface that allows to Get or Set a Command</short>
+<descr><printshort id="ICommandHolder"/>. An example of a class that implements this interface
+is the <link id="fpg_button.TfpgBaseButton">TfpgBaseButton</link> class.</descr>
+</element>
+
+</module>
+
+</package>
+</fpdoc-descriptions>