From c51ef797a707f4e2c6f9688d4378f2b0e9898a66 Mon Sep 17 00:00:00 2001 From: Perberos Date: Thu, 1 Dec 2011 22:56:10 -0300 Subject: moving from https://github.com/perberos/mate-desktop-environment --- doc/reference/Makefile.am | 3 + doc/reference/Makefile.in | 672 +++++++++++++++ doc/reference/mate-panel-applet/Makefile.am | 68 ++ doc/reference/mate-panel-applet/Makefile.in | 804 +++++++++++++++++ .../mate-panel-applet/html/applet-popups.html | 31 + .../mate-panel-applet/html/applet-porting.html | 207 +++++ .../mate-panel-applet/html/applet-writing.html | 93 ++ doc/reference/mate-panel-applet/html/home.png | Bin 0 -> 654 bytes doc/reference/mate-panel-applet/html/index.html | 64 ++ doc/reference/mate-panel-applet/html/index.sgml | 69 ++ doc/reference/mate-panel-applet/html/left.png | Bin 0 -> 459 bytes ...nel-applet-Panel-Applet-MateConf-Utilities.html | 655 ++++++++++++++ .../html/mate-panel-applet-mate-panel-applet.html | 948 +++++++++++++++++++++ .../html/mate-panel-applet.devhelp | 68 ++ .../html/mate-panel-applet.devhelp2 | 75 ++ .../mate-panel-applet/html/mate-panel-applet.html | 38 + .../mate-panel-applet/html/multi-applets.html | 31 + .../mate-panel-applet/html/panel-signals.html | 31 + doc/reference/mate-panel-applet/html/right.png | Bin 0 -> 472 bytes .../mate-panel-applet/html/server-files.html | 67 ++ .../mate-panel-applet/html/session-saving.html | 31 + doc/reference/mate-panel-applet/html/style.css | 265 ++++++ doc/reference/mate-panel-applet/html/up.png | Bin 0 -> 406 bytes .../mate-panel-applet/mate-panel-applet-docs.sgml | 385 +++++++++ .../mate-panel-applet-overrides.txt | 0 .../mate-panel-applet-sections.txt | 67 ++ .../mate-panel-applet/mate-panel-applet.types | 3 + .../tmpl/mate-panel-applet-mateconf.sgml | 263 ++++++ .../tmpl/mate-panel-applet-unused.sgml | 109 +++ .../mate-panel-applet/tmpl/mate-panel-applet.sgml | 393 +++++++++ 30 files changed, 5440 insertions(+) create mode 100644 doc/reference/Makefile.am create mode 100644 doc/reference/Makefile.in create mode 100644 doc/reference/mate-panel-applet/Makefile.am create mode 100644 doc/reference/mate-panel-applet/Makefile.in create mode 100644 doc/reference/mate-panel-applet/html/applet-popups.html create mode 100644 doc/reference/mate-panel-applet/html/applet-porting.html create mode 100644 doc/reference/mate-panel-applet/html/applet-writing.html create mode 100644 doc/reference/mate-panel-applet/html/home.png create mode 100644 doc/reference/mate-panel-applet/html/index.html create mode 100644 doc/reference/mate-panel-applet/html/index.sgml create mode 100644 doc/reference/mate-panel-applet/html/left.png create mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet-Panel-Applet-MateConf-Utilities.html create mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html create mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp create mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp2 create mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet.html create mode 100644 doc/reference/mate-panel-applet/html/multi-applets.html create mode 100644 doc/reference/mate-panel-applet/html/panel-signals.html create mode 100644 doc/reference/mate-panel-applet/html/right.png create mode 100644 doc/reference/mate-panel-applet/html/server-files.html create mode 100644 doc/reference/mate-panel-applet/html/session-saving.html create mode 100644 doc/reference/mate-panel-applet/html/style.css create mode 100644 doc/reference/mate-panel-applet/html/up.png create mode 100644 doc/reference/mate-panel-applet/mate-panel-applet-docs.sgml create mode 100644 doc/reference/mate-panel-applet/mate-panel-applet-overrides.txt create mode 100644 doc/reference/mate-panel-applet/mate-panel-applet-sections.txt create mode 100644 doc/reference/mate-panel-applet/mate-panel-applet.types create mode 100644 doc/reference/mate-panel-applet/tmpl/mate-panel-applet-mateconf.sgml create mode 100644 doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml create mode 100644 doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml (limited to 'doc/reference') diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am new file mode 100644 index 00000000..5f8c36bb --- /dev/null +++ b/doc/reference/Makefile.am @@ -0,0 +1,3 @@ +SUBDIRS = mate-panel-applet + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/Makefile.in b/doc/reference/Makefile.in new file mode 100644 index 00000000..71fda978 --- /dev/null +++ b/doc/reference/Makefile.in @@ -0,0 +1,672 @@ +# 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@ +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@ +subdir = doc/reference +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/d-type.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/ltoptions.m4 \ + $(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \ + $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/m4/mate-doc-utils.m4 $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +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 = +RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ + html-recursive info-recursive install-data-recursive \ + install-dvi-recursive install-exec-recursive \ + install-html-recursive install-info-recursive \ + install-pdf-recursive install-ps-recursive install-recursive \ + installcheck-recursive installdirs-recursive pdf-recursive \ + ps-recursive uninstall-recursive +RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ + distclean-recursive maintainer-clean-recursive +AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \ + $(RECURSIVE_CLEAN_TARGETS:-recursive=) tags TAGS ctags CTAGS \ + distdir +ETAGS = etags +CTAGS = ctags +DIST_SUBDIRS = $(SUBDIRS) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +am__relativize = \ + dir0=`pwd`; \ + sed_first='s,^\([^/]*\)/.*$$,\1,'; \ + sed_rest='s,^[^/]*/*,,'; \ + sed_last='s,^.*/\([^/]*\)$$,\1,'; \ + sed_butlast='s,/*[^/]*$$,,'; \ + while test -n "$$dir1"; do \ + first=`echo "$$dir1" | sed -e "$$sed_first"`; \ + if test "$$first" != "."; then \ + if test "$$first" = ".."; then \ + dir2=`echo "$$dir0" | sed -e "$$sed_last"`/"$$dir2"; \ + dir0=`echo "$$dir0" | sed -e "$$sed_butlast"`; \ + else \ + first2=`echo "$$dir2" | sed -e "$$sed_first"`; \ + if test "$$first2" = "$$first"; then \ + dir2=`echo "$$dir2" | sed -e "$$sed_rest"`; \ + else \ + dir2="../$$dir2"; \ + fi; \ + dir0="$$dir0"/"$$first"; \ + fi; \ + fi; \ + dir1=`echo "$$dir1" | sed -e "$$sed_rest"`; \ + done; \ + reldir="$$dir2" +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +ALL_LINGUAS = @ALL_LINGUAS@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AS = @AS@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CATALOGS = @CATALOGS@ +CATOBJEXT = @CATOBJEXT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CLOCK_CFLAGS = @CLOCK_CFLAGS@ +CLOCK_EDS_ICONDIR = @CLOCK_EDS_ICONDIR@ +CLOCK_LIBS = @CLOCK_LIBS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DATADIRNAME = @DATADIRNAME@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DISABLE_DEPRECATED = @DISABLE_DEPRECATED@ +DISABLE_DEPRECATED_CFLAGS = @DISABLE_DEPRECATED_CFLAGS@ +DISTCHECK_CONFIGURE_FLAGS = @DISTCHECK_CONFIGURE_FLAGS@ +DLLTOOL = @DLLTOOL@ +DOC_USER_FORMATS = @DOC_USER_FORMATS@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGG_SMCLIENT_CFLAGS = @EGG_SMCLIENT_CFLAGS@ +EGG_SMCLIENT_LIBS = @EGG_SMCLIENT_LIBS@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +FISH_CFLAGS = @FISH_CFLAGS@ +FISH_LIBS = @FISH_LIBS@ +GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ +GIO_QUERYMODULES = @GIO_QUERYMODULES@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GMOFILES = @GMOFILES@ +GMSGFMT = @GMSGFMT@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +HELP_DIR = @HELP_DIR@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INSTOBJEXT = @INSTOBJEXT@ +INTLLIBS = @INTLLIBS@ +INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ +INTLTOOL_MERGE = @INTLTOOL_MERGE@ +INTLTOOL_PERL = @INTLTOOL_PERL@ +INTLTOOL_UPDATE = @INTLTOOL_UPDATE@ +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@ +LIBMATE_PANEL_APPLET_CFLAGS = @LIBMATE_PANEL_APPLET_CFLAGS@ +LIBMATE_PANEL_APPLET_LIBS = @LIBMATE_PANEL_APPLET_LIBS@ +LIBMATE_PANEL_APPLET_MATECOMPONENT_CFLAGS = @LIBMATE_PANEL_APPLET_MATECOMPONENT_CFLAGS@ +LIBMATE_PANEL_APPLET_MATECOMPONENT_LIBS = @LIBMATE_PANEL_APPLET_MATECOMPONENT_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_MATE_PANEL_APPLET_LT_VERSION = @LIB_MATE_PANEL_APPLET_LT_VERSION@ +LIB_MATE_PANEL_APPLET_MATECOMPONENT_LT_VERSION = @LIB_MATE_PANEL_APPLET_MATECOMPONENT_LT_VERSION@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MATECOMPONENT_ACT_IDLDIR = @MATECOMPONENT_ACT_IDLDIR@ +MATECOMPONENT_CFLAGS = @MATECOMPONENT_CFLAGS@ +MATECOMPONENT_IDLDIR = @MATECOMPONENT_IDLDIR@ +MATECOMPONENT_LIBS = @MATECOMPONENT_LIBS@ +MATECONFTOOL = @MATECONFTOOL@ +MATECONF_SCHEMA_CONFIG_SOURCE = @MATECONF_SCHEMA_CONFIG_SOURCE@ +MATECONF_SCHEMA_FILE_DIR = @MATECONF_SCHEMA_FILE_DIR@ +MATECORBA_IDL = @MATECORBA_IDL@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGFMT_OPTS = @MSGFMT_OPTS@ +MSGMERGE = @MSGMERGE@ +NETWORK_MANAGER_CFLAGS = @NETWORK_MANAGER_CFLAGS@ +NETWORK_MANAGER_LIBS = @NETWORK_MANAGER_LIBS@ +NM = @NM@ +NMEDIT = @NMEDIT@ +NOTIFICATION_AREA_CFLAGS = @NOTIFICATION_AREA_CFLAGS@ +NOTIFICATION_AREA_LIBS = @NOTIFICATION_AREA_LIBS@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OMF_DIR = @OMF_DIR@ +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@ +PANEL_CFLAGS = @PANEL_CFLAGS@ +PANEL_INTLTOOL_MATE_PANEL_APPLET_RULE = @PANEL_INTLTOOL_MATE_PANEL_APPLET_RULE@ +PANEL_LIBS = @PANEL_LIBS@ +PANEL_MODULE_MATECOMPONENT_CFLAGS = @PANEL_MODULE_MATECOMPONENT_CFLAGS@ +PANEL_MODULE_MATECOMPONENT_LIBS = @PANEL_MODULE_MATECOMPONENT_LIBS@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +POFILES = @POFILES@ +POSUB = @POSUB@ +PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ +PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ +PYTHON = @PYTHON@ +PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@ +PYTHON_PLATFORM = @PYTHON_PLATFORM@ +PYTHON_PREFIX = @PYTHON_PREFIX@ +PYTHON_VERSION = @PYTHON_VERSION@ +RANLIB = @RANLIB@ +REBUILD = @REBUILD@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TZ_CFLAGS = @TZ_CFLAGS@ +TZ_LIBS = @TZ_LIBS@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +WARN_CFLAGS = @WARN_CFLAGS@ +WNCKLET_CFLAGS = @WNCKLET_CFLAGS@ +WNCKLET_LIBS = @WNCKLET_LIBS@ +XGETTEXT = @XGETTEXT@ +XMKMF = @XMKMF@ +XRANDR_CFLAGS = @XRANDR_CFLAGS@ +XRANDR_LIBS = @XRANDR_LIBS@ +X_CFLAGS = @X_CFLAGS@ +X_EXTRA_LIBS = @X_EXTRA_LIBS@ +X_LIBS = @X_LIBS@ +X_PRE_LIBS = @X_PRE_LIBS@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +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@ +appletsdir = @appletsdir@ +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@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +modulesdir = @modulesdir@ +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@ +SUBDIRS = mate-panel-applet +all: all-recursive + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(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 doc/reference/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/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): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs + +# This directory's subdirectories are mostly independent; you can cd +# into them and run `make' without going through this Makefile. +# To change the values of `make' variables: instead of editing Makefiles, +# (1) if the variable is set in `config.status', edit `config.status' +# (which will cause the Makefiles to be regenerated when you run `make'); +# (2) otherwise, pass the desired values on the `make' command line. +$(RECURSIVE_TARGETS): + @fail= failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ + fi; test -z "$$fail" + +$(RECURSIVE_CLEAN_TARGETS): + @fail= failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + rev=''; for subdir in $$list; do \ + if test "$$subdir" = "."; then :; else \ + rev="$$subdir $$rev"; \ + fi; \ + done; \ + rev="$$rev ."; \ + target=`echo $@ | sed s/-recursive//`; \ + for subdir in $$rev; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done && test -z "$$fail" +tags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \ + done +ctags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \ + done + +ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + mkid -fID $$unique +tags: TAGS + +TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + set x; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + set "$$@" "$$include_option=$$here/$$subdir/TAGS"; \ + fi; \ + done; \ + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$unique; \ + fi; \ + fi +ctags: CTAGS +CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags + +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 + @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ + fi; \ + done + @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ + $(am__relativize); \ + new_distdir=$$reldir; \ + dir1=$$subdir; dir2="$(top_distdir)"; \ + $(am__relativize); \ + new_top_distdir=$$reldir; \ + echo " (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) top_distdir="$$new_top_distdir" distdir="$$new_distdir" \\"; \ + echo " am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)"; \ + ($(am__cd) $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$new_top_distdir" \ + distdir="$$new_distdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + am__skip_mode_fix=: \ + distdir) \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-recursive +all-am: Makefile +installdirs: installdirs-recursive +installdirs-am: +install: install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-recursive +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: + +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) + +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-recursive + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-recursive + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-recursive + +dvi-am: + +html: html-recursive + +html-am: + +info: info-recursive + +info-am: + +install-data-am: + +install-dvi: install-dvi-recursive + +install-dvi-am: + +install-exec-am: + +install-html: install-html-recursive + +install-html-am: + +install-info: install-info-recursive + +install-info-am: + +install-man: + +install-pdf: install-pdf-recursive + +install-pdf-am: + +install-ps: install-ps-recursive + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-recursive + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-recursive + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-recursive + +pdf-am: + +ps: ps-recursive + +ps-am: + +uninstall-am: + +.MAKE: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) ctags-recursive \ + install-am install-strip tags-recursive + +.PHONY: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) CTAGS GTAGS \ + all all-am check check-am clean clean-generic clean-libtool \ + ctags ctags-recursive distclean distclean-generic \ + distclean-libtool distclean-tags distdir dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am 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 installdirs-am maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am tags tags-recursive \ + uninstall uninstall-am + + +-include $(top_srcdir)/git.mk + +# 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/doc/reference/mate-panel-applet/Makefile.am b/doc/reference/mate-panel-applet/Makefile.am new file mode 100644 index 00000000..2002b3d6 --- /dev/null +++ b/doc/reference/mate-panel-applet/Makefile.am @@ -0,0 +1,68 @@ +## Process this file with automake to produce Makefile.in + +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE=mate-panel-applet + +# The top-level SGML file. Change it if you want. +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 functions and macros. +DOC_SOURCE_DIR=../../../libmate-panel-applet + +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--output-format=xml + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= + +# Used for dependencies. +HFILE_GLOB=$(top_srcdir)/libmate-panel-applet/*.h +CFILE_GLOB=$(top_srcdir)/libmate-panel-applet/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES = \ + MATE_Panel.h \ + mate-panel-applet-enums.h \ + mate-panel-applet-marshal.h \ + mate-panel-applet-private.h \ + mate-panel-applet-shell.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +GTKDOC_CFLAGS = \ + $(CFLAGS) \ + $(CPPFLAGS) \ + $(PANEL_CFLAGS) \ + -I$(srcdir)/../../../libmate-panel-applet \ + -I$(top_builddir)/libmate-panel-applet + +GTKDOC_LIBS = \ + $(LDFLAGS) \ + $(PANEL_LIBS) \ + ../../../libmate-panel-applet/libmate-panel-applet-3.la + +include $(top_srcdir)/gtk-doc.make + +dist-hook-local: +# mkdir $(distdir)/TEXT; \ +# for f in $(srcdir)/TEXT/* ; do \ +# test -f $$f && cp -p $$f $(distdir)/TEXT; \ +# done + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/mate-panel-applet/Makefile.in b/doc/reference/mate-panel-applet/Makefile.in new file mode 100644 index 00000000..e65c93af --- /dev/null +++ b/doc/reference/mate-panel-applet/Makefile.in @@ -0,0 +1,804 @@ +# 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 \ + $(top_srcdir)/gtk-doc.make +subdir = doc/reference/mate-panel-applet +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/d-type.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/ltoptions.m4 \ + $(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \ + $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/m4/mate-doc-utils.m4 $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +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 = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +ALL_LINGUAS = @ALL_LINGUAS@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AS = @AS@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CATALOGS = @CATALOGS@ +CATOBJEXT = @CATOBJEXT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CLOCK_CFLAGS = @CLOCK_CFLAGS@ +CLOCK_EDS_ICONDIR = @CLOCK_EDS_ICONDIR@ +CLOCK_LIBS = @CLOCK_LIBS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DATADIRNAME = @DATADIRNAME@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DISABLE_DEPRECATED = @DISABLE_DEPRECATED@ +DISABLE_DEPRECATED_CFLAGS = @DISABLE_DEPRECATED_CFLAGS@ +DISTCHECK_CONFIGURE_FLAGS = @DISTCHECK_CONFIGURE_FLAGS@ +DLLTOOL = @DLLTOOL@ +DOC_USER_FORMATS = @DOC_USER_FORMATS@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGG_SMCLIENT_CFLAGS = @EGG_SMCLIENT_CFLAGS@ +EGG_SMCLIENT_LIBS = @EGG_SMCLIENT_LIBS@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +FISH_CFLAGS = @FISH_CFLAGS@ +FISH_LIBS = @FISH_LIBS@ +GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ +GIO_QUERYMODULES = @GIO_QUERYMODULES@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GMOFILES = @GMOFILES@ +GMSGFMT = @GMSGFMT@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +HELP_DIR = @HELP_DIR@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INSTOBJEXT = @INSTOBJEXT@ +INTLLIBS = @INTLLIBS@ +INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ +INTLTOOL_MERGE = @INTLTOOL_MERGE@ +INTLTOOL_PERL = @INTLTOOL_PERL@ +INTLTOOL_UPDATE = @INTLTOOL_UPDATE@ +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@ +LIBMATE_PANEL_APPLET_CFLAGS = @LIBMATE_PANEL_APPLET_CFLAGS@ +LIBMATE_PANEL_APPLET_LIBS = @LIBMATE_PANEL_APPLET_LIBS@ +LIBMATE_PANEL_APPLET_MATECOMPONENT_CFLAGS = @LIBMATE_PANEL_APPLET_MATECOMPONENT_CFLAGS@ +LIBMATE_PANEL_APPLET_MATECOMPONENT_LIBS = @LIBMATE_PANEL_APPLET_MATECOMPONENT_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_MATE_PANEL_APPLET_LT_VERSION = @LIB_MATE_PANEL_APPLET_LT_VERSION@ +LIB_MATE_PANEL_APPLET_MATECOMPONENT_LT_VERSION = @LIB_MATE_PANEL_APPLET_MATECOMPONENT_LT_VERSION@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MATECOMPONENT_ACT_IDLDIR = @MATECOMPONENT_ACT_IDLDIR@ +MATECOMPONENT_CFLAGS = @MATECOMPONENT_CFLAGS@ +MATECOMPONENT_IDLDIR = @MATECOMPONENT_IDLDIR@ +MATECOMPONENT_LIBS = @MATECOMPONENT_LIBS@ +MATECONFTOOL = @MATECONFTOOL@ +MATECONF_SCHEMA_CONFIG_SOURCE = @MATECONF_SCHEMA_CONFIG_SOURCE@ +MATECONF_SCHEMA_FILE_DIR = @MATECONF_SCHEMA_FILE_DIR@ +MATECORBA_IDL = @MATECORBA_IDL@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGFMT_OPTS = @MSGFMT_OPTS@ +MSGMERGE = @MSGMERGE@ +NETWORK_MANAGER_CFLAGS = @NETWORK_MANAGER_CFLAGS@ +NETWORK_MANAGER_LIBS = @NETWORK_MANAGER_LIBS@ +NM = @NM@ +NMEDIT = @NMEDIT@ +NOTIFICATION_AREA_CFLAGS = @NOTIFICATION_AREA_CFLAGS@ +NOTIFICATION_AREA_LIBS = @NOTIFICATION_AREA_LIBS@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OMF_DIR = @OMF_DIR@ +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@ +PANEL_CFLAGS = @PANEL_CFLAGS@ +PANEL_INTLTOOL_MATE_PANEL_APPLET_RULE = @PANEL_INTLTOOL_MATE_PANEL_APPLET_RULE@ +PANEL_LIBS = @PANEL_LIBS@ +PANEL_MODULE_MATECOMPONENT_CFLAGS = @PANEL_MODULE_MATECOMPONENT_CFLAGS@ +PANEL_MODULE_MATECOMPONENT_LIBS = @PANEL_MODULE_MATECOMPONENT_LIBS@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +POFILES = @POFILES@ +POSUB = @POSUB@ +PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ +PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ +PYTHON = @PYTHON@ +PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@ +PYTHON_PLATFORM = @PYTHON_PLATFORM@ +PYTHON_PREFIX = @PYTHON_PREFIX@ +PYTHON_VERSION = @PYTHON_VERSION@ +RANLIB = @RANLIB@ +REBUILD = @REBUILD@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TZ_CFLAGS = @TZ_CFLAGS@ +TZ_LIBS = @TZ_LIBS@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +WARN_CFLAGS = @WARN_CFLAGS@ +WNCKLET_CFLAGS = @WNCKLET_CFLAGS@ +WNCKLET_LIBS = @WNCKLET_LIBS@ +XGETTEXT = @XGETTEXT@ +XMKMF = @XMKMF@ +XRANDR_CFLAGS = @XRANDR_CFLAGS@ +XRANDR_LIBS = @XRANDR_LIBS@ +X_CFLAGS = @X_CFLAGS@ +X_EXTRA_LIBS = @X_EXTRA_LIBS@ +X_LIBS = @X_LIBS@ +X_PRE_LIBS = @X_PRE_LIBS@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +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@ +appletsdir = @appletsdir@ +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@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +modulesdir = @modulesdir@ +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@ +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE = mate-panel-applet + +# The top-level SGML file. Change it if you want. +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 functions and macros. +DOC_SOURCE_DIR = ../../../libmate-panel-applet + +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS = + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS = --output-format=xml + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS = + +# Used for dependencies. +HFILE_GLOB = $(top_srcdir)/libmate-panel-applet/*.h +CFILE_GLOB = $(top_srcdir)/libmate-panel-applet/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES = \ + MATE_Panel.h \ + mate-panel-applet-enums.h \ + mate-panel-applet-marshal.h \ + mate-panel-applet-private.h \ + mate-panel-applet-shell.h + + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +GTKDOC_CFLAGS = \ + $(CFLAGS) \ + $(CPPFLAGS) \ + $(PANEL_CFLAGS) \ + -I$(srcdir)/../../../libmate-panel-applet \ + -I$(top_builddir)/libmate-panel-applet + +GTKDOC_LIBS = \ + $(LDFLAGS) \ + $(PANEL_LIBS) \ + ../../../libmate-panel-applet/libmate-panel-applet-3.la + +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_RUN = +@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) +SETUP_FILES = \ + $(content_files) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + +EXTRA_DIST = \ + $(HTML_IMAGES) \ + $(SETUP_FILES) + +DOC_STAMPS = setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \ + html-build.stamp pdf-build.stamp \ + tmpl.stamp sgml.stamp html.stamp pdf.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) +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.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 doc/reference/mate-panel-applet/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/reference/mate-panel-applet/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): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +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 +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) + +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: install-am install-strip + +.PHONY: all all-am all-local check 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) $(PDF_BUILD_STAMP) +@ENABLE_GTK_DOC_FALSE@all-local: + +docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) + +$(REPORT_FILES): sgml-build.stamp + +#### setup #### + +setup-build.stamp: + -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + echo ' DOC Preparing build'; \ + files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ + if test "x$$files" != "x" ; then \ + for file in $$files ; do \ + test -f $(abs_srcdir)/$$file && \ + cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \ + done; \ + fi; \ + test -d $(abs_srcdir)/tmpl && \ + { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \ + chmod -R u+w $(abs_builddir)/tmpl; } \ + fi + @touch setup-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + @echo ' DOC Scanning header files' + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) + @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ + echo " DOC Introspecting gobjects"; \ + scanobj_options=""; \ + gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + scanobj_options="--verbose"; \ + fi; \ + fi; \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \ + gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \ + else \ + 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: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo ' DOC Rebuilding template files' + @gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + if test -w $(abs_srcdir) ; then \ + cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \ + fi \ + fi + @touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +$(srcdir)/tmpl/*.sgml: + @true + +#### xml #### + +sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) + @echo ' DOC Building XML' + @-chmod -R u+w $(srcdir) + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(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 ' DOC Building HTML' + @rm -rf html + @mkdir html + @mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkhtml_options="$$mkhtml_options --verbose"; \ + fi; \ + fi; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ + fi; \ + cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + -@test "x$(HTML_IMAGES)" = "x" || \ + for file in $(HTML_IMAGES) ; do \ + if test -f $(abs_srcdir)/$$file ; then \ + cp $(abs_srcdir)/$$file $(abs_builddir)/html; \ + fi; \ + if test -f $(abs_builddir)/$$file ; then \ + cp $(abs_builddir)/$$file $(abs_builddir)/html; \ + fi; \ + done; + @echo ' DOC Fixing cross-references' + @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + @touch html-build.stamp + +#### pdf #### + +pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building PDF' + @rm -f $(DOC_MODULE).pdf + @mkpdf_options=""; \ + gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkpdf_options="$$mkpdf_options --verbose"; \ + fi; \ + fi; \ + if test "x$(HTML_IMAGES)" != "x"; then \ + for img in $(HTML_IMAGES); do \ + part=`dirname $$img`; \ + echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \ + if test $$? != 0; then \ + mkpdf_options="$$mkpdf_options --imgdir=$$part"; \ + fi; \ + done; \ + fi; \ + gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) + @touch pdf-build.stamp + +############## + +clean-local: + @rm -f *~ *.bak + @rm -rf .libs + +distclean-local: + @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \ + $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \ + rm -rf tmpl; \ + fi + +maintainer-clean-local: clean + @rm -rf xml html + +install-data-local: + @installfiles=`echo $(builddir)/html/*`; \ + if test "$$installfiles" = '$(builddir)/html/*'; \ + then echo 1>&2 '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 ' $(INSTALL_DATA) '$$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; \ + fi; \ + $(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)/html + @-cp ./tmpl/*.sgml $(distdir)/tmpl + @cp ./html/* $(distdir)/html + @-cp ./$(DOC_MODULE).pdf $(distdir)/ + @-cp ./$(DOC_MODULE).types $(distdir)/ + @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/ + @cd $(distdir) && rm -f $(DISTCLEANFILES) + @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html + +.PHONY : dist-hook-local docs + +dist-hook-local: +# mkdir $(distdir)/TEXT; \ +# for f in $(srcdir)/TEXT/* ; do \ +# test -f $$f && cp -p $$f $(distdir)/TEXT; \ +# done + +-include $(top_srcdir)/git.mk + +# 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/doc/reference/mate-panel-applet/html/applet-popups.html b/doc/reference/mate-panel-applet/html/applet-popups.html new file mode 100644 index 00000000..a2002d8c --- /dev/null +++ b/doc/reference/mate-panel-applet/html/applet-popups.html @@ -0,0 +1,31 @@ + + + + +Defining a Popup Context Menu + + + + + + + + + + + + + + + + +
+

