summaryrefslogtreecommitdiff
path: root/doc/tmpl
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tmpl')
-rw-r--r--doc/tmpl/glade-clipboard-view.sgml6
-rw-r--r--doc/tmpl/glade-clipboard.sgml6
-rw-r--r--doc/tmpl/glade-command.sgml69
-rw-r--r--doc/tmpl/glade-editor-property.sgml6
-rw-r--r--doc/tmpl/glade-editor.sgml5
-rw-r--r--doc/tmpl/glade-fixed-manager.sgml5
-rw-r--r--doc/tmpl/glade-palette.sgml6
-rw-r--r--doc/tmpl/glade-parameter.sgml7
-rw-r--r--doc/tmpl/glade-placeholder.sgml8
-rw-r--r--doc/tmpl/glade-project-view.sgml6
-rw-r--r--doc/tmpl/glade-property-class.sgml7
-rw-r--r--doc/tmpl/glade-property.sgml10
-rw-r--r--doc/tmpl/glade-signal-editor.sgml8
-rw-r--r--doc/tmpl/glade-utils.sgml6
-rw-r--r--doc/tmpl/glade-widget-class.sgml6
-rw-r--r--doc/tmpl/glade-widget.sgml14
16 files changed, 104 insertions, 71 deletions
diff --git a/doc/tmpl/glade-clipboard-view.sgml b/doc/tmpl/glade-clipboard-view.sgml
index 9148d38c..8449a173 100644
--- a/doc/tmpl/glade-clipboard-view.sgml
+++ b/doc/tmpl/glade-clipboard-view.sgml
@@ -2,11 +2,13 @@
GladeClipboardView
<!-- ##### SECTION Short_Description ##### -->
-
+A widget to view and control the #GladeClipboard
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+The #GladeClipboardView is a widget to view the #GladeWidget objects
+in the #GladeClipboard; the user can paste or delete objects on the
+clipboard.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-clipboard.sgml b/doc/tmpl/glade-clipboard.sgml
index ab1d3e6e..a7dfe4b1 100644
--- a/doc/tmpl/glade-clipboard.sgml
+++ b/doc/tmpl/glade-clipboard.sgml
@@ -2,11 +2,13 @@
GladeClipboard
<!-- ##### SECTION Short_Description ##### -->
-
+A list of #GladeWidget objects not in any #GladeProject
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+The #GladeClipboard is a singleton and is an accumulative shelf
+of all cut or copied #GladeWidget in the application. A #GladeWidget
+can be cut from one #GladeProject and pasted to another.
</para>
<!-- ##### SECTION See_Also ##### -->
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 ##### -->
diff --git a/doc/tmpl/glade-editor-property.sgml b/doc/tmpl/glade-editor-property.sgml
index 1c33675e..bc370a09 100644
--- a/doc/tmpl/glade-editor-property.sgml
+++ b/doc/tmpl/glade-editor-property.sgml
@@ -2,11 +2,13 @@
GladeEditorProperty
<!-- ##### SECTION Short_Description ##### -->
-
+A generic widget to edit a #GladeProperty
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+The #GladeEditorProperty is a factory that will create the correct
+control for the #GladePropertyClass it was created for and provides
+a simple unified api to them.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-editor.sgml b/doc/tmpl/glade-editor.sgml
index ce00e1fe..530f7250 100644
--- a/doc/tmpl/glade-editor.sgml
+++ b/doc/tmpl/glade-editor.sgml
@@ -2,11 +2,12 @@
GladeEditor
<!-- ##### SECTION Short_Description ##### -->
-
+A Widget to edit a #GladeWidget
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+This is the Glade Notebook containing all the controls needed to
+configure a #GladeWidget.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-fixed-manager.sgml b/doc/tmpl/glade-fixed-manager.sgml
index 433c117f..7c407462 100644
--- a/doc/tmpl/glade-fixed-manager.sgml
+++ b/doc/tmpl/glade-fixed-manager.sgml
@@ -2,11 +2,12 @@
GladeFixedManager
<!-- ##### SECTION Short_Description ##### -->
-
+A mechanism to handle free from widget placement containers
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+This object provides a flexable layer that allows plugins to
+implement free-form placement of child widgets.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-palette.sgml b/doc/tmpl/glade-palette.sgml
index 57c798f8..a95d6b7e 100644
--- a/doc/tmpl/glade-palette.sgml
+++ b/doc/tmpl/glade-palette.sgml
@@ -2,11 +2,13 @@
GladePalette
<!-- ##### SECTION Short_Description ##### -->
-
+A widget to select a #GladeWidgetClass for addition
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#GladePalette is responsable for displaying the list of available
+#GladeWidgetClass types and publishing the currently selected class
+to the Glade core.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-parameter.sgml b/doc/tmpl/glade-parameter.sgml
index 8d4ea6ce..410af654 100644
--- a/doc/tmpl/glade-parameter.sgml
+++ b/doc/tmpl/glade-parameter.sgml
@@ -1,12 +1,13 @@
<!-- ##### SECTION Title ##### -->
-glade-parameter
+Catalog Parameters
<!-- ##### SECTION Short_Description ##### -->
-
+Parameters set in the catalog retrievable from the plugin
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Parameters can be set in your catalog file that may determine how
+your plugin will treat certain widget classes.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-placeholder.sgml b/doc/tmpl/glade-placeholder.sgml
index eca25ec4..9487a8f4 100644
--- a/doc/tmpl/glade-placeholder.sgml
+++ b/doc/tmpl/glade-placeholder.sgml
@@ -2,11 +2,15 @@
GladePlaceholder
<!-- ##### SECTION Short_Description ##### -->
-
+A #GtkWidget to fill empty places
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Generally in Glade, container widgets are implemented with #GladePlaceholder
+children to allow users to 'click' and add thier widgets to a container.
+It is the responsability of the plugin writer to create placeholders for
+container widgets where appropriate; usually in #GladePostCreateFunc
+when the #GladeCreateReason is %GLADE_CREATE_USER.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-project-view.sgml b/doc/tmpl/glade-project-view.sgml
index e9a6597c..74da478f 100644
--- a/doc/tmpl/glade-project-view.sgml
+++ b/doc/tmpl/glade-project-view.sgml
@@ -2,11 +2,13 @@
GladeProjectView
<!-- ##### SECTION Short_Description ##### -->
-
+A widget to view the project heirarchy
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+The #GladeProjectView is a heirarchical treeview that allows the
+user to control selection and cut/copy/paste/delete #GladeWidget
+objects in the #GladeProject.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-property-class.sgml b/doc/tmpl/glade-property-class.sgml
index e4b20152..efa0fddf 100644
--- a/doc/tmpl/glade-property-class.sgml
+++ b/doc/tmpl/glade-property-class.sgml
@@ -2,11 +2,14 @@
GladePropertyClass
<!-- ##### SECTION Short_Description ##### -->
-
+Property Class-wide metadata
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#GladePropertyClass is a structure based on a #GParamSpec and parameters
+from the Glade catalog files and describes how properties are to be handled
+in Glade; it also provides an interface to convert #GValue to strings and
+va_lists etc (back and forth).
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-property.sgml b/doc/tmpl/glade-property.sgml
index 8d5fd5aa..4b79889f 100644
--- a/doc/tmpl/glade-property.sgml
+++ b/doc/tmpl/glade-property.sgml
@@ -2,11 +2,17 @@
GladeProperty
<!-- ##### SECTION Short_Description ##### -->
-
+An interface to properties on the #GladeWidget
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Every object property of every #GladeWidget in every #GladeProject has
+a #GladeProperty to interface with, #GladeProperty provides a means
+to handle properties in the runtime environment.
+</para>
+<para>
+A #GladeProperty can be seen as an instance of a #GladePropertyClass,
+the #GladePropertyClass describes how a #GladeProperty will function.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-signal-editor.sgml b/doc/tmpl/glade-signal-editor.sgml
index 7e5e18e2..30be8a56 100644
--- a/doc/tmpl/glade-signal-editor.sgml
+++ b/doc/tmpl/glade-signal-editor.sgml
@@ -1,12 +1,14 @@
<!-- ##### SECTION Title ##### -->
-glade-signal-editor
+Glade Signal Editor
<!-- ##### SECTION Short_Description ##### -->
-
+An interface to edit signals for a #GladeWidget
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+This isnt really a dockable widget, since you need to access the
+#GladeSignalEditor struct's '->main_window' widget, the signal editor
+is mostly of interest when implementing a custom object editor.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-utils.sgml b/doc/tmpl/glade-utils.sgml
index 72b1ccdb..06a55cea 100644
--- a/doc/tmpl/glade-utils.sgml
+++ b/doc/tmpl/glade-utils.sgml
@@ -1,12 +1,12 @@
<!-- ##### SECTION Title ##### -->
-glade-utils
+Utilities
<!-- ##### SECTION Short_Description ##### -->
-
+Welcome to the zoo
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+This is where all of that really usefull miscalanious stuff lands up.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-widget-class.sgml b/doc/tmpl/glade-widget-class.sgml
index 7ed3aba6..ef93f8a9 100644
--- a/doc/tmpl/glade-widget-class.sgml
+++ b/doc/tmpl/glade-widget-class.sgml
@@ -2,11 +2,13 @@
GladeWidgetClass
<!-- ##### SECTION Short_Description ##### -->
-
+Object Class-wide metadata
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#GladeWidgetClass is a structure based on a #GType and parameters
+from the Glade catalog files and is the central metadata for object
+classes; it also provides an abstraction later to container apis.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/glade-widget.sgml b/doc/tmpl/glade-widget.sgml
index 229a0f03..50c47e61 100644
--- a/doc/tmpl/glade-widget.sgml
+++ b/doc/tmpl/glade-widget.sgml
@@ -52,37 +52,37 @@ convenience api for getting and setting properties (mostly from the plugin).
<!-- ##### ARG GladeWidget:class ##### -->
<para>
-Private
+
</para>
<!-- ##### ARG GladeWidget:internal ##### -->
<para>
-Private
+
</para>
<!-- ##### ARG GladeWidget:name ##### -->
<para>
-Can be used when implementing custom editors.
+
</para>
<!-- ##### ARG GladeWidget:object ##### -->
<para>
-Private
+
</para>
<!-- ##### ARG GladeWidget:parent ##### -->
<para>
-Private
+
</para>
<!-- ##### ARG GladeWidget:project ##### -->
<para>
-Private
+
</para>
<!-- ##### ARG GladeWidget:properties ##### -->
<para>
-Private
+
</para>
<!-- ##### FUNCTION glade_widget_new ##### -->