diff options
author | Thomas Wood <thomas.wood@intel.com> | 2010-05-18 16:09:26 +0100 |
---|---|---|
committer | Thomas Wood <thomas.wood@intel.com> | 2010-05-18 16:09:26 +0100 |
commit | b4fdb6db4ff7a0a261947ad7b350122e9ba7890b (patch) | |
tree | 024417fc8e5b0407ff8446d96f7f76383203c047 /docs | |
parent | eb0e3e77858895b8336d2b5196c4e9a3575f4c04 (diff) | |
download | gnome-control-center-b4fdb6db4ff7a0a261947ad7b350122e9ba7890b.tar.gz |
Add libgnome-control-center with two new classes: CcShell and CcPanel
CcShell is an abstract class that represents an instance of a control
center shell. It provides access to some of the properties of the shell
that panels will need to read or change. When a panel is created it has an
instance of CcShell available that represents the current shell.
CcPanel is an abstract class used to implement panels for the shell. A
panel contains a collection of related settings that are displayed within
the shell window.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 3 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 3 | ||||
-rw-r--r-- | docs/reference/libgnome-control-center/Makefile.am | 102 | ||||
-rw-r--r-- | docs/reference/libgnome-control-center/libgnome-control-center-docs.sgml | 35 | ||||
-rw-r--r-- | docs/reference/libgnome-control-center/libgnome-control-center-sections.txt | 43 | ||||
-rw-r--r-- | docs/reference/libgnome-control-center/version.xml.in | 1 |
6 files changed, 187 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 000000000..372c2a7a1 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,3 @@ +SUBDIRS=reference + +-include $(top_srcdir)/git.mk diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 000000000..9917ad725 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,3 @@ +SUBDIRS=libgnome-control-center + +-include $(top_srcdir)/git.mk diff --git a/docs/reference/libgnome-control-center/Makefile.am b/docs/reference/libgnome-control-center/Makefile.am new file mode 100644 index 000000000..c6e6ccd61 --- /dev/null +++ b/docs/reference/libgnome-control-center/Makefile.am @@ -0,0 +1,102 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libgnome-control-center + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# Directories containing the source code, relative to $(srcdir). +# gtk-doc will search all .c and .h files beneath these paths +# for inline comments documenting functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk +DOC_SOURCE_DIR=../../../libgnome-control-center + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/libgnome-control-center/*.h +CFILE_GLOB=$(top_srcdir)/libgnome-control-center/*.c + +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files to ignore when scanning. Use base file name, no paths +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS=$(CAPPLET_CFLAGS) +GTKDOC_LIBS=$(CAPPLET_LIBS) $(top_builddir)/libgnome-control-center/libgnome-control-center.la + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +if ENABLE_GTK_DOC +#TESTS_ENVIRONMENT = cd $(srcsrc) && +#TESTS = $(GTKDOC_CHECK) +endif + +-include $(top_srcdir)/git.mk diff --git a/docs/reference/libgnome-control-center/libgnome-control-center-docs.sgml b/docs/reference/libgnome-control-center/libgnome-control-center-docs.sgml new file mode 100644 index 000000000..7609382c1 --- /dev/null +++ b/docs/reference/libgnome-control-center/libgnome-control-center-docs.sgml @@ -0,0 +1,35 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> + <!ENTITY version SYSTEM "version.xml"> +]> +<book id="index"> + <bookinfo> + <title>libgnome-control-center Reference Manual</title> + <releaseinfo> + for libgnome-control-center &version;. + <!-- + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/libgnome-control-center/index.html">http://[SERVER]/libgnome-control-center/</ulink>. + --> + </releaseinfo> + </bookinfo> + + <chapter> + <title>libgnome-control-center</title> + <xi:include href="xml/cc-shell.xml"/> + <xi:include href="xml/cc-panel.xml"/> + </chapter> + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/docs/reference/libgnome-control-center/libgnome-control-center-sections.txt b/docs/reference/libgnome-control-center/libgnome-control-center-sections.txt new file mode 100644 index 000000000..fcd1ba1d5 --- /dev/null +++ b/docs/reference/libgnome-control-center/libgnome-control-center-sections.txt @@ -0,0 +1,43 @@ +<SECTION> +<FILE>cc-shell</FILE> +<TITLE>CcShell</TITLE> +CcShell +CcShellClass +cc_shell_get_active_panel +cc_shell_set_active_panel +cc_shell_set_active_panel_from_id +<SUBSECTION Standard> +CC_SHELL +CC_IS_SHELL +CC_TYPE_SHELL +cc_shell_get_type +CC_SHELL_CLASS +CC_IS_SHELL_CLASS +CC_SHELL_GET_CLASS +<SUBSECTION Private> +CcShellPrivate +</SECTION> + +<SECTION> +<FILE>cc-panel</FILE> +<TITLE>CcPanel</TITLE> +CcPanel +CcPanelClass +cc_panel_get_id +cc_panel_get_shell +cc_panel_get_display_name +cc_panel_set_display_name +cc_panel_get_active +cc_panel_set_active +<SUBSECTION Standard> +CC_PANEL +CC_IS_PANEL +CC_TYPE_PANEL +cc_panel_get_type +CC_PANEL_CLASS +CC_IS_PANEL_CLASS +CC_PANEL_GET_CLASS +<SUBSECTION Private> +CcPanelPrivate +</SECTION> + diff --git a/docs/reference/libgnome-control-center/version.xml.in b/docs/reference/libgnome-control-center/version.xml.in new file mode 100644 index 000000000..a5c3beba0 --- /dev/null +++ b/docs/reference/libgnome-control-center/version.xml.in @@ -0,0 +1 @@ +@CONTROL_CENTER_VERSION@ |