diff options
author | Tristan Van Berkom <tvb@src.gnome.org> | 2006-02-10 08:02:19 +0000 |
---|---|---|
committer | Tristan Van Berkom <tvb@src.gnome.org> | 2006-02-10 08:02:19 +0000 |
commit | eac7e6c3533f34cdd22bf59ed422be59ff88f90b (patch) | |
tree | 7f6a33cd5f2cc793b26ff246a59e21fe3b27e33e | |
parent | 3784941d349d51ef8afc65bc12ad441a4df3f90d (diff) | |
download | glade-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.
-rw-r--r-- | ChangeLog | 5 | ||||
-rw-r--r-- | doc/gladeui-docs.sgml | 6 | ||||
-rw-r--r-- | doc/gladeui-sections.txt | 22 | ||||
-rw-r--r-- | doc/tmpl/glade-clipboard-view.sgml | 6 | ||||
-rw-r--r-- | doc/tmpl/glade-clipboard.sgml | 6 | ||||
-rw-r--r-- | doc/tmpl/glade-command.sgml | 69 | ||||
-rw-r--r-- | doc/tmpl/glade-editor-property.sgml | 6 | ||||
-rw-r--r-- | doc/tmpl/glade-editor.sgml | 5 | ||||
-rw-r--r-- | doc/tmpl/glade-fixed-manager.sgml | 5 | ||||
-rw-r--r-- | doc/tmpl/glade-palette.sgml | 6 | ||||
-rw-r--r-- | doc/tmpl/glade-parameter.sgml | 7 | ||||
-rw-r--r-- | doc/tmpl/glade-placeholder.sgml | 8 | ||||
-rw-r--r-- | doc/tmpl/glade-project-view.sgml | 6 | ||||
-rw-r--r-- | doc/tmpl/glade-property-class.sgml | 7 | ||||
-rw-r--r-- | doc/tmpl/glade-property.sgml | 10 | ||||
-rw-r--r-- | doc/tmpl/glade-signal-editor.sgml | 8 | ||||
-rw-r--r-- | doc/tmpl/glade-utils.sgml | 6 | ||||
-rw-r--r-- | doc/tmpl/glade-widget-class.sgml | 6 | ||||
-rw-r--r-- | doc/tmpl/glade-widget.sgml | 14 | ||||
-rw-r--r-- | src/glade-app.h | 2 | ||||
-rw-r--r-- | src/glade-project-view.h | 5 | ||||
-rw-r--r-- | src/glade-project.h | 2 |
22 files changed, 137 insertions, 80 deletions
@@ -1,3 +1,8 @@ +2006-02-10 Tristan Van Berkom <tvb@gnome.org> + + * doc/*.sgml, doc/tmpl/*.sgml: Finished writing up short and long + descriptions for all generated docs, also fixed up main page a bit. + 2006-02-09 Tristan Van Berkom <tvb@gnome.org> * configure.in: Glade 3.0 --> Glade-3 diff --git a/doc/gladeui-docs.sgml b/doc/gladeui-docs.sgml index 4da1b9bc..95a55706 100644 --- a/doc/gladeui-docs.sgml +++ b/doc/gladeui-docs.sgml @@ -73,14 +73,14 @@ and you should have recieved a copy with the glade-3 tarball. &GladePalette; &GladeClipboardView; &GladeProjectView; + &GladeSignalEditor; </part> <part id="misc"> - <title>The rest</title> - &GladeSignalEditor; + <title>Miscalanious utilities</title> &GladeFixedManager; - &GladeParameter; &GladePlaceholder; + &GladeParameter; &GladeUtils; </part> diff --git a/doc/gladeui-sections.txt b/doc/gladeui-sections.txt index 01880c18..14525e8d 100644 --- a/doc/gladeui-sections.txt +++ b/doc/gladeui-sections.txt @@ -68,6 +68,7 @@ glade_app_get_type GLADE_APP_CLASS GLADE_IS_APP_CLASS GLADE_APP_GET_CLASS +GladeAppClass <SUBSECTION Private> GLADE_CONFIG_FILENAME GladeAppPriv @@ -89,6 +90,7 @@ glade_clipboard_view_get_type GLADE_CLIPBOARD_VIEW_CLASS GLADE_IS_CLIPBOARD_VIEW_CLASS GLADE_CLIPBOARD_VIEW_GET_CLASS +GladeClipboardViewClass </SECTION> <SECTION> @@ -106,24 +108,25 @@ GLADE_CLIPBOARD GLADE_IS_CLIPBOARD GLADE_TYPE_CLIPBOARD glade_clipboard_get_type +GladeClipboardClass </SECTION> <SECTION> <FILE>glade-command</FILE> <TITLE>GladeCommand</TITLE> -GCSetPropData glade_command_undo glade_command_redo glade_command_next_undo_item glade_command_next_redo_item glade_command_push_group glade_command_pop_group +glade_command_set_name +glade_command_create +glade_command_delete +GCSetPropData glade_command_set_property glade_command_set_properties glade_command_set_properties_list -glade_command_set_name -glade_command_delete -glade_command_create glade_command_cut glade_command_copy glade_command_paste @@ -138,6 +141,8 @@ glade_command_get_type GLADE_COMMAND_CLASS GLADE_IS_COMMAND_CLASS GLADE_COMMAND_GET_CLASS +GladeCommandClass +GladeCommand </SECTION> <SECTION> @@ -157,6 +162,7 @@ glade_editor_property_get_type GLADE_EDITOR_PROPERTY_CLASS GLADE_IS_EDITOR_PROPERTY_CLASS GLADE_EDITOR_PROPERTY_GET_CLASS +GladeEditorPropertyClass </SECTION> <SECTION> @@ -199,6 +205,7 @@ glade_fixed_manager_get_type GLADE_FIXED_MANAGER_CLASS GLADE_IS_FIXED_MANAGER_CLASS GLADE_FIXED_MANAGER_GET_CLASS +GladeFixedManagerClass </SECTION> <SECTION> @@ -215,6 +222,7 @@ glade_palette_get_type GLADE_PALETTE_CLASS GLADE_IS_PALETTE_CLASS GLADE_PALETTE_GET_CLASS +GladePaletteClass </SECTION> <SECTION> @@ -231,6 +239,7 @@ glade_placeholder_get_type GLADE_PLACEHOLDER_CLASS GLADE_IS_PLACEHOLDER_CLASS GLADE_PLACEHOLDER_GET_CLASS +GladePlaceholderClass <SUBSECTION Private> GLADE_PLACEHOLDER_WIDTH_REQ GLADE_PLACEHOLDER_HEIGHT_REQ @@ -253,6 +262,7 @@ glade_project_view_get_type GLADE_PROJECT_VIEW_CLASS GLADE_IS_PROJECT_VIEW_CLASS GLADE_PROJECT_VIEW_GET_CLASS +GladeProjectViewClass </SECTION> <SECTION> @@ -291,6 +301,7 @@ glade_project_get_type GLADE_PROJECT_CLASS GLADE_IS_PROJECT_CLASS GLADE_PROJECT_GET_CLASS +GladeProjectClass </SECTION> <SECTION> @@ -358,6 +369,7 @@ GLADE_PROPERTY GLADE_IS_PROPERTY GLADE_TYPE_PROPERTY glade_property_get_type +GladePropertyKlass </SECTION> <SECTION> @@ -369,6 +381,7 @@ glade_signal_editor_load_widget <SUBSECTION Standard> GLADE_SIGNAL_EDITOR GLADE_IS_SIGNAL_EDITOR +GladeEditorClass </SECTION> <SECTION> @@ -486,6 +499,7 @@ glade_widget_get_type GLADE_WIDGET_KLASS GLADE_IS_WIDGET_KLASS GLADE_WIDGET_GET_KLASS +GladeWidgetKlass </SECTION> <SECTION> 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 ##### --> diff --git a/src/glade-app.h b/src/glade-app.h index 1dd4f9cb..5fe3b297 100644 --- a/src/glade-app.h +++ b/src/glade-app.h @@ -61,7 +61,7 @@ struct _GladeAppClass }; LIBGLADEUI_API -GType glade_app_get_type (void); +GType glade_app_get_type (void) G_GNUC_CONST; LIBGLADEUI_API GladeApp* glade_app_new (void); diff --git a/src/glade-project-view.h b/src/glade-project-view.h index 4fa72fc3..f423442d 100644 --- a/src/glade-project-view.h +++ b/src/glade-project-view.h @@ -90,6 +90,11 @@ struct _GladeProjectViewClass GladeProject *project); }; +/** + * GladeProjectViewType: + * @GLADE_PROJECT_VIEW_LIST: View only toplevels as a flat list + * @GLADE_PROJECT_VIEW_TREE: View as the entire project tree + */ typedef enum { GLADE_PROJECT_VIEW_LIST, GLADE_PROJECT_VIEW_TREE, diff --git a/src/glade-project.h b/src/glade-project.h index f75788f1..b5ba446b 100644 --- a/src/glade-project.h +++ b/src/glade-project.h @@ -20,7 +20,7 @@ typedef struct _GladeProjectClass GladeProjectClass; */ struct _GladeProject { - GObject object; /* We emit signals */ + GObject object; gchar *name; /* The name of the project like network-conf */ |