diff options
Diffstat (limited to 'docs/reference')
20 files changed, 4717 insertions, 0 deletions
diff --git a/docs/reference/Makefile.in b/docs/reference/Makefile.in new file mode 100644 index 0000000..67a1b69 --- /dev/null +++ b/docs/reference/Makefile.in @@ -0,0 +1,813 @@ +# Makefile.in generated by automake 1.11.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, +# Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# -*- mode: makefile -*- + +#################################### +# Everything below here is generic # +#################################### +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(srcdir)/libappindicator-docs.sgml.in \ + $(srcdir)/version.xml.in $(top_srcdir)/gtk-doc.local.make +subdir = docs/reference +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = version.xml libappindicator-docs.sgml +CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_$(V)) +am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_$(V)) +am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +am__v_at_0 = @ +SOURCES = +DIST_SOURCES = +am__tty_colors = \ +red=; grn=; lgn=; blu=; std= +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AL = @AL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +APPINDICATOR_PYTHON_CFLAGS = @APPINDICATOR_PYTHON_CFLAGS@ +APPINDICATOR_PYTHON_LIBS = @APPINDICATOR_PYTHON_LIBS@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CSC = @CSC@ +CYGPATH_W = @CYGPATH_W@ +DBUSSERVICEDIR = @DBUSSERVICEDIR@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GACUTIL = @GACUTIL@ +GAPI_CFLAGS = @GAPI_CFLAGS@ +GAPI_CODEGEN = @GAPI_CODEGEN@ +GAPI_FIXUP = @GAPI_FIXUP@ +GAPI_LIBS = @GAPI_LIBS@ +GAPI_PARSER = @GAPI_PARSER@ +GENERATED_SOURCES = @GENERATED_SOURCES@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +GTK_SHARP_CFLAGS = @GTK_SHARP_CFLAGS@ +GTK_SHARP_LIBS = @GTK_SHARP_LIBS@ +HTML_DIR = @HTML_DIR@ +INDICATORDIR = @INDICATORDIR@ +INDICATORICONSDIR = @INDICATORICONSDIR@ +INDICATOR_CFLAGS = @INDICATOR_CFLAGS@ +INDICATOR_LIBS = @INDICATOR_LIBS@ +INSTALL = @INSTALL@ +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@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_PREFIX = @LIB_PREFIX@ +LIB_SUFFIX = @LIB_SUFFIX@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +MONO_DEPENDENCY_CFLAGS = @MONO_DEPENDENCY_CFLAGS@ +MONO_DEPENDENCY_LIBS = @MONO_DEPENDENCY_LIBS@ +NM = @NM@ +NMEDIT = @NMEDIT@ +NUNIT_CFLAGS = @NUNIT_CFLAGS@ +NUNIT_LIBS = @NUNIT_LIBS@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +PYGTK_CODEGEN = @PYGTK_CODEGEN@ +PYGTK_DEFSDIR = @PYGTK_DEFSDIR@ +PYTHON = @PYTHON@ +PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@ +PYTHON_INCLUDES = @PYTHON_INCLUDES@ +PYTHON_PLATFORM = @PYTHON_PLATFORM@ +PYTHON_PREFIX = @PYTHON_PREFIX@ +PYTHON_VERSION = @PYTHON_VERSION@ +RANLIB = @RANLIB@ +RUNTIME = @RUNTIME@ +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@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +lt_ECHO = @lt_ECHO@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +pkgpyexecdir = @pkgpyexecdir@ +pkgpythondir = @pkgpythondir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +pyexecdir = @pyexecdir@ +pythondir = @pythondir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# 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 = libappindicator + +# 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 + +# The directory containing the source code. Relative to $(srcdir). +# 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 + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS = --nogtkinit --type-init-func="g_type_init()" + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +#SCAN_OPTIONS=--rebuild-types --rebuild-sections +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)/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-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 \ + generate-id.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 +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 = version.xml + +# 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 = -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) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_RUN = sh -c +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_RUN = $(LIBTOOL) --mode=execute + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) +TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST = $(content_files) $(HTML_IMAGES) $(DOC_MAIN_SGML_FILE) \ + version.xml.in libappindicator-docs.sgml.in +DOC_STAMPS = scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ + $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals + +REPORT_FILES = \ + $(DOC_MODULE)-undocumented.txt \ + $(DOC_MODULE)-undeclared.txt \ + $(DOC_MODULE)-unused.txt + +CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) + +# 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' +TESTS = gtkdoc-in-srcdir +DISTCLEANFILES = gtkdoc-in-srcdir +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.local.make $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu docs/reference/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu docs/reference/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +version.xml: $(top_builddir)/config.status $(srcdir)/version.xml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ +libappindicator-docs.sgml: $(top_builddir)/config.status $(srcdir)/libappindicator-docs.sgml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +check-TESTS: $(TESTS) + @failed=0; all=0; xfail=0; xpass=0; skip=0; \ + srcdir=$(srcdir); export srcdir; \ + list=' $(TESTS) '; \ + $(am__tty_colors); \ + if test -n "$$list"; then \ + for tst in $$list; do \ + if test -f ./$$tst; then dir=./; \ + elif test -f $$tst; then dir=; \ + else dir="$(srcdir)/"; fi; \ + if $(TESTS_ENVIRONMENT) $${dir}$$tst; then \ + all=`expr $$all + 1`; \ + case " $(XFAIL_TESTS) " in \ + *[\ \ ]$$tst[\ \ ]*) \ + xpass=`expr $$xpass + 1`; \ + failed=`expr $$failed + 1`; \ + col=$$red; res=XPASS; \ + ;; \ + *) \ + col=$$grn; res=PASS; \ + ;; \ + esac; \ + elif test $$? -ne 77; then \ + all=`expr $$all + 1`; \ + case " $(XFAIL_TESTS) " in \ + *[\ \ ]$$tst[\ \ ]*) \ + xfail=`expr $$xfail + 1`; \ + col=$$lgn; res=XFAIL; \ + ;; \ + *) \ + failed=`expr $$failed + 1`; \ + col=$$red; res=FAIL; \ + ;; \ + esac; \ + else \ + skip=`expr $$skip + 1`; \ + col=$$blu; res=SKIP; \ + fi; \ + echo "$${col}$$res$${std}: $$tst"; \ + done; \ + if test "$$all" -eq 1; then \ + tests="test"; \ + All=""; \ + else \ + tests="tests"; \ + All="All "; \ + fi; \ + if test "$$failed" -eq 0; then \ + if test "$$xfail" -eq 0; then \ + banner="$$All$$all $$tests passed"; \ + else \ + if test "$$xfail" -eq 1; then failures=failure; else failures=failures; fi; \ + banner="$$All$$all $$tests behaved as expected ($$xfail expected $$failures)"; \ + fi; \ + else \ + if test "$$xpass" -eq 0; then \ + banner="$$failed of $$all $$tests failed"; \ + else \ + if test "$$xpass" -eq 1; then passes=pass; else passes=passes; fi; \ + banner="$$failed of $$all $$tests did not behave as expected ($$xpass unexpected $$passes)"; \ + fi; \ + fi; \ + dashes="$$banner"; \ + skipped=""; \ + if test "$$skip" -ne 0; then \ + if test "$$skip" -eq 1; then \ + skipped="($$skip test was not run)"; \ + else \ + skipped="($$skip tests were not run)"; \ + fi; \ + test `echo "$$skipped" | wc -c` -le `echo "$$banner" | wc -c` || \ + dashes="$$skipped"; \ + fi; \ + report=""; \ + if test "$$failed" -ne 0 && test -n "$(PACKAGE_BUGREPORT)"; then \ + report="Please report to $(PACKAGE_BUGREPORT)"; \ + test `echo "$$report" | wc -c` -le `echo "$$banner" | wc -c` || \ + dashes="$$report"; \ + fi; \ + dashes=`echo "$$dashes" | sed s/./=/g`; \ + if test "$$failed" -eq 0; then \ + echo "$$grn$$dashes"; \ + else \ + echo "$$red$$dashes"; \ + fi; \ + echo "$$banner"; \ + test -z "$$skipped" || echo "$$skipped"; \ + test -z "$$report" || echo "$$report"; \ + echo "$$dashes$$std"; \ + test "$$failed" -eq 0; \ + else :; fi + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am + $(MAKE) $(AM_MAKEFLAGS) check-TESTS +check: check-am +all-am: Makefile all-local +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + -test -z "$(DISTCLEANFILES)" || rm -f $(DISTCLEANFILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-local + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic \ + maintainer-clean-local + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-local + +.MAKE: check-am install-am install-strip + +.PHONY: all all-am all-local check check-TESTS check-am clean \ + clean-generic clean-libtool clean-local dist-hook distclean \ + distclean-generic distclean-libtool distclean-local distdir \ + dvi dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-data-local install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic \ + maintainer-clean-local mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-local + + +@ENABLE_GTK_DOC_TRUE@all-local: html-build.stamp +@ENABLE_GTK_DOC_FALSE@all-local: + +docs: html-build.stamp + +$(REPORT_FILES): sgml-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + @echo 'gtk-doc: Scanning header files' + @-chmod -R u+w $(srcdir) + cd $(srcdir) && \ + gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) + if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ + else \ + cd $(srcdir) ; \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp + @true + +#### templates #### + +tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo 'gtk-doc: Rebuilding template files' + @-chmod -R u+w $(srcdir) + cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) + touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +tmpl/*.sgml: + @true + +#### xml #### + +sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) + @echo 'gtk-doc: Building XML' + @-chmod -R u+w $(srcdir) + cd $(srcdir) && \ + gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) + touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo 'gtk-doc: Building HTML' + @-chmod -R u+w $(srcdir) + rm -rf $(srcdir)/html + mkdir $(srcdir)/html + mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options=--path="$(srcdir)"; \ + fi + cd $(srcdir)/html && gtkdoc-mkhtml $(mkhtml_options) $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) + @echo 'gtk-doc: Fixing cross-references' + cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + touch html-build.stamp + +############## + +clean-local: + rm -f *~ *.bak + rm -rf .libs + +distclean-local: + cd $(srcdir) && \ + rm -rf xml $(REPORT_FILES) \ + $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf xml html + +install-data-local: + installfiles=`echo $(srcdir)/html/*`; \ + if test "$$installfiles" = '$(srcdir)/html/*'; \ + then echo '-- Nothing to install' ; \ + else \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + $(mkinstalldirs) $${installdir} ; \ + for i in $$installfiles; do \ + echo '-- Installing '$$i ; \ + $(INSTALL_DATA) $$i $${installdir}; \ + done; \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + mv -f $${installdir}/$(DOC_MODULE).devhelp2 \ + $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \ + mv -f $${installdir}/$(DOC_MODULE).devhelp \ + $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \ + fi; \ + ! which gtkdoc-rebase >/dev/null 2>&1 || \ + gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir} ; \ + fi + +uninstall-local: + if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + rm -rf $${installdir} + +# +# Require gtk-doc when making dist +# +@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" +@ENABLE_GTK_DOC_FALSE@ @false + +dist-hook: dist-check-gtkdoc dist-hook-local + mkdir $(distdir)/tmpl + mkdir $(distdir)/xml + mkdir $(distdir)/html + -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl + -cp $(srcdir)/xml/*.xml $(distdir)/xml + -cp $(srcdir)/html/* $(distdir)/html + -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/ + -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/ + cd $(distdir) && rm -f $(DISTCLEANFILES) + ! which gtkdoc-rebase >/dev/null 2>&1 || \ + gtkdoc-rebase --online --relative --html-dir=$(distdir)/html + +.PHONY : dist-hook-local docs + +gtkdoc-in-srcdir: Makefile.am + @echo "#!/bin/sh" > $@ + @echo "cd \"$(srcdir)\"" >> $@ + @echo "$(GTKDOC_CHECK)" >> $@ + @chmod +x $@ + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/reference/html/api-index-full.html b/docs/reference/html/api-index-full.html new file mode 100644 index 0000000..8d49112 --- /dev/null +++ b/docs/reference/html/api-index-full.html @@ -0,0 +1,265 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>API Index</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libappindicator Reference Manual"> +<link rel="up" href="index.html" title="libappindicator Reference Manual"> +<link rel="prev" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="object-tree.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libappindicator Reference Manual</th> +<td> </td> +</tr> +<tr><td colspan="5" class="shortcuts"><a class="shortcut" href="#idxI">I</a></td></tr> +</table> +<div class="index" title="API Index"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="api-index-full"></a>API Index</h2></div></div></div> +<a name="idx"></a><a name="idxI"></a><h3 class="title">I</h3> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-struct" title="AppIndicator">AppIndicator</a>, struct in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR:CAPS" title="APP_INDICATOR()">APP_INDICATOR</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-connection-changed" title='The "connection-changed" signal'>AppIndicator::connection-changed</a>, object signal in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-attention-icon" title='The "new-attention-icon" signal'>AppIndicator::new-attention-icon</a>, object signal in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon" title='The "new-icon" signal'>AppIndicator::new-icon</a>, object signal in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon-theme-path" title='The "new-icon-theme-path" signal'>AppIndicator::new-icon-theme-path</a>, object signal in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-label" title='The "new-label" signal'>AppIndicator::new-label</a>, object signal in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-status" title='The "new-status" signal'>AppIndicator::new-status</a>, object signal in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator-x-ayatana-new-label" title='The "x-ayatana-new-label" signal'>AppIndicator::x-ayatana-new-label</a>, object signal in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'>AppIndicator:attention-icon-name</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--category" title='The "category" property'>AppIndicator:category</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--connected" title='The "connected" property'>AppIndicator:connected</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'>AppIndicator:icon-name</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-theme-path" title='The "icon-theme-path" property'>AppIndicator:icon-theme-path</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'>AppIndicator:id</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'>AppIndicator:label</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--label-guide" title='The "label-guide" property'>AppIndicator:label-guide</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--menu" title='The "menu" property'>AppIndicator:menu</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--ordering-index" title='The "ordering-index" property'>AppIndicator:ordering-index</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'>AppIndicator:status</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label" title='The "x-ayatana-label" property'>AppIndicator:x-ayatana-label</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label-guide" title='The "x-ayatana-label-guide" property'>AppIndicator:x-ayatana-label-guide</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--x-ayatana-ordering-index" title='The "x-ayatana-ordering-index" property'>AppIndicator:x-ayatana-ordering-index</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory">AppIndicatorCategory</a>, enum in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicatorClass" title="AppIndicatorClass">AppIndicatorClass</a>, struct in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicatorPrivate" title="AppIndicatorPrivate">AppIndicatorPrivate</a>, struct in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus">AppIndicatorStatus</a>, enum in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-CLASS:CAPS" title="APP_INDICATOR_CLASS()">APP_INDICATOR_CLASS</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<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>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-category" title="app_indicator_get_category ()">app_indicator_get_category</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-GET-CLASS:CAPS" title="APP_INDICATOR_GET_CLASS()">APP_INDICATOR_GET_CLASS</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon" title="app_indicator_get_icon ()">app_indicator_get_icon</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path" title="app_indicator_get_icon_theme_path ()">app_indicator_get_icon_theme_path</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-id" title="app_indicator_get_id ()">app_indicator_get_id</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-label" title="app_indicator_get_label ()">app_indicator_get_label</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-label-guide" title="app_indicator_get_label_guide ()">app_indicator_get_label_guide</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-menu" title="app_indicator_get_menu ()">app_indicator_get_menu</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-ordering-index" title="app_indicator_get_ordering_index ()">app_indicator_get_ordering_index</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-status" title="app_indicator_get_status ()">app_indicator_get_status</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-type" title="app_indicator_get_type ()">app_indicator_get_type</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-new" title="app_indicator_new ()">app_indicator_new</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<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>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<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>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon" title="app_indicator_set_icon ()">app_indicator_set_icon</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon-theme-path" title="app_indicator_set_icon_theme_path ()">app_indicator_set_icon_theme_path</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-label" title="app_indicator_set_label ()">app_indicator_set_label</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-menu" title="app_indicator_set_menu ()">app_indicator_set_menu</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-ordering-index" title="app_indicator_set_ordering_index ()">app_indicator_set_ordering_index</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-status" title="app_indicator_set_status ()">app_indicator_set_status</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS" title="APP_INDICATOR_SIGNAL_CONNECTION_CHANGED">APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS" title="APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON">APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON:CAPS" title="APP_INDICATOR_SIGNAL_NEW_ICON">APP_INDICATOR_SIGNAL_NEW_ICON</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS" title="APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH">APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS" title="APP_INDICATOR_SIGNAL_NEW_LABEL">APP_INDICATOR_SIGNAL_NEW_LABEL</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS" title="APP_INDICATOR_SIGNAL_NEW_STATUS">APP_INDICATOR_SIGNAL_NEW_STATUS</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-TYPE:CAPS" title="APP_INDICATOR_TYPE">APP_INDICATOR_TYPE</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#IS-APP-INDICATOR:CAPS" title="IS_APP_INDICATOR()">IS_APP_INDICATOR</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#IS-APP-INDICATOR-CLASS:CAPS" title="IS_APP_INDICATOR_CLASS()">IS_APP_INDICATOR_CLASS</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/ch01.html b/docs/reference/html/ch01.html new file mode 100644 index 0000000..6ed73af --- /dev/null +++ b/docs/reference/html/ch01.html @@ -0,0 +1,34 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Base Classes for Applications</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libappindicator Reference Manual"> +<link rel="up" href="index.html" title="libappindicator Reference Manual"> +<link rel="prev" href="index.html" title="libappindicator Reference Manual"> +<link rel="next" href="libappindicator-app-indicator.html" title="AppIndicator"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libappindicator Reference Manual</th> +<td><a accesskey="n" href="libappindicator-app-indicator.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter" title="Base Classes for Applications"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id500112"></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> +</dt></dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/home.png b/docs/reference/html/home.png Binary files differnew file mode 100644 index 0000000..1700361 --- /dev/null +++ b/docs/reference/html/home.png diff --git a/docs/reference/html/index.html b/docs/reference/html/index.html new file mode 100644 index 0000000..687d69d --- /dev/null +++ b/docs/reference/html/index.html @@ -0,0 +1,37 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>libappindicator Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libappindicator Reference Manual"> +<link rel="next" href="ch01.html" title="Base Classes for Applications"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book" title="libappindicator Reference Manual"> +<div class="titlepage"> +<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.2.5 + </p></div> +</div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="chapter"><a href="ch01.html">Base Classes for Applications</a></span></dt> +<dd><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> +</dt></dl></dd> +<dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt> +<dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/index.sgml b/docs/reference/html/index.sgml new file mode 100644 index 0000000..550deb3 --- /dev/null +++ b/docs/reference/html/index.sgml @@ -0,0 +1,77 @@ +<ANCHOR id="libappindicator-app-indicator" href="libappindicator/libappindicator-app-indicator.html"> +<ANCHOR id="libappindicator-app-indicator.stability-level" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.stability-level"> +<ANCHOR id="libappindicator-app-indicator.synopsis" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.synopsis"> +<ANCHOR id="AppIndicator" href="libappindicator/libappindicator-app-indicator.html#AppIndicator"> +<ANCHOR id="libappindicator-app-indicator.object-hierarchy" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.object-hierarchy"> +<ANCHOR id="libappindicator-app-indicator.properties" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.properties"> +<ANCHOR id="libappindicator-app-indicator.signals" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.signals"> +<ANCHOR id="libappindicator-app-indicator.description" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.description"> +<ANCHOR id="libappindicator-app-indicator.details" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.details"> +<ANCHOR id="APP-INDICATOR-TYPE:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-TYPE:CAPS"> +<ANCHOR id="APP-INDICATOR:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR:CAPS"> +<ANCHOR id="APP-INDICATOR-CLASS:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-CLASS:CAPS"> +<ANCHOR id="IS-APP-INDICATOR:CAPS" href="libappindicator/libappindicator-app-indicator.html#IS-APP-INDICATOR:CAPS"> +<ANCHOR id="IS-APP-INDICATOR-CLASS:CAPS" href="libappindicator/libappindicator-app-indicator.html#IS-APP-INDICATOR-CLASS:CAPS"> +<ANCHOR id="APP-INDICATOR-GET-CLASS:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-GET-CLASS:CAPS"> +<ANCHOR id="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON:CAPS"> +<ANCHOR id="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS"> +<ANCHOR id="APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS"> +<ANCHOR id="APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS"> +<ANCHOR id="APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS"> +<ANCHOR id="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS"> +<ANCHOR id="AppIndicatorCategory" href="libappindicator/libappindicator-app-indicator.html#AppIndicatorCategory"> +<ANCHOR id="APP-INDICATOR-CATEGORY-APPLICATION-STATUS:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-APPLICATION-STATUS:CAPS"> +<ANCHOR id="APP-INDICATOR-CATEGORY-COMMUNICATIONS:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-COMMUNICATIONS:CAPS"> +<ANCHOR id="APP-INDICATOR-CATEGORY-SYSTEM-SERVICES:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-SYSTEM-SERVICES:CAPS"> +<ANCHOR id="APP-INDICATOR-CATEGORY-HARDWARE:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-HARDWARE:CAPS"> +<ANCHOR id="APP-INDICATOR-CATEGORY-OTHER:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-OTHER:CAPS"> +<ANCHOR id="AppIndicatorStatus" href="libappindicator/libappindicator-app-indicator.html#AppIndicatorStatus"> +<ANCHOR id="APP-INDICATOR-STATUS-PASSIVE:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-STATUS-PASSIVE:CAPS"> +<ANCHOR id="APP-INDICATOR-STATUS-ACTIVE:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-STATUS-ACTIVE:CAPS"> +<ANCHOR id="APP-INDICATOR-STATUS-ATTENTION:CAPS" href="libappindicator/libappindicator-app-indicator.html#APP-INDICATOR-STATUS-ATTENTION:CAPS"> +<ANCHOR id="AppIndicatorPrivate" href="libappindicator/libappindicator-app-indicator.html#AppIndicatorPrivate"> +<ANCHOR id="AppIndicator-struct" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-struct"> +<ANCHOR id="AppIndicatorClass" href="libappindicator/libappindicator-app-indicator.html#AppIndicatorClass"> +<ANCHOR id="app-indicator-get-type" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-type"> +<ANCHOR id="app-indicator-new" href="libappindicator/libappindicator-app-indicator.html#app-indicator-new"> +<ANCHOR id="app-indicator-new-with-path" href="libappindicator/libappindicator-app-indicator.html#app-indicator-new-with-path"> +<ANCHOR id="app-indicator-set-status" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-status"> +<ANCHOR id="app-indicator-set-attention-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-attention-icon"> +<ANCHOR id="app-indicator-set-menu" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-menu"> +<ANCHOR id="app-indicator-set-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-icon"> +<ANCHOR id="app-indicator-set-icon-theme-path" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-icon-theme-path"> +<ANCHOR id="app-indicator-set-label" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-label"> +<ANCHOR id="app-indicator-set-ordering-index" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-ordering-index"> +<ANCHOR id="app-indicator-get-id" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-id"> +<ANCHOR id="app-indicator-get-category" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-category"> +<ANCHOR id="app-indicator-get-status" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-status"> +<ANCHOR id="app-indicator-get-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-icon"> +<ANCHOR id="app-indicator-get-icon-theme-path" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-icon-theme-path"> +<ANCHOR id="app-indicator-get-attention-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-attention-icon"> +<ANCHOR id="app-indicator-get-menu" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-menu"> +<ANCHOR id="app-indicator-get-label" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-label"> +<ANCHOR id="app-indicator-get-label-guide" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-label-guide"> +<ANCHOR id="app-indicator-get-ordering-index" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-ordering-index"> +<ANCHOR id="libappindicator-app-indicator.property-details" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.property-details"> +<ANCHOR id="AppIndicator--attention-icon-name" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--attention-icon-name"> +<ANCHOR id="AppIndicator--category" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--category"> +<ANCHOR id="AppIndicator--connected" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--connected"> +<ANCHOR id="AppIndicator--icon-name" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--icon-name"> +<ANCHOR id="AppIndicator--icon-theme-path" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--icon-theme-path"> +<ANCHOR id="AppIndicator--id" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--id"> +<ANCHOR id="AppIndicator--label" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--label"> +<ANCHOR id="AppIndicator--label-guide" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--label-guide"> +<ANCHOR id="AppIndicator--menu" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--menu"> +<ANCHOR id="AppIndicator--ordering-index" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--ordering-index"> +<ANCHOR id="AppIndicator--status" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--status"> +<ANCHOR id="AppIndicator--x-ayatana-label" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--x-ayatana-label"> +<ANCHOR id="AppIndicator--x-ayatana-label-guide" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--x-ayatana-label-guide"> +<ANCHOR id="AppIndicator--x-ayatana-ordering-index" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--x-ayatana-ordering-index"> +<ANCHOR id="libappindicator-app-indicator.signal-details" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.signal-details"> +<ANCHOR id="AppIndicator-connection-changed" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-connection-changed"> +<ANCHOR id="AppIndicator-new-attention-icon" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-attention-icon"> +<ANCHOR id="AppIndicator-new-icon" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-icon"> +<ANCHOR id="AppIndicator-new-icon-theme-path" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-icon-theme-path"> +<ANCHOR id="AppIndicator-new-label" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-label"> +<ANCHOR id="AppIndicator-new-status" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-status"> +<ANCHOR id="AppIndicator-x-ayatana-new-label" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-x-ayatana-new-label"> diff --git a/docs/reference/html/left.png b/docs/reference/html/left.png Binary files differnew file mode 100644 index 0000000..2d05b3d --- /dev/null +++ b/docs/reference/html/left.png diff --git a/docs/reference/html/libappindicator-app-indicator.html b/docs/reference/html/libappindicator-app-indicator.html new file mode 100644 index 0000000..2217219 --- /dev/null +++ b/docs/reference/html/libappindicator-app-indicator.html @@ -0,0 +1,1431 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AppIndicator</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libappindicator Reference Manual"> +<link rel="up" href="ch01.html" title="Base Classes for Applications"> +<link rel="prev" href="ch01.html" title="Base Classes for Applications"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libappindicator Reference Manual</th> +<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libappindicator-app-indicator.synopsis" class="shortcut">Top</a> + | + <a href="#libappindicator-app-indicator.description" class="shortcut">Description</a> + | + <a href="#libappindicator-app-indicator.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#libappindicator-app-indicator.properties" class="shortcut">Properties</a> + | + <a href="#libappindicator-app-indicator.signals" class="shortcut">Signals</a> +</td></tr> +</table> +<div class="refentry" title="AppIndicator"> +<a name="libappindicator-app-indicator"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libappindicator-app-indicator.top_of_page"></a>AppIndicator</span></h2> +<p>AppIndicator — An object to put application information + into the panel.</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1" title="Stability Level"> +<a name="libappindicator-app-indicator.stability-level"></a><h2>Stability Level</h2> +Unstable, unless otherwise indicated +</div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libappindicator-app-indicator.synopsis"></a><h2>Synopsis</h2> +<a name="AppIndicator"></a><pre class="synopsis"> +#include <libappindicator/app-indicator.h> + +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-TYPE:CAPS" title="APP_INDICATOR_TYPE">APP_INDICATOR_TYPE</a> +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR:CAPS" title="APP_INDICATOR()">APP_INDICATOR</a> (obj) +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-CLASS:CAPS" title="APP_INDICATOR_CLASS()">APP_INDICATOR_CLASS</a> (klass) +#define <a class="link" href="libappindicator-app-indicator.html#IS-APP-INDICATOR:CAPS" title="IS_APP_INDICATOR()">IS_APP_INDICATOR</a> (obj) +#define <a class="link" href="libappindicator-app-indicator.html#IS-APP-INDICATOR-CLASS:CAPS" title="IS_APP_INDICATOR_CLASS()">IS_APP_INDICATOR_CLASS</a> (klass) +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-GET-CLASS:CAPS" title="APP_INDICATOR_GET_CLASS()">APP_INDICATOR_GET_CLASS</a> (obj) +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON:CAPS" title="APP_INDICATOR_SIGNAL_NEW_ICON">APP_INDICATOR_SIGNAL_NEW_ICON</a> +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS" title="APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON">APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</a> +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS" title="APP_INDICATOR_SIGNAL_NEW_STATUS">APP_INDICATOR_SIGNAL_NEW_STATUS</a> +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS" title="APP_INDICATOR_SIGNAL_NEW_LABEL">APP_INDICATOR_SIGNAL_NEW_LABEL</a> +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS" title="APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH">APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH</a> +#define <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS" title="APP_INDICATOR_SIGNAL_CONNECTION_CHANGED">APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</a> +enum <a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory">AppIndicatorCategory</a>; +enum <a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus">AppIndicatorStatus</a>; + <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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_theme_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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/gtk/unstable/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="http://library.gnome.org/devel/glib/unstable/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-icon-theme-path" title="app_indicator_set_icon_theme_path ()">app_indicator_set_icon_theme_path</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_theme_path</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-label" title="app_indicator_set_label ()">app_indicator_set_label</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *guide</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-ordering-index" title="app_indicator_set_ordering_index ()">app_indicator_set_ordering_index</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> ordering_index</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path" title="app_indicator_get_icon_theme_path ()">app_indicator_get_icon_theme_path</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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/gtk/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-label" title="app_indicator_get_label ()">app_indicator_get_label</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-label-guide" title="app_indicator_get_label_guide ()">app_indicator_get_label_guide</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-ordering-index" title="app_indicator_get_ordering_index ()">app_indicator_get_ordering_index</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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'>id</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'>label</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--label-guide" title='The "label-guide" property'>label-guide</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<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--ordering-index" title='The "ordering-index" property'>ordering-index</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'>status</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label" title='The "x-ayatana-label" property'>x-ayatana-label</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label-guide" title='The "x-ayatana-label-guide" property'>x-ayatana-label-guide</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--x-ayatana-ordering-index" title='The "x-ayatana-ordering-index" property'>x-ayatana-ordering-index</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write +</pre> +</div> +<div class="refsect1" title="Signals"> +<a name="libappindicator-app-indicator.signals"></a><h2>Signals</h2> +<pre class="synopsis"> + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator-connection-changed" title='The "connection-changed" signal'>connection-changed</a>" : Run Last + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-attention-icon" title='The "new-attention-icon" signal'>new-attention-icon</a>" : Run Last + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon" title='The "new-icon" signal'>new-icon</a>" : Run Last + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon-theme-path" title='The "new-icon-theme-path" signal'>new-icon-theme-path</a>" : Run Last + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-label" title='The "new-label" signal'>new-label</a>" : Run Last + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-status" title='The "new-status" signal'>new-status</a>" : Run Last + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator-x-ayatana-new-label" title='The "x-ayatana-new-label" signal'>x-ayatana-new-label</a>" : Run Last +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libappindicator-app-indicator.description"></a><h2>Description</h2> +<p> +An application indicator is a way for an application to put + a menu into the panel on the user's screen. This allows the + user to interact with the application even though it might + not be visible to the user at the time. In most cases this + is not a good solution as there are other ways to inform the + user. It should only be use if persistence is a desired + feature for the user (not for your marketing purpose of + having your logo in the panel). +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libappindicator-app-indicator.details"></a><h2>Details</h2> +<div class="refsect2" title="APP_INDICATOR_TYPE"> +<a name="APP-INDICATOR-TYPE:CAPS"></a><h3>APP_INDICATOR_TYPE</h3> +<pre class="programlisting">#define APP_INDICATOR_TYPE (app_indicator_get_type ()) +</pre> +<p> +Get the <a href="http://library.gnome.org/devel/gobject/unstable/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> +<div class="refsect2" title="APP_INDICATOR()"> +<a name="APP-INDICATOR:CAPS"></a><h3>APP_INDICATOR()</h3> +<pre class="programlisting">#define APP_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), APP_INDICATOR_TYPE, AppIndicator)) +</pre> +<p> +Safely convert a <a href="http://library.gnome.org/devel/gobject/unstable/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"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> +<td>The object to convert +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_CLASS()"> +<a name="APP-INDICATOR-CLASS:CAPS"></a><h3>APP_INDICATOR_CLASS()</h3> +<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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> based class to convert. +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="IS_APP_INDICATOR()"> +<a name="IS-APP-INDICATOR:CAPS"></a><h3>IS_APP_INDICATOR()</h3> +<pre class="programlisting">#define IS_APP_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), APP_INDICATOR_TYPE)) +</pre> +<p> +Checks to see if <em class="parameter"><code>obj</code></em> is in the object hierarchy of <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"><em class="parameter"><code>obj</code></em> :</span></p></td> +<td>An <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to check +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="IS_APP_INDICATOR_CLASS()"> +<a name="IS-APP-INDICATOR-CLASS:CAPS"></a><h3>IS_APP_INDICATOR_CLASS()</h3> +<pre class="programlisting">#define IS_APP_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), APP_INDICATOR_TYPE)) +</pre> +<p> +Checks to see if <em class="parameter"><code>klass</code></em> is in the object class hierarchy of <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>An <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> to check +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_GET_CLASS()"> +<a name="APP-INDICATOR-GET-CLASS:CAPS"></a><h3>APP_INDICATOR_GET_CLASS()</h3> +<pre class="programlisting">#define APP_INDICATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), APP_INDICATOR_TYPE, AppIndicatorClass)) +</pre> +<p> +Gets a pointer to the <a class="link" href="libappindicator-app-indicator.html#AppIndicatorClass" title="AppIndicatorClass"><span class="type">AppIndicatorClass</span></a> for the object <em class="parameter"><code>obj</code></em>. +</p> +<div class="variablelist"><table border="0"> +<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="http://library.gnome.org/devel/gobject/unstable/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> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_SIGNAL_NEW_ICON"> +<a name="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS"></a><h3>APP_INDICATOR_SIGNAL_NEW_ICON</h3> +<pre class="programlisting">#define APP_INDICATOR_SIGNAL_NEW_ICON "new-icon" +</pre> +<p> +String identifier for the <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon" title='The "new-icon" signal'><span class="type">"new-icon"</span></a> signal. +</p> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON"> +<a name="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS"></a><h3>APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</h3> +<pre class="programlisting">#define APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON "new-attention-icon" +</pre> +<p> +String identifier for the <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-attention-icon" title='The "new-attention-icon" signal'><span class="type">"new-attention-icon"</span></a> signal. +</p> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_SIGNAL_NEW_STATUS"> +<a name="APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS"></a><h3>APP_INDICATOR_SIGNAL_NEW_STATUS</h3> +<pre class="programlisting">#define APP_INDICATOR_SIGNAL_NEW_STATUS "new-status" +</pre> +<p> +String identifier for the <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-status" title='The "new-status" signal'><span class="type">"new-status"</span></a> signal. +</p> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_SIGNAL_NEW_LABEL"> +<a name="APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS"></a><h3>APP_INDICATOR_SIGNAL_NEW_LABEL</h3> +<pre class="programlisting">#define APP_INDICATOR_SIGNAL_NEW_LABEL "new-label" +</pre> +<p> +String identifier for the <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-label" title='The "new-label" signal'><span class="type">"new-label"</span></a> signal. +</p> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH"> +<a name="APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS"></a><h3>APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH</h3> +<pre class="programlisting">#define APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH "new-icon-theme-path" +</pre> +<p> +String identifier for the <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon-theme-path" title='The "new-icon-theme-path" signal'><span class="type">"new-icon-theme-path"</span></a> signal. +</p> +</div> +<hr> +<div class="refsect2" title="APP_INDICATOR_SIGNAL_CONNECTION_CHANGED"> +<a name="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS"></a><h3>APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</h3> +<pre class="programlisting">#define APP_INDICATOR_SIGNAL_CONNECTION_CHANGED "connection-changed" +</pre> +<p> +String identifier for the <a class="link" href="libappindicator-app-indicator.html#AppIndicator-connection-changed" title='The "connection-changed" signal'><span class="type">"connection-changed"</span></a> signal. +</p> +</div> +<hr> +<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, /*< 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> +The category provides grouping for the indicators so that + users can find indicators that are similar together. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="APP-INDICATOR-CATEGORY-APPLICATION-STATUS:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_CATEGORY_APPLICATION_STATUS</code></span></p></td> +<td>The indicator is used to display the status of the application. +</td> +</tr> +<tr> +<td><p><a name="APP-INDICATOR-CATEGORY-COMMUNICATIONS:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_CATEGORY_COMMUNICATIONS</code></span></p></td> +<td>The application is used for communication with other people. +</td> +</tr> +<tr> +<td><p><a name="APP-INDICATOR-CATEGORY-SYSTEM-SERVICES:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_CATEGORY_SYSTEM_SERVICES</code></span></p></td> +<td>A system indicator relating to something in the user's system. +</td> +</tr> +<tr> +<td><p><a name="APP-INDICATOR-CATEGORY-HARDWARE:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_CATEGORY_HARDWARE</code></span></p></td> +<td>An indicator relating to the user's hardware. +</td> +</tr> +<tr> +<td><p><a name="APP-INDICATOR-CATEGORY-OTHER:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_CATEGORY_OTHER</code></span></p></td> +<td>Something not defined in this enum, please don't use unless you really need it. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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, /*< nick=Passive >*/ + APP_INDICATOR_STATUS_ACTIVE, /*< nick=Active >*/ + APP_INDICATOR_STATUS_ATTENTION /*< nick=NeedsAttention >*/ +} AppIndicatorStatus; +</pre> +<p> +These are the states that the indicator can be on in + the user's panel. The indicator by default starts + in the state <em class="parameter"><code>APP_INDICATOR_STATUS_PASSIVE</code></em> and can be + shown by setting it to <em class="parameter"><code>APP_INDICATOR_STATUS_ACTIVE</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="APP-INDICATOR-STATUS-PASSIVE:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_STATUS_PASSIVE</code></span></p></td> +<td>The indicator should not be shown to the user. +</td> +</tr> +<tr> +<td><p><a name="APP-INDICATOR-STATUS-ACTIVE:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_STATUS_ACTIVE</code></span></p></td> +<td>The indicator should be shown in it's default state. +</td> +</tr> +<tr> +<td><p><a name="APP-INDICATOR-STATUS-ATTENTION:CAPS"></a><span class="term"><code class="literal">APP_INDICATOR_STATUS_ATTENTION</code></span></p></td> +<td>The indicator should show it's attention icon. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="AppIndicatorPrivate"> +<a name="AppIndicatorPrivate"></a><h3>AppIndicatorPrivate</h3> +<pre class="programlisting">typedef struct _AppIndicatorPrivate AppIndicatorPrivate;</pre> +<p> +All of the private data in an instance of a + application indicator. +</p> +</div> +<hr> +<div class="refsect2" title="AppIndicator"> +<a name="AppIndicator-struct"></a><h3>AppIndicator</h3> +<pre class="programlisting">typedef struct _AppIndicator AppIndicator;</pre> +<p> +A application indicator represents the values that are needed to show a + unique status in the panel for an application. In general, applications + should try to fit in the other indicators that are available on the + panel before using this. But, sometimes it is necissary. +</p> +</div> +<hr> +<div class="refsect2" title="AppIndicatorClass"> +<a name="AppIndicatorClass"></a><h3>AppIndicatorClass</h3> +<pre class="programlisting">typedef struct { + /* Parent */ + GObjectClass parent_class; + + /* DBus Signals */ + void (* new_icon) (AppIndicator *indicator, + gpointer user_data); + void (* new_attention_icon) (AppIndicator *indicator, + gpointer user_data); + void (* new_status) (AppIndicator *indicator, + const gchar *status, + gpointer user_data); + void (* new_icon_theme_path) (AppIndicator *indicator, + const gchar *icon_theme_path, + gpointer user_data); + void (* new_label) (AppIndicator *indicator, + const gchar *label, + const gchar *guide, + gpointer user_data); + + /* Local Signals */ + void (* connection_changed) (AppIndicator * indicator, + gboolean connected, + gpointer user_data); + void (*app_indicator_reserved_sw)(void); + void (*app_indicator_reserved_ats)(void); + + /* Overridable Functions */ + GtkStatusIcon * (*fallback) (AppIndicator * indicator); + void (*unfallback) (AppIndicator * indicator, + GtkStatusIcon * status_icon); + + /* Reserved */ + void (*app_indicator_reserved_1)(void); + void (*app_indicator_reserved_2)(void); + void (*app_indicator_reserved_3)(void); + void (*app_indicator_reserved_4)(void); + void (*app_indicator_reserved_5)(void); + void (*app_indicator_reserved_6)(void); +} AppIndicatorClass; +</pre> +<p> +The signals and external functions that make up the <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> + class object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/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> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.new-icon"></a>new_icon</code></em> ()</span></p></td> +<td>Slot for <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon" title='The "new-icon" signal'><span class="type">"new-icon"</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.new-attention-icon"></a>new_attention_icon</code></em> ()</span></p></td> +<td>Slot for <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-attention-icon" title='The "new-attention-icon" signal'><span class="type">"new-attention-icon"</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.new-status"></a>new_status</code></em> ()</span></p></td> +<td>Slot for <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-status" title='The "new-status" signal'><span class="type">"new-status"</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.new-icon-theme-path"></a>new_icon_theme_path</code></em> ()</span></p></td> +<td>Slot for <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-icon-theme-path" title='The "new-icon-theme-path" signal'><span class="type">"new-icon-theme-path"</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.new-label"></a>new_label</code></em> ()</span></p></td> +<td>Slot for <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-label" title='The "new-label" signal'><span class="type">"new-label"</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.connection-changed"></a>connection_changed</code></em> ()</span></p></td> +<td>Slot for <a class="link" href="libappindicator-app-indicator.html#AppIndicator-connection-changed" title='The "connection-changed" signal'><span class="type">"connection-changed"</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-sw"></a>app_indicator_reserved_sw</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-ats"></a>app_indicator_reserved_ats</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</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="http://library.gnome.org/devel/gtk/unstable/GtkStatusIcon.html"><span class="type">GtkStatusIcon</span></a> when + there is no Application Indicator area available. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.unfallback"></a>unfallback</code></em> ()</span></p></td> +<td>The function that gets called if an Application + Indicator area appears after the fallback has been created. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-1"></a>app_indicator_reserved_1</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-2"></a>app_indicator_reserved_2</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-3"></a>app_indicator_reserved_3</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-4"></a>app_indicator_reserved_4</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-5"></a>app_indicator_reserved_5</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.app-indicator-reserved-6"></a>app_indicator_reserved_6</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +</tbody> +</table></div> +</div> +<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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/gobject/unstable/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> +</div> +<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/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: + <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"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>The unique id of the indicator to create. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> +<td>The icon name for this indicator +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td> +<td>The category of indicator. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A pointer to a new <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object. +</td> +</tr> +</tbody> +</table></div> +</div> +<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_theme_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: + <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_theme_path</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>The unique id of the indicator to create. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> +<td>The icon name for this indicator +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td> +<td>The category of indicator. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_theme_path</code></em> :</span></p></td> +<td>A custom path for finding icons. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A pointer to a new <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_set_status ()"> +<a name="app-indicator-set-status"></a><h3>app_indicator_set_status ()</h3> +<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 <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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td> +<td>The status to set for this indicator +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre> +<p> +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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> +<td>The name of the attention icon to set for this indicator +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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="http://library.gnome.org/devel/gtk/unstable/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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td> +<td>A <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenu.html"><span class="type">GtkMenu</span></a> to set +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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="http://library.gnome.org/devel/glib/unstable/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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> +<td>The icon name to set. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_set_icon_theme_path ()"> +<a name="app-indicator-set-icon-theme-path"></a><h3>app_indicator_set_icon_theme_path ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_icon_theme_path (<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_theme_path</code></em>);</pre> +<p> +Sets the path to use when searching for icons. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_theme_path</code></em> :</span></p></td> +<td>The icon theme path to set. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_set_label ()"> +<a name="app-indicator-set-label"></a><h3>app_indicator_set_label ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_label (<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *guide</code></em>);</pre> +<p> +This is a wrapper function for the <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'><span class="type">"label"</span></a> and + <span class="type">"guide"</span> properties. This function can take <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> + as either <em class="parameter"><code>label</code></em> or <em class="parameter"><code>guide</code></em> and will clear the entries. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td> +<td>The label to show next to the icon. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>guide</code></em> :</span></p></td> +<td>A guide to size the label correctly. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_set_ordering_index ()"> +<a name="app-indicator-set-ordering-index"></a><h3>app_indicator_set_ordering_index ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_ordering_index (<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> ordering_index</code></em>);</pre> +<p> +Sets the ordering index for the app indicator which effects the + placement of it on the panel. For almost all app indicator + this is not the function you're looking for. +</p> +<p> + Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--ordering-index" title='The "ordering-index" property'><span class="type">"ordering-index"</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>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ordering_index</code></em> :</span></p></td> +<td>A value for the ordering of this app indicator +</td> +</tr> +</tbody> +</table></div> +</div> +<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="http://library.gnome.org/devel/glib/unstable/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 <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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current ID +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_get_category ()"> +<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 <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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current category. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_get_status ()"> +<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 <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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current status. +</td> +</tr> +</tbody> +</table></div> +</div> +<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="http://library.gnome.org/devel/glib/unstable/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 <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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current icon name. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_get_icon_theme_path ()"> +<a name="app-indicator-get-icon-theme-path"></a><h3>app_indicator_get_icon_theme_path ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_icon_theme_path (<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 <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>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current icon theme path. +</td> +</tr> +</tbody> +</table></div> +</div> +<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="http://library.gnome.org/devel/glib/unstable/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 <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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current attention icon name. +</td> +</tr> +</tbody> +</table></div> +</div> +<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="http://library.gnome.org/devel/gtk/unstable/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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenu.html"><span class="type">GtkMenu</span></a> object or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if one hasn't been set. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_get_label ()"> +<a name="app-indicator-get-label"></a><h3>app_indicator_get_label ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_label (<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 <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'><span class="type">"label"</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>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current label. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_get_label_guide ()"> +<a name="app-indicator-get-label-guide"></a><h3>app_indicator_get_label_guide ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_label_guide (<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 <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label-guide" title='The "label-guide" property'><span class="type">"label-guide"</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>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current label guide. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="app_indicator_get_ordering_index ()"> +<a name="app-indicator-get-ordering-index"></a><h3>app_indicator_get_ordering_index ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> app_indicator_get_ordering_index (<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 <a class="link" href="libappindicator-app-indicator.html#AppIndicator--ordering-index" title='The "ordering-index" property'><span class="type">"ordering-index"</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>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The current ordering index. +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Property Details"> +<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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre> +<p> +Pretty simple, <a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</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="http://library.gnome.org/devel/glib/unstable/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 "label" property'> +<a name="AppIndicator--label"></a><h3>The <code class="literal">"label"</code> property</h3> +<pre class="programlisting"> "label" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +A label that can be shown next to the string in the application + indicator. The label will not be shown unless there is an icon + as well. The label is useful for numerical and other frequently + updated information. In general, it shouldn't be shown unless a + user requests it as it can take up a significant amount of space + on the user's panel. This may not be shown in all visualizations. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "label-guide" property'> +<a name="AppIndicator--label-guide"></a><h3>The <code class="literal">"label-guide"</code> property</h3> +<pre class="programlisting"> "label-guide" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +An optional string to provide guidance to the panel on how big + the <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'><span class="type">"label"</span></a> string could get. If this is set correctly + then the panel should never 'jiggle' as the string adjusts through + out the range of options. For instance, if you were providing a + percentage like "54% thrust" in <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'><span class="type">"label"</span></a> you'd want to + set this string to "100% thrust" to ensure space when Scotty can + get you enough power. +</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> +</div> +<hr> +<div class="refsect2" title='The "ordering-index" property'> +<a name="AppIndicator--ordering-index"></a><h3>The <code class="literal">"ordering-index"</code> property</h3> +<pre class="programlisting"> "ordering-index" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre> +<p> +The ordering index is an odd parameter, and if you think you don't need + it you're probably right. In general, the application indicator try + to place the applications in a recreatable place taking into account + which category they're in to try and group them. But, there are some + cases where you'd want to ensure indicators are next to each other. + To do that you can override the generated ordering index and replace it + with a new one. Again, you probably don't want to be doing this, but + in case you do, this is the way. +</p> +<p>Default value: 0</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="http://library.gnome.org/devel/glib/unstable/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> +<hr> +<div class="refsect2" title='The "x-ayatana-label" property'> +<a name="AppIndicator--x-ayatana-label"></a><h3>The <code class="literal">"x-ayatana-label"</code> property</h3> +<pre class="programlisting"> "x-ayatana-label" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Wrapper for <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'><span class="type">"label"</span></a>. Please use that in all of your + code. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "x-ayatana-label-guide" property'> +<a name="AppIndicator--x-ayatana-label-guide"></a><h3>The <code class="literal">"x-ayatana-label-guide"</code> property</h3> +<pre class="programlisting"> "x-ayatana-label-guide" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Wrapper for <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label-guide" title='The "label-guide" property'><span class="type">"label-guide"</span></a>. Please use that in all of your + code. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "x-ayatana-ordering-index" property'> +<a name="AppIndicator--x-ayatana-ordering-index"></a><h3>The <code class="literal">"x-ayatana-ordering-index"</code> property</h3> +<pre class="programlisting"> "x-ayatana-ordering-index" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre> +<p> +A wrapper for <a class="link" href="libappindicator-app-indicator.html#AppIndicator--ordering-index" title='The "ordering-index" property'><span class="type">"ordering-index"</span></a> so that it can match the + dbus interface currently. It will hopefully be retired, please don't + use it anywhere. +</p> +<p>Default value: 0</p> +</div> +</div> +<div class="refsect1" title="Signal Details"> +<a name="libappindicator-app-indicator.signal-details"></a><h2>Signal Details</h2> +<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg1, + <a href="http://library.gnome.org/devel/glib/unstable/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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg0</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td> +<td>Whether we're connected or not +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> +<p> +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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg0</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> +<p> +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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg0</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title='The "new-icon-theme-path" signal'> +<a name="AppIndicator-new-icon-theme-path"></a><h3>The <code class="literal">"new-icon-theme-path"</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, + <a href="http://library.gnome.org/devel/glib/unstable/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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg0</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title='The "new-label" signal'> +<a name="AppIndicator-new-label"></a><h3>The <code class="literal">"new-label"</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> +<p> +Emitted when either <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'><span class="type">"label"</span></a> or <a class="link" href="libappindicator-app-indicator.html#AppIndicator--label-guide" title='The "label-guide" property'><span class="type">"label-guide"</span></a> are + changed. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg0</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td> +<td>The string for the label +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td> +<td>The string for the guide +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> +<p> +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"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg0</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td> +<td>The string value of the <a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus"><span class="type">AppIndicatorStatus</span></a> enum. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title='The "x-ayatana-new-label" signal'> +<a name="AppIndicator-x-ayatana-new-label"></a><h3>The <code class="literal">"x-ayatana-new-label"</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> +<p> +Wrapper for <a class="link" href="libappindicator-app-indicator.html#AppIndicator-new-label" title='The "new-label" signal'><span class="type">"new-label"</span></a>, please don't use this signal + use the other one. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg0</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td> +<td>The string for the label +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td> +<td>The string for the guide +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/libappindicator.devhelp b/docs/reference/html/libappindicator.devhelp new file mode 100644 index 0000000..848aa27 --- /dev/null +++ b/docs/reference/html/libappindicator.devhelp @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="libappindicator Reference Manual" link="index.html" author="" name="libappindicator"> + <chapters> + <sub name="Base Classes for Applications" link="ch01.html"> + <sub name="AppIndicator" link="libappindicator-app-indicator.html"/> + </sub> + <sub name="Object Hierarchy" link="object-tree.html"/> + <sub name="API Index" link="api-index-full.html"/> + </chapters> + <functions> + <function name="APP_INDICATOR_TYPE" link="libappindicator-app-indicator.html#APP-INDICATOR-TYPE:CAPS"/> + <function name="APP_INDICATOR()" link="libappindicator-app-indicator.html#APP-INDICATOR:CAPS"/> + <function name="APP_INDICATOR_CLASS()" link="libappindicator-app-indicator.html#APP-INDICATOR-CLASS:CAPS"/> + <function name="IS_APP_INDICATOR()" link="libappindicator-app-indicator.html#IS-APP-INDICATOR:CAPS"/> + <function name="IS_APP_INDICATOR_CLASS()" link="libappindicator-app-indicator.html#IS-APP-INDICATOR-CLASS:CAPS"/> + <function name="APP_INDICATOR_GET_CLASS()" link="libappindicator-app-indicator.html#APP-INDICATOR-GET-CLASS:CAPS"/> + <function name="APP_INDICATOR_SIGNAL_NEW_ICON" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON:CAPS"/> + <function name="APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS"/> + <function name="APP_INDICATOR_SIGNAL_NEW_STATUS" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS"/> + <function name="APP_INDICATOR_SIGNAL_NEW_LABEL" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS"/> + <function name="APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS"/> + <function name="APP_INDICATOR_SIGNAL_CONNECTION_CHANGED" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS"/> + <function name="enum AppIndicatorCategory" link="libappindicator-app-indicator.html#AppIndicatorCategory"/> + <function name="enum AppIndicatorStatus" link="libappindicator-app-indicator.html#AppIndicatorStatus"/> + <function name="AppIndicatorPrivate" link="libappindicator-app-indicator.html#AppIndicatorPrivate"/> + <function name="AppIndicator" link="libappindicator-app-indicator.html#AppIndicator-struct"/> + <function name="AppIndicatorClass" link="libappindicator-app-indicator.html#AppIndicatorClass"/> + <function name="app_indicator_get_type ()" link="libappindicator-app-indicator.html#app-indicator-get-type"/> + <function name="app_indicator_new ()" link="libappindicator-app-indicator.html#app-indicator-new"/> + <function name="app_indicator_new_with_path ()" link="libappindicator-app-indicator.html#app-indicator-new-with-path"/> + <function name="app_indicator_set_status ()" link="libappindicator-app-indicator.html#app-indicator-set-status"/> + <function name="app_indicator_set_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-attention-icon"/> + <function name="app_indicator_set_menu ()" link="libappindicator-app-indicator.html#app-indicator-set-menu"/> + <function name="app_indicator_set_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-icon"/> + <function name="app_indicator_set_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-set-icon-theme-path"/> + <function name="app_indicator_set_label ()" link="libappindicator-app-indicator.html#app-indicator-set-label"/> + <function name="app_indicator_set_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-set-ordering-index"/> + <function name="app_indicator_get_id ()" link="libappindicator-app-indicator.html#app-indicator-get-id"/> + <function name="app_indicator_get_category ()" link="libappindicator-app-indicator.html#app-indicator-get-category"/> + <function name="app_indicator_get_status ()" link="libappindicator-app-indicator.html#app-indicator-get-status"/> + <function name="app_indicator_get_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-icon"/> + <function name="app_indicator_get_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path"/> + <function name="app_indicator_get_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-attention-icon"/> + <function name="app_indicator_get_menu ()" link="libappindicator-app-indicator.html#app-indicator-get-menu"/> + <function name="app_indicator_get_label ()" link="libappindicator-app-indicator.html#app-indicator-get-label"/> + <function name="app_indicator_get_label_guide ()" link="libappindicator-app-indicator.html#app-indicator-get-label-guide"/> + <function name="app_indicator_get_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-get-ordering-index"/> + <function name="The "attention-icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--attention-icon-name"/> + <function name="The "category" property" link="libappindicator-app-indicator.html#AppIndicator--category"/> + <function name="The "connected" property" link="libappindicator-app-indicator.html#AppIndicator--connected"/> + <function name="The "icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--icon-name"/> + <function name="The "icon-theme-path" property" link="libappindicator-app-indicator.html#AppIndicator--icon-theme-path"/> + <function name="The "id" property" link="libappindicator-app-indicator.html#AppIndicator--id"/> + <function name="The "label" property" link="libappindicator-app-indicator.html#AppIndicator--label"/> + <function name="The "label-guide" property" link="libappindicator-app-indicator.html#AppIndicator--label-guide"/> + <function name="The "menu" property" link="libappindicator-app-indicator.html#AppIndicator--menu"/> + <function name="The "ordering-index" property" link="libappindicator-app-indicator.html#AppIndicator--ordering-index"/> + <function name="The "status" property" link="libappindicator-app-indicator.html#AppIndicator--status"/> + <function name="The "x-ayatana-label" property" link="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label"/> + <function name="The "x-ayatana-label-guide" property" link="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label-guide"/> + <function name="The "x-ayatana-ordering-index" property" link="libappindicator-app-indicator.html#AppIndicator--x-ayatana-ordering-index"/> + <function name="The "connection-changed" signal" link="libappindicator-app-indicator.html#AppIndicator-connection-changed"/> + <function name="The "new-attention-icon" signal" link="libappindicator-app-indicator.html#AppIndicator-new-attention-icon"/> + <function name="The "new-icon" signal" link="libappindicator-app-indicator.html#AppIndicator-new-icon"/> + <function name="The "new-icon-theme-path" signal" link="libappindicator-app-indicator.html#AppIndicator-new-icon-theme-path"/> + <function name="The "new-label" signal" link="libappindicator-app-indicator.html#AppIndicator-new-label"/> + <function name="The "new-status" signal" link="libappindicator-app-indicator.html#AppIndicator-new-status"/> + <function name="The "x-ayatana-new-label" signal" link="libappindicator-app-indicator.html#AppIndicator-x-ayatana-new-label"/> + </functions> +</book> diff --git a/docs/reference/html/libappindicator.devhelp2 b/docs/reference/html/libappindicator.devhelp2 new file mode 100644 index 0000000..644764f --- /dev/null +++ b/docs/reference/html/libappindicator.devhelp2 @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="libappindicator Reference Manual" link="index.html" author="" name="libappindicator" version="2" language="c"> + <chapters> + <sub name="Base Classes for Applications" link="ch01.html"> + <sub name="AppIndicator" link="libappindicator-app-indicator.html"/> + </sub> + <sub name="Object Hierarchy" link="object-tree.html"/> + <sub name="API Index" link="api-index-full.html"/> + </chapters> + <functions> + <keyword type="macro" name="APP_INDICATOR_TYPE" link="libappindicator-app-indicator.html#APP-INDICATOR-TYPE:CAPS"/> + <keyword type="macro" name="APP_INDICATOR()" link="libappindicator-app-indicator.html#APP-INDICATOR:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_CLASS()" link="libappindicator-app-indicator.html#APP-INDICATOR-CLASS:CAPS"/> + <keyword type="macro" name="IS_APP_INDICATOR()" link="libappindicator-app-indicator.html#IS-APP-INDICATOR:CAPS"/> + <keyword type="macro" name="IS_APP_INDICATOR_CLASS()" link="libappindicator-app-indicator.html#IS-APP-INDICATOR-CLASS:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_GET_CLASS()" link="libappindicator-app-indicator.html#APP-INDICATOR-GET-CLASS:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_SIGNAL_NEW_ICON" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_SIGNAL_NEW_STATUS" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_SIGNAL_NEW_LABEL" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS"/> + <keyword type="macro" name="APP_INDICATOR_SIGNAL_CONNECTION_CHANGED" link="libappindicator-app-indicator.html#APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS"/> + <keyword type="enum" name="enum AppIndicatorCategory" link="libappindicator-app-indicator.html#AppIndicatorCategory"/> + <keyword type="enum" name="enum AppIndicatorStatus" link="libappindicator-app-indicator.html#AppIndicatorStatus"/> + <keyword type="struct" name="AppIndicatorPrivate" link="libappindicator-app-indicator.html#AppIndicatorPrivate"/> + <keyword type="struct" name="AppIndicator" link="libappindicator-app-indicator.html#AppIndicator-struct"/> + <keyword type="struct" name="AppIndicatorClass" link="libappindicator-app-indicator.html#AppIndicatorClass"/> + <keyword type="function" name="app_indicator_get_type ()" link="libappindicator-app-indicator.html#app-indicator-get-type"/> + <keyword type="function" name="app_indicator_new ()" link="libappindicator-app-indicator.html#app-indicator-new"/> + <keyword type="function" name="app_indicator_new_with_path ()" link="libappindicator-app-indicator.html#app-indicator-new-with-path"/> + <keyword type="function" name="app_indicator_set_status ()" link="libappindicator-app-indicator.html#app-indicator-set-status"/> + <keyword type="function" name="app_indicator_set_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-attention-icon"/> + <keyword type="function" name="app_indicator_set_menu ()" link="libappindicator-app-indicator.html#app-indicator-set-menu"/> + <keyword type="function" name="app_indicator_set_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-icon"/> + <keyword type="function" name="app_indicator_set_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-set-icon-theme-path"/> + <keyword type="function" name="app_indicator_set_label ()" link="libappindicator-app-indicator.html#app-indicator-set-label"/> + <keyword type="function" name="app_indicator_set_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-set-ordering-index"/> + <keyword type="function" name="app_indicator_get_id ()" link="libappindicator-app-indicator.html#app-indicator-get-id"/> + <keyword type="function" name="app_indicator_get_category ()" link="libappindicator-app-indicator.html#app-indicator-get-category"/> + <keyword type="function" name="app_indicator_get_status ()" link="libappindicator-app-indicator.html#app-indicator-get-status"/> + <keyword type="function" name="app_indicator_get_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-icon"/> + <keyword type="function" name="app_indicator_get_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path"/> + <keyword type="function" name="app_indicator_get_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-attention-icon"/> + <keyword type="function" name="app_indicator_get_menu ()" link="libappindicator-app-indicator.html#app-indicator-get-menu"/> + <keyword type="function" name="app_indicator_get_label ()" link="libappindicator-app-indicator.html#app-indicator-get-label"/> + <keyword type="function" name="app_indicator_get_label_guide ()" link="libappindicator-app-indicator.html#app-indicator-get-label-guide"/> + <keyword type="function" name="app_indicator_get_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-get-ordering-index"/> + <keyword type="property" name="The "attention-icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--attention-icon-name"/> + <keyword type="property" name="The "category" property" link="libappindicator-app-indicator.html#AppIndicator--category"/> + <keyword type="property" name="The "connected" property" link="libappindicator-app-indicator.html#AppIndicator--connected"/> + <keyword type="property" name="The "icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--icon-name"/> + <keyword type="property" name="The "icon-theme-path" property" link="libappindicator-app-indicator.html#AppIndicator--icon-theme-path"/> + <keyword type="property" name="The "id" property" link="libappindicator-app-indicator.html#AppIndicator--id"/> + <keyword type="property" name="The "label" property" link="libappindicator-app-indicator.html#AppIndicator--label"/> + <keyword type="property" name="The "label-guide" property" link="libappindicator-app-indicator.html#AppIndicator--label-guide"/> + <keyword type="property" name="The "menu" property" link="libappindicator-app-indicator.html#AppIndicator--menu"/> + <keyword type="property" name="The "ordering-index" property" link="libappindicator-app-indicator.html#AppIndicator--ordering-index"/> + <keyword type="property" name="The "status" property" link="libappindicator-app-indicator.html#AppIndicator--status"/> + <keyword type="property" name="The "x-ayatana-label" property" link="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label"/> + <keyword type="property" name="The "x-ayatana-label-guide" property" link="libappindicator-app-indicator.html#AppIndicator--x-ayatana-label-guide"/> + <keyword type="property" name="The "x-ayatana-ordering-index" property" link="libappindicator-app-indicator.html#AppIndicator--x-ayatana-ordering-index"/> + <keyword type="signal" name="The "connection-changed" signal" link="libappindicator-app-indicator.html#AppIndicator-connection-changed"/> + <keyword type="signal" name="The "new-attention-icon" signal" link="libappindicator-app-indicator.html#AppIndicator-new-attention-icon"/> + <keyword type="signal" name="The "new-icon" signal" link="libappindicator-app-indicator.html#AppIndicator-new-icon"/> + <keyword type="signal" name="The "new-icon-theme-path" signal" link="libappindicator-app-indicator.html#AppIndicator-new-icon-theme-path"/> + <keyword type="signal" name="The "new-label" signal" link="libappindicator-app-indicator.html#AppIndicator-new-label"/> + <keyword type="signal" name="The "new-status" signal" link="libappindicator-app-indicator.html#AppIndicator-new-status"/> + <keyword type="signal" name="The "x-ayatana-new-label" signal" link="libappindicator-app-indicator.html#AppIndicator-x-ayatana-new-label"/> + <keyword type="constant" name="APP_INDICATOR_CATEGORY_APPLICATION_STATUS" link="libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-APPLICATION-STATUS:CAPS"/> + <keyword type="constant" name="APP_INDICATOR_CATEGORY_COMMUNICATIONS" link="libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-COMMUNICATIONS:CAPS"/> + <keyword type="constant" name="APP_INDICATOR_CATEGORY_SYSTEM_SERVICES" link="libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-SYSTEM-SERVICES:CAPS"/> + <keyword type="constant" name="APP_INDICATOR_CATEGORY_HARDWARE" link="libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-HARDWARE:CAPS"/> + <keyword type="constant" name="APP_INDICATOR_CATEGORY_OTHER" link="libappindicator-app-indicator.html#APP-INDICATOR-CATEGORY-OTHER:CAPS"/> + <keyword type="constant" name="APP_INDICATOR_STATUS_PASSIVE" link="libappindicator-app-indicator.html#APP-INDICATOR-STATUS-PASSIVE:CAPS"/> + <keyword type="constant" name="APP_INDICATOR_STATUS_ACTIVE" link="libappindicator-app-indicator.html#APP-INDICATOR-STATUS-ACTIVE:CAPS"/> + <keyword type="constant" name="APP_INDICATOR_STATUS_ATTENTION" link="libappindicator-app-indicator.html#APP-INDICATOR-STATUS-ATTENTION:CAPS"/> + </functions> +</book> diff --git a/docs/reference/html/object-tree.html b/docs/reference/html/object-tree.html new file mode 100644 index 0000000..d6e519f --- /dev/null +++ b/docs/reference/html/object-tree.html @@ -0,0 +1,34 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Object Hierarchy</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libappindicator Reference Manual"> +<link rel="up" href="index.html" title="libappindicator Reference Manual"> +<link rel="prev" href="libappindicator-app-indicator.html" title="AppIndicator"> +<link rel="next" href="api-index-full.html" title="API Index"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="libappindicator-app-indicator.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libappindicator Reference Manual</th> +<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter" title="Object Hierarchy"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="object-tree"></a>Object Hierarchy</h2></div></div></div> +<pre class="screen"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <a class="link" href="libappindicator-app-indicator.html#AppIndicator">AppIndicator</a> +</pre> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/right.png b/docs/reference/html/right.png Binary files differnew file mode 100644 index 0000000..92832e3 --- /dev/null +++ b/docs/reference/html/right.png diff --git a/docs/reference/html/style.css b/docs/reference/html/style.css new file mode 100644 index 0000000..d544a2c --- /dev/null +++ b/docs/reference/html/style.css @@ -0,0 +1,265 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + position: relative; + padding-top:4.5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/reference/html/up.png b/docs/reference/html/up.png Binary files differnew file mode 100644 index 0000000..85b3e2a --- /dev/null +++ b/docs/reference/html/up.png diff --git a/docs/reference/libappindicator-docs.sgml b/docs/reference/libappindicator-docs.sgml new file mode 100644 index 0000000..ca18a64 --- /dev/null +++ b/docs/reference/libappindicator-docs.sgml @@ -0,0 +1,30 @@ +<?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'"> +]> +<book id="index"> + <bookinfo> + <title>libappindicator Reference Manual</title> + <releaseinfo> + for libappindicator 0.2.8 + </releaseinfo> + </bookinfo> + + <chapter> + <title>Base Classes for Applications</title> + <xi:include href="xml/app-indicator.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/tmpl/app-indicator.sgml b/docs/reference/tmpl/app-indicator.sgml new file mode 100644 index 0000000..0c8eab3 --- /dev/null +++ b/docs/reference/tmpl/app-indicator.sgml @@ -0,0 +1,478 @@ +<!-- ##### SECTION Title ##### --> +AppIndicator + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO APP_INDICATOR_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO APP_INDICATOR_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO IS_APP_INDICATOR ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO IS_APP_INDICATOR_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO APP_INDICATOR_GET_CLASS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ICON ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_STATUS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_LABEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO APP_INDICATOR_SIGNAL_CONNECTION_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### ENUM AppIndicatorCategory ##### --> +<para> + +</para> + +@APP_INDICATOR_CATEGORY_APPLICATION_STATUS: +@APP_INDICATOR_CATEGORY_COMMUNICATIONS: +@APP_INDICATOR_CATEGORY_SYSTEM_SERVICES: +@APP_INDICATOR_CATEGORY_HARDWARE: +@APP_INDICATOR_CATEGORY_OTHER: + +<!-- ##### ENUM AppIndicatorStatus ##### --> +<para> + +</para> + +@APP_INDICATOR_STATUS_PASSIVE: +@APP_INDICATOR_STATUS_ACTIVE: +@APP_INDICATOR_STATUS_ATTENTION: + +<!-- ##### STRUCT AppIndicatorPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AppIndicator ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL AppIndicator::connection-changed ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL AppIndicator::new-attention-icon ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. + +<!-- ##### SIGNAL AppIndicator::new-icon ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. + +<!-- ##### SIGNAL AppIndicator::new-icon-theme-path ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL AppIndicator::new-label ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL AppIndicator::new-status ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL AppIndicator::x-ayatana-new-label ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### ARG AppIndicator:attention-icon-name ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:category ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:connected ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:icon-name ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:icon-theme-path ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:id ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:label ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:label-guide ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:menu ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:ordering-index ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:status ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:x-ayatana-label ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:x-ayatana-label-guide ##### --> +<para> + +</para> + +<!-- ##### ARG AppIndicator:x-ayatana-ordering-index ##### --> +<para> + +</para> + +<!-- ##### STRUCT AppIndicatorClass ##### --> +<para> + +</para> + +@parent_class: +@new_icon: +@new_attention_icon: +@new_status: +@new_icon_theme_path: +@new_label: +@connection_changed: +@app_indicator_reserved_sw: +@app_indicator_reserved_ats: +@fallback: +@unfallback: +@app_indicator_reserved_1: +@app_indicator_reserved_2: +@app_indicator_reserved_3: +@app_indicator_reserved_4: +@app_indicator_reserved_5: +@app_indicator_reserved_6: + +<!-- ##### FUNCTION app_indicator_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION app_indicator_new ##### --> +<para> + +</para> + +@id: +@icon_name: +@category: +@Returns: + + +<!-- ##### FUNCTION app_indicator_new_with_path ##### --> +<para> + +</para> + +@id: +@icon_name: +@category: +@icon_theme_path: +@Returns: + + +<!-- ##### FUNCTION app_indicator_set_status ##### --> +<para> + +</para> + +@self: +@status: + + +<!-- ##### FUNCTION app_indicator_set_attention_icon ##### --> +<para> + +</para> + +@self: +@icon_name: + + +<!-- ##### FUNCTION app_indicator_set_menu ##### --> +<para> + +</para> + +@self: +@menu: + + +<!-- ##### FUNCTION app_indicator_set_icon ##### --> +<para> + +</para> + +@self: +@icon_name: + + +<!-- ##### FUNCTION app_indicator_set_icon_theme_path ##### --> +<para> + +</para> + +@self: +@icon_theme_path: + + +<!-- ##### FUNCTION app_indicator_set_label ##### --> +<para> + +</para> + +@self: +@label: +@guide: + + +<!-- ##### FUNCTION app_indicator_set_ordering_index ##### --> +<para> + +</para> + +@self: +@ordering_index: + + +<!-- ##### FUNCTION app_indicator_get_id ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_category ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_status ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_icon ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_icon_theme_path ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_attention_icon ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_menu ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_label ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_label_guide ##### --> +<para> + +</para> + +@self: +@Returns: + + +<!-- ##### FUNCTION app_indicator_get_ordering_index ##### --> +<para> + +</para> + +@self: +@Returns: + + diff --git a/docs/reference/version.xml b/docs/reference/version.xml new file mode 100644 index 0000000..a45be46 --- /dev/null +++ b/docs/reference/version.xml @@ -0,0 +1 @@ +0.2.8 diff --git a/docs/reference/xml/api-index-deprecated.xml b/docs/reference/xml/api-index-deprecated.xml new file mode 100644 index 0000000..8ec0fe4 --- /dev/null +++ b/docs/reference/xml/api-index-deprecated.xml @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<!DOCTYPE indexdiv 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'"> +]> +<indexdiv> +</indexdiv> diff --git a/docs/reference/xml/api-index-full.xml b/docs/reference/xml/api-index-full.xml new file mode 100644 index 0000000..5a26892 --- /dev/null +++ b/docs/reference/xml/api-index-full.xml @@ -0,0 +1,68 @@ +<?xml version="1.0"?> +<!DOCTYPE indexdiv 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'"> +]> +<indexdiv> +<indexdiv><title>I</title> +<indexentry><primaryie linkends="AppIndicator-struct"><link linkend="AppIndicator-struct">AppIndicator</link>, struct in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR:CAPS"><link linkend="APP-INDICATOR:CAPS">APP_INDICATOR</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator-connection-changed"><link linkend="AppIndicator-connection-changed">AppIndicator::connection-changed</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator-new-attention-icon"><link linkend="AppIndicator-new-attention-icon">AppIndicator::new-attention-icon</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator-new-icon"><link linkend="AppIndicator-new-icon">AppIndicator::new-icon</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator-new-icon-theme-path"><link linkend="AppIndicator-new-icon-theme-path">AppIndicator::new-icon-theme-path</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator-new-label"><link linkend="AppIndicator-new-label">AppIndicator::new-label</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator-new-status"><link linkend="AppIndicator-new-status">AppIndicator::new-status</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator-x-ayatana-new-label"><link linkend="AppIndicator-x-ayatana-new-label">AppIndicator::x-ayatana-new-label</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--attention-icon-name"><link linkend="AppIndicator--attention-icon-name">AppIndicator:attention-icon-name</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--category"><link linkend="AppIndicator--category">AppIndicator:category</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--connected"><link linkend="AppIndicator--connected">AppIndicator:connected</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--icon-name"><link linkend="AppIndicator--icon-name">AppIndicator:icon-name</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--icon-theme-path"><link linkend="AppIndicator--icon-theme-path">AppIndicator:icon-theme-path</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--id"><link linkend="AppIndicator--id">AppIndicator:id</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--label"><link linkend="AppIndicator--label">AppIndicator:label</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--label-guide"><link linkend="AppIndicator--label-guide">AppIndicator:label-guide</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--menu"><link linkend="AppIndicator--menu">AppIndicator:menu</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--ordering-index"><link linkend="AppIndicator--ordering-index">AppIndicator:ordering-index</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--status"><link linkend="AppIndicator--status">AppIndicator:status</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--x-ayatana-label"><link linkend="AppIndicator--x-ayatana-label">AppIndicator:x-ayatana-label</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--x-ayatana-label-guide"><link linkend="AppIndicator--x-ayatana-label-guide">AppIndicator:x-ayatana-label-guide</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--x-ayatana-ordering-index"><link linkend="AppIndicator--x-ayatana-ordering-index">AppIndicator:x-ayatana-ordering-index</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicatorCategory"><link linkend="AppIndicatorCategory">AppIndicatorCategory</link>, enum in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicatorClass"><link linkend="AppIndicatorClass">AppIndicatorClass</link>, struct in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicatorPrivate"><link linkend="AppIndicatorPrivate">AppIndicatorPrivate</link>, struct in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicatorStatus"><link linkend="AppIndicatorStatus">AppIndicatorStatus</link>, enum in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-CLASS:CAPS"><link linkend="APP-INDICATOR-CLASS:CAPS">APP_INDICATOR_CLASS</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-attention-icon"><link linkend="app-indicator-get-attention-icon">app_indicator_get_attention_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-category"><link linkend="app-indicator-get-category">app_indicator_get_category</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-GET-CLASS:CAPS"><link linkend="APP-INDICATOR-GET-CLASS:CAPS">APP_INDICATOR_GET_CLASS</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-icon"><link linkend="app-indicator-get-icon">app_indicator_get_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-icon-theme-path"><link linkend="app-indicator-get-icon-theme-path">app_indicator_get_icon_theme_path</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-id"><link linkend="app-indicator-get-id">app_indicator_get_id</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-label"><link linkend="app-indicator-get-label">app_indicator_get_label</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-label-guide"><link linkend="app-indicator-get-label-guide">app_indicator_get_label_guide</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-menu"><link linkend="app-indicator-get-menu">app_indicator_get_menu</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-ordering-index"><link linkend="app-indicator-get-ordering-index">app_indicator_get_ordering_index</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-status"><link linkend="app-indicator-get-status">app_indicator_get_status</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-type"><link linkend="app-indicator-get-type">app_indicator_get_type</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-new"><link linkend="app-indicator-new">app_indicator_new</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-new-with-path"><link linkend="app-indicator-new-with-path">app_indicator_new_with_path</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-attention-icon"><link linkend="app-indicator-set-attention-icon">app_indicator_set_attention_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-icon"><link linkend="app-indicator-set-icon">app_indicator_set_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-icon-theme-path"><link linkend="app-indicator-set-icon-theme-path">app_indicator_set_icon_theme_path</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-label"><link linkend="app-indicator-set-label">app_indicator_set_label</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-menu"><link linkend="app-indicator-set-menu">app_indicator_set_menu</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-ordering-index"><link linkend="app-indicator-set-ordering-index">app_indicator_set_ordering_index</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-status"><link linkend="app-indicator-set-status">app_indicator_set_status</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS"><link linkend="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS">APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS"><link linkend="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS">APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS"><link linkend="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS">APP_INDICATOR_SIGNAL_NEW_ICON</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS"><link linkend="APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS">APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS"><link linkend="APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS">APP_INDICATOR_SIGNAL_NEW_LABEL</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS"><link linkend="APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS">APP_INDICATOR_SIGNAL_NEW_STATUS</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="APP-INDICATOR-TYPE:CAPS"><link linkend="APP-INDICATOR-TYPE:CAPS">APP_INDICATOR_TYPE</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="IS-APP-INDICATOR:CAPS"><link linkend="IS-APP-INDICATOR:CAPS">IS_APP_INDICATOR</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="IS-APP-INDICATOR-CLASS:CAPS"><link linkend="IS-APP-INDICATOR-CLASS:CAPS">IS_APP_INDICATOR_CLASS</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> +</indexdiv> +</indexdiv> diff --git a/docs/reference/xml/app-indicator.xml b/docs/reference/xml/app-indicator.xml new file mode 100644 index 0000000..09a63a7 --- /dev/null +++ b/docs/reference/xml/app-indicator.xml @@ -0,0 +1,1026 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry 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'"> +]> +<refentry id="libappindicator-app-indicator"> +<refmeta> +<refentrytitle role="top_of_page" id="libappindicator-app-indicator.top_of_page">AppIndicator</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBAPPINDICATOR Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>AppIndicator</refname> +<refpurpose>An object to put application information + into the panel.</refpurpose> +</refnamediv> +<refsect1 id="libappindicator-app-indicator.stability-level"> +<title>Stability Level</title> +Unstable, unless otherwise indicated +</refsect1> + +<refsynopsisdiv id="libappindicator-app-indicator.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> +<anchor id="AppIndicator"/> +<synopsis> +#include <libappindicator/app-indicator.h> + +#define <link linkend="APP-INDICATOR-TYPE:CAPS">APP_INDICATOR_TYPE</link> +#define <link linkend="APP-INDICATOR:CAPS">APP_INDICATOR</link> (obj) +#define <link linkend="APP-INDICATOR-CLASS:CAPS">APP_INDICATOR_CLASS</link> (klass) +#define <link linkend="IS-APP-INDICATOR:CAPS">IS_APP_INDICATOR</link> (obj) +#define <link linkend="IS-APP-INDICATOR-CLASS:CAPS">IS_APP_INDICATOR_CLASS</link> (klass) +#define <link linkend="APP-INDICATOR-GET-CLASS:CAPS">APP_INDICATOR_GET_CLASS</link> (obj) +#define <link linkend="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS">APP_INDICATOR_SIGNAL_NEW_ICON</link> +#define <link linkend="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS">APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</link> +#define <link linkend="APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS">APP_INDICATOR_SIGNAL_NEW_STATUS</link> +#define <link linkend="APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS">APP_INDICATOR_SIGNAL_NEW_LABEL</link> +#define <link linkend="APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS">APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH</link> +#define <link linkend="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS">APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</link> +enum <link linkend="AppIndicatorCategory">AppIndicatorCategory</link>; +enum <link linkend="AppIndicatorStatus">AppIndicatorStatus</link>; + <link linkend="AppIndicatorPrivate">AppIndicatorPrivate</link>; + <link linkend="AppIndicator-struct">AppIndicator</link>; + <link linkend="AppIndicatorClass">AppIndicatorClass</link>; +<link linkend="GType"><returnvalue>GType</returnvalue></link> <link linkend="app-indicator-get-type">app_indicator_get_type</link> (<parameter><type>void</type></parameter>); +<link linkend="AppIndicator"><returnvalue>AppIndicator</returnvalue></link> * <link linkend="app-indicator-new">app_indicator_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>, + <parameter><link linkend="AppIndicatorCategory"><type>AppIndicatorCategory</type></link> category</parameter>); +<link linkend="AppIndicator"><returnvalue>AppIndicator</returnvalue></link> * <link linkend="app-indicator-new-with-path">app_indicator_new_with_path</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>, + <parameter><link linkend="AppIndicatorCategory"><type>AppIndicatorCategory</type></link> category</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_theme_path</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-status">app_indicator_set_status</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter><link linkend="AppIndicatorStatus"><type>AppIndicatorStatus</type></link> status</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-attention-icon">app_indicator_set_attention_icon</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-menu">app_indicator_set_menu</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter><link linkend="GtkMenu"><type>GtkMenu</type></link> *menu</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-icon">app_indicator_set_icon</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-icon-theme-path">app_indicator_set_icon_theme_path</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_theme_path</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-label">app_indicator_set_label</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *label</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *guide</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-ordering-index">app_indicator_set_ordering_index</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter><link linkend="guint32"><type>guint32</type></link> ordering_index</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-id">app_indicator_get_id</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +<link linkend="AppIndicatorCategory"><returnvalue>AppIndicatorCategory</returnvalue></link> <link linkend="app-indicator-get-category">app_indicator_get_category</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +<link linkend="AppIndicatorStatus"><returnvalue>AppIndicatorStatus</returnvalue></link> <link linkend="app-indicator-get-status">app_indicator_get_status</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-icon">app_indicator_get_icon</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-icon-theme-path">app_indicator_get_icon_theme_path</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-attention-icon">app_indicator_get_attention_icon</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +<link linkend="GtkMenu"><returnvalue>GtkMenu</returnvalue></link> * <link linkend="app-indicator-get-menu">app_indicator_get_menu</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-label">app_indicator_get_label</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-label-guide">app_indicator_get_label_guide</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +<link linkend="guint32"><returnvalue>guint32</returnvalue></link> <link linkend="app-indicator-get-ordering-index">app_indicator_get_ordering_index</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +</synopsis> +</refsynopsisdiv> +<refsect1 id="libappindicator-app-indicator.object-hierarchy" role="object_hierarchy"> +<title role="object_hierarchy.title">Object Hierarchy</title> +<synopsis> + <link linkend="GObject">GObject</link> + +----AppIndicator +</synopsis> +</refsect1> +<refsect1 id="libappindicator-app-indicator.properties" role="properties"> +<title role="properties.title">Properties</title> +<synopsis> + "<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 / Construct + "<link linkend="AppIndicator--icon-theme-path">icon-theme-path</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct + "<link linkend="AppIndicator--id">id</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only + "<link linkend="AppIndicator--label">label</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--label-guide">label-guide</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--menu">menu</link>" <link linkend="DBusGObjectPath"><type>DBusGObjectPath</type></link>* : Read + "<link linkend="AppIndicator--ordering-index">ordering-index</link>" <link linkend="guint"><type>guint</type></link> : Read / Write + "<link linkend="AppIndicator--status">status</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--x-ayatana-label">x-ayatana-label</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--x-ayatana-label-guide">x-ayatana-label-guide</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--x-ayatana-ordering-index">x-ayatana-ordering-index</link>" <link linkend="guint"><type>guint</type></link> : Read / Write +</synopsis> +</refsect1> +<refsect1 id="libappindicator-app-indicator.signals" role="signal_proto"> +<title role="signal_proto.title">Signals</title> +<synopsis> + "<link linkend="AppIndicator-connection-changed">connection-changed</link>" : Run Last + "<link linkend="AppIndicator-new-attention-icon">new-attention-icon</link>" : Run Last + "<link linkend="AppIndicator-new-icon">new-icon</link>" : Run Last + "<link linkend="AppIndicator-new-icon-theme-path">new-icon-theme-path</link>" : Run Last + "<link linkend="AppIndicator-new-label">new-label</link>" : Run Last + "<link linkend="AppIndicator-new-status">new-status</link>" : Run Last + "<link linkend="AppIndicator-x-ayatana-new-label">x-ayatana-new-label</link>" : Run Last +</synopsis> +</refsect1> + +<refsect1 id="libappindicator-app-indicator.description" role="desc"> +<title role="desc.title">Description</title> +<para> +An application indicator is a way for an application to put + a menu into the panel on the user's screen. This allows the + user to interact with the application even though it might + not be visible to the user at the time. In most cases this + is not a good solution as there are other ways to inform the + user. It should only be use if persistence is a desired + feature for the user (not for your marketing purpose of + having your logo in the panel). +</para> +</refsect1> +<refsect1 id="libappindicator-app-indicator.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="APP-INDICATOR-TYPE:CAPS" role="macro"> +<title>APP_INDICATOR_TYPE</title> +<indexterm zone="APP-INDICATOR-TYPE:CAPS"><primary>APP_INDICATOR_TYPE</primary></indexterm> +<programlisting>#define APP_INDICATOR_TYPE (app_indicator_get_type ()) +</programlisting> +<para> +Get the <link linkend="GType"><type>GType</type></link> for a <link linkend="AppIndicator"><type>AppIndicator</type></link>. +</para></refsect2> +<refsect2 id="APP-INDICATOR:CAPS" role="macro"> +<title>APP_INDICATOR()</title> +<indexterm zone="APP-INDICATOR:CAPS"><primary>APP_INDICATOR</primary></indexterm> +<programlisting>#define APP_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), APP_INDICATOR_TYPE, AppIndicator)) +</programlisting> +<para> +Safely convert a <link linkend="GObject"><type>GObject</type></link> into an <link linkend="AppIndicator"><type>AppIndicator</type></link>. +</para><variablelist role="params"> +<varlistentry><term><parameter>obj</parameter> :</term> +<listitem><simpara>The object to convert +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="APP-INDICATOR-CLASS:CAPS" role="macro"> +<title>APP_INDICATOR_CLASS()</title> +<indexterm zone="APP-INDICATOR-CLASS:CAPS"><primary>APP_INDICATOR_CLASS</primary></indexterm> +<programlisting>#define APP_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), APP_INDICATOR_TYPE, AppIndicatorClass)) +</programlisting> +<para> +Safely convert a <link linkend="GObjectClass"><type>GObjectClass</type></link> into a <link linkend="AppIndicatorClass"><type>AppIndicatorClass</type></link>. +</para><variablelist role="params"> +<varlistentry><term><parameter>klass</parameter> :</term> +<listitem><simpara><link linkend="GObjectClass"><type>GObjectClass</type></link> based class to convert. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="IS-APP-INDICATOR:CAPS" role="macro"> +<title>IS_APP_INDICATOR()</title> +<indexterm zone="IS-APP-INDICATOR:CAPS"><primary>IS_APP_INDICATOR</primary></indexterm> +<programlisting>#define IS_APP_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), APP_INDICATOR_TYPE)) +</programlisting> +<para> +Checks to see if <parameter>obj</parameter> is in the object hierarchy of <link linkend="AppIndicator"><type>AppIndicator</type></link>. +</para><variablelist role="params"> +<varlistentry><term><parameter>obj</parameter> :</term> +<listitem><simpara>An <link linkend="GObject"><type>GObject</type></link> to check +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="IS-APP-INDICATOR-CLASS:CAPS" role="macro"> +<title>IS_APP_INDICATOR_CLASS()</title> +<indexterm zone="IS-APP-INDICATOR-CLASS:CAPS"><primary>IS_APP_INDICATOR_CLASS</primary></indexterm> +<programlisting>#define IS_APP_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), APP_INDICATOR_TYPE)) +</programlisting> +<para> +Checks to see if <parameter>klass</parameter> is in the object class hierarchy of <link linkend="AppIndicatorClass"><type>AppIndicatorClass</type></link>. +</para><variablelist role="params"> +<varlistentry><term><parameter>klass</parameter> :</term> +<listitem><simpara>An <link linkend="GObjectClass"><type>GObjectClass</type></link> to check +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="APP-INDICATOR-GET-CLASS:CAPS" role="macro"> +<title>APP_INDICATOR_GET_CLASS()</title> +<indexterm zone="APP-INDICATOR-GET-CLASS:CAPS"><primary>APP_INDICATOR_GET_CLASS</primary></indexterm> +<programlisting>#define APP_INDICATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), APP_INDICATOR_TYPE, AppIndicatorClass)) +</programlisting> +<para> +Gets a pointer to the <link linkend="AppIndicatorClass"><type>AppIndicatorClass</type></link> for the object <parameter>obj</parameter>. +</para><variablelist role="params"> +<varlistentry><term><parameter>obj</parameter> :</term> +<listitem><simpara>A <link linkend="GObject"><type>GObject</type></link> in the class hierarchy of <link linkend="AppIndicator"><type>AppIndicator</type></link>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS" role="macro"> +<title>APP_INDICATOR_SIGNAL_NEW_ICON</title> +<indexterm zone="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS"><primary>APP_INDICATOR_SIGNAL_NEW_ICON</primary></indexterm> +<programlisting>#define APP_INDICATOR_SIGNAL_NEW_ICON "new-icon" +</programlisting> +<para> +String identifier for the <link linkend="AppIndicator-new-icon"><type>"new-icon"</type></link> signal. +</para></refsect2> +<refsect2 id="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS" role="macro"> +<title>APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</title> +<indexterm zone="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS"><primary>APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</primary></indexterm> +<programlisting>#define APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON "new-attention-icon" +</programlisting> +<para> +String identifier for the <link linkend="AppIndicator-new-attention-icon"><type>"new-attention-icon"</type></link> signal. +</para></refsect2> +<refsect2 id="APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS" role="macro"> +<title>APP_INDICATOR_SIGNAL_NEW_STATUS</title> +<indexterm zone="APP-INDICATOR-SIGNAL-NEW-STATUS:CAPS"><primary>APP_INDICATOR_SIGNAL_NEW_STATUS</primary></indexterm> +<programlisting>#define APP_INDICATOR_SIGNAL_NEW_STATUS "new-status" +</programlisting> +<para> +String identifier for the <link linkend="AppIndicator-new-status"><type>"new-status"</type></link> signal. +</para></refsect2> +<refsect2 id="APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS" role="macro"> +<title>APP_INDICATOR_SIGNAL_NEW_LABEL</title> +<indexterm zone="APP-INDICATOR-SIGNAL-NEW-LABEL:CAPS"><primary>APP_INDICATOR_SIGNAL_NEW_LABEL</primary></indexterm> +<programlisting>#define APP_INDICATOR_SIGNAL_NEW_LABEL "new-label" +</programlisting> +<para> +String identifier for the <link linkend="AppIndicator-new-label"><type>"new-label"</type></link> signal. +</para></refsect2> +<refsect2 id="APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS" role="macro"> +<title>APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH</title> +<indexterm zone="APP-INDICATOR-SIGNAL-NEW-ICON-THEME-PATH:CAPS"><primary>APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH</primary></indexterm> +<programlisting>#define APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH "new-icon-theme-path" +</programlisting> +<para> +String identifier for the <link linkend="AppIndicator-new-icon-theme-path"><type>"new-icon-theme-path"</type></link> signal. +</para></refsect2> +<refsect2 id="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS" role="macro"> +<title>APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</title> +<indexterm zone="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS"><primary>APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</primary></indexterm> +<programlisting>#define APP_INDICATOR_SIGNAL_CONNECTION_CHANGED "connection-changed" +</programlisting> +<para> +String identifier for the <link linkend="AppIndicator-connection-changed"><type>"connection-changed"</type></link> signal. +</para></refsect2> +<refsect2 id="AppIndicatorCategory" role="enum"> +<title>enum AppIndicatorCategory</title> +<indexterm zone="AppIndicatorCategory"><primary>AppIndicatorCategory</primary></indexterm> +<programlisting>typedef enum { /*< prefix=APP_INDICATOR_CATEGORY >*/ + 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> +The category provides grouping for the indicators so that + users can find indicators that are similar together. +</para><variablelist role="enum"> +<varlistentry id="APP-INDICATOR-CATEGORY-APPLICATION-STATUS:CAPS" role="constant"> +<term><literal>APP_INDICATOR_CATEGORY_APPLICATION_STATUS</literal></term> +<listitem><simpara>The indicator is used to display the status of the application. +</simpara></listitem> +</varlistentry> +<varlistentry id="APP-INDICATOR-CATEGORY-COMMUNICATIONS:CAPS" role="constant"> +<term><literal>APP_INDICATOR_CATEGORY_COMMUNICATIONS</literal></term> +<listitem><simpara>The application is used for communication with other people. +</simpara></listitem> +</varlistentry> +<varlistentry id="APP-INDICATOR-CATEGORY-SYSTEM-SERVICES:CAPS" role="constant"> +<term><literal>APP_INDICATOR_CATEGORY_SYSTEM_SERVICES</literal></term> +<listitem><simpara>A system indicator relating to something in the user's system. +</simpara></listitem> +</varlistentry> +<varlistentry id="APP-INDICATOR-CATEGORY-HARDWARE:CAPS" role="constant"> +<term><literal>APP_INDICATOR_CATEGORY_HARDWARE</literal></term> +<listitem><simpara>An indicator relating to the user's hardware. +</simpara></listitem> +</varlistentry> +<varlistentry id="APP-INDICATOR-CATEGORY-OTHER:CAPS" role="constant"> +<term><literal>APP_INDICATOR_CATEGORY_OTHER</literal></term> +<listitem><simpara>Something not defined in this enum, please don't use unless you really need it. +</simpara></listitem> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="AppIndicatorStatus" role="enum"> +<title>enum AppIndicatorStatus</title> +<indexterm zone="AppIndicatorStatus"><primary>AppIndicatorStatus</primary></indexterm> +<programlisting>typedef enum { /*< prefix=APP_INDICATOR_STATUS >*/ + APP_INDICATOR_STATUS_PASSIVE, /*< nick=Passive >*/ + APP_INDICATOR_STATUS_ACTIVE, /*< nick=Active >*/ + APP_INDICATOR_STATUS_ATTENTION /*< nick=NeedsAttention >*/ +} AppIndicatorStatus; +</programlisting> +<para> +These are the states that the indicator can be on in + the user's panel. The indicator by default starts + in the state <parameter>APP_INDICATOR_STATUS_PASSIVE</parameter> and can be + shown by setting it to <parameter>APP_INDICATOR_STATUS_ACTIVE</parameter>. +</para><variablelist role="enum"> +<varlistentry id="APP-INDICATOR-STATUS-PASSIVE:CAPS" role="constant"> +<term><literal>APP_INDICATOR_STATUS_PASSIVE</literal></term> +<listitem><simpara>The indicator should not be shown to the user. +</simpara></listitem> +</varlistentry> +<varlistentry id="APP-INDICATOR-STATUS-ACTIVE:CAPS" role="constant"> +<term><literal>APP_INDICATOR_STATUS_ACTIVE</literal></term> +<listitem><simpara>The indicator should be shown in it's default state. +</simpara></listitem> +</varlistentry> +<varlistentry id="APP-INDICATOR-STATUS-ATTENTION:CAPS" role="constant"> +<term><literal>APP_INDICATOR_STATUS_ATTENTION</literal></term> +<listitem><simpara>The indicator should show it's attention icon. +</simpara></listitem> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="AppIndicatorPrivate" role="struct"> +<title>AppIndicatorPrivate</title> +<indexterm zone="AppIndicatorPrivate"><primary>AppIndicatorPrivate</primary></indexterm> +<programlisting>typedef struct _AppIndicatorPrivate AppIndicatorPrivate;</programlisting> +<para> +All of the private data in an instance of a + application indicator. +</para></refsect2> +<refsect2 id="AppIndicator-struct" role="struct"> +<title>AppIndicator</title> +<indexterm zone="AppIndicator-struct"><primary>AppIndicator</primary></indexterm> +<programlisting>typedef struct _AppIndicator AppIndicator;</programlisting> +<para> +A application indicator represents the values that are needed to show a + unique status in the panel for an application. In general, applications + should try to fit in the other indicators that are available on the + panel before using this. But, sometimes it is necissary. +</para></refsect2> +<refsect2 id="AppIndicatorClass" role="struct"> +<title>AppIndicatorClass</title> +<indexterm zone="AppIndicatorClass"><primary>AppIndicatorClass</primary></indexterm> +<programlisting>typedef struct { + /* Parent */ + GObjectClass parent_class; + + /* DBus Signals */ + void (* new_icon) (AppIndicator *indicator, + gpointer user_data); + void (* new_attention_icon) (AppIndicator *indicator, + gpointer user_data); + void (* new_status) (AppIndicator *indicator, + const gchar *status, + gpointer user_data); + void (* new_icon_theme_path) (AppIndicator *indicator, + const gchar *icon_theme_path, + gpointer user_data); + void (* new_label) (AppIndicator *indicator, + const gchar *label, + const gchar *guide, + gpointer user_data); + + /* Local Signals */ + void (* connection_changed) (AppIndicator * indicator, + gboolean connected, + gpointer user_data); + void (*app_indicator_reserved_sw)(void); + void (*app_indicator_reserved_ats)(void); + + /* Overridable Functions */ + GtkStatusIcon * (*fallback) (AppIndicator * indicator); + void (*unfallback) (AppIndicator * indicator, + GtkStatusIcon * status_icon); + + /* Reserved */ + void (*app_indicator_reserved_1)(void); + void (*app_indicator_reserved_2)(void); + void (*app_indicator_reserved_3)(void); + void (*app_indicator_reserved_4)(void); + void (*app_indicator_reserved_5)(void); + void (*app_indicator_reserved_6)(void); +} AppIndicatorClass; +</programlisting> +<para> +The signals and external functions that make up the <link linkend="AppIndicator"><type>AppIndicator</type></link> + class object. +</para><variablelist role="struct"> +<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="AppIndicatorClass.parent-class">parent_class</structfield>;</term> +<listitem><simpara>Mia familia +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.new-icon">new_icon</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="AppIndicator-new-icon"><type>"new-icon"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.new-attention-icon">new_attention_icon</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="AppIndicator-new-attention-icon"><type>"new-attention-icon"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.new-status">new_status</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="AppIndicator-new-status"><type>"new-status"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.new-icon-theme-path">new_icon_theme_path</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="AppIndicator-new-icon-theme-path"><type>"new-icon-theme-path"</type></link> +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.new-label">new_label</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="AppIndicator-new-label"><type>"new-label"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.connection-changed">connection_changed</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="AppIndicator-connection-changed"><type>"connection-changed"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-sw">app_indicator_reserved_sw</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-ats">app_indicator_reserved_ats</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.fallback">fallback</structfield> ()</term> +<listitem><simpara>Function that gets called to make a <link linkend="GtkStatusIcon"><type>GtkStatusIcon</type></link> when + there is no Application Indicator area available. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.unfallback">unfallback</structfield> ()</term> +<listitem><simpara>The function that gets called if an Application + Indicator area appears after the fallback has been created. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-1">app_indicator_reserved_1</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-2">app_indicator_reserved_2</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-3">app_indicator_reserved_3</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-4">app_indicator_reserved_4</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-5">app_indicator_reserved_5</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="AppIndicatorClass.app-indicator-reserved-6">app_indicator_reserved_6</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-type" role="function"> +<title>app_indicator_get_type ()</title> +<indexterm zone="app-indicator-get-type"><primary>app_indicator_get_type</primary></indexterm> +<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link> app_indicator_get_type (<parameter><type>void</type></parameter>);</programlisting> +<para> +Generates or returns the unique <link linkend="GType"><type>GType</type></link> for <link linkend="AppIndicator"><type>AppIndicator</type></link>. +</para><variablelist role="params"> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A unique <link linkend="GType"><type>GType</type></link> for <link linkend="AppIndicator"><type>AppIndicator</type></link> objects. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-new" role="function"> +<title>app_indicator_new ()</title> +<indexterm zone="app-indicator-new"><primary>app_indicator_new</primary></indexterm> +<programlisting><link linkend="AppIndicator"><returnvalue>AppIndicator</returnvalue></link> * app_indicator_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>, + <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 + <parameter>icon_name</parameter>. +</para><variablelist role="params"> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara>The unique id of the indicator to create. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_name</parameter> :</term> +<listitem><simpara>The icon name for this indicator +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>category</parameter> :</term> +<listitem><simpara>The category of indicator. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to a new <link linkend="AppIndicator"><type>AppIndicator</type></link> object. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-new-with-path" role="function"> +<title>app_indicator_new_with_path ()</title> +<indexterm zone="app-indicator-new-with-path"><primary>app_indicator_new_with_path</primary></indexterm> +<programlisting><link linkend="AppIndicator"><returnvalue>AppIndicator</returnvalue></link> * app_indicator_new_with_path (<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>, + <parameter><link linkend="AppIndicatorCategory"><type>AppIndicatorCategory</type></link> category</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_theme_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_theme_path</parameter>. +</para><variablelist role="params"> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara>The unique id of the indicator to create. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_name</parameter> :</term> +<listitem><simpara>The icon name for this indicator +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>category</parameter> :</term> +<listitem><simpara>The category of indicator. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_theme_path</parameter> :</term> +<listitem><simpara>A custom path for finding icons. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to a new <link linkend="AppIndicator"><type>AppIndicator</type></link> object. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-set-status" role="function"> +<title>app_indicator_set_status ()</title> +<indexterm zone="app-indicator-set-status"><primary>app_indicator_set_status</primary></indexterm> +<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>. +</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><parameter>status</parameter> :</term> +<listitem><simpara>The status to set for this indicator +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-set-attention-icon" role="function"> +<title>app_indicator_set_attention_icon ()</title> +<indexterm zone="app-indicator-set-attention-icon"><primary>app_indicator_set_attention_icon</primary></indexterm> +<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-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 +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_name</parameter> :</term> +<listitem><simpara>The name of the attention icon to set for this indicator +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-set-menu" role="function"> +<title>app_indicator_set_menu ()</title> +<indexterm zone="app-indicator-set-menu"><primary>app_indicator_set_menu</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_menu (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter><link linkend="GtkMenu"><type>GtkMenu</type></link> *menu</parameter>);</programlisting> +<para> +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> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>menu</parameter> :</term> +<listitem><simpara>A <link linkend="GtkMenu"><type>GtkMenu</type></link> to set +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-set-icon" role="function"> +<title>app_indicator_set_icon ()</title> +<indexterm zone="app-indicator-set-icon"><primary>app_indicator_set_icon</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_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> +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 +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_name</parameter> :</term> +<listitem><simpara>The icon name to set. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-set-icon-theme-path" role="function"> +<title>app_indicator_set_icon_theme_path ()</title> +<indexterm zone="app-indicator-set-icon-theme-path"><primary>app_indicator_set_icon_theme_path</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_icon_theme_path (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_theme_path</parameter>);</programlisting> +<para> +Sets the path to use when searching for icons. +</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><parameter>icon_theme_path</parameter> :</term> +<listitem><simpara>The icon theme path to set. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-set-label" role="function"> +<title>app_indicator_set_label ()</title> +<indexterm zone="app-indicator-set-label"><primary>app_indicator_set_label</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_label (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *label</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *guide</parameter>);</programlisting> +<para> +This is a wrapper function for the <link linkend="AppIndicator--label"><type>"label"</type></link> and + <link linkend="AppIndicator--guide"><type>"guide"</type></link> properties. This function can take <link linkend="NULL:CAPS"><type>NULL</type></link> + as either <parameter>label</parameter> or <parameter>guide</parameter> and will clear the entries. +</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><parameter>label</parameter> :</term> +<listitem><simpara>The label to show next to the icon. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>guide</parameter> :</term> +<listitem><simpara>A guide to size the label correctly. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-set-ordering-index" role="function"> +<title>app_indicator_set_ordering_index ()</title> +<indexterm zone="app-indicator-set-ordering-index"><primary>app_indicator_set_ordering_index</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_ordering_index (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter><link linkend="guint32"><type>guint32</type></link> ordering_index</parameter>);</programlisting> +<para> +Sets the ordering index for the app indicator which effects the + placement of it on the panel. For almost all app indicator + this is not the function you're looking for. +</para> +<para> + Wrapper function for property <link linkend="AppIndicator--ordering-index"><type>"ordering-index"</type></link>. +</para><variablelist role="params"> +<varlistentry><term><parameter>self</parameter> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>ordering_index</parameter> :</term> +<listitem><simpara>A value for the ordering of this app indicator +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-id" role="function"> +<title>app_indicator_get_id ()</title> +<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>. +</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> The current ID +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-category" role="function"> +<title>app_indicator_get_category ()</title> +<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>. +</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> The current category. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-status" role="function"> +<title>app_indicator_get_status ()</title> +<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>. +</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> The current status. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-icon" role="function"> +<title>app_indicator_get_icon ()</title> +<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>. +</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> The current icon name. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-icon-theme-path" role="function"> +<title>app_indicator_get_icon_theme_path ()</title> +<indexterm zone="app-indicator-get-icon-theme-path"><primary>app_indicator_get_icon_theme_path</primary></indexterm> +<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_icon_theme_path (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> +<para> +Wrapper function for property <link linkend="AppIndicator--icon-theme-path"><type>"icon-theme-path"</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> The current icon theme path. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-attention-icon" role="function"> +<title>app_indicator_get_attention_icon ()</title> +<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>. +</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> The current attention icon name. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-menu" role="function"> +<title>app_indicator_get_menu ()</title> +<indexterm zone="app-indicator-get-menu"><primary>app_indicator_get_menu</primary></indexterm> +<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 <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> +<refsect2 id="app-indicator-get-label" role="function"> +<title>app_indicator_get_label ()</title> +<indexterm zone="app-indicator-get-label"><primary>app_indicator_get_label</primary></indexterm> +<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_label (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> +<para> +Wrapper function for property <link linkend="AppIndicator--label"><type>"label"</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> The current label. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-label-guide" role="function"> +<title>app_indicator_get_label_guide ()</title> +<indexterm zone="app-indicator-get-label-guide"><primary>app_indicator_get_label_guide</primary></indexterm> +<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_label_guide (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> +<para> +Wrapper function for property <link linkend="AppIndicator--label-guide"><type>"label-guide"</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> The current label guide. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="app-indicator-get-ordering-index" role="function"> +<title>app_indicator_get_ordering_index ()</title> +<indexterm zone="app-indicator-get-ordering-index"><primary>app_indicator_get_ordering_index</primary></indexterm> +<programlisting><link linkend="guint32"><returnvalue>guint32</returnvalue></link> app_indicator_get_ordering_index (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> +<para> +Wrapper function for property <link linkend="AppIndicator--ordering-index"><type>"ordering-index"</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> The current ordering index. +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> +<refsect1 id="libappindicator-app-indicator.property-details" role="property_details"> +<title role="property_details.title">Property Details</title> +<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 <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 '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, <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 / 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</programlisting> +<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> +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--label" role="property"><title>The <literal>"label"</literal> property</title> +<indexterm zone="AppIndicator--label"><primary>AppIndicator:label</primary></indexterm> +<programlisting> "label" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> +<para> +A label that can be shown next to the string in the application + indicator. The label will not be shown unless there is an icon + as well. The label is useful for numerical and other frequently + updated information. In general, it shouldn't be shown unless a + user requests it as it can take up a significant amount of space + on the user's panel. This may not be shown in all visualizations. +</para><para>Default value: NULL</para> +</refsect2> +<refsect2 id="AppIndicator--label-guide" role="property"><title>The <literal>"label-guide"</literal> property</title> +<indexterm zone="AppIndicator--label-guide"><primary>AppIndicator:label-guide</primary></indexterm> +<programlisting> "label-guide" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> +<para> +An optional string to provide guidance to the panel on how big + the <link linkend="AppIndicator--label"><type>"label"</type></link> string could get. If this is set correctly + then the panel should never 'jiggle' as the string adjusts through + out the range of options. For instance, if you were providing a + percentage like "54% thrust" in <link linkend="AppIndicator--label"><type>"label"</type></link> you'd want to + set this string to "100% thrust" to ensure space when Scotty can + get you enough power. +</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> +<refsect2 id="AppIndicator--ordering-index" role="property"><title>The <literal>"ordering-index"</literal> property</title> +<indexterm zone="AppIndicator--ordering-index"><primary>AppIndicator:ordering-index</primary></indexterm> +<programlisting> "ordering-index" <link linkend="guint"><type>guint</type></link> : Read / Write</programlisting> +<para> +The ordering index is an odd parameter, and if you think you don't need + it you're probably right. In general, the application indicator try + to place the applications in a recreatable place taking into account + which category they're in to try and group them. But, there are some + cases where you'd want to ensure indicators are next to each other. + To do that you can override the generated ordering index and replace it + with a new one. Again, you probably don't want to be doing this, but + in case you do, this is the way. +</para><para>Default value: 0</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 + 'Passive'. +</para><para>Default value: NULL</para> +</refsect2> +<refsect2 id="AppIndicator--x-ayatana-label" role="property"><title>The <literal>"x-ayatana-label"</literal> property</title> +<indexterm zone="AppIndicator--x-ayatana-label"><primary>AppIndicator:x-ayatana-label</primary></indexterm> +<programlisting> "x-ayatana-label" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> +<para> +Wrapper for <link linkend="AppIndicator--label"><type>"label"</type></link>. Please use that in all of your + code. +</para><para>Default value: NULL</para> +</refsect2> +<refsect2 id="AppIndicator--x-ayatana-label-guide" role="property"><title>The <literal>"x-ayatana-label-guide"</literal> property</title> +<indexterm zone="AppIndicator--x-ayatana-label-guide"><primary>AppIndicator:x-ayatana-label-guide</primary></indexterm> +<programlisting> "x-ayatana-label-guide" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> +<para> +Wrapper for <link linkend="AppIndicator--label-guide"><type>"label-guide"</type></link>. Please use that in all of your + code. +</para><para>Default value: NULL</para> +</refsect2> +<refsect2 id="AppIndicator--x-ayatana-ordering-index" role="property"><title>The <literal>"x-ayatana-ordering-index"</literal> property</title> +<indexterm zone="AppIndicator--x-ayatana-ordering-index"><primary>AppIndicator:x-ayatana-ordering-index</primary></indexterm> +<programlisting> "x-ayatana-ordering-index" <link linkend="guint"><type>guint</type></link> : Read / Write</programlisting> +<para> +A wrapper for <link linkend="AppIndicator--ordering-index"><type>"ordering-index"</type></link> so that it can match the + dbus interface currently. It will hopefully be retired, please don't + use it anywhere. +</para><para>Default value: 0</para> +</refsect2> + +</refsect1> +<refsect1 id="libappindicator-app-indicator.signal-details" role="signals"> +<title role="signals.title">Signal Details</title> +<refsect2 id="AppIndicator-connection-changed" role="signal"><title>The <literal>"connection-changed"</literal> signal</title> +<indexterm zone="AppIndicator-connection-changed"><primary>AppIndicator::connection-changed</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="AppIndicator"><type>AppIndicator</type></link> *arg0, + <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. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>Whether we're connected or not +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="AppIndicator-new-attention-icon" role="signal"><title>The <literal>"new-attention-icon"</literal> signal</title> +<indexterm zone="AppIndicator-new-attention-icon"><primary>AppIndicator::new-attention-icon</primary></indexterm> +<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> +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 +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="AppIndicator-new-icon" role="signal"><title>The <literal>"new-icon"</literal> signal</title> +<indexterm zone="AppIndicator-new-icon"><primary>AppIndicator::new-icon</primary></indexterm> +<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> +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 +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="AppIndicator-new-icon-theme-path" role="signal"><title>The <literal>"new-icon-theme-path"</literal> signal</title> +<indexterm zone="AppIndicator-new-icon-theme-path"><primary>AppIndicator::new-icon-theme-path</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="AppIndicator"><type>AppIndicator</type></link> *arg0, + <link linkend="gchar"><type>gchar</type></link> *arg1, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Signaled when there is a new icon set for the + object. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="AppIndicator-new-label" role="signal"><title>The <literal>"new-label"</literal> signal</title> +<indexterm zone="AppIndicator-new-label"><primary>AppIndicator::new-label</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="AppIndicator"><type>AppIndicator</type></link> *arg0, + <link linkend="gchar"><type>gchar</type></link> *arg1, + <link linkend="gchar"><type>gchar</type></link> *arg1, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Emitted when either <link linkend="AppIndicator--label"><type>"label"</type></link> or <link linkend="AppIndicator--label-guide"><type>"label-guide"</type></link> are + changed. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The string for the label +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The string for the guide +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="AppIndicator-new-status" role="signal"><title>The <literal>"new-status"</literal> signal</title> +<indexterm zone="AppIndicator-new-status"><primary>AppIndicator::new-status</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="AppIndicator"><type>AppIndicator</type></link> *arg0, + <link linkend="gchar"><type>gchar</type></link> *arg1, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +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 +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The string value of the <link linkend="AppIndicatorStatus"><type>AppIndicatorStatus</type></link> enum. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="AppIndicator-x-ayatana-new-label" role="signal"><title>The <literal>"x-ayatana-new-label"</literal> signal</title> +<indexterm zone="AppIndicator-x-ayatana-new-label"><primary>AppIndicator::x-ayatana-new-label</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="AppIndicator"><type>AppIndicator</type></link> *arg0, + <link linkend="gchar"><type>gchar</type></link> *arg1, + <link linkend="gchar"><type>gchar</type></link> *arg1, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Wrapper for <link linkend="AppIndicator-new-label"><type>"new-label"</type></link>, please don't use this signal + use the other one. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The string for the label +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The string for the guide +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2> +</refsect1> + +</refentry> |