+Defining a Popup Context Menu

+

FIXME: write

+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/applet-porting.html b/doc/reference/mate-panel-applet/html/applet-porting.html new file mode 100644 index 00000000..64c3169f --- /dev/null +++ b/doc/reference/mate-panel-applet/html/applet-porting.html @@ -0,0 +1,207 @@ + + + + +Porting Applets from the MATE 1.x interfaces + + + + + + + + + + + + + + + + +
+

+Porting Applets from the MATE 1.x interfaces

+

In MATE 1.x the applet interface lived in a header called +applet-widget.h. The interface was based on GOAD, +the MATE 1.x object activation framework. A new interface was +designed for MATE 2.x using the power of matecomponent UI embedding and the +new object activation framework, matecomponent-activation. The interface is +intended to be easy to use, cruft free, but semantically similar to +the old API in order to make porting relatively painless.

+
+

+Applet Activation

+

The first thing to change when porting to the new API is +the header. Include mate-panel-applet.h instead of +applet-widget.h.

+

Next you need to change how the applet is activated. +Browsing through old applet's code, its obvious that this was done in +various ways in the past. The best advice is to hunt out the calls to +applet_widget_init, applet_widget_new and applet_widget_add. +applet_widget_new and applet_widget_add are now effectively merged +into one call mate_panel_applet_new, to which the top-level widget of the +applet should be passed. applet_widget_init is not neccessary anymore. +So the new code should look something like this

