diff options
author | Vincent Geddes <vgeddes@src.gnome.org> | 2007-06-20 18:15:41 +0000 |
---|---|---|
committer | Vincent Geddes <vgeddes@src.gnome.org> | 2007-06-20 18:15:41 +0000 |
commit | f228d65a45f5e8ee066b576fb876021cd0241bf7 (patch) | |
tree | 6cbdd66e37387440cecd73495a6b077e8517cfea /doc | |
parent | 6fbff4c18912a2e81a98b0752bba5ba6af0cfe5f (diff) | |
download | glade-f228d65a45f5e8ee066b576fb876021cd0241bf7.tar.gz |
Set up documentation for GladeInspector.
* doc/gladeui-docs.sgml, doc/gladeui.types, doc/gladeui-sections.txt,
doc/tmpl/glade-inspector.sgml: Set up documentation for GladeInspector.
* po/POTFILES.in: Add glade-inspector.c
* gladeui/glade-inspector.[ch]: Add convenience function
`glade_inspector_new_with_project()'.
svn path=/trunk/; revision=1374
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gladeui-docs.sgml | 4 | ||||
-rw-r--r-- | doc/gladeui-sections.txt | 33 | ||||
-rw-r--r-- | doc/gladeui.types | 2 | ||||
-rw-r--r-- | doc/tmpl/glade-app.sgml | 13 | ||||
-rw-r--r-- | doc/tmpl/glade-inspector.sgml | 93 | ||||
-rw-r--r-- | doc/tmpl/glade-project-view.sgml | 61 | ||||
-rw-r--r-- | doc/tmpl/glade-widget-class.sgml | 11 |
7 files changed, 118 insertions, 99 deletions
diff --git a/doc/gladeui-docs.sgml b/doc/gladeui-docs.sgml index 062644dd..1d60c4d1 100644 --- a/doc/gladeui-docs.sgml +++ b/doc/gladeui-docs.sgml @@ -14,7 +14,7 @@ <!ENTITY GladePalette SYSTEM "xml/glade-palette.xml"> <!ENTITY GladeParameter SYSTEM "xml/glade-parameter.xml"> <!ENTITY GladePlaceholder SYSTEM "xml/glade-placeholder.xml"> -<!ENTITY GladeProjectView SYSTEM "xml/glade-project-view.xml"> +<!ENTITY GladeInspector SYSTEM "xml/glade-inspector.xml"> <!ENTITY GladeProject SYSTEM "xml/glade-project.xml"> <!ENTITY GladePropertyClass SYSTEM "xml/glade-property-class.xml"> <!ENTITY GladeProperty SYSTEM "xml/glade-property.xml"> @@ -76,7 +76,7 @@ &GladeEditorProperty; &GladePalette; &GladeClipboardView; - &GladeProjectView; + &GladeInspector; &GladeSignalEditor; </part> diff --git a/doc/gladeui-sections.txt b/doc/gladeui-sections.txt index e43bcb61..db349b59 100644 --- a/doc/gladeui-sections.txt +++ b/doc/gladeui-sections.txt @@ -1,4 +1,4 @@ -<INCLUDE>glade.h</INCLUDE> +<INCLUDE>gladeui/glade.h</INCLUDE> <SECTION> <FILE>glade-app</FILE> @@ -243,22 +243,23 @@ GLADE_PLACEHOLDER_HEIGHT_REQ </SECTION> <SECTION> -<FILE>glade-project-view</FILE> -<TITLE>GladeProjectView</TITLE> -GladeProjectViewType -GladeProjectView -glade_project_view_new -glade_project_view_get_project -glade_project_view_set_project +<FILE>glade-inspector</FILE> +<TITLE>GladeInspector</TITLE> +GladeInspector +glade_inspector_new +glade_inspector_new_with_project +glade_inspector_get_project +glade_inspector_set_project +glade_inspector_get_selected_items <SUBSECTION Standard> -GLADE_PROJECT_VIEW -GLADE_IS_PROJECT_VIEW -GLADE_TYPE_PROJECT_VIEW -glade_project_view_get_type -GLADE_PROJECT_VIEW_CLASS -GLADE_IS_PROJECT_VIEW_CLASS -GLADE_PROJECT_VIEW_GET_CLASS -GladeProjectViewClass +GLADE_INSPECTOR +GLADE_IS_INSPECTOR +GLADE_TYPE_INSPECTOR +GLADE_INSPECTOR_CLASS +GLADE_IS_INSPECTOR_CLASS +GLADE_INSPECTOR_GET_CLASS +glade_inspector_get_type +GladeInspectorClass </SECTION> <SECTION> diff --git a/doc/gladeui.types b/doc/gladeui.types index 211dc32d..44967dfd 100644 --- a/doc/gladeui.types +++ b/doc/gladeui.types @@ -10,6 +10,6 @@ glade_fixed_get_type glade_palette_get_type glade_placeholder_get_type glade_project_get_type -glade_project_view_get_type +glade_inspector_get_type glade_property_get_type glade_widget_get_type diff --git a/doc/tmpl/glade-app.sgml b/doc/tmpl/glade-app.sgml index 3918ed56..0572f661 100644 --- a/doc/tmpl/glade-app.sgml +++ b/doc/tmpl/glade-app.sgml @@ -48,6 +48,11 @@ to initialize the Glade core. </para> +<!-- ##### ARG GladeApp:pointer-mode ##### --> +<para> + +</para> + <!-- ##### FUNCTION glade_app_get ##### --> <para> @@ -192,14 +197,6 @@ to initialize the Glade core. -<!-- ##### FUNCTION glade_app_add_project_view ##### --> -<para> - -</para> - -@view: - - <!-- ##### FUNCTION glade_app_command_undo ##### --> <para> diff --git a/doc/tmpl/glade-inspector.sgml b/doc/tmpl/glade-inspector.sgml new file mode 100644 index 00000000..c440a4f4 --- /dev/null +++ b/doc/tmpl/glade-inspector.sgml @@ -0,0 +1,93 @@ +<!-- ##### SECTION Title ##### --> +GladeInspector + +<!-- ##### SECTION Short_Description ##### --> +A widget for inspecting objects in a #GladeProject + +<!-- ##### SECTION Long_Description ##### --> +<para> +A #GladeInspector is a widget for inspecting the objects that make up a user interface. +</para> + +<para> +An inspector is created by calling either glade_inspector_new() or glade_inspector_new_with_project(). +The #GladeInspector can be also be specifically made to inspect a #GladeProject by calling glade_inspector_set_project(). +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GladeInspector ##### --> +<para> +The #GladeInspector struct contains private data only, and should be manipulated using the functions below. +</para> + + +<!-- ##### SIGNAL GladeInspector::item-activated ##### --> +<para> + +</para> + +@gladeinspector: the object which received the signal. + +<!-- ##### SIGNAL GladeInspector::selection-changed ##### --> +<para> + +</para> + +@gladeinspector: the object which received the signal. + +<!-- ##### ARG GladeInspector:project ##### --> +<para> + +</para> + +<!-- ##### FUNCTION glade_inspector_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION glade_inspector_new_with_project ##### --> +<para> + +</para> + +@project: +@Returns: + + +<!-- ##### FUNCTION glade_inspector_get_project ##### --> +<para> + +</para> + +@inspector: +@Returns: + + +<!-- ##### FUNCTION glade_inspector_set_project ##### --> +<para> + +</para> + +@inspector: +@project: + + +<!-- ##### FUNCTION glade_inspector_get_selected_items ##### --> +<para> + +</para> + +@inspector: +@Returns: + + diff --git a/doc/tmpl/glade-project-view.sgml b/doc/tmpl/glade-project-view.sgml deleted file mode 100644 index b3d4cdac..00000000 --- a/doc/tmpl/glade-project-view.sgml +++ /dev/null @@ -1,61 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GladeProjectView - -<!-- ##### SECTION Short_Description ##### --> -A widget to view the project hierarchy - -<!-- ##### 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 ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GladeProjectView ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeProjectView::item-activated ##### --> -<para> - -</para> - -@gladeprojectview: the object which received the signal. -@arg1: - -<!-- ##### FUNCTION glade_project_view_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION glade_project_view_get_project ##### --> -<para> - -</para> - -@view: -@Returns: - - -<!-- ##### FUNCTION glade_project_view_set_project ##### --> -<para> - -</para> - -@view: -@project: - - diff --git a/doc/tmpl/glade-widget-class.sgml b/doc/tmpl/glade-widget-class.sgml index 4a16b593..c22dca5b 100644 --- a/doc/tmpl/glade-widget-class.sgml +++ b/doc/tmpl/glade-widget-class.sgml @@ -45,17 +45,6 @@ classes; it also provides an abstraction later to container apis. @name: @type: -<!-- ##### ENUM GladeCreateReason ##### --> -<para> - -</para> - -@GLADE_CREATE_USER: -@GLADE_CREATE_COPY: -@GLADE_CREATE_LOAD: -@GLADE_CREATE_REBUILD: -@GLADE_CREATE_REASONS: - <!-- ##### USER_FUNCTION GladePostCreateFunc ##### --> <para> |