summaryrefslogtreecommitdiff
path: root/doc/tmpl/glade-command.sgml
diff options
context:
space:
mode:
authorTristan Van Berkom <tvb@src.gnome.org>2006-02-10 08:02:19 +0000
committerTristan Van Berkom <tvb@src.gnome.org>2006-02-10 08:02:19 +0000
commiteac7e6c3533f34cdd22bf59ed422be59ff88f90b (patch)
tree7f6a33cd5f2cc793b26ff246a59e21fe3b27e33e /doc/tmpl/glade-command.sgml
parent3784941d349d51ef8afc65bc12ad441a4df3f90d (diff)
downloadglade-eac7e6c3533f34cdd22bf59ed422be59ff88f90b.tar.gz
Finished writing up short and long descriptions for all generated docs,
* doc/*.sgml, doc/tmpl/*.sgml: Finished writing up short and long descriptions for all generated docs, also fixed up main page a bit.
Diffstat (limited to 'doc/tmpl/glade-command.sgml')
-rw-r--r--doc/tmpl/glade-command.sgml69
1 files changed, 36 insertions, 33 deletions
diff --git a/doc/tmpl/glade-command.sgml b/doc/tmpl/glade-command.sgml
index 1ca1ebbb..b38281cf 100644
--- a/doc/tmpl/glade-command.sgml
+++ b/doc/tmpl/glade-command.sgml
@@ -1,12 +1,13 @@
<!-- ##### SECTION Title ##### -->
-GladeCommand
+Glade Commands
<!-- ##### SECTION Short_Description ##### -->
-
+An event filter to implement the Undo/Redo stack
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+The Glade Command api allows us to view user actions as items and execute
+and undo those items; each #GladeProject has its own Undo/Redo stack.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -17,15 +18,6 @@ GladeCommand
<!-- ##### SECTION Stability_Level ##### -->
-<!-- ##### STRUCT GCSetPropData ##### -->
-<para>
-
-</para>
-
-@property:
-@new_value:
-@old_value:
-
<!-- ##### FUNCTION glade_command_undo ##### -->
<para>
@@ -75,62 +67,73 @@ GladeCommand
-<!-- ##### FUNCTION glade_command_set_property ##### -->
+<!-- ##### FUNCTION glade_command_set_name ##### -->
<para>
</para>
-@property:
-@value:
+@glade_widget:
+@name:
-<!-- ##### FUNCTION glade_command_set_properties ##### -->
+<!-- ##### FUNCTION glade_command_create ##### -->
<para>
</para>
-@property:
-@old_value:
-@new_value:
-@Varargs:
+@class:
+@parent:
+@placeholder:
+@project:
+@Returns:
-<!-- ##### FUNCTION glade_command_set_properties_list ##### -->
+<!-- ##### FUNCTION glade_command_delete ##### -->
<para>
</para>
-@project:
-@props:
+@widgets:
-<!-- ##### FUNCTION glade_command_set_name ##### -->
+<!-- ##### STRUCT GCSetPropData ##### -->
+<para>
+#GladeProperties can be set in a list as one command,
+for Undo purposes; we store the list of #GCSetPropData with
+their old and new #GValue.
+</para>
+
+@property: A #GladeProperty to set
+@new_value: The new #GValue to assign to @property
+@old_value: The old #GValue of @property
+
+<!-- ##### FUNCTION glade_command_set_property ##### -->
<para>
</para>
-@glade_widget:
-@name:
+@property:
+@value:
-<!-- ##### FUNCTION glade_command_delete ##### -->
+<!-- ##### FUNCTION glade_command_set_properties ##### -->
<para>
</para>
-@widgets:
+@property:
+@old_value:
+@new_value:
+@Varargs:
-<!-- ##### FUNCTION glade_command_create ##### -->
+<!-- ##### FUNCTION glade_command_set_properties_list ##### -->
<para>
</para>
-@class:
-@parent:
-@placeholder:
@project:
-@Returns:
+@props:
<!-- ##### FUNCTION glade_command_cut ##### -->