+
+#include <mate-panel-applet.h>
+
+static MateComponentObject *
+blah_applet_new ()
+{
+        MatePanelApplet *applet;
+
+	/*
+	 * The old code setting up the applet widgetry
+	 * goes here. So effectively delete calls to
+	 * applet_widget_init and applet_widget_new
+	 * and the replace applet_widget_add with a call
+	 * to mate_panel_applet_new.
+	 */
+
+        applet = mate_panel_applet_new (label);
+
+        return MATECOMPONENT_OBJECT (mate_panel_applet_get_control (applet));
+}
+
+static MateComponentObject *
+blah_applet_factory (MateComponentGenericFactory *this,
+		     const gchar          *iid,
+		     gpointer              data)
+{
+        MateComponentObject *applet = NULL;
+
+        if (!strcmp (iid, "OAFIID:BlahApplet"))
+                applet = blah_applet_new ();
+
+        return applet;
+}
+
+
+MATE_PANEL_APPLET_MATECOMPONENT_FACTORY ("OAFIID:BlahApplet_Factory",
+                             "Blah",
+                             "0",
+                             blah_applet_factory,
+                             NULL)
+
+

You should use MATE_PANEL_APPLET_MATECOMPONENT_FACTORY or +MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY depending on whether you want the +applet to be out of process or in process.

+
+
+

+Activation files

+

The next thing to do may be to port from a +.gnorba file to a matecomponent-activation +.server file. You no longer need a .desktop file +for applets. A .gnorba looks something like this +:

+
+[blah]
+type=exe
+repo_id=IDL:MATE/Applet:1.0
+description=Blah
+location_info=blah-de-blah
+
+

Your .server file should look like +this :

+
+<oaf_info>
+
+<oaf_server iid="OAFIID:BlahApplet"
+            type="exe"
+            location="blah-de-blah-2">
+
+        <oaf_attribute name="repo_ids" type="stringv">
+                <item value="IDL:MateComponent/GenericFactory:1.0""/>
+                <item value="IDL:MateComponent/Unknown:1.0"/>
+        </oaf_attribute>
+        <oaf_attribute name="name" type="string" value="Blah Factory"/>
+        <oaf_attribute name="description" type="string" value="Blah De Blah"/>
+
+</oaf_server>
+
+<oaf_server iid="OAFIID:BlahApplet"
+            type="factory"
+            location="OAFIID:BlahApplet_Factory">
+
+        <oaf_attribute name="repo_ids" type="stringv">
+                <item value="IDL:MATE/MatePanelAppletShell:1.0"/>
+                <item value="IDL:MateComponent/Control:1.0"/>
+                <item value="IDL:MateComponent/Unknown:1.0"/>
+        </oaf_attribute>
+        <oaf_attribute name="name" type="string" value="Blah Applet"/>
+        <oaf_attribute name="description" type="string" value="Blah De Blah"/>
+        <oaf_attribute name="panel:icon" type="string" value="blah-de-blah.png"/>
+
+</oaf_server>
+
+</oaf_info>
+
+

A lot of this should be copied and pasted. The most +important bit is "panel:icon" which specfies the icon +that should be displayed in the "Add to Panel" dialog.

+
+
+

+Context Menu

+

Most applets also place extra menu items into it context +menu. It might be a good idea to port this next. In MATE 1.x this was +done using the applet_widget_register_stock_callback API call. In +MATE 2.x 3 things must be done

+
    +

  • An xml desription of the popup menu must be +written.

    • +

  • A description of the verbs must be prepared. +This is basically a list of callbacks to be call when a certain menu +item is clicked in the popup.

    • +

  • The menu is registered using a call to +mate_panel_applet_setup_menu.

    • +
+

The xml description should look something like this +:

+
+static const char fish_menu_xml [] =
+        "<popup name=\"button3\">\n"
+        "   <menuitem name=\"Properties Item\" verb=\"BlahProperties\" _label=\"Properties ...\"\n"
+        "             pixtype=\"stock\" pixname=\"gtk-properties\"/>\n"
+        "   <menuitem name=\"Help Item\" verb=\"BlahHelp\" _label=\"Help\"\n"
+        "             pixtype=\"stock\" pixname=\"gtk-help\"/>\n"
+        "   <menuitem name=\"About Item\" verb=\"BlahAbout\" _label=\"About ...\"\n"
+        "             pixtype=\"stock\" pixname=\"mate-stock-about\"/>\n"
+        "</popup>\n";
+
+

This could also be in a seperate +.xml file and loaded with +mate_panel_applet_setup_menu_from_file. The description of the verbs should +look something like :

+
+static const MateComponentUIVerb fish_menu_verbs [] = {
+        MATECOMPONENT_UI_VERB ("BlahProperties", display_properties_dialog),
+        MATECOMPONENT_UI_VERB ("BlahHelp",       display_help_dialog),
+        MATECOMPONENT_UI_VERB ("BlahAbout",      display_about_dialog),
+
+        MATECOMPONENT_UI_VERB_END
+};
+
+

This is just a list of callbacks invoked when the menu +items are clicked. There are other macros you may use other than +MATECOMPONENT_UI_VERB - see +matecomponent-ui-component.h.

+

To actually register the menu you just do something like +:

+
+	mate_panel_applet_setup_menu (MATE_PANEL_APPLET (blah->applet),
+                                 blah_menu_xml,
+                                 blah_menu_verbs,
+                                 blah);
+
+

The last argument is the user_data argument passed back +to the callbacks.

+
+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/applet-writing.html b/doc/reference/mate-panel-applet/html/applet-writing.html new file mode 100644 index 00000000..a56a125d --- /dev/null +++ b/doc/reference/mate-panel-applet/html/applet-writing.html @@ -0,0 +1,93 @@ + + + + +Writing Applets + + + + + + + + + + + + + + + + +
+

