diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/Makefile.am | 24 | ||||
| -rw-r--r-- | docs/reference/Makefile.in | 34 | ||||
| -rw-r--r-- | docs/reference/html/ch01.html | 2 | ||||
| -rw-r--r-- | docs/reference/html/index.html | 2 | ||||
| -rw-r--r-- | docs/reference/html/libappindicator-app-indicator.html | 213 | ||||
| -rw-r--r-- | docs/reference/libappindicator-docs.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/tmpl/app-indicator.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/version.xml | 2 | ||||
| -rw-r--r-- | docs/reference/xml/app-indicator.xml | 100 |
9 files changed, 234 insertions, 147 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 1292f4d..10d8b2a 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -22,7 +22,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # gtk-doc will search all .c & .h files beneath here for inline comments # documenting the functions and macros. # e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR=../../src/libappindicator +DOC_SOURCE_DIR=../../src # Extra options to pass to gtkdoc-scangobj. Not normally needed. SCANGOBJ_OPTIONS=--nogtkinit --type-init-func="g_type_init()" @@ -50,12 +50,26 @@ 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)/src/libappindicator/*.h -CFILE_GLOB=$(top_srcdir)/src/libappindicator/*.c +HFILE_GLOB=$(top_srcdir)/src/app-indicator*.h +CFILE_GLOB=$(top_srcdir)/src/app-indicator*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=app-indicator-enum-types.h application-service-appstore.h application-service-client.h application-service-marshal.h application-service-server.h application-service-watcher.h dbus-properties-client.h dbus-properties-server.h dbus-shared.h notification-item-client.h notification-item-server.h notification-watcher-client.h notification-watcher-server.h +IGNORE_HFILES= \ + app-indicator-enum-types.h \ + application-service-appstore.h \ + application-service-client.h \ + application-service-lru-file.h \ + application-service-marshal.h \ + application-service-server.h \ + application-service-watcher.h \ + dbus-properties-client.h \ + dbus-properties-server.h \ + dbus-shared.h \ + notification-item-client.h \ + notification-item-server.h \ + notification-watcher-client.h \ + notification-watcher-server.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png @@ -75,7 +89,7 @@ expand_content_files= # 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=-I$(top_srcdir) -I$(top_srcdir)/src -I$(top_srcdir)/src/libappindicator $(INDICATOR_CFLAGS) +GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_srcdir)/src -I$(top_srcdir)/src $(INDICATOR_CFLAGS) GTKDOC_LIBS=$(top_builddir)/src/libappindicator.la $(top_builddir)/src/libapplication.la # This includes the standard gtk-doc make rules, copied by gtkdocize. diff --git a/docs/reference/Makefile.in b/docs/reference/Makefile.in index 061e68a..8d6228d 100644 --- a/docs/reference/Makefile.in +++ b/docs/reference/Makefile.in @@ -117,6 +117,14 @@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ +INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ +INTROSPECTION_GENERATE = @INTROSPECTION_GENERATE@ +INTROSPECTION_GIRDIR = @INTROSPECTION_GIRDIR@ +INTROSPECTION_LIBS = @INTROSPECTION_LIBS@ +INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ +INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ +INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ LD = @LD@ LDFLAGS = @LDFLAGS@ LIBOBJS = @LIBOBJS@ @@ -163,6 +171,7 @@ SED = @SED@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ STRIP = @STRIP@ +VALA_API_GEN = @VALA_API_GEN@ VERSION = @VERSION@ abs_builddir = @abs_builddir@ abs_srcdir = @abs_srcdir@ @@ -242,7 +251,7 @@ DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml # gtk-doc will search all .c & .h files beneath here for inline comments # documenting the functions and macros. # e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR = ../../src/libappindicator +DOC_SOURCE_DIR = ../../src # Extra options to pass to gtkdoc-scangobj. Not normally needed. SCANGOBJ_OPTIONS = --nogtkinit --type-init-func="g_type_init()" @@ -270,12 +279,27 @@ 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)/src/libappindicator/*.h -CFILE_GLOB = $(top_srcdir)/src/libappindicator/*.c +HFILE_GLOB = $(top_srcdir)/src/app-indicator*.h +CFILE_GLOB = $(top_srcdir)/src/app-indicator*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES = app-indicator-enum-types.h application-service-appstore.h application-service-client.h application-service-marshal.h application-service-server.h application-service-watcher.h dbus-properties-client.h dbus-properties-server.h dbus-shared.h notification-item-client.h notification-item-server.h notification-watcher-client.h notification-watcher-server.h +IGNORE_HFILES = \ + app-indicator-enum-types.h \ + application-service-appstore.h \ + application-service-client.h \ + application-service-lru-file.h \ + application-service-marshal.h \ + application-service-server.h \ + application-service-watcher.h \ + dbus-properties-client.h \ + dbus-properties-server.h \ + dbus-shared.h \ + notification-item-client.h \ + notification-item-server.h \ + notification-watcher-client.h \ + notification-watcher-server.h + # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png @@ -295,7 +319,7 @@ expand_content_files = # 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 = -I$(top_srcdir) -I$(top_srcdir)/src -I$(top_srcdir)/src/libappindicator $(INDICATOR_CFLAGS) +GTKDOC_CFLAGS = -I$(top_srcdir) -I$(top_srcdir)/src -I$(top_srcdir)/src $(INDICATOR_CFLAGS) GTKDOC_LIBS = $(top_builddir)/src/libappindicator.la $(top_builddir)/src/libapplication.la @GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) @GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) diff --git a/docs/reference/html/ch01.html b/docs/reference/html/ch01.html index d1a4792..482df68 100644 --- a/docs/reference/html/ch01.html +++ b/docs/reference/html/ch01.html @@ -21,7 +21,7 @@ </tr></table> <div class="chapter" title="Base Classes for Applications"> <div class="titlepage"><div><div><h2 class="title"> -<a name="id387749"></a>Base Classes for Applications</h2></div></div></div> +<a name="id460829"></a>Base Classes for Applications</h2></div></div></div> <div class="toc"><dl><dt> <span class="refentrytitle"><a href="libappindicator-app-indicator.html">AppIndicator</a></span><span class="refpurpose"> — An object to put application information into the panel.</span> diff --git a/docs/reference/html/index.html b/docs/reference/html/index.html index de1a3d6..b189675 100644 --- a/docs/reference/html/index.html +++ b/docs/reference/html/index.html @@ -15,7 +15,7 @@ <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">libappindicator Reference Manual</p></th></tr></table></div> <div><p class="releaseinfo"> - for libappindicator 0.0.19 + for libappindicator 0.2.0 </p></div> </div> <hr> diff --git a/docs/reference/html/libappindicator-app-indicator.html b/docs/reference/html/libappindicator-app-indicator.html index 332e705..f3e2c45 100644 --- a/docs/reference/html/libappindicator-app-indicator.html +++ b/docs/reference/html/libappindicator-app-indicator.html @@ -66,48 +66,48 @@ enum <a class="link" href="libappindicator-app-indicator.html#App <a class="link" href="libappindicator-app-indicator.html#AppIndicatorPrivate" title="AppIndicatorPrivate">AppIndicatorPrivate</a>; <a class="link" href="libappindicator-app-indicator.html#AppIndicator-struct" title="AppIndicator">AppIndicator</a>; <a class="link" href="libappindicator-app-indicator.html#AppIndicatorClass" title="AppIndicatorClass">AppIndicatorClass</a>; -<a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-type" title="app_indicator_get_type ()">app_indicator_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-new" title="app_indicator_new ()">app_indicator_new</a> (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, +<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-type" title="app_indicator_get_type ()">app_indicator_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-new" title="app_indicator_new ()">app_indicator_new</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, <em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory"><span class="type">AppIndicatorCategory</span></a> category</code></em>); -<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-new-with-path" title="app_indicator_new_with_path ()">app_indicator_new_with_path</a> (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, +<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-new-with-path" title="app_indicator_new_with_path ()">app_indicator_new_with_path</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, <em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory"><span class="type">AppIndicatorCategory</span></a> category</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_path</code></em>); + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_path</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-status" title="app_indicator_set_status ()">app_indicator_set_status</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, <em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus"><span class="type">AppIndicatorStatus</span></a> status</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-attention-icon" title="app_indicator_set_attention_icon ()">app_indicator_set_attention_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>); + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-menu" title="app_indicator_set_menu ()">app_indicator_set_menu</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code><a href="../gtk/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>); + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon" title="app_indicator_set_icon ()">app_indicator_set_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>); -const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-id" title="app_indicator_get_id ()">app_indicator_get_id</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>); +const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-id" title="app_indicator_get_id ()">app_indicator_get_id</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); <a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory"><span class="returnvalue">AppIndicatorCategory</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-category" title="app_indicator_get_category ()">app_indicator_get_category</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); <a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus"><span class="returnvalue">AppIndicatorStatus</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-status" title="app_indicator_get_status ()">app_indicator_get_status</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); -const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon" title="app_indicator_get_icon ()">app_indicator_get_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); -const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-attention-icon" title="app_indicator_get_attention_icon ()">app_indicator_get_attention_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); -<a href="../gtk/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-menu" title="app_indicator_get_menu ()">app_indicator_get_menu</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); +const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon" title="app_indicator_get_icon ()">app_indicator_get_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); +const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-attention-icon" title="app_indicator_get_attention_icon ()">app_indicator_get_attention_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); +<a href="/usr/share/gtk-doc/html/gtk/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-menu" title="app_indicator_get_menu ()">app_indicator_get_menu</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); </pre> </div> <div class="refsect1" title="Object Hierarchy"> <a name="libappindicator-app-indicator.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> - <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> +----AppIndicator </pre> </div> <div class="refsect1" title="Properties"> <a name="libappindicator-app-indicator.properties"></a><h2>Properties</h2> <pre class="synopsis"> - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'>attention-icon-name</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--category" title='The "category" property'>category</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--connected" title='The "connected" property'>connected</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'>icon-name</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-theme-path" title='The "icon-theme-path" property'>icon-theme-path</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'>id</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'>attention-icon-name</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--category" title='The "category" property'>category</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--connected" title='The "connected" property'>connected</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'>icon-name</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-theme-path" title='The "icon-theme-path" property'>icon-theme-path</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'>id</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--menu" title='The "menu" property'>menu</a>" <span class="type">DBusGObjectPath</span>* : Read - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'>status</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'>status</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write </pre> </div> <div class="refsect1" title="Signals"> @@ -139,7 +139,7 @@ An application indicator is a way for an application to put <pre class="programlisting">#define APP_INDICATOR_TYPE (app_indicator_get_type ()) </pre> <p> -Get the <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for a <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. +Get the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for a <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. </p> </div> <hr> @@ -148,7 +148,7 @@ Get the <a href="../gobject/gobject-Type-Information.html#GType"><span class="ty <pre class="programlisting">#define APP_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), APP_INDICATOR_TYPE, AppIndicator)) </pre> <p> -Safely convert a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> into an <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. +Safely convert a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> into an <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -165,14 +165,14 @@ Safely convert a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"> <pre class="programlisting">#define APP_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), APP_INDICATOR_TYPE, AppIndicatorClass)) </pre> <p> -Safely convert a <a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> into a <a class="link" href="libappindicator-app-indicator.html#AppIndicatorClass" title="AppIndicatorClass"><span class="type">AppIndicatorClass</span></a>. +Safely convert a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> into a <a class="link" href="libappindicator-app-indicator.html#AppIndicatorClass" title="AppIndicatorClass"><span class="type">AppIndicatorClass</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td> <td> -<a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> based class to convert. +<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> based class to convert. </td> </tr></tbody> </table></div> @@ -189,7 +189,7 @@ Checks to see if <em class="parameter"><code>obj</code></em> is in the object hi <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> -<td>An <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to check +<td>An <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to check </td> </tr></tbody> </table></div> @@ -206,7 +206,7 @@ Checks to see if <em class="parameter"><code>klass</code></em> is in the object <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td> -<td>An <a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> to check +<td>An <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> to check </td> </tr></tbody> </table></div> @@ -223,7 +223,7 @@ Gets a pointer to the <a class="link" href="libappindicator-app-indicator.html#A <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> -<td>A <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> in the class hierarchy of <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. +<td>A <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> in the class hierarchy of <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. </td> </tr></tbody> </table></div> @@ -268,11 +268,11 @@ String identifier for the <a class="link" href="libappindicator-app-indicator.ht <div class="refsect2" title="enum AppIndicatorCategory"> <a name="AppIndicatorCategory"></a><h3>enum AppIndicatorCategory</h3> <pre class="programlisting">typedef enum { /*< prefix=APP_INDICATOR_CATEGORY >*/ - APP_INDICATOR_CATEGORY_APPLICATION_STATUS, - APP_INDICATOR_CATEGORY_COMMUNICATIONS, - APP_INDICATOR_CATEGORY_SYSTEM_SERVICES, - APP_INDICATOR_CATEGORY_HARDWARE, - APP_INDICATOR_CATEGORY_OTHER + APP_INDICATOR_CATEGORY_APPLICATION_STATUS, /*< nick=ApplicationStatus >*/ + APP_INDICATOR_CATEGORY_COMMUNICATIONS, /*< nick=Communications >*/ + APP_INDICATOR_CATEGORY_SYSTEM_SERVICES, /*< nick=SystemServices >*/ + APP_INDICATOR_CATEGORY_HARDWARE, /*< nick=Hardware >*/ + APP_INDICATOR_CATEGORY_OTHER /*< nick=Other >*/ } AppIndicatorCategory; </pre> <p> @@ -314,9 +314,9 @@ The category provides grouping for the indicators so that <div class="refsect2" title="enum AppIndicatorStatus"> <a name="AppIndicatorStatus"></a><h3>enum AppIndicatorStatus</h3> <pre class="programlisting">typedef enum { /*< prefix=APP_INDICATOR_STATUS >*/ - APP_INDICATOR_STATUS_PASSIVE, - APP_INDICATOR_STATUS_ACTIVE, - APP_INDICATOR_STATUS_ATTENTION + APP_INDICATOR_STATUS_PASSIVE, /*< nick=Passive >*/ + APP_INDICATOR_STATUS_ACTIVE, /*< nick=Active >*/ + APP_INDICATOR_STATUS_ATTENTION /*< nick=NeedsAttention >*/ } AppIndicatorStatus; </pre> <p> @@ -405,7 +405,7 @@ The signals and external functions that make up the <a class="link" href="libapp <col align="left" valign="top"> <tbody> <tr> -<td><p><span class="term"><a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="AppIndicatorClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td><p><span class="term"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="AppIndicatorClass.parent-class"></a>parent_class</code></em>;</span></p></td> <td>Mia familia </td> </tr> @@ -431,7 +431,7 @@ The signals and external functions that make up the <a class="link" href="libapp </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.fallback"></a>fallback</code></em> ()</span></p></td> -<td>Function that gets called to make a <a href="../gtk/GtkStatusIcon.html"><span class="type">GtkStatusIcon</span></a> when +<td>Function that gets called to make a <a href="/usr/share/gtk-doc/html/gtk/GtkStatusIcon.html"><span class="type">GtkStatusIcon</span></a> when there is no Application Indicator area available. </td> </tr> @@ -457,15 +457,15 @@ The signals and external functions that make up the <a class="link" href="libapp <hr> <div class="refsect2" title="app_indicator_get_type ()"> <a name="app-indicator-get-type"></a><h3>app_indicator_get_type ()</h3> -<pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> app_indicator_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> app_indicator_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> -Generates or returns the unique <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. +Generates or returns the unique <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> A unique <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> objects. +<td> A unique <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> objects. </td> </tr></tbody> </table></div> @@ -473,13 +473,13 @@ Generates or returns the unique <a href="../gobject/gobject-Type-Information.htm <hr> <div class="refsect2" title="app_indicator_new ()"> <a name="app-indicator-new"></a><h3>app_indicator_new ()</h3> -<pre class="programlisting"><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * app_indicator_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, +<pre class="programlisting"><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * app_indicator_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, <em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory"><span class="type">AppIndicatorCategory</span></a> category</code></em>);</pre> <p> Creates a new <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> setting the properties: - <span class="type">"id"</span> with <em class="parameter"><code>id</code></em>, <span class="type">"category"</span> - with <em class="parameter"><code>category</code></em> and <span class="type">"icon-name"</span> with + <a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'><span class="type">"id"</span></a> with <em class="parameter"><code>id</code></em>, <a class="link" href="libappindicator-app-indicator.html#AppIndicator--category" title='The "category" property'><span class="type">"category"</span></a> + with <em class="parameter"><code>category</code></em> and <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'><span class="type">"icon-name"</span></a> with <em class="parameter"><code>icon_name</code></em>. </p> <div class="variablelist"><table border="0"> @@ -511,15 +511,15 @@ Creates a new <a class="link" href="libappindicator-app-indicator.html#AppIndica <hr> <div class="refsect2" title="app_indicator_new_with_path ()"> <a name="app-indicator-new-with-path"></a><h3>app_indicator_new_with_path ()</h3> -<pre class="programlisting"><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * app_indicator_new_with_path (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, +<pre class="programlisting"><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="returnvalue">AppIndicator</span></a> * app_indicator_new_with_path (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, <em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory"><span class="type">AppIndicatorCategory</span></a> category</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_path</code></em>);</pre> + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_path</code></em>);</pre> <p> Creates a new <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> setting the properties: - <span class="type">"id"</span> with <em class="parameter"><code>id</code></em>, <span class="type">"category"</span> - with <em class="parameter"><code>category</code></em>, <span class="type">"icon-name"</span> with - <em class="parameter"><code>icon_name</code></em> and <span class="type">"icon-theme-path"</span> with <em class="parameter"><code>icon_path</code></em>. + <a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'><span class="type">"id"</span></a> with <em class="parameter"><code>id</code></em>, <a class="link" href="libappindicator-app-indicator.html#AppIndicator--category" title='The "category" property'><span class="type">"category"</span></a> + with <em class="parameter"><code>category</code></em>, <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'><span class="type">"icon-name"</span></a> with + <em class="parameter"><code>icon_name</code></em> and <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-theme-path" title='The "icon-theme-path" property'><span class="type">"icon-theme-path"</span></a> with <em class="parameter"><code>icon_path</code></em>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -558,7 +558,7 @@ Creates a new <a class="link" href="libappindicator-app-indicator.html#AppIndica <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_status (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, <em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus"><span class="type">AppIndicatorStatus</span></a> status</code></em>);</pre> <p> -Wrapper function for property <span class="type">"status"</span>. +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'><span class="type">"status"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -580,9 +580,9 @@ Wrapper function for property <span class="type">"status"</span>. <div class="refsect2" title="app_indicator_set_attention_icon ()"> <a name="app-indicator-set-attention-icon"></a><h3>app_indicator_set_attention_icon ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_attention_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre> + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre> <p> -Wrapper function for property <span class="type">"attention-icon"</span>. +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'><span class="type">"attention-icon-name"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -604,11 +604,13 @@ Wrapper function for property <span class="type">"attention-icon"</span>. <div class="refsect2" title="app_indicator_set_menu ()"> <a name="app-indicator-set-menu"></a><h3>app_indicator_set_menu ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_menu (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code><a href="../gtk/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);</pre> + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);</pre> <p> Sets the menu that should be shown when the Application Indicator is clicked on in the panel. An application indicator will not be rendered unless it has a menu. + + Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--menu" title='The "menu" property'><span class="type">"menu"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -620,7 +622,7 @@ Sets the menu that should be shown when the Application Indicator </tr> <tr> <td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td> -<td>A <a href="../gtk/GtkMenu.html"><span class="type">GtkMenu</span></a> to set +<td>A <a href="/usr/share/gtk-doc/html/gtk/GtkMenu.html"><span class="type">GtkMenu</span></a> to set </td> </tr> </tbody> @@ -630,11 +632,12 @@ Sets the menu that should be shown when the Application Indicator <div class="refsect2" title="app_indicator_set_icon ()"> <a name="app-indicator-set-icon"></a><h3>app_indicator_set_icon ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre> + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre> <p> Sets the default icon to use when the status is active but not set to attention. In most cases, this should be the application icon for the program. + Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'><span class="type">"icon-name"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -655,9 +658,9 @@ Sets the default icon to use when the status is active but <hr> <div class="refsect2" title="app_indicator_get_id ()"> <a name="app-indicator-get-id"></a><h3>app_indicator_get_id ()</h3> -<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_id (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_id (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> -Wrapper function for property <span class="type">"id"</span>. +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'><span class="type">"id"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -680,7 +683,7 @@ Wrapper function for property <span class="type">"id"</span>. <a name="app-indicator-get-category"></a><h3>app_indicator_get_category ()</h3> <pre class="programlisting"><a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory"><span class="returnvalue">AppIndicatorCategory</span></a> app_indicator_get_category (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> -Wrapper function for property <span class="type">"category"</span>. +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--category" title='The "category" property'><span class="type">"category"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -703,7 +706,7 @@ Wrapper function for property <span class="type">"category"</span>. <a name="app-indicator-get-status"></a><h3>app_indicator_get_status ()</h3> <pre class="programlisting"><a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus"><span class="returnvalue">AppIndicatorStatus</span></a> app_indicator_get_status (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> -Wrapper function for property <span class="type">"status"</span>. +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'><span class="type">"status"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -724,9 +727,9 @@ Wrapper function for property <span class="type">"status"</span>. <hr> <div class="refsect2" title="app_indicator_get_icon ()"> <a name="app-indicator-get-icon"></a><h3>app_indicator_get_icon ()</h3> -<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> -Wrapper function for property <span class="type">"icon-name"</span>. +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'><span class="type">"icon-name"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -747,9 +750,9 @@ Wrapper function for property <span class="type">"icon-name"</span>. <hr> <div class="refsect2" title="app_indicator_get_attention_icon ()"> <a name="app-indicator-get-attention-icon"></a><h3>app_indicator_get_attention_icon ()</h3> -<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_attention_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> +<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_attention_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> -Wrapper function for property <span class="type">"attention-icon-name"</span>. +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'><span class="type">"attention-icon-name"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -770,9 +773,10 @@ Wrapper function for property <span class="type">"attention-icon-name"</span>. <hr> <div class="refsect2" title="app_indicator_get_menu ()"> <a name="app-indicator-get-menu"></a><h3>app_indicator_get_menu ()</h3> -<pre class="programlisting"><a href="../gtk/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * app_indicator_get_menu (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * app_indicator_get_menu (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> Gets the menu being used for this application indicator. + Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--menu" title='The "menu" property'><span class="type">"menu"</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -784,7 +788,7 @@ Gets the menu being used for this application indicator. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> A menu object or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if one hasn't been set. +<td> A <a href="/usr/share/gtk-doc/html/gtk/GtkMenu.html"><span class="type">GtkMenu</span></a> object or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if one hasn't been set. </td> </tr> </tbody> @@ -795,56 +799,78 @@ Gets the menu being used for this application indicator. <a name="libappindicator-app-indicator.property-details"></a><h2>Property Details</h2> <div class="refsect2" title='The "attention-icon-name" property'> <a name="AppIndicator--attention-icon-name"></a><h3>The <code class="literal">"attention-icon-name"</code> property</h3> -<pre class="programlisting"> "attention-icon-name" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> -<p>If the indicator sets it's status to 'attention' then this icon is shown.</p> +<pre class="programlisting"> "attention-icon-name" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +If the indicator sets it's status to <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-STATUS-ATTENTION:CAPS"><code class="literal">APP_INDICATOR_STATUS_ATTENTION</code></a> + then this icon is shown. +</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2" title='The "category" property'> <a name="AppIndicator--category"></a><h3>The <code class="literal">"category"</code> property</h3> -<pre class="programlisting"> "category" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> -<p>The type of indicator that this represents. Please don't use 'other'. Defaults to 'Application Status'.</p> +<pre class="programlisting"> "category" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> +<p> +The type of indicator that this represents. Please don't use 'Other'. + Defaults to 'ApplicationStatus'. +</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2" title='The "connected" property'> <a name="AppIndicator--connected"></a><h3>The <code class="literal">"connected"</code> property</h3> -<pre class="programlisting"> "connected" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre> -<p>Pretty simple, true if we have a reasonable expectation of being displayed through this object. You should hide your TrayIcon if so.</p> +<pre class="programlisting"> "connected" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre> +<p> +Pretty simple, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if we have a reasonable expectation of being + displayed through this object. You should hide your TrayIcon if so. +</p> <p>Default value: FALSE</p> </div> <hr> <div class="refsect2" title='The "icon-name" property'> <a name="AppIndicator--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3> -<pre class="programlisting"> "icon-name" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> -<p>The default icon that is shown for the indicator.</p> +<pre class="programlisting"> "icon-name" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre> +<p> +The name of the regular icon that is shown for the indicator. +</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2" title='The "icon-theme-path" property'> <a name="AppIndicator--icon-theme-path"></a><h3>The <code class="literal">"icon-theme-path"</code> property</h3> -<pre class="programlisting"> "icon-theme-path" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> -<p>An additional place to look for icon names that may be installed by the application.</p> +<pre class="programlisting"> "icon-theme-path" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> +<p> +An additional place to look for icon names that may be installed by the + application. +</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2" title='The "id" property'> <a name="AppIndicator--id"></a><h3>The <code class="literal">"id"</code> property</h3> -<pre class="programlisting"> "id" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> -<p>An ID that should be unique, but used consistently by this program and it's indicator.</p> +<pre class="programlisting"> "id" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> +<p> +The ID for this indicator, which should be unique, but used consistently + by this program and its indicator. +</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2" title='The "menu" property'> <a name="AppIndicator--menu"></a><h3>The <code class="literal">"menu"</code> property</h3> <pre class="programlisting"> "menu" <span class="type">DBusGObjectPath</span>* : Read</pre> -<p>A method for getting the menu path as a string for DBus.</p> +<p> +A method for getting the menu path as a string for DBus. +</p> </div> <hr> <div class="refsect2" title='The "status" property'> <a name="AppIndicator--status"></a><h3>The <code class="literal">"status"</code> property</h3> -<pre class="programlisting"> "status" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> -<p>Whether the indicator is shown or requests attention. Defaults to 'off'.</p> +<pre class="programlisting"> "status" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Whether the indicator is shown or requests attention. Defaults to + 'Passive'. +</p> <p>Default value: NULL</p> </div> </div> @@ -853,11 +879,10 @@ Gets the menu being used for this application indicator. <div class="refsect2" title='The "connection-changed" signal'> <a name="AppIndicator-connection-changed"></a><h3>The <code class="literal">"connection-changed"</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *arg0, - <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg1, - <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg1, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> <p> -Signaled when we connect to a watcher, or when it drops - away. +Signaled when we connect to a watcher, or when it drops away. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -883,10 +908,9 @@ Signaled when we connect to a watcher, or when it drops <div class="refsect2" title='The "new-attention-icon" signal'> <a name="AppIndicator-new-attention-icon"></a><h3>The <code class="literal">"new-attention-icon"</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *arg0, - <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> <p> -Signaled when there is a new attention icon set for the - object. +Emitted when <a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'><span class="type">"attention-icon-name"</span></a> is changed </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -907,10 +931,9 @@ Signaled when there is a new attention icon set for the <div class="refsect2" title='The "new-icon" signal'> <a name="AppIndicator-new-icon"></a><h3>The <code class="literal">"new-icon"</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *arg0, - <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> <p> -Signaled when there is a new icon set for the - object. +Emitted when <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'><span class="type">"icon-name"</span></a> is changed </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -931,10 +954,10 @@ Signaled when there is a new icon set for the <div class="refsect2" title='The "new-status" signal'> <a name="AppIndicator-new-status"></a><h3>The <code class="literal">"new-status"</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *arg0, - <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, - <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> <p> -Signaled when the status of the indicator changes. +Emitted when <a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'><span class="type">"status"</span></a> is changed </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> diff --git a/docs/reference/libappindicator-docs.sgml b/docs/reference/libappindicator-docs.sgml index e6c3060..2f0ebc6 100644 --- a/docs/reference/libappindicator-docs.sgml +++ b/docs/reference/libappindicator-docs.sgml @@ -8,7 +8,7 @@ <bookinfo> <title>libappindicator Reference Manual</title> <releaseinfo> - for libappindicator 0.0.21 + for libappindicator 0.2.0 </releaseinfo> </bookinfo> diff --git a/docs/reference/tmpl/app-indicator.sgml b/docs/reference/tmpl/app-indicator.sgml index 283e58d..3fe1f6e 100644 --- a/docs/reference/tmpl/app-indicator.sgml +++ b/docs/reference/tmpl/app-indicator.sgml @@ -9,11 +9,13 @@ AppIndicator </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/reference/version.xml b/docs/reference/version.xml index 236c7ad..0ea3a94 100644 --- a/docs/reference/version.xml +++ b/docs/reference/version.xml @@ -1 +1 @@ -0.0.21 +0.2.0 diff --git a/docs/reference/xml/app-indicator.xml b/docs/reference/xml/app-indicator.xml index 1df7c9b..4740918 100644 --- a/docs/reference/xml/app-indicator.xml +++ b/docs/reference/xml/app-indicator.xml @@ -80,7 +80,7 @@ const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <lin "<link linkend="AppIndicator--attention-icon-name">attention-icon-name</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write "<link linkend="AppIndicator--category">category</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only "<link linkend="AppIndicator--connected">connected</link>" <link linkend="gboolean"><type>gboolean</type></link> : Read - "<link linkend="AppIndicator--icon-name">icon-name</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--icon-name">icon-name</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct "<link linkend="AppIndicator--icon-theme-path">icon-theme-path</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only "<link linkend="AppIndicator--id">id</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only "<link linkend="AppIndicator--menu">menu</link>" <link linkend="DBusGObjectPath"><type>DBusGObjectPath</type></link>* : Read @@ -216,11 +216,11 @@ String identifier for the <link linkend="AppIndicator-connection-changed"><type> <title>enum AppIndicatorCategory</title> <indexterm zone="AppIndicatorCategory"><primary>AppIndicatorCategory</primary></indexterm> <programlisting>typedef enum { /*< prefix=APP_INDICATOR_CATEGORY >*/ - APP_INDICATOR_CATEGORY_APPLICATION_STATUS, - APP_INDICATOR_CATEGORY_COMMUNICATIONS, - APP_INDICATOR_CATEGORY_SYSTEM_SERVICES, - APP_INDICATOR_CATEGORY_HARDWARE, - APP_INDICATOR_CATEGORY_OTHER + APP_INDICATOR_CATEGORY_APPLICATION_STATUS, /*< nick=ApplicationStatus >*/ + APP_INDICATOR_CATEGORY_COMMUNICATIONS, /*< nick=Communications >*/ + APP_INDICATOR_CATEGORY_SYSTEM_SERVICES, /*< nick=SystemServices >*/ + APP_INDICATOR_CATEGORY_HARDWARE, /*< nick=Hardware >*/ + APP_INDICATOR_CATEGORY_OTHER /*< nick=Other >*/ } AppIndicatorCategory; </programlisting> <para> @@ -257,9 +257,9 @@ The category provides grouping for the indicators so that <title>enum AppIndicatorStatus</title> <indexterm zone="AppIndicatorStatus"><primary>AppIndicatorStatus</primary></indexterm> <programlisting>typedef enum { /*< prefix=APP_INDICATOR_STATUS >*/ - APP_INDICATOR_STATUS_PASSIVE, - APP_INDICATOR_STATUS_ACTIVE, - APP_INDICATOR_STATUS_ATTENTION + APP_INDICATOR_STATUS_PASSIVE, /*< nick=Passive >*/ + APP_INDICATOR_STATUS_ACTIVE, /*< nick=Active >*/ + APP_INDICATOR_STATUS_ATTENTION /*< nick=NeedsAttention >*/ } AppIndicatorStatus; </programlisting> <para> @@ -394,8 +394,8 @@ Generates or returns the unique <link linkend="GType"><type>GType</type></link> <parameter><link linkend="AppIndicatorCategory"><type>AppIndicatorCategory</type></link> category</parameter>);</programlisting> <para> Creates a new <link linkend="AppIndicator"><type>AppIndicator</type></link> setting the properties: - <link linkend="AppIndicator-id"><type>"id"</type></link> with <parameter>id</parameter>, <link linkend="AppIndicator-category"><type>"category"</type></link> - with <parameter>category</parameter> and <link linkend="AppIndicator-icon-name"><type>"icon-name"</type></link> with + <link linkend="AppIndicator--id"><type>"id"</type></link> with <parameter>id</parameter>, <link linkend="AppIndicator--category"><type>"category"</type></link> + with <parameter>category</parameter> and <link linkend="AppIndicator--icon-name"><type>"icon-name"</type></link> with <parameter>icon_name</parameter>. </para><variablelist role="params"> <varlistentry><term><parameter>id</parameter> :</term> @@ -419,9 +419,9 @@ Creates a new <link linkend="AppIndicator"><type>AppIndicator</type></link> sett <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_path</parameter>);</programlisting> <para> Creates a new <link linkend="AppIndicator"><type>AppIndicator</type></link> setting the properties: - <link linkend="AppIndicator-id"><type>"id"</type></link> with <parameter>id</parameter>, <link linkend="AppIndicator-category"><type>"category"</type></link> - with <parameter>category</parameter>, <link linkend="AppIndicator-icon-name"><type>"icon-name"</type></link> with - <parameter>icon_name</parameter> and <link linkend="AppIndicator-icon-theme-path"><type>"icon-theme-path"</type></link> with <parameter>icon_path</parameter>. + <link linkend="AppIndicator--id"><type>"id"</type></link> with <parameter>id</parameter>, <link linkend="AppIndicator--category"><type>"category"</type></link> + with <parameter>category</parameter>, <link linkend="AppIndicator--icon-name"><type>"icon-name"</type></link> with + <parameter>icon_name</parameter> and <link linkend="AppIndicator--icon-theme-path"><type>"icon-theme-path"</type></link> with <parameter>icon_path</parameter>. </para><variablelist role="params"> <varlistentry><term><parameter>id</parameter> :</term> <listitem><simpara>The unique id of the indicator to create. @@ -444,7 +444,7 @@ Creates a new <link linkend="AppIndicator"><type>AppIndicator</type></link> sett <programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_status (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, <parameter><link linkend="AppIndicatorStatus"><type>AppIndicatorStatus</type></link> status</parameter>);</programlisting> <para> -Wrapper function for property <link linkend="AppIndicator-status"><type>"status"</type></link>. +Wrapper function for property <link linkend="AppIndicator--status"><type>"status"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -459,7 +459,7 @@ Wrapper function for property <link linkend="AppIndicator-status"><type>"status" <programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_attention_icon (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>);</programlisting> <para> -Wrapper function for property <link linkend="AppIndicator-attention-icon"><type>"attention-icon"</type></link>. +Wrapper function for property <link linkend="AppIndicator--attention-icon-name"><type>"attention-icon-name"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -477,6 +477,8 @@ Wrapper function for property <link linkend="AppIndicator-attention-icon"><type> Sets the menu that should be shown when the Application Indicator is clicked on in the panel. An application indicator will not be rendered unless it has a menu. + + Wrapper function for property <link linkend="AppIndicator--menu"><type>"menu"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> @@ -494,6 +496,7 @@ Sets the menu that should be shown when the Application Indicator Sets the default icon to use when the status is active but not set to attention. In most cases, this should be the application icon for the program. + Wrapper function for property <link linkend="AppIndicator--icon-name"><type>"icon-name"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -507,7 +510,7 @@ Sets the default icon to use when the status is active but <indexterm zone="app-indicator-get-id"><primary>app_indicator_get_id</primary></indexterm> <programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_id (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> <para> -Wrapper function for property <link linkend="AppIndicator-id"><type>"id"</type></link>. +Wrapper function for property <link linkend="AppIndicator--id"><type>"id"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -520,7 +523,7 @@ Wrapper function for property <link linkend="AppIndicator-id"><type>"id"</type>< <indexterm zone="app-indicator-get-category"><primary>app_indicator_get_category</primary></indexterm> <programlisting><link linkend="AppIndicatorCategory"><returnvalue>AppIndicatorCategory</returnvalue></link> app_indicator_get_category (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> <para> -Wrapper function for property <link linkend="AppIndicator-category"><type>"category"</type></link>. +Wrapper function for property <link linkend="AppIndicator--category"><type>"category"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -533,7 +536,7 @@ Wrapper function for property <link linkend="AppIndicator-category"><type>"categ <indexterm zone="app-indicator-get-status"><primary>app_indicator_get_status</primary></indexterm> <programlisting><link linkend="AppIndicatorStatus"><returnvalue>AppIndicatorStatus</returnvalue></link> app_indicator_get_status (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> <para> -Wrapper function for property <link linkend="AppIndicator-status"><type>"status"</type></link>. +Wrapper function for property <link linkend="AppIndicator--status"><type>"status"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -546,7 +549,7 @@ Wrapper function for property <link linkend="AppIndicator-status"><type>"status" <indexterm zone="app-indicator-get-icon"><primary>app_indicator_get_icon</primary></indexterm> <programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_icon (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> <para> -Wrapper function for property <link linkend="AppIndicator-icon-name"><type>"icon-name"</type></link>. +Wrapper function for property <link linkend="AppIndicator--icon-name"><type>"icon-name"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -559,7 +562,7 @@ Wrapper function for property <link linkend="AppIndicator-icon-name"><type>"icon <indexterm zone="app-indicator-get-attention-icon"><primary>app_indicator_get_attention_icon</primary></indexterm> <programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_attention_icon (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> <para> -Wrapper function for property <link linkend="AppIndicator-attention-icon-name"><type>"attention-icon-name"</type></link>. +Wrapper function for property <link linkend="AppIndicator--attention-icon-name"><type>"attention-icon-name"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use @@ -573,11 +576,12 @@ Wrapper function for property <link linkend="AppIndicator-attention-icon-name">< <programlisting><link linkend="GtkMenu"><returnvalue>GtkMenu</returnvalue></link> * app_indicator_get_menu (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> <para> Gets the menu being used for this application indicator. + Wrapper function for property <link linkend="AppIndicator--menu"><type>"menu"</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>self</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use </simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A menu object or <link linkend="NULL:CAPS"><type>NULL</type></link> if one hasn't been set. +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkMenu"><type>GtkMenu</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if one hasn't been set. </simpara></listitem></varlistentry> </variablelist></refsect2> @@ -587,42 +591,65 @@ Gets the menu being used for this application indicator. <refsect2 id="AppIndicator--attention-icon-name" role="property"><title>The <literal>"attention-icon-name"</literal> property</title> <indexterm zone="AppIndicator--attention-icon-name"><primary>AppIndicator:attention-icon-name</primary></indexterm> <programlisting> "attention-icon-name" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> -<para>If the indicator sets it's status to 'attention' then this icon is shown.</para><para>Default value: NULL</para> +<para> +If the indicator sets it's status to <link linkend="APP-INDICATOR-STATUS-ATTENTION:CAPS"><literal>APP_INDICATOR_STATUS_ATTENTION</literal></link> + then this icon is shown. +</para><para>Default value: NULL</para> </refsect2> <refsect2 id="AppIndicator--category" role="property"><title>The <literal>"category"</literal> property</title> <indexterm zone="AppIndicator--category"><primary>AppIndicator:category</primary></indexterm> <programlisting> "category" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only</programlisting> -<para>The type of indicator that this represents. Please don't use 'other'. Defaults to 'Application Status'.</para><para>Default value: NULL</para> +<para> +The type of indicator that this represents. Please don't use 'Other'. + Defaults to 'ApplicationStatus'. +</para><para>Default value: NULL</para> </refsect2> <refsect2 id="AppIndicator--connected" role="property"><title>The <literal>"connected"</literal> property</title> <indexterm zone="AppIndicator--connected"><primary>AppIndicator:connected</primary></indexterm> <programlisting> "connected" <link linkend="gboolean"><type>gboolean</type></link> : Read</programlisting> -<para>Pretty simple, true if we have a reasonable expectation of being displayed through this object. You should hide your TrayIcon if so.</para><para>Default value: FALSE</para> +<para> +Pretty simple, <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we have a reasonable expectation of being + displayed through this object. You should hide your TrayIcon if so. +</para><para>Default value: FALSE</para> </refsect2> <refsect2 id="AppIndicator--icon-name" role="property"><title>The <literal>"icon-name"</literal> property</title> <indexterm zone="AppIndicator--icon-name"><primary>AppIndicator:icon-name</primary></indexterm> -<programlisting> "icon-name" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> -<para>The default icon that is shown for the indicator.</para><para>Default value: NULL</para> +<programlisting> "icon-name" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct</programlisting> +<para> +The name of the regular icon that is shown for the indicator. +</para><para>Default value: NULL</para> </refsect2> <refsect2 id="AppIndicator--icon-theme-path" role="property"><title>The <literal>"icon-theme-path"</literal> property</title> <indexterm zone="AppIndicator--icon-theme-path"><primary>AppIndicator:icon-theme-path</primary></indexterm> <programlisting> "icon-theme-path" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only</programlisting> -<para>An additional place to look for icon names that may be installed by the application.</para><para>Default value: NULL</para> +<para> +An additional place to look for icon names that may be installed by the + application. +</para><para>Default value: NULL</para> </refsect2> <refsect2 id="AppIndicator--id" role="property"><title>The <literal>"id"</literal> property</title> <indexterm zone="AppIndicator--id"><primary>AppIndicator:id</primary></indexterm> <programlisting> "id" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only</programlisting> -<para>An ID that should be unique, but used consistently by this program and it's indicator.</para><para>Default value: NULL</para> +<para> +The ID for this indicator, which should be unique, but used consistently + by this program and its indicator. +</para><para>Default value: NULL</para> </refsect2> <refsect2 id="AppIndicator--menu" role="property"><title>The <literal>"menu"</literal> property</title> <indexterm zone="AppIndicator--menu"><primary>AppIndicator:menu</primary></indexterm> <programlisting> "menu" <link linkend="DBusGObjectPath"><type>DBusGObjectPath</type></link>* : Read</programlisting> -<para>A method for getting the menu path as a string for DBus.</para></refsect2> +<para> +A method for getting the menu path as a string for DBus. +</para></refsect2> <refsect2 id="AppIndicator--status" role="property"><title>The <literal>"status"</literal> property</title> <indexterm zone="AppIndicator--status"><primary>AppIndicator:status</primary></indexterm> <programlisting> "status" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> -<para>Whether the indicator is shown or requests attention. Defaults to 'off'.</para><para>Default value: NULL</para> +<para> +Whether the indicator is shown or requests attention. Defaults to + 'Passive'. +</para><para>Default value: NULL</para> </refsect2> + </refsect1> <refsect1 id="libappindicator-app-indicator.signal-details" role="signals"> <title role="signals.title">Signal Details</title> @@ -632,8 +659,7 @@ Gets the menu being used for this application indicator. <link linkend="gboolean"><type>gboolean</type></link> arg1, <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> <para> -Signaled when we connect to a watcher, or when it drops - away. +Signaled when we connect to a watcher, or when it drops away. </para><variablelist role="params"> <varlistentry><term><parameter>arg0</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object @@ -648,8 +674,7 @@ Signaled when we connect to a watcher, or when it drops <programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="AppIndicator"><type>AppIndicator</type></link> *arg0, <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> <para> -Signaled when there is a new attention icon set for the - object. +Emitted when <link linkend="AppIndicator--attention-icon-name"><type>"attention-icon-name"</type></link> is changed </para><variablelist role="params"> <varlistentry><term><parameter>arg0</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object @@ -661,8 +686,7 @@ Signaled when there is a new attention icon set for the <programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="AppIndicator"><type>AppIndicator</type></link> *arg0, <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> <para> -Signaled when there is a new icon set for the - object. +Emitted when <link linkend="AppIndicator--icon-name"><type>"icon-name"</type></link> is changed </para><variablelist role="params"> <varlistentry><term><parameter>arg0</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object @@ -675,7 +699,7 @@ Signaled when there is a new icon set for the <link linkend="gchar"><type>gchar</type></link> *arg1, <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> <para> -Signaled when the status of the indicator changes. +Emitted when <link linkend="AppIndicator--status"><type>"status"</type></link> is changed </para><variablelist role="params"> <varlistentry><term><parameter>arg0</parameter> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object |