+Writing Applets

+
+
Hello World Applet
+
MateComponent Activation .server Files For Applets
+
Defining a Popup Context Menu
+
Detecting Changes in the Panel.
+
Session/Preference Saving.
+
Multiple Applets
+
+

Writing applets is very simple. You take some boiler plate +code like below, change a couple of things and write the code that +implements your widgetry. The hardest part is writing your widgetry - +and its completely up to yourself how hard that should be. +

+
+

+Hello World Applet

+

As usual, following the pointless tradition of starting with +an example of how get 'Hello World' on the screen in some form, here's +just about the simplest applet you could write. +

+
+#include <string.h>
+
+#include <mate-panel-applet.h>
+#include <gtk/gtklabel.h>
+
+static gboolean
+hello_applet_fill (MatePanelApplet *applet,
+		   const gchar *iid,
+		   gpointer     data)
+{
+        GtkWidget *label;
+
+        if (strcmp (iid, "OAFIID:My_HelloApplet") != 0)
+		return FALSE;
+
+        label = gtk_label_new ("Hello World");
+	gtk_container_add (GTK_CONTAINER (applet), label);
+
+	gtk_widget_show_all (GTK_WIDGET (applet));
+
+        return TRUE;
+}
+
+
+MATE_PANEL_APPLET_MATECOMPONENT_FACTORY ("OAFIID:My_HelloApplet_Factory",
+                             PANEL_TYPE_APPLET,
+                             "TheHelloWorldApplet",
+                             "0",
+                             hello_applet_fill,
+                             NULL);
+
+

The code here is very similar to writing a normal MateComponent +control. You define a factory using MATE_PANEL_APPLET_MATECOMPONENT_FACTORY(), +passing it a factory function like hello_applet_fill(). +

+

libmate-panel-applet automatically creates a #MatePanelApplet object +for you, passing this to your factory method. Here, you should fill +the applet with your widgets just like a #GtkBin. For example, if you +were writing a cdplayer applet you would create a #GtkHBox, pack the +hbox with the cdplayer buttons and in turn add the hbox to the applet. +

+
+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/home.png b/doc/reference/mate-panel-applet/html/home.png new file mode 100644 index 00000000..17003611 Binary files /dev/null and b/doc/reference/mate-panel-applet/html/home.png differ diff --git a/doc/reference/mate-panel-applet/html/index.html b/doc/reference/mate-panel-applet/html/index.html new file mode 100644 index 00000000..e3290d87 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/index.html @@ -0,0 +1,64 @@ + + + + +Panel Applet Library Reference Manual + + + + + + + + +
+
+
+
+
+

+Mark McLoughlin +

+


+            
+          

+
+

Copyright © 2001, 2003 Sun Microsystems, Inc.

+
+

Abstract

+

+This manual documents the interfaces of the panel applet +library for MATE 2.x and a short guide to porting applets from +the MATE 1.x interfaces. +

+
+
+
+
+
+
Writing Applets
+
+
Hello World Applet
+
MateComponent Activation .server Files For Applets
+
Defining a Popup Context Menu
+
Detecting Changes in the Panel.
+
Session/Preference Saving.
+
Multiple Applets
+
+
Porting Applets from the MATE 1.x interfaces
+
The Panel Applet Library
+
+
+MatePanelApplet — The MatePanelApplet object. +
+
+Panel Applet MateConf Utilities — Utility methods for manipulating per-applet MateConf preferences. +
+
+
+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/index.sgml b/doc/reference/mate-panel-applet/html/index.sgml new file mode 100644 index 00000000..19974235 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/index.sgml @@ -0,0 +1,69 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/reference/mate-panel-applet/html/left.png b/doc/reference/mate-panel-applet/html/left.png new file mode 100644 index 00000000..2d05b3d5 Binary files /dev/null and b/doc/reference/mate-panel-applet/html/left.png differ diff --git a/doc/reference/mate-panel-applet/html/mate-panel-applet-Panel-Applet-MateConf-Utilities.html b/doc/reference/mate-panel-applet/html/mate-panel-applet-Panel-Applet-MateConf-Utilities.html new file mode 100644 index 00000000..ed0de262 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/mate-panel-applet-Panel-Applet-MateConf-Utilities.html @@ -0,0 +1,655 @@ + + + + +Panel Applet MateConf Utilities + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

Panel Applet MateConf Utilities

+

Panel Applet MateConf Utilities — Utility methods for manipulating per-applet MateConf preferences.

+
+
+

Synopsis

+
+#include <mate-panel-applet-mateconf.h>
+
+gchar *             mate_panel_applet_mateconf_get_full_key     (MatePanelApplet *applet,
+                                                         const gchar *key);
+gboolean            mate_panel_applet_mateconf_get_bool         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+gint                mate_panel_applet_mateconf_get_int          (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+gchar *             mate_panel_applet_mateconf_get_string       (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+gdouble             mate_panel_applet_mateconf_get_float        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+GSList *            mate_panel_applet_mateconf_get_list         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         MateConfValueType list_type,
+                                                         GError **opt_error);
+MateConfValue *        mate_panel_applet_mateconf_get_value        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+void                mate_panel_applet_mateconf_set_bool         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         gboolean the_bool,
+                                                         GError **opt_error);
+void                mate_panel_applet_mateconf_set_int          (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         gint the_int,
+                                                         GError **opt_error);
+void                mate_panel_applet_mateconf_set_string       (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         const gchar *the_string,
+                                                         GError **opt_error);
+void                mate_panel_applet_mateconf_set_float        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         gdouble the_float,
+                                                         GError **opt_error);
+void                mate_panel_applet_mateconf_set_list         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         MateConfValueType list_type,
+                                                         GSList *list,
+                                                         GError **opt_error);
+void                mate_panel_applet_mateconf_set_value        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         MateConfValue *value,
+                                                         GError **opt_error);
+
+
+
+

Description

+

+Applets typically define a set of preferences using a schemas +file and mate_panel_applet_add_preferences(). Such preferences apply +only to an individual applet instance. For example, you may add +two clock applets to the panel and configure them differently. +

+

+In order for the preferences to only apply to a single applet, +each applet must have a seperate MateConf key for each of these +preferences. The methods described below provide convient wrappers +around the usual MateConfClient functions and operate on these +per-applet keys. +

+
+
+

Details

+
+

mate_panel_applet_mateconf_get_full_key ()

+
gchar *             mate_panel_applet_mateconf_get_full_key     (MatePanelApplet *applet,
+                                                         const gchar *key);
+

+Access the full path for an individual per-applet MateConf key. Using +the returned path you may directly modify the preference using +the usual MateConf functions without using any of the convenience +wrappers described below. +

+
++ + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

Returns :

The full MateConf key - free using g_free(). +
+
+
+
+

mate_panel_applet_mateconf_get_bool ()

+
gboolean            mate_panel_applet_mateconf_get_bool         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_get_bool() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_get_bool() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

opt_error :

Optional GError**. +

Returns :

The bool value of the key. +
+
+
+
+

mate_panel_applet_mateconf_get_int ()

+
gint                mate_panel_applet_mateconf_get_int          (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_get_int() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_get_int() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

opt_error :

Optional GError**. +

Returns :

The integer value of the key. +
+
+
+
+

mate_panel_applet_mateconf_get_string ()

+
gchar *             mate_panel_applet_mateconf_get_string       (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_get_string() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_get_string() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

opt_error :

Optional GError**. +

Returns :

The string value of the key, or NULL if unset. +
+
+
+
+

mate_panel_applet_mateconf_get_float ()

+
gdouble             mate_panel_applet_mateconf_get_float        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_get_float() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_get_float() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

opt_error :

Optional GError**. +

Returns :

The floating point value of the key. +
+
+
+
+

mate_panel_applet_mateconf_get_list ()

+
GSList *            mate_panel_applet_mateconf_get_list         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         MateConfValueType list_type,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_get_list() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_get_list() +returns. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

list_type :

The MateConf value type of the list elements. +

opt_error :

Optional GError**. +

Returns :

The list of values set for the key. +
+
+
+
+

mate_panel_applet_mateconf_get_value ()

+
MateConfValue *        mate_panel_applet_mateconf_get_value        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_get_value() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_get_value() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

opt_error :

Optional GError**. +

Returns :

The MateConf value set for the key. +
+
+
+
+

mate_panel_applet_mateconf_set_bool ()

+
void                mate_panel_applet_mateconf_set_bool         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         gboolean the_bool,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_set_bool() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_set_bool() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

the_bool :

The boolean value to set the key with. +

opt_error :

Optional GError**. +
+
+
+
+

mate_panel_applet_mateconf_set_int ()

+
void                mate_panel_applet_mateconf_set_int          (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         gint the_int,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_set_int() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_set_int() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

the_int :

The integer value to set the key with. +

opt_error :

Optional GError**. +
+
+
+
+

mate_panel_applet_mateconf_set_string ()

+
void                mate_panel_applet_mateconf_set_string       (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         const gchar *the_string,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_set_string() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_set_string() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

the_string :

The string value to set the key with. +

opt_error :

Optional GError**. +
+
+
+
+

mate_panel_applet_mateconf_set_float ()

+
void                mate_panel_applet_mateconf_set_float        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         gdouble the_float,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_set_float() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_set_float() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

the_float :

The floating point value to set the key with. +

opt_error :

Optional GError**. +
+
+
+
+

mate_panel_applet_mateconf_set_list ()

+
void                mate_panel_applet_mateconf_set_list         (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         MateConfValueType list_type,
+                                                         GSList *list,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_set_list() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_set_list() +returns. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

list_type :

The MateConf value type of the list items. +

list :

The list of values to set the key with. +

opt_error :

Optional GError**. +
+
+
+
+

mate_panel_applet_mateconf_set_value ()

+
void                mate_panel_applet_mateconf_set_value        (MatePanelApplet *applet,
+                                                         const gchar *key,
+                                                         MateConfValue *value,
+                                                         GError **opt_error);
+

+Convience wrapper for mateconf_client_set_value() which operates +on the individual per-applet key. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which mateconf_client_set_value() +returns. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

key :

The key name of the preference. +

value :

The MateConf value to set the key with. +

opt_error :

Optional GError**. +
+
+
+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html b/doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html new file mode 100644 index 00000000..4086c6ad --- /dev/null +++ b/doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html @@ -0,0 +1,948 @@ + + + + +MatePanelApplet + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatePanelApplet

+

MatePanelApplet — The MatePanelApplet object.

+
+
+

Synopsis

+
+#include <mate-panel-applet.h>
+
+struct              MatePanelApplet;
+enum                MatePanelAppletOrient;
+enum                MatePanelAppletBackgroundType;
+enum                MatePanelAppletFlags;
+gboolean            (*MatePanelAppletFactoryCallback)       (MatePanelApplet *applet,
+                                                         const gchar *iid,
+                                                         gpointer user_data);
+GtkWidget *         mate_panel_applet_new                    (void);
+MatePanelAppletOrient   mate_panel_applet_get_orient             (MatePanelApplet *applet);
+guint               mate_panel_applet_get_size               (MatePanelApplet *applet);
+MatePanelAppletBackgroundType  mate_panel_applet_get_background  (MatePanelApplet *applet,
+                                                         GdkColor *color,
+                                                         GdkPixmap **pixmap);
+gchar *             mate_panel_applet_get_preferences_key    (MatePanelApplet *applet);
+void                mate_panel_applet_add_preferences        (MatePanelApplet *applet,
+                                                         const gchar *schema_dir,
+                                                         GError **opt_error);
+MatePanelAppletFlags    mate_panel_applet_get_flags              (MatePanelApplet *applet);
+void                mate_panel_applet_set_flags              (MatePanelApplet *applet,
+                                                         MatePanelAppletFlags flags);
+void                mate_panel_applet_set_size_hints         (MatePanelApplet *applet,
+                                                         const int *size_hints,
+                                                         int n_elements,
+                                                         int base_size);
+gboolean            mate_panel_applet_get_locked_down        (MatePanelApplet *applet);
+void                mate_panel_applet_request_focus          (MatePanelApplet *applet,
+                                                         guint32 timestamp);
+void                mate_panel_applet_setup_menu             (MatePanelApplet *applet,
+                                                         const gchar *xml,
+                                                         GtkActionGroup *action_group);
+void                mate_panel_applet_setup_menu_from_file   (MatePanelApplet *applet,
+                                                         const gchar *filename,
+                                                         GtkActionGroup *action_group);
+int                 mate_panel_applet_factory_main           (const gchar *factory_id,
+                                                         gboolean out_process,
+                                                         GType applet_type,
+                                                         MatePanelAppletFactoryCallback callback,
+                                                         gpointer data);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----GInitiallyUnowned
+         +----GtkObject
+               +----GtkWidget
+                     +----GtkContainer
+                           +----GtkBin
+                                 +----GtkEventBox
+                                       +----MatePanelApplet
+
+
+
+

Implemented Interfaces

+

+MatePanelApplet implements + AtkImplementorIface and GtkBuildable.

+
+
+

Properties

+
+  "background"               gchar*                : Read / Write
+  "closure"                  gpointer              : Read / Write / Construct Only
+  "connection"               GDBusConnection*      : Read / Write / Construct Only
+  "flags"                    guint                 : Read / Write
+  "id"                       gchar*                : Read / Write / Construct Only
+  "locked"                   gboolean              : Read / Write
+  "locked-down"              gboolean              : Read / Write
+  "orient"                   guint                 : Read / Write
+  "prefs-key"                gchar*                : Read / Write
+  "size"                     guint                 : Read / Write
+  "size-hints"               gpointer              : Read / Write
+
+
+
+

Signals

+
+  "change-background"                              : Run Last
+  "change-orient"                                  : Run Last
+  "change-size"                                    : Run Last
+  "move-focus-out-of-applet"                       : Action
+
+
+
+

Description

+

+The MatePanelApplet object is an object which encapsulates an applet. It +is a GtkContainer which may contain a single widget. This widget, in +turn, should contain all widgets exposed by the applet. +

+

+A MatePanelApplet is associated with a MateComponentControl. The control makes +the cross process UI emmbedding required by applets possible. +

+
+
+

Details

+
+

struct MatePanelApplet

+
struct MatePanelApplet;
+

+The MatePanelApplet struct contains private data only. +

+
+
+
+

enum MatePanelAppletOrient

+
typedef enum {
+	MATE_PANEL_APPLET_ORIENT_UP,
+	MATE_PANEL_APPLET_ORIENT_DOWN,
+	MATE_PANEL_APPLET_ORIENT_LEFT,
+	MATE_PANEL_APPLET_ORIENT_RIGHT
+} MatePanelAppletOrient;
+
+

+The MatePanelAppletOrient type specifies the orientation of the applet. The +values may seem backward (e.g. MATE_PANEL_APPLET_ORIENT_LEFT means the panel +is on the right hand side), but this is because the value is representative +of the applet's orientation, not the panel's position. +

+
+
+
+

enum MatePanelAppletBackgroundType

+
typedef enum {
+	PANEL_NO_BACKGROUND,
+	PANEL_COLOR_BACKGROUND,
+	PANEL_PIXMAP_BACKGROUND
+} MatePanelAppletBackgroundType;
+
+

+The MatePanelAppletBackgroundType enumerated type specifies the type of +background of a panel. +

+
++ + + + + + + + + + + + + + +

PANEL_NO_BACKGROUND

The panel has no background, the default is used. +

PANEL_COLOR_BACKGROUND

The panel has a color, i.e rgb value, +background. +

PANEL_PIXMAP_BACKGROUND

 The panel has either an image background +or is translucent. +
+
+
+
+

enum MatePanelAppletFlags

+
typedef enum {
+	MATE_PANEL_APPLET_FLAGS_NONE   = 0,
+	MATE_PANEL_APPLET_EXPAND_MAJOR = 1 << 0,
+	MATE_PANEL_APPLET_EXPAND_MINOR = 1 << 1,
+	MATE_PANEL_APPLET_HAS_HANDLE   = 1 << 2
+} MatePanelAppletFlags;
+
+

+The MatePanelAppletFlags associated with the applet are boolean flags which +the panel may read in order to figure out how to handle the applet. +

+
++ + + + + + + + + + + + + + + + + + +

MATE_PANEL_APPLET_FLAGS_NONE

No flags are to be associated with the applet. +

MATE_PANEL_APPLET_EXPAND_MAJOR

The applet should expand horizontally on an +horizontal panel and vertically on a vertical panel - e.g. the behaviour +of the Window List applet. +

MATE_PANEL_APPLET_EXPAND_MINOR

The applet should expand vertically on an +horizontal panel and horizontally on a vertical panel. Most applets should +set this flag in order to utilise the full panel width and allow the applet +to be Fitt's Law compliant. +

MATE_PANEL_APPLET_HAS_HANDLE

The panel should draw a grab handle around the +applet - e.g. the Window List and Notification Area applets both set this +flag. +
+
+
+
+

MatePanelAppletFactoryCallback ()

+
gboolean            (*MatePanelAppletFactoryCallback)       (MatePanelApplet *applet,
+                                                         const gchar *iid,
+                                                         gpointer user_data);
+

+This callback is invoked when the applet is loaded onto the panel. Typically +the callback will check that iid matches and fill the applet with the +widgets which make up the applet. +

+

+Prior to the callback being invoked the MatePanelApplet (or an instance of the +sub-class specified by the GType passed to the factory macros) is instantiated +and initialized. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

iid :

The MateComponent IID of the applet requested. +

user_data :

The data passed to the factory macros. +

Returns :

 +TRUE on success, FALSE on failure. +
+
+
+
+

mate_panel_applet_new ()

+
GtkWidget *         mate_panel_applet_new                    (void);
+

+Creates a new MatePanelApplet. This function is typically not +useful as the applet is created before the MatePanelAppletFactoryCallback +is invoked. +

+
++ + + + +

Returns :

The MatePanelApplet. +
+
+
+
+

mate_panel_applet_get_orient ()

+
MatePanelAppletOrient   mate_panel_applet_get_orient             (MatePanelApplet *applet);
+

+Get the current orientation of the applet. +

+
++ + + + + + + + + + +

applet :

The MatePanelApplet. +

Returns :

The orientation of the applet. +
+
+
+
+

mate_panel_applet_get_size ()

+
guint               mate_panel_applet_get_size               (MatePanelApplet *applet);
+

+Get the current size hint for the panel. The size hint is +not useful for most applets. +

+

+Note: The return value is not an integer value +specifying the pixel size of the panel. Do not +use this value to calculate the size of the applet. Use it +only as a hint by which to decide the applet's layout. +

+
++ + + + + + + + + + +

applet :

The MatePanelApplet. +

Returns :

The panel's size hint. +
+
+
+
+

mate_panel_applet_get_background ()

+
MatePanelAppletBackgroundType  mate_panel_applet_get_background  (MatePanelApplet *applet,
+                                                         GdkColor *color,
+                                                         GdkPixmap **pixmap);
+

+Returns the current background type. If the background +type is PANEL_NO_BACKGROUND both color and pixmap will +be unaffected. If the background type is PANEL_COLOR_BACKGROUND +then color will contain the current panel background colour. +If the background type is PANEL_PIXMAP_BACKGROUND, pixmap will +contain a pointer to a GdkPixmap which is a copy of the applet's +portion of the panel's background pixmap. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

A MatePanelApplet. +

color :

A GdkColor to be filled in. +

pixmap :

Returned GdkPixmap. +

Returns :

The background type. +
+
+
+
+

mate_panel_applet_get_preferences_key ()

+
gchar *             mate_panel_applet_get_preferences_key    (MatePanelApplet *applet);
+

+Returns the MateConf path to the directory containing the applet's +per-instance preference keys. Using this you may construct the +full path for the applet's preference keys. See +Panel Applet MateConf Utilities(3) for +more information. +

+
++ + + + + + + + + + +

applet :

The MatePanelApplet. +

Returns :

A MateConf path. +
+
+
+
+

mate_panel_applet_add_preferences ()

+
void                mate_panel_applet_add_preferences        (MatePanelApplet *applet,
+                                                         const gchar *schema_dir,
+                                                         GError **opt_error);
+

+Associates each schema in schema_dir with a key in the applet's +preferences directory (i.e. the directory returned by +mate_panel_applet_get_preferences_key()). Each applet preference +should have an associated schema to ensure that the key has +a defined type, sane default and documentation. +

+

+If you pass NULL for opt_error, this function will print +a warning message from any GError which MateConf may return. +

+
++ + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

schema_dir :

The MateConf path where the applet's schemas are installed +e.g. /schemas/apps/my_applet +

opt_error :

Optional GError. +
+
+
+
+

mate_panel_applet_get_flags ()

+
MatePanelAppletFlags    mate_panel_applet_get_flags              (MatePanelApplet *applet);
+

+Retrieve the MatePanelAppletFlags associated with the applet. +

+
++ + + + + + + + + + +

applet :

The MatePanelApplet. +

Returns :

The MatePanelAppletFlags. +
+
+
+
+

mate_panel_applet_set_flags ()

+
void                mate_panel_applet_set_flags              (MatePanelApplet *applet,
+                                                         MatePanelAppletFlags flags);
+

+Set the MatePanelAppletFlags associated with the applet. See +MatePanelAppletFlags for more details on the possible uses of +these flags. +

+
++ + + + + + + + + + +

applet :

The MatePanelApplet. +

flags :

The MatePanelAppletFlags to associate. +
+
+
+
+

mate_panel_applet_set_size_hints ()

+
void                mate_panel_applet_set_size_hints         (MatePanelApplet *applet,
+                                                         const int *size_hints,
+                                                         int n_elements,
+                                                         int base_size);
+

+Set a list of desired size ranges for an applet with the +MATE_PANEL_APPLET_EXPAND_MAJOR flags set. size_hints is an +array of (max, min) pairs where min(i) > max(i + 1). +

+

+The panel will endeavour to allocate the applet a size +in one of the (base + max, base + min) ranges. +

+
++ + + + + + + + + + + + + + + + + + +

applet :

The MatePanelApplet. +

size_hints :

Array of size_hints. +

n_elements :

Number of elements in the array. +Not the number of pairs. +

base_size :

The base size of the applet. +
+
+
+
+

mate_panel_applet_get_locked_down ()

+
gboolean            mate_panel_applet_get_locked_down        (MatePanelApplet *applet);
+

+Check if the applet is locked down. A locked down applet should not allow any change to its configuration. +

+
++ + + + + + + + + + +

applet :

The MatePanelApplet. +

Returns :

 +TRUE if the applet is locked down, FALSE otherwise. +
+
+
+
+

mate_panel_applet_request_focus ()

+
void                mate_panel_applet_request_focus          (MatePanelApplet *applet,
+                                                         guint32 timestamp);
+

+Set keyboard focus to applet. +

+
++ + + + + + + + + + +

applet :

The MatePanelApplet. +

timestamp :

timestamp of the event triggering the window focus +
+
+
+
+

mate_panel_applet_setup_menu ()

+
void                mate_panel_applet_setup_menu             (MatePanelApplet *applet,
+                                                         const gchar *xml,
+                                                         GtkActionGroup *action_group);
+

+Sets up a popup menu for applet described by the xml +string, xml. See Writing Applets section +for a description of the format of the xml. +

+
++ + + + + + + + + + + + + + +

applet :

A MatePanelApplet. +

xml :

The xml character string describing the popup menu. +

action_group :

 +
+
+
+
+

mate_panel_applet_setup_menu_from_file ()

+
void                mate_panel_applet_setup_menu_from_file   (MatePanelApplet *applet,
+                                                         const gchar *filename,
+                                                         GtkActionGroup *action_group);
+

+Sets up a popup menu for applet described by the xml +file, file. See Writing Applets for a description of +the format of the xml. +

+
++ + + + + + + + + + + + + + +

applet :

A MatePanelApplet. +

filename :

 +

action_group :

 +
+
+
+
+

mate_panel_applet_factory_main ()

+
int                 mate_panel_applet_factory_main           (const gchar *factory_id,
+                                                         gboolean out_process,
+                                                         GType applet_type,
+                                                         MatePanelAppletFactoryCallback callback,
+                                                         gpointer data);
+

+A generic 'main' routine for applets. This should not normally be +used directly because it is invoked by MATE_PANEL_APPLET_MATECOMPONENT_FACTORY. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + +

factory_id :

 +

out_process :

 +

applet_type :

The GType to instantiate. +

callback :

The factory callback. +

data :

The factory user data pointer. +

Returns :

0 on success, 1 on failure. +
+
+
+
+

Property Details

+
+

The "background" property

+
  "background"               gchar*                : Read / Write
+

Panel Applet Background.

+

Default value: NULL

+
+
+
+

The "closure" property

+
  "closure"                  gpointer              : Read / Write / Construct Only
+

The Applet closure.

+
+
+
+

The "connection" property

+
  "connection"               GDBusConnection*      : Read / Write / Construct Only
+

The DBus Connection.

+
+
+
+

The "flags" property

+
  "flags"                    guint                 : Read / Write
+

Panel Applet flags.

+

Default value: 0

+
+
+
+

The "id" property

+
  "id"                       gchar*                : Read / Write / Construct Only
+

The Applet identifier.

+

Default value: NULL

+
+
+
+

The "locked" property

+
  "locked"                   gboolean              : Read / Write
+

Whether Panel Applet is locked.

+

Default value: FALSE

+
+
+
+

The "locked-down" property

+
  "locked-down"              gboolean              : Read / Write
+

Whether Panel Applet is locked down.

+

Default value: FALSE

+
+
+
+

The "orient" property

+
  "orient"                   guint                 : Read / Write
+

Panel Applet Orientation.

+

Default value: 0

+
+
+
+

The "prefs-key" property

+
  "prefs-key"                gchar*                : Read / Write
+

MateConf Preferences Key.

+

Default value: NULL

+
+
+
+

The "size" property

+
  "size"                     guint                 : Read / Write
+

Panel Applet Size.

+

Default value: 0

+
+
+
+

The "size-hints" property

+
  "size-hints"               gpointer              : Read / Write
+

Panel Applet Size Hints.

+
+
+
+

Signal Details

+
+

The "change-background" signal

+
void                user_function                      (MatePanelApplet              *matepanelapplet,
+                                                        MatePanelAppletBackgroundType arg1,
+                                                        GdkColor                 *arg2,
+                                                        GdkPixmap                *arg3,
+                                                        gpointer                  user_data)        : Run Last
+

+Emitted when the background of the panel changes. Use type to +determine which, if any, of color and pimxap is valid. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

matepanelapplet :

The object which received the signal. +

arg1 :

 +

arg2 :

 +

arg3 :

 +

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "change-orient" signal

+
void                user_function                      (MatePanelApplet *matepanelapplet,
+                                                        guint        arg1,
+                                                        gpointer     user_data)        : Run Last
+

+Emitted when the orientation of the panel changes. +

+
++ + + + + + + + + + + + + + +

matepanelapplet :

The object which received the signal. +

orient :

The new MatePanelAppletOrient of the applet. +

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "change-size" signal

+
void                user_function                      (MatePanelApplet *matepanelapplet,
+                                                        gint         arg1,
+                                                        gpointer     user_data)        : Run Last
+

+Emitted when the size of the panel changes. +

+

+Note: this is different for size negotiation which is handled by +size_request() and size_allocate() as usual. This signal should +be used to determine what font size or widget layout to use +depending on the size of the panel. See mate_panel_applet_get_size(). +

+
++ + + + + + + + + + + + + + +

matepanelapplet :

The object which received the signal. +

size :

The size hint of the panel. +

user_data :

user data set when the signal handler was connected.
+
+
+
+

The "move-focus-out-of-applet" signal

+
void                user_function                      (MatePanelApplet     *matepanelapplet,
+                                                        GtkDirectionType arg1,
+                                                        gpointer         user_data)        : Action
+

+Emitted when the applet has lost focus. This signal is used internally and is not meant to be used by applets themselves. +

+
++ + + + + + + + + + + + + + +

matepanelapplet :

The object which received the signal. +

direction :

The direction of focus movement. +

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp b/doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp new file mode 100644 index 00000000..317f43b4 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp2 b/doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp2 new file mode 100644 index 00000000..9b00aec5 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp2 @@ -0,0 +1,75 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/reference/mate-panel-applet/html/mate-panel-applet.html b/doc/reference/mate-panel-applet/html/mate-panel-applet.html new file mode 100644 index 00000000..d332a83d --- /dev/null +++ b/doc/reference/mate-panel-applet/html/mate-panel-applet.html @@ -0,0 +1,38 @@ + + + + +The Panel Applet Library + + + + + + + + + + + + + + + + +
+

+The Panel Applet Library

+
+
+MatePanelApplet — The MatePanelApplet object. +
+
+Panel Applet MateConf Utilities — Utility methods for manipulating per-applet MateConf preferences. +
+
+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/multi-applets.html b/doc/reference/mate-panel-applet/html/multi-applets.html new file mode 100644 index 00000000..6d0a6121 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/multi-applets.html @@ -0,0 +1,31 @@ + + + + +Multiple Applets + + + + + + + + + + + + + + + + +
+

+Multiple Applets

+

FIXME: write

+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/panel-signals.html b/doc/reference/mate-panel-applet/html/panel-signals.html new file mode 100644 index 00000000..3332c2b4 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/panel-signals.html @@ -0,0 +1,31 @@ + + + + +Detecting Changes in the Panel. + + + + + + + + + + + + + + + + +
+

+Detecting Changes in the Panel.

+

FIXME: write

+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/right.png b/doc/reference/mate-panel-applet/html/right.png new file mode 100644 index 00000000..92832e3a Binary files /dev/null and b/doc/reference/mate-panel-applet/html/right.png differ diff --git a/doc/reference/mate-panel-applet/html/server-files.html b/doc/reference/mate-panel-applet/html/server-files.html new file mode 100644 index 00000000..fb3b353e --- /dev/null +++ b/doc/reference/mate-panel-applet/html/server-files.html @@ -0,0 +1,67 @@ + + + + +MateComponent Activation .server Files For Applets + + + + + + + + + + + + + + + + +
+

+MateComponent Activation .server Files For Applets

+

Since an applet is a matecomponent component, you must write +a .server file so that the matecomponent activation daemon is aware that +your component exists and how to activate it. Copy and paste is +your friend here ... +

+
+<oaf_info>
+<oaf_server iid="OAFIID:My_HelloApplet_Factory" type="exe"
+            location="test-matecomponent-applet">
+
+        <oaf_attribute name="repo_ids" type="stringv">
+                <item value="IDL:MateComponent/GenericFactory:1.0"/>
+                <item value="IDL:MateComponent/Unknown:1.0"/>
+        </oaf_attribute>
+        <oaf_attribute name="name" type="string" value="Hello World Applet Factory"/>
+        <oaf_attribute name="description" type="string" value="My first applet factory"/>
+</oaf_server>
+
+<oaf_server iid="OAFIID:My_HelloApplet" type="factory"
+            location="OAFIID:My_HelloApplet_Factory">
+
+        <oaf_attribute name="repo_ids" type="stringv">
+                <item value="IDL:MATE/Vertigo/MatePanelAppletShell:1.0"/>
+                <item value="IDL:MateComponent/Control:1.0"/>
+                <item value="IDL:MateComponent/Unknown:1.0"/>
+        </oaf_attribute>
+        <oaf_attribute name="name" type="string" value="Hello World Applet"/>
+        <oaf_attribute name="description" type="string" value="My first applet for the MATE2 panel"/>
+        <oaf_attribute name="panel:icon" type="string" value="mate-applets.png"/>
+</oaf_server>
+</oaf_info>
+
+

Probably the most important thing to note here is that, unlike +.server files for other matecomponent components, applet .server files contain +a special attribute called 'panel:icon'. This is used by the panel to display +an entry for the applet in the 'Add to Panel' dialog. +

+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/session-saving.html b/doc/reference/mate-panel-applet/html/session-saving.html new file mode 100644 index 00000000..5ba77463 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/session-saving.html @@ -0,0 +1,31 @@ + + + + +Session/Preference Saving. + + + + + + + + + + + + + + + + +
+

+Session/Preference Saving.

+

FIXME: write

+
+
+
+ Generated by GTK-Doc V1.15.1
+ + \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/style.css b/doc/reference/mate-panel-applet/html/style.css new file mode 100644 index 00000000..d544a2c2 --- /dev/null +++ b/doc/reference/mate-panel-applet/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/doc/reference/mate-panel-applet/html/up.png b/doc/reference/mate-panel-applet/html/up.png new file mode 100644 index 00000000..85b3e2a2 Binary files /dev/null and b/doc/reference/mate-panel-applet/html/up.png differ diff --git a/doc/reference/mate-panel-applet/mate-panel-applet-docs.sgml b/doc/reference/mate-panel-applet/mate-panel-applet-docs.sgml new file mode 100644 index 00000000..3ada0d9e --- /dev/null +++ b/doc/reference/mate-panel-applet/mate-panel-applet-docs.sgml @@ -0,0 +1,385 @@ + + + +]> + + + + Panel Applet Library Reference Manual + + + Mark + McLoughlin + +
+ mark@skynet.ie +
+ + + + + + 2001 + 2003 + Sun Microsystems, Inc. + + + + +This manual documents the interfaces of the panel applet +library for MATE 2.x and a short guide to porting applets from +the MATE 1.x interfaces. + + + + + + + Writing Applets + + Writing applets is very simple. You take some boiler plate +code like below, change a couple of things and write the code that +implements your widgetry. The hardest part is writing your widgetry - +and its completely up to yourself how hard that should be. + + + + Hello World Applet + + As usual, following the pointless tradition of starting with +an example of how get 'Hello World' on the screen in some form, here's +just about the simplest applet you could write. + + + +#include <string.h> + +#include <mate-panel-applet.h> +#include <gtk/gtklabel.h> + +static gboolean +hello_applet_fill (MatePanelApplet *applet, + const gchar *iid, + gpointer data) +{ + GtkWidget *label; + + if (strcmp (iid, "OAFIID:My_HelloApplet") != 0) + return FALSE; + + label = gtk_label_new ("Hello World"); + gtk_container_add (GTK_CONTAINER (applet), label); + + gtk_widget_show_all (GTK_WIDGET (applet)); + + return TRUE; +} + + +MATE_PANEL_APPLET_MATECOMPONENT_FACTORY ("OAFIID:My_HelloApplet_Factory", + PANEL_TYPE_APPLET, + "TheHelloWorldApplet", + "0", + hello_applet_fill, + NULL); + + + The code here is very similar to writing a normal MateComponent +control. You define a factory using MATE_PANEL_APPLET_MATECOMPONENT_FACTORY(), +passing it a factory function like hello_applet_fill(). + + + libmate-panel-applet automatically creates a #MatePanelApplet object +for you, passing this to your factory method. Here, you should fill +the applet with your widgets just like a #GtkBin. For example, if you +were writing a cdplayer applet you would create a #GtkHBox, pack the +hbox with the cdplayer buttons and in turn add the hbox to the applet. + + + + + + MateComponent Activation .server Files For Applets + + Since an applet is a matecomponent component, you must write +a .server file so that the matecomponent activation daemon is aware that +your component exists and how to activate it. Copy and paste is +your friend here ... + + + +<oaf_info> +<oaf_server iid="OAFIID:My_HelloApplet_Factory" type="exe" + location="test-matecomponent-applet"> + + <oaf_attribute name="repo_ids" type="stringv"> + <item value="IDL:MateComponent/GenericFactory:1.0"/> + <item value="IDL:MateComponent/Unknown:1.0"/> + </oaf_attribute> + <oaf_attribute name="name" type="string" value="Hello World Applet Factory"/> + <oaf_attribute name="description" type="string" value="My first applet factory"/> +</oaf_server> + +<oaf_server iid="OAFIID:My_HelloApplet" type="factory" + location="OAFIID:My_HelloApplet_Factory"> + + <oaf_attribute name="repo_ids" type="stringv"> + <item value="IDL:MATE/Vertigo/MatePanelAppletShell:1.0"/> + <item value="IDL:MateComponent/Control:1.0"/> + <item value="IDL:MateComponent/Unknown:1.0"/> + </oaf_attribute> + <oaf_attribute name="name" type="string" value="Hello World Applet"/> + <oaf_attribute name="description" type="string" value="My first applet for the MATE2 panel"/> + <oaf_attribute name="panel:icon" type="string" value="mate-applets.png"/> +</oaf_server> +</oaf_info> + + + Probably the most important thing to note here is that, unlike +.server files for other matecomponent components, applet .server files contain +a special attribute called 'panel:icon'. This is used by the panel to display +an entry for the applet in the 'Add to Panel' dialog. + + + + + Defining a Popup Context Menu + + FIXME: write + + + + Detecting Changes in the Panel. + + FIXME: write + + + + Session/Preference Saving. + + FIXME: write + + + + Multiple Applets + + FIXME: write + + + + + + Porting Applets from the MATE 1.x interfaces + + In MATE 1.x the applet interface lived in a header called +applet-widget.h. The interface was based on GOAD, +the MATE 1.x object activation framework. A new interface was +designed for MATE 2.x using the power of matecomponent UI embedding and the +new object activation framework, matecomponent-activation. The interface is +intended to be easy to use, cruft free, but semantically similar to +the old API in order to make porting relatively painless. + + + Applet Activation + + The first thing to change when porting to the new API is +the header. Include mate-panel-applet.h instead of +applet-widget.h. + + Next you need to change how the applet is activated. +Browsing through old applet's code, its obvious that this was done in +various ways in the past. The best advice is to hunt out the calls to +applet_widget_init, applet_widget_new and applet_widget_add. +applet_widget_new and applet_widget_add are now effectively merged +into one call mate_panel_applet_new, to which the top-level widget of the +applet should be passed. applet_widget_init is not neccessary anymore. +So the new code should look something like this + + +#include <mate-panel-applet.h> + +static MateComponentObject * +blah_applet_new () +{ + MatePanelApplet *applet; + + /* + * The old code setting up the applet widgetry + * goes here. So effectively delete calls to + * applet_widget_init and applet_widget_new + * and the replace applet_widget_add with a call + * to mate_panel_applet_new. + */ + + applet = mate_panel_applet_new (label); + + return MATECOMPONENT_OBJECT (mate_panel_applet_get_control (applet)); +} + +static MateComponentObject * +blah_applet_factory (MateComponentGenericFactory *this, + const gchar *iid, + gpointer data) +{ + MateComponentObject *applet = NULL; + + if (!strcmp (iid, "OAFIID:BlahApplet")) + applet = blah_applet_new (); + + return applet; +} + + +MATE_PANEL_APPLET_MATECOMPONENT_FACTORY ("OAFIID:BlahApplet_Factory", + "Blah", + "0", + blah_applet_factory, + NULL) + + + You should use MATE_PANEL_APPLET_MATECOMPONENT_FACTORY or +MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY depending on whether you want the +applet to be out of process or in process. + + + + + Activation files + + The next thing to do may be to port from a +.gnorba file to a matecomponent-activation +.server file. You no longer need a .desktop file +for applets. A .gnorba looks something like this +: + + +[blah] +type=exe +repo_id=IDL:MATE/Applet:1.0 +description=Blah +location_info=blah-de-blah + + + Your .server file should look like +this : + + +<oaf_info> + +<oaf_server iid="OAFIID:BlahApplet" + type="exe" + location="blah-de-blah-2"> + + <oaf_attribute name="repo_ids" type="stringv"> + <item value="IDL:MateComponent/GenericFactory:1.0""/> + <item value="IDL:MateComponent/Unknown:1.0"/> + </oaf_attribute> + <oaf_attribute name="name" type="string" value="Blah Factory"/> + <oaf_attribute name="description" type="string" value="Blah De Blah"/> + +</oaf_server> + +<oaf_server iid="OAFIID:BlahApplet" + type="factory" + location="OAFIID:BlahApplet_Factory"> + + <oaf_attribute name="repo_ids" type="stringv"> + <item value="IDL:MATE/MatePanelAppletShell:1.0"/> + <item value="IDL:MateComponent/Control:1.0"/> + <item value="IDL:MateComponent/Unknown:1.0"/> + </oaf_attribute> + <oaf_attribute name="name" type="string" value="Blah Applet"/> + <oaf_attribute name="description" type="string" value="Blah De Blah"/> + <oaf_attribute name="panel:icon" type="string" value="blah-de-blah.png"/> + +</oaf_server> + +</oaf_info> + + + A lot of this should be copied and pasted. The most +important bit is "panel:icon" which specfies the icon +that should be displayed in the "Add to Panel" dialog. + + + + + Context Menu + + Most applets also place extra menu items into it context +menu. It might be a good idea to port this next. In MATE 1.x this was +done using the applet_widget_register_stock_callback API call. In +MATE 2.x 3 things must be done + + + An xml desription of the popup menu must be +written. + A description of the verbs must be prepared. +This is basically a list of callbacks to be call when a certain menu +item is clicked in the popup. + The menu is registered using a call to +mate_panel_applet_setup_menu. + + + The xml description should look something like this +: + + +static const char fish_menu_xml [] = + "<popup name=\"button3\">\n" + " <menuitem name=\"Properties Item\" verb=\"BlahProperties\" _label=\"Properties ...\"\n" + " pixtype=\"stock\" pixname=\"gtk-properties\"/>\n" + " <menuitem name=\"Help Item\" verb=\"BlahHelp\" _label=\"Help\"\n" + " pixtype=\"stock\" pixname=\"gtk-help\"/>\n" + " <menuitem name=\"About Item\" verb=\"BlahAbout\" _label=\"About ...\"\n" + " pixtype=\"stock\" pixname=\"mate-stock-about\"/>\n" + "</popup>\n"; + + + This could also be in a seperate +.xml file and loaded with +mate_panel_applet_setup_menu_from_file. The description of the verbs should +look something like : + + +static const MateComponentUIVerb fish_menu_verbs [] = { + MATECOMPONENT_UI_VERB ("BlahProperties", display_properties_dialog), + MATECOMPONENT_UI_VERB ("BlahHelp", display_help_dialog), + MATECOMPONENT_UI_VERB ("BlahAbout", display_about_dialog), + + MATECOMPONENT_UI_VERB_END +}; + + + This is just a list of callbacks invoked when the menu +items are clicked. There are other macros you may use other than +MATECOMPONENT_UI_VERB - see +matecomponent-ui-component.h. + + To actually register the menu you just do something like +: + + + mate_panel_applet_setup_menu (MATE_PANEL_APPLET (blah->applet), + blah_menu_xml, + blah_menu_verbs, + blah); + + + The last argument is the user_data argument passed back +to the callbacks. + + + + + + + The Panel Applet Library + + &MatePanelApplet; + &MatePanelAppletMateConf; + + + diff --git a/doc/reference/mate-panel-applet/mate-panel-applet-overrides.txt b/doc/reference/mate-panel-applet/mate-panel-applet-overrides.txt new file mode 100644 index 00000000..e69de29b diff --git a/doc/reference/mate-panel-applet/mate-panel-applet-sections.txt b/doc/reference/mate-panel-applet/mate-panel-applet-sections.txt new file mode 100644 index 00000000..5493db24 --- /dev/null +++ b/doc/reference/mate-panel-applet/mate-panel-applet-sections.txt @@ -0,0 +1,67 @@ +mate-panel-applet.h + +
+mate-panel-applet +MatePanelApplet +MatePanelAppletOrient +MATE_PANEL_APPLET_ORIENT_UP +MATE_PANEL_APPLET_ORIENT_DOWN +MATE_PANEL_APPLET_ORIENT_LEFT +MATE_PANEL_APPLET_ORIENT_RIGHT +MatePanelAppletBackgroundType +MatePanelAppletFlags +MatePanelAppletFactoryCallback +MatePanelApplet +mate_panel_applet_new +mate_panel_applet_get_orient +mate_panel_applet_get_size +mate_panel_applet_get_background +mate_panel_applet_get_preferences_key +mate_panel_applet_add_preferences +mate_panel_applet_get_flags +mate_panel_applet_set_flags +mate_panel_applet_set_size_hints +mate_panel_applet_get_locked_down +mate_panel_applet_request_focus +mate_panel_applet_get_control +mate_panel_applet_get_popup_component +mate_panel_applet_setup_menu +mate_panel_applet_setup_menu_from_file +mate_panel_applet_factory_main +mate_panel_applet_factory_main_closure +MATE_PANEL_APPLET_MATECOMPONENT_FACTORY +mate_panel_applet_shlib_factory +mate_panel_applet_shlib_factory_closure +MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY + +MATE_PANEL_APPLET +PANEL_IS_APPLET +PANEL_TYPE_APPLET +mate_panel_applet_get_type +MATE_PANEL_APPLET_CLASS +PANEL_IS_APPLET_CLASS +MATE_PANEL_APPLET_GET_CLASS + +MatePanelAppletClass +MatePanelAppletPrivate +
+ +mate-panel-applet-mateconf.h + +
+mate-panel-applet-mateconf +Panel Applet MateConf Utilities +mate_panel_applet_mateconf_get_full_key +mate_panel_applet_mateconf_get_bool +mate_panel_applet_mateconf_get_int +mate_panel_applet_mateconf_get_string +mate_panel_applet_mateconf_get_float +mate_panel_applet_mateconf_get_list +mate_panel_applet_mateconf_get_value +mate_panel_applet_mateconf_set_bool +mate_panel_applet_mateconf_set_int +mate_panel_applet_mateconf_set_string +mate_panel_applet_mateconf_set_float +mate_panel_applet_mateconf_set_list +mate_panel_applet_mateconf_set_value +
diff --git a/doc/reference/mate-panel-applet/mate-panel-applet.types b/doc/reference/mate-panel-applet/mate-panel-applet.types new file mode 100644 index 00000000..64dbeac4 --- /dev/null +++ b/doc/reference/mate-panel-applet/mate-panel-applet.types @@ -0,0 +1,3 @@ +#include + +mate_panel_applet_get_type diff --git a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-mateconf.sgml b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-mateconf.sgml new file mode 100644 index 00000000..2ff1e459 --- /dev/null +++ b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-mateconf.sgml @@ -0,0 +1,263 @@ + +Panel Applet MateConf Utilities + + +Utility methods for manipulating per-applet MateConf preferences. + + + +Applets typically define a set of preferences using a schemas +file and mate_panel_applet_add_preferences(). Such preferences apply +only to an individual applet instance. For example, you may add +two clock applets to the panel and configure them differently. + + + +In order for the preferences to only apply to a single applet, +each applet must have a seperate MateConf key for each of these +preferences. The methods described below provide convient wrappers +around the usual #MateConfClient functions and operate on these +per-applet keys. + + + + + + + + + + + + + + +Access the full path for an individual per-applet MateConf key. Using +the returned path you may directly modify the preference using +the usual MateConf functions without using any of the convenience +wrappers described below. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@Returns: The full MateConf key - free using g_free(). + + + + +Convience wrapper for mateconf_client_get_bool() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_bool() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The bool value of the key. + + + + +Convience wrapper for mateconf_client_get_int() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_int() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The integer value of the key. + + + + +Convience wrapper for mateconf_client_get_string() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_string() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The string value of the key, or %NULL if unset. + + + + +Convience wrapper for mateconf_client_get_float() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_float() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The floating point value of the key. + + + + +Convience wrapper for mateconf_client_get_list() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_list() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@list_type: The MateConf value type of the list elements. +@opt_error: Optional #GError**. +@Returns: The list of values set for the key. + + + + +Convience wrapper for mateconf_client_get_value() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_value() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The MateConf value set for the key. + + + + +Convience wrapper for mateconf_client_set_bool() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_bool() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@the_bool: The boolean value to set the key with. +@opt_error: Optional #GError**. + + + + +Convience wrapper for mateconf_client_set_int() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_int() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@the_int: The integer value to set the key with. +@opt_error: Optional #GError**. + + + + +Convience wrapper for mateconf_client_set_string() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_string() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@the_string: The string value to set the key with. +@opt_error: Optional #GError**. + + + + +Convience wrapper for mateconf_client_set_float() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_float() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@the_float: The floating point value to set the key with. +@opt_error: Optional #GError**. + + + + +Convience wrapper for mateconf_client_set_list() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_list() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@list_type: The MateConf value type of the list items. +@list: The list of values to set the key with. +@opt_error: Optional #GError**. + + + + +Convience wrapper for mateconf_client_set_value() which operates +on the individual per-applet key. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_value() +returns. + + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@value: The MateConf value to set the key with. +@opt_error: Optional #GError**. + + diff --git a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml new file mode 100644 index 00000000..f184f7f2 --- /dev/null +++ b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml @@ -0,0 +1,109 @@ + + +Defines a 'main' routine for the applet factory. + + +@iid: The matecomponent-activation iid of the factory. +@type: The #GType to instantiate. +@name: The applet ID string. +@version: The applet version string. +@callback: The factory callback. +@data: The factory user data pointer. + + + +Defines a MateComponent Activation shared library plugin and associated +factory callback. + + +@iid: The matecomponent-activation iid of the factory. +@type: The #GType to instantiate. +@descr: A description of the applet. +@callback: The factory callback. +@data: The factory user data pointer. + + + +The applet is orientated down (i.e. the panel is at the top of the screen). + + + + + +The applet is orientated left (i.e. the panel is at the right hand side of the screen). + + + + + +The applet is orientated right (i.e. the panel is at the left hand side of the screen). + + + + + +The applet is orientated up (i.e. the panel is at the bottom of the screen). + + + + + +A generic 'main' routine for applets. This should not normally be +used directly because it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_FACTORY. + + +@iid: The matecomponent-activation iid of the factory. +@applet_type: The #GType to instantiate. +@closure: The factory callback closure. +@Returns: 0 on success, 1 on failure. + + + +Retrieves the #MateComponentControl associated with @applet. + + +@applet: The #MatePanelApplet. +@Returns: A #MateComponentControl. + + + +Retrieves the #MateComponentUIComponent used for popup menus associated +with @applet. + + +@applet: The #MatePanelApplet. +@Returns: A #MateComponentUIComponent. + + + +A generic shared library factory routine for applets. This should not +normally be used directly as it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY. + + +@iid: The matecomponent-activation iid of the factory. +@applet_type: The #GType to instantiate. +@poa: The #PortableServer_POA passed to the shlib factory +callback. +@impl_ptr: The #gpointer passed to the shlib factory callback. +@callback: The applet factory callback. +@user_data: The factory user data pointer. +@ev: The $CORBA_Environment passed to the shlib factory callback. +@Returns: A #MateComponent_Unknown to return from the shlib factory +callback. + + + +A generic shared library factory routine for applets. This should not +normally be used directly as it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY. + + +@iid: The matecomponent-activation iid of the factory. +@applet_type: The #GType to instantiate. +@poa: The #PortableServer_POA passed to the shlib factory +callback. +@impl_ptr: The #gpointer passed to the shlib factory callback. +@closure: The applet factory closure. +@ev: The $CORBA_Environment passed to the shlib factory callback. +@Returns: A #MateComponent_Unknown to return from the shlib factory +callback. + diff --git a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml new file mode 100644 index 00000000..01d72e2d --- /dev/null +++ b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml @@ -0,0 +1,393 @@ + +MatePanelApplet + + +The MatePanelApplet object. + + + +The #MatePanelApplet object is an object which encapsulates an applet. It +is a #GtkContainer which may contain a single widget. This widget, in +turn, should contain all widgets exposed by the applet. + + + +A #MatePanelApplet is associated with a #MateComponentControl. The control makes +the cross process UI emmbedding required by applets possible. + + + + + + + + + + + + + + + +The #MatePanelApplet struct contains private data only. + + + + + +Emitted when the background of the panel changes. Use @type to +determine which, if any, of @color and @pimxap is valid. + + +@matepanelapplet: The object which received the signal. +@arg1: +@arg2: +@arg3: + +@type: The #MatePanelAppletBackgroundType. +@color: The #GdkColor if @type is #PANEL_COLOR_BACKGROUND. +@pixmap: The pixmap file name if @type is #PANEL_PIXMAP_BACKGROUND + + + +Emitted when the orientation of the panel changes. + + +@matepanelapplet: The object which received the signal. +@orient: The new #MatePanelAppletOrient of the applet. + + + +Emitted when the size of the panel changes. + + + +Note: this is different for size negotiation which is handled by +size_request() and size_allocate() as usual. This signal should +be used to determine what font size or widget layout to use +depending on the size of the panel. See mate_panel_applet_get_size(). + + +@matepanelapplet: The object which received the signal. +@size: The size hint of the panel. + + + +Emitted when the applet has lost focus. This signal is used internally and is not meant to be used by applets themselves. + + +@matepanelapplet: The object which received the signal. +@direction: The direction of focus movement. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +The #MatePanelAppletOrient type specifies the orientation of the applet. The +values may seem backward (e.g. %MATE_PANEL_APPLET_ORIENT_LEFT means the panel +is on the right hand side), but this is because the value is representative +of the applet's orientation, not the panel's position. + + +@MATE_PANEL_APPLET_ORIENT_UP: +@MATE_PANEL_APPLET_ORIENT_DOWN: +@MATE_PANEL_APPLET_ORIENT_LEFT: +@MATE_PANEL_APPLET_ORIENT_RIGHT: + + + +The #MatePanelAppletBackgroundType enumerated type specifies the type of +background of a panel. + + +@PANEL_NO_BACKGROUND: The panel has no background, the default is used. +@PANEL_COLOR_BACKGROUND: The panel has a color, i.e rgb value, +background. +@PANEL_PIXMAP_BACKGROUND: The panel has either an image background +or is translucent. + + + +The #MatePanelAppletFlags associated with the applet are boolean flags which +the panel may read in order to figure out how to handle the applet. + + +@MATE_PANEL_APPLET_FLAGS_NONE: No flags are to be associated with the applet. +@MATE_PANEL_APPLET_EXPAND_MAJOR: The applet should expand horizontally on an +horizontal panel and vertically on a vertical panel - e.g. the behaviour +of the Window List applet. +@MATE_PANEL_APPLET_EXPAND_MINOR: The applet should expand vertically on an +horizontal panel and horizontally on a vertical panel. Most applets should +set this flag in order to utilise the full panel width and allow the applet +to be Fitt's Law compliant. +@MATE_PANEL_APPLET_HAS_HANDLE: The panel should draw a grab handle around the +applet - e.g. the Window List and Notification Area applets both set this +flag. + + + +This callback is invoked when the applet is loaded onto the panel. Typically +the callback will check that @iid matches and fill the @applet with the +widgets which make up the applet. + + + +Prior to the callback being invoked the #MatePanelApplet (or an instance of the +sub-class specified by the #GType passed to the factory macros) is instantiated +and initialized. + + +@applet: The #MatePanelApplet. +@iid: The MateComponent IID of the applet requested. +@user_data: The data passed to the factory macros. +@Returns: %TRUE on success, %FALSE on failure. + + + + +Creates a new #MatePanelApplet. This function is typically not +useful as the applet is created before the #MatePanelAppletFactoryCallback +is invoked. + + +@void: +@Returns: The #MatePanelApplet. + + + + +Get the current orientation of the applet. + + +@applet: The #MatePanelApplet. +@Returns: The orientation of the applet. + + + + +Get the current size hint for the panel. The size hint is +not useful for most applets. + + + +Note: The return value is not an integer value +specifying the pixel size of the panel. Do not +use this value to calculate the size of the applet. Use it +only as a hint by which to decide the applet's layout. + + +@applet: The #MatePanelApplet. +@Returns: The panel's size hint. + + + + +Returns the current background type. If the background +type is %PANEL_NO_BACKGROUND both @color and @pixmap will +be unaffected. If the background type is %PANEL_COLOR_BACKGROUND +then @color will contain the current panel background colour. +If the background type is %PANEL_PIXMAP_BACKGROUND, @pixmap will +contain a pointer to a #GdkPixmap which is a copy of the applet's +portion of the panel's background pixmap. + + + + +@applet: A #MatePanelApplet. +@color: A #GdkColor to be filled in. +@pixmap: Returned #GdkPixmap. +@Returns: The background type. + + + + +Returns the MateConf path to the directory containing the applet's +per-instance preference keys. Using this you may construct the +full path for the applet's preference keys. See + for +more information. + + +@applet: The #MatePanelApplet. +@Returns: A MateConf path. + + + + +Associates each schema in @schema_dir with a key in the applet's +preferences directory (i.e. the directory returned by +mate_panel_applet_get_preferences_key()). Each applet preference +should have an associated schema to ensure that the key has +a defined type, sane default and documentation. + + + +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which MateConf may return. + + +@applet: The #MatePanelApplet. +@schema_dir: The MateConf path where the applet's schemas are installed +e.g. /schemas/apps/my_applet +@opt_error: Optional #GError. + + + + +Retrieve the #MatePanelAppletFlags associated with the applet. + + +@applet: The #MatePanelApplet. +@Returns: The #MatePanelAppletFlags. + + + + +Set the #MatePanelAppletFlags associated with the applet. See +#MatePanelAppletFlags for more details on the possible uses of +these flags. + + +@applet: The #MatePanelApplet. +@flags: The #MatePanelAppletFlags to associate. + + + + +Set a list of desired size ranges for an applet with the +#MATE_PANEL_APPLET_EXPAND_MAJOR flags set. @size_hints is an +array of (max, min) pairs where min(i) > max(i + 1). + + + +The panel will endeavour to allocate the applet a size +in one of the (@base + max, @base + min) ranges. + + +@applet: The #MatePanelApplet. +@size_hints: Array of size_hints. +@n_elements: Number of elements in the array. +Not the number of pairs. +@base_size: The base size of the applet. + + + + +Check if the @applet is locked down. A locked down applet should not allow any change to its configuration. + + +@applet: The #MatePanelApplet. +@Returns: %TRUE if the @applet is locked down, %FALSE otherwise. + + + + +Set keyboard focus to @applet. + + +@applet: The #MatePanelApplet. +@timestamp: timestamp of the event triggering the window focus + + + + +Sets up a popup menu for @applet described by the xml +string, @xml. See section +for a description of the format of the xml. + + +@applet: A #MatePanelApplet. +@xml: The xml character string describing the popup menu. +@action_group: + +@verb_list: The list of #MateComponentUIVerbs for the menu. +@user_data: The user data pointer for the menu. + + + + +Sets up a popup menu for @applet described by the xml +file, @file. See for a description of +the format of the xml. + + +@applet: A #MatePanelApplet. +@filename: +@action_group: + +@opt_datadir: The data directory - i.e. ${prefix}/share (optional). +@file: The file's name. +@opt_app_name: The application's name (optional). +@verb_list: The list of #MateComponentUIVerbs for the menu. +@user_data: The user data pointer for the menu. + + + + +A generic 'main' routine for applets. This should not normally be +used directly because it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_FACTORY. + + +@factory_id: +@out_process: +@applet_type: The #GType to instantiate. +@callback: The factory callback. +@data: The factory user data pointer. +@Returns: 0 on success, 1 on failure. + +@iid: The matecomponent-activation iid of the factory. + + -- cgit v1.2.1