diff options
Diffstat (limited to 'doc/reference/mate-panel-applet')
28 files changed, 4765 insertions, 0 deletions
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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Defining a Popup Context Menu</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="applet-writing.html" title="Writing Applets"> +<link rel="prev" href="server-files.html" title="MateComponent Activation .server Files For Applets"> +<link rel="next" href="panel-signals.html" title="Detecting Changes in the Panel."> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="server-files.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="applet-writing.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="panel-signals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="applet-popups"></a>Defining a Popup Context Menu</h2></div></div></div> +<p>FIXME: write</p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Porting Applets from the MATE 1.x interfaces</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="prev" href="multi-applets.html" title="Multiple Applets"> +<link rel="next" href="mate-panel-applet.html" title="The Panel Applet Library"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="multi-applets.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td>Â </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="mate-panel-applet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="applet-porting"></a>Porting Applets from the MATE 1.x interfaces</h2></div></div></div> +<p>In MATE 1.x the applet interface lived in a header called +<code class="filename">applet-widget.h</code>. 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.</p> +<div class="simplesect"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="applet-porting-activation"></a>Applet Activation</h2></div></div></div> +<p>The first thing to change when porting to the new API is +the header. Include <code class="filename">mate-panel-applet.h</code> instead of +<code class="filename">applet-widget.h</code>.</p> +<p>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</p> +<pre class="programlisting"> +#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) + </pre> +<p>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.</p> +</div> +<div class="simplesect"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="applet-porting-activation-files"></a>Activation files</h2></div></div></div> +<p>The next thing to do may be to port from a +<code class="filename">.gnorba</code> file to a matecomponent-activation +<code class="filename">.server</code> file. You no longer need a .desktop file +for applets. A <code class="filename">.gnorba</code> looks something like this +:</p> +<pre class="programlisting"> +[blah] +type=exe +repo_id=IDL:MATE/Applet:1.0 +description=Blah +location_info=blah-de-blah + </pre> +<p>Your <code class="filename">.server</code> file should look like +this :</p> +<pre class="programlisting"> +<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> + </pre> +<p>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.</p> +</div> +<div class="simplesect"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="applet-porting-menus"></a>Context Menu</h2></div></div></div> +<p>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</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p>An xml desription of the popup menu must be +written.</p></li> +<li class="listitem"><p>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.</p></li> +<li class="listitem"><p>The menu is registered using a call to +mate_panel_applet_setup_menu.</p></li> +</ul></div> +<p>The xml description should look something like this +:</p> +<pre class="programlisting"> +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"; + </pre> +<p>This could also be in a seperate +<code class="filename">.xml</code> file and loaded with +mate_panel_applet_setup_menu_from_file. The description of the verbs should +look something like :</p> +<pre class="programlisting"> +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 +}; + </pre> +<p>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 +<code class="filename">matecomponent-ui-component.h</code>.</p> +<p>To actually register the menu you just do something like +:</p> +<pre class="programlisting"> + mate_panel_applet_setup_menu (MATE_PANEL_APPLET (blah->applet), + blah_menu_xml, + blah_menu_verbs, + blah); + </pre> +<p>The last argument is the user_data argument passed back +to the callbacks.</p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Writing Applets</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="prev" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="next" href="server-files.html" title="MateComponent Activation .server Files For Applets"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td>Â </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="server-files.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="applet-writing"></a>Writing Applets</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="sect1"><a href="applet-writing.html#hello-world">Hello World Applet</a></span></dt> +<dt><span class="sect1"><a href="server-files.html">MateComponent Activation .server Files For Applets</a></span></dt> +<dt><span class="sect1"><a href="applet-popups.html">Defining a Popup Context Menu</a></span></dt> +<dt><span class="sect1"><a href="panel-signals.html">Detecting Changes in the Panel.</a></span></dt> +<dt><span class="sect1"><a href="session-saving.html">Session/Preference Saving.</a></span></dt> +<dt><span class="sect1"><a href="multi-applets.html">Multiple Applets</a></span></dt> +</dl></div> +<p>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. + </p> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="hello-world"></a>Hello World Applet</h2></div></div></div> +<p>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. + </p> +<pre class="programlisting"> +#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); + </pre> +<p>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(). + </p> +<p>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. + </p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 Binary files differnew file mode 100644 index 00000000..17003611 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/home.png 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Panel Applet Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<meta name="description" content="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."> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="next" href="applet-writing.html" title="Writing Applets"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Panel Applet Library Reference Manual</p></th></tr></table></div> +<div><div class="authorgroup"><div class="author"> +<h3 class="author"> +<span class="firstname">Mark</span> <span class="surname">McLoughlin</span> +</h3> +<div class="affiliation"><div class="address"><p><br> +            <code class="email"><<a class="email" href="mailto:[email protected]">[email protected]</a>></code><br> +          </p></div></div> +</div></div></div> +<div><p class="copyright">Copyright © 2001, 2003 Sun Microsystems, Inc.</p></div> +<div><div class="abstract"> +<p class="title"><b>Abstract</b></p> +<p> +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. + </p> +</div></div> +</div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="chapter"><a href="applet-writing.html">Writing Applets</a></span></dt> +<dd><dl> +<dt><span class="sect1"><a href="applet-writing.html#hello-world">Hello World Applet</a></span></dt> +<dt><span class="sect1"><a href="server-files.html">MateComponent Activation .server Files For Applets</a></span></dt> +<dt><span class="sect1"><a href="applet-popups.html">Defining a Popup Context Menu</a></span></dt> +<dt><span class="sect1"><a href="panel-signals.html">Detecting Changes in the Panel.</a></span></dt> +<dt><span class="sect1"><a href="session-saving.html">Session/Preference Saving.</a></span></dt> +<dt><span class="sect1"><a href="multi-applets.html">Multiple Applets</a></span></dt> +</dl></dd> +<dt><span class="chapter"><a href="applet-porting.html">Porting Applets from the MATE 1.x interfaces</a></span></dt> +<dt><span class="chapter"><a href="mate-panel-applet.html">The Panel Applet Library</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="mate-panel-applet-mate-panel-applet.html">MatePanelApplet</a></span><span class="refpurpose"> — The MatePanelApplet object.</span> +</dt> +<dt> +<span class="refentrytitle"><a href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html">Panel Applet MateConf Utilities</a></span><span class="refpurpose"> — Utility methods for manipulating per-applet MateConf preferences.</span> +</dt> +</dl></dd> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<ANCHOR id="mate-panel-applet-mate-panel-applet" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.synopsis" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.synopsis"> +<ANCHOR id="MatePanelApplet" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.object-hierarchy" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.object-hierarchy"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.implemented-interfaces" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.implemented-interfaces"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.properties" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.properties"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.signals" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.signals"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.description" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.description"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.details" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.details"> +<ANCHOR id="MatePanelApplet-struct" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet-struct"> +<ANCHOR id="MatePanelAppletOrient" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient"> +<ANCHOR id="MatePanelAppletBackgroundType" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType"> +<ANCHOR id="PANEL-NO-BACKGROUND:CAPS" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#PANEL-NO-BACKGROUND:CAPS"> +<ANCHOR id="PANEL-COLOR-BACKGROUND:CAPS" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#PANEL-COLOR-BACKGROUND:CAPS"> +<ANCHOR id="PANEL-PIXMAP-BACKGROUND:CAPS" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#PANEL-PIXMAP-BACKGROUND:CAPS"> +<ANCHOR id="MatePanelAppletFlags" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags"> +<ANCHOR id="PANEL-APPLET-FLAGS-NONE:CAPS" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-FLAGS-NONE:CAPS"> +<ANCHOR id="PANEL-APPLET-EXPAND-MAJOR:CAPS" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-EXPAND-MAJOR:CAPS"> +<ANCHOR id="PANEL-APPLET-EXPAND-MINOR:CAPS" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-EXPAND-MINOR:CAPS"> +<ANCHOR id="PANEL-APPLET-HAS-HANDLE:CAPS" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-HAS-HANDLE:CAPS"> +<ANCHOR id="MatePanelAppletFactoryCallback" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelAppletFactoryCallback"> +<ANCHOR id="mate-panel-applet-new" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-new"> +<ANCHOR id="mate-panel-applet-get-orient" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-orient"> +<ANCHOR id="mate-panel-applet-get-size" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-size"> +<ANCHOR id="mate-panel-applet-get-background" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-background"> +<ANCHOR id="mate-panel-applet-get-preferences-key" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-preferences-key"> +<ANCHOR id="mate-panel-applet-add-preferences" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-add-preferences"> +<ANCHOR id="mate-panel-applet-get-flags" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-flags"> +<ANCHOR id="mate-panel-applet-set-flags" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-flags"> +<ANCHOR id="mate-panel-applet-set-size-hints" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-size-hints"> +<ANCHOR id="mate-panel-applet-get-locked-down" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-locked-down"> +<ANCHOR id="mate-panel-applet-request-focus" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-request-focus"> +<ANCHOR id="mate-panel-applet-setup-menu" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu"> +<ANCHOR id="mate-panel-applet-setup-menu-from-file" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu-from-file"> +<ANCHOR id="mate-panel-applet-factory-main" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-factory-main"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.property-details" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.property-details"> +<ANCHOR id="MatePanelApplet--background" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--background"> +<ANCHOR id="MatePanelApplet--closure" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--closure"> +<ANCHOR id="MatePanelApplet--connection" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--connection"> +<ANCHOR id="MatePanelApplet--flags" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--flags"> +<ANCHOR id="MatePanelApplet--id" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--id"> +<ANCHOR id="MatePanelApplet--locked" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked"> +<ANCHOR id="MatePanelApplet--locked-down" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked-down"> +<ANCHOR id="MatePanelApplet--orient" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--orient"> +<ANCHOR id="MatePanelApplet--prefs-key" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--prefs-key"> +<ANCHOR id="MatePanelApplet--size" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size"> +<ANCHOR id="MatePanelApplet--size-hints" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size-hints"> +<ANCHOR id="mate-panel-applet-mate-panel-applet.signal-details" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#mate-panel-applet-mate-panel-applet.signal-details"> +<ANCHOR id="MatePanelApplet-change-background" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-background"> +<ANCHOR id="MatePanelApplet-change-orient" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-orient"> +<ANCHOR id="MatePanelApplet-change-size" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-size"> +<ANCHOR id="MatePanelApplet-move-focus-out-of-applet" href="mate-panel-applet/mate-panel-applet-mate-panel-applet.html#MatePanelApplet-move-focus-out-of-applet"> +<ANCHOR id="mate-panel-applet-Panel-Applet-MateConf-Utilities" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html"> +<ANCHOR id="mate-panel-applet-Panel-Applet-MateConf-Utilities.synopsis" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-Panel-Applet-MateConf-Utilities.synopsis"> +<ANCHOR id="mate-panel-applet-Panel-Applet-MateConf-Utilities.description" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-Panel-Applet-MateConf-Utilities.description"> +<ANCHOR id="mate-panel-applet-Panel-Applet-MateConf-Utilities.details" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-Panel-Applet-MateConf-Utilities.details"> +<ANCHOR id="mate-panel-applet-mateconf-get-full-key" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-full-key"> +<ANCHOR id="mate-panel-applet-mateconf-get-bool" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-bool"> +<ANCHOR id="mate-panel-applet-mateconf-get-int" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-int"> +<ANCHOR id="mate-panel-applet-mateconf-get-string" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-string"> +<ANCHOR id="mate-panel-applet-mateconf-get-float" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-float"> +<ANCHOR id="mate-panel-applet-mateconf-get-list" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-list"> +<ANCHOR id="mate-panel-applet-mateconf-get-value" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-value"> +<ANCHOR id="mate-panel-applet-mateconf-set-bool" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-bool"> +<ANCHOR id="mate-panel-applet-mateconf-set-int" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-int"> +<ANCHOR id="mate-panel-applet-mateconf-set-string" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-string"> +<ANCHOR id="mate-panel-applet-mateconf-set-float" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-float"> +<ANCHOR id="mate-panel-applet-mateconf-set-list" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-list"> +<ANCHOR id="mate-panel-applet-mateconf-set-value" href="mate-panel-applet/mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-value"> diff --git a/doc/reference/mate-panel-applet/html/left.png b/doc/reference/mate-panel-applet/html/left.png Binary files differnew file mode 100644 index 00000000..2d05b3d5 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/left.png 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Panel Applet MateConf Utilities</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="mate-panel-applet.html" title="The Panel Applet Library"> +<link rel="prev" href="mate-panel-applet-mate-panel-applet.html" title="MatePanelApplet"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="mate-panel-applet-mate-panel-applet.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="mate-panel-applet.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td> </td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#mate-panel-applet-Panel-Applet-MateConf-Utilities.synopsis" class="shortcut">Top</a> +  | + <a href="#mate-panel-applet-Panel-Applet-MateConf-Utilities.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="mate-panel-applet-Panel-Applet-MateConf-Utilities"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="mate-panel-applet-Panel-Applet-MateConf-Utilities.top_of_page"></a>Panel Applet MateConf Utilities</span></h2> +<p>Panel Applet MateConf Utilities — Utility methods for manipulating per-applet MateConf preferences.</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="mate-panel-applet-Panel-Applet-MateConf-Utilities.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <mate-panel-applet-mateconf.h> + +<span class="returnvalue">gchar</span> * <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-full-key" title="mate_panel_applet_mateconf_get_full_key ()">mate_panel_applet_mateconf_get_full_key</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-bool" title="mate_panel_applet_mateconf_get_bool ()">mate_panel_applet_mateconf_get_bool</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">gint</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-int" title="mate_panel_applet_mateconf_get_int ()">mate_panel_applet_mateconf_get_int</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">gchar</span> * <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-string" title="mate_panel_applet_mateconf_get_string ()">mate_panel_applet_mateconf_get_string</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">gdouble</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-float" title="mate_panel_applet_mateconf_get_float ()">mate_panel_applet_mateconf_get_float</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">GSList</span> * <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-list" title="mate_panel_applet_mateconf_get_list ()">mate_panel_applet_mateconf_get_list</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValueType"><span class="type">MateConfValueType</span></a> list_type</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValue"><span class="returnvalue">MateConfValue</span></a> * <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-value" title="mate_panel_applet_mateconf_get_value ()">mate_panel_applet_mateconf_get_value</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-bool" title="mate_panel_applet_mateconf_set_bool ()">mate_panel_applet_mateconf_set_bool</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> the_bool</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-int" title="mate_panel_applet_mateconf_set_int ()">mate_panel_applet_mateconf_set_int</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">gint</span> the_int</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-string" title="mate_panel_applet_mateconf_set_string ()">mate_panel_applet_mateconf_set_string</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *the_string</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-float" title="mate_panel_applet_mateconf_set_float ()">mate_panel_applet_mateconf_set_float</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> the_float</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-list" title="mate_panel_applet_mateconf_set_list ()">mate_panel_applet_mateconf_set_list</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValueType"><span class="type">MateConfValueType</span></a> list_type</code></em>, + <em class="parameter"><code><span class="type">GSList</span> *list</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-value" title="mate_panel_applet_mateconf_set_value ()">mate_panel_applet_mateconf_set_value</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValue"><span class="type">MateConfValue</span></a> *value</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-Panel-Applet-MateConf-Utilities.description"></a><h2>Description</h2> +<p> +Applets typically define a set of preferences using a schemas +file and <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-add-preferences" title="mate_panel_applet_add_preferences ()"><code class="function">mate_panel_applet_add_preferences()</code></a>. Such preferences apply +only to an individual applet instance. For example, you may add +two clock applets to the panel and configure them differently. +</p> +<p> +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 <span class="type">MateConfClient</span> functions and operate on these +per-applet keys. +</p> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-Panel-Applet-MateConf-Utilities.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-get-full-key"></a><h3>mate_panel_applet_mateconf_get_full_key ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * mate_panel_applet_mateconf_get_full_key (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre> +<p> +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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The full MateConf key - free using <code class="function">g_free()</code>. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-get-bool"></a><h3>mate_panel_applet_mateconf_get_bool ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> mate_panel_applet_mateconf_get_bool (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-bool"><code class="function">mateconf_client_get_bool()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-bool"><code class="function">mateconf_client_get_bool()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The bool value of the key. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-get-int"></a><h3>mate_panel_applet_mateconf_get_int ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> mate_panel_applet_mateconf_get_int (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-int"><code class="function">mateconf_client_get_int()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-int"><code class="function">mateconf_client_get_int()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The integer value of the key. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-get-string"></a><h3>mate_panel_applet_mateconf_get_string ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * mate_panel_applet_mateconf_get_string (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-string"><code class="function">mateconf_client_get_string()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-string"><code class="function">mateconf_client_get_string()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The string value of the key, or <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if unset. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-get-float"></a><h3>mate_panel_applet_mateconf_get_float ()</h3> +<pre class="programlisting"><span class="returnvalue">gdouble</span> mate_panel_applet_mateconf_get_float (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-float"><code class="function">mateconf_client_get_float()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-float"><code class="function">mateconf_client_get_float()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The floating point value of the key. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-get-list"></a><h3>mate_panel_applet_mateconf_get_list ()</h3> +<pre class="programlisting"><span class="returnvalue">GSList</span> * mate_panel_applet_mateconf_get_list (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValueType"><span class="type">MateConfValueType</span></a> list_type</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-list"><code class="function">mateconf_client_get_list()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-get-list"><code class="function">mateconf_client_get_list()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>list_type</code></em> :</span></p></td> +<td>The MateConf value type of the list elements. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The list of values set for the key. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-get-value"></a><h3>mate_panel_applet_mateconf_get_value ()</h3> +<pre class="programlisting"><a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValue"><span class="returnvalue">MateConfValue</span></a> * mate_panel_applet_mateconf_get_value (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <code class="function">mateconf_client_get_value()</code> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <code class="function">mateconf_client_get_value()</code> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The MateConf value set for the key. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-set-bool"></a><h3>mate_panel_applet_mateconf_set_bool ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_mateconf_set_bool (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> the_bool</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-bool"><code class="function">mateconf_client_set_bool()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-bool"><code class="function">mateconf_client_set_bool()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>the_bool</code></em> :</span></p></td> +<td>The boolean value to set the key with. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-set-int"></a><h3>mate_panel_applet_mateconf_set_int ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_mateconf_set_int (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">gint</span> the_int</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-int"><code class="function">mateconf_client_set_int()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-int"><code class="function">mateconf_client_set_int()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>the_int</code></em> :</span></p></td> +<td>The integer value to set the key with. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-set-string"></a><h3>mate_panel_applet_mateconf_set_string ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_mateconf_set_string (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *the_string</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-string"><code class="function">mateconf_client_set_string()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-string"><code class="function">mateconf_client_set_string()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>the_string</code></em> :</span></p></td> +<td>The string value to set the key with. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-set-float"></a><h3>mate_panel_applet_mateconf_set_float ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_mateconf_set_float (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> the_float</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-float"><code class="function">mateconf_client_set_float()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-float"><code class="function">mateconf_client_set_float()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>the_float</code></em> :</span></p></td> +<td>The floating point value to set the key with. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-set-list"></a><h3>mate_panel_applet_mateconf_set_list ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_mateconf_set_list (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValueType"><span class="type">MateConfValueType</span></a> list_type</code></em>, + <em class="parameter"><code><span class="type">GSList</span> *list</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-list"><code class="function">mateconf_client_set_list()</code></a> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-client.html#mateconf-client-set-list"><code class="function">mateconf_client_set_list()</code></a> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>list_type</code></em> :</span></p></td> +<td>The MateConf value type of the list items. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>The list of values to set the key with. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-mateconf-set-value"></a><h3>mate_panel_applet_mateconf_set_value ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_mateconf_set_value (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>, + <em class="parameter"><code><a href="/mate/usr/share/gtk-doc/html/mateconf/mateconf-mateconf-value.html#MateConfValue"><span class="type">MateConfValue</span></a> *value</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Convience wrapper for <code class="function">mateconf_client_set_value()</code> which operates +on the individual per-applet key. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which <code class="function">mateconf_client_set_value()</code> +returns. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The key name of the preference. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>The MateConf value to set the key with. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>**. +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MatePanelApplet</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="mate-panel-applet.html" title="The Panel Applet Library"> +<link rel="prev" href="mate-panel-applet.html" title="The Panel Applet Library"> +<link rel="next" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html" title="Panel Applet MateConf Utilities"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="mate-panel-applet.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="mate-panel-applet.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#mate-panel-applet-mate-panel-applet.synopsis" class="shortcut">Top</a> +  | + <a href="#mate-panel-applet-mate-panel-applet.description" class="shortcut">Description</a> +  | + <a href="#mate-panel-applet-mate-panel-applet.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#mate-panel-applet-mate-panel-applet.implemented-interfaces" class="shortcut">Implemented Interfaces</a> +  | + <a href="#mate-panel-applet-mate-panel-applet.properties" class="shortcut">Properties</a> +  | + <a href="#mate-panel-applet-mate-panel-applet.signals" class="shortcut">Signals</a> +</td></tr> +</table> +<div class="refentry"> +<a name="mate-panel-applet-mate-panel-applet"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="mate-panel-applet-mate-panel-applet.top_of_page"></a>MatePanelApplet</span></h2> +<p>MatePanelApplet — The MatePanelApplet object.</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="mate-panel-applet-mate-panel-applet.synopsis"></a><h2>Synopsis</h2> +<a name="MatePanelApplet"></a><pre class="synopsis"> +#include <mate-panel-applet.h> + +struct <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-struct" title="struct MatePanelApplet">MatePanelApplet</a>; +enum <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient" title="enum MatePanelAppletOrient">MatePanelAppletOrient</a>; +enum <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType" title="enum MatePanelAppletBackgroundType">MatePanelAppletBackgroundType</a>; +enum <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags">MatePanelAppletFlags</a>; +<span class="returnvalue">gboolean</span> (<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFactoryCallback" title="MatePanelAppletFactoryCallback ()">*MatePanelAppletFactoryCallback</a>) (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<span class="returnvalue">GtkWidget</span> * <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-new" title="mate_panel_applet_new ()">mate_panel_applet_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient" title="enum MatePanelAppletOrient"><span class="returnvalue">MatePanelAppletOrient</span></a> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-orient" title="mate_panel_applet_get_orient ()">mate_panel_applet_get_orient</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>); +<span class="returnvalue">guint</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-size" title="mate_panel_applet_get_size ()">mate_panel_applet_get_size</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>); +<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType" title="enum MatePanelAppletBackgroundType"><span class="returnvalue">MatePanelAppletBackgroundType</span></a> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-background" title="mate_panel_applet_get_background ()">mate_panel_applet_get_background</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code><span class="type">GdkColor</span> *color</code></em>, + <em class="parameter"><code><span class="type">GdkPixmap</span> **pixmap</code></em>); +<span class="returnvalue">gchar</span> * <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-preferences-key" title="mate_panel_applet_get_preferences_key ()">mate_panel_applet_get_preferences_key</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-add-preferences" title="mate_panel_applet_add_preferences ()">mate_panel_applet_add_preferences</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *schema_dir</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>); +<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="returnvalue">MatePanelAppletFlags</span></a> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-flags" title="mate_panel_applet_get_flags ()">mate_panel_applet_get_flags</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-flags" title="mate_panel_applet_set_flags ()">mate_panel_applet_set_flags</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a> flags</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-size-hints" title="mate_panel_applet_set_size_hints ()">mate_panel_applet_set_size_hints</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">int</span> *size_hints</code></em>, + <em class="parameter"><code><span class="type">int</span> n_elements</code></em>, + <em class="parameter"><code><span class="type">int</span> base_size</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-locked-down" title="mate_panel_applet_get_locked_down ()">mate_panel_applet_get_locked_down</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-request-focus" title="mate_panel_applet_request_focus ()">mate_panel_applet_request_focus</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu" title="mate_panel_applet_setup_menu ()">mate_panel_applet_setup_menu</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *xml</code></em>, + <em class="parameter"><code><span class="type">GtkActionGroup</span> *action_group</code></em>); +<span class="returnvalue">void</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu-from-file" title="mate_panel_applet_setup_menu_from_file ()">mate_panel_applet_setup_menu_from_file</a> (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>, + <em class="parameter"><code><span class="type">GtkActionGroup</span> *action_group</code></em>); +<span class="returnvalue">int</span> <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-factory-main" title="mate_panel_applet_factory_main ()">mate_panel_applet_factory_main</a> (<em class="parameter"><code>const <span class="type">gchar</span> *factory_id</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> out_process</code></em>, + <em class="parameter"><code><span class="type">GType</span> applet_type</code></em>, + <em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFactoryCallback" title="MatePanelAppletFactoryCallback ()"><span class="type">MatePanelAppletFactoryCallback</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GInitiallyUnowned + +----GtkObject + +----GtkWidget + +----GtkContainer + +----GtkBin + +----GtkEventBox + +----MatePanelApplet +</pre> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +MatePanelApplet implements + AtkImplementorIface and GtkBuildable.</p> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--background" title='The "background" property'>background</a>" <span class="type">gchar</span>* : Read / Write + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--closure" title='The "closure" property'>closure</a>" <span class="type">gpointer</span> : Read / Write / Construct Only + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--connection" title='The "connection" property'>connection</a>" <span class="type">GDBusConnection</span>* : Read / Write / Construct Only + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--flags" title='The "flags" property'>flags</a>" <span class="type">guint</span> : Read / Write + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--id" title='The "id" property'>id</a>" <span class="type">gchar</span>* : Read / Write / Construct Only + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked" title='The "locked" property'>locked</a>" <span class="type">gboolean</span> : Read / Write + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked-down" title='The "locked-down" property'>locked-down</a>" <span class="type">gboolean</span> : Read / Write + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--orient" title='The "orient" property'>orient</a>" <span class="type">guint</span> : Read / Write + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--prefs-key" title='The "prefs-key" property'>prefs-key</a>" <span class="type">gchar</span>* : Read / Write + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size" title='The "size" property'>size</a>" <span class="type">guint</span> : Read / Write + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size-hints" title='The "size-hints" property'>size-hints</a>" <span class="type">gpointer</span> : Read / Write +</pre> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.signals"></a><h2>Signals</h2> +<pre class="synopsis"> + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-background" title='The "change-background" signal'>change-background</a>" : <code class="literal">Run Last</code> + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-orient" title='The "change-orient" signal'>change-orient</a>" : <code class="literal">Run Last</code> + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-size" title='The "change-size" signal'>change-size</a>" : <code class="literal">Run Last</code> + "<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-move-focus-out-of-applet" title='The "move-focus-out-of-applet" signal'>move-focus-out-of-applet</a>" : <code class="literal">Action</code> +</pre> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.description"></a><h2>Description</h2> +<p> +The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> object is an object which encapsulates an applet. It +is a <span class="type">GtkContainer</span> which may contain a single widget. This widget, in +turn, should contain all widgets exposed by the applet. +</p> +<p> +A <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> is associated with a <span class="type">MateComponentControl</span>. The control makes +the cross process UI emmbedding required by applets possible. +</p> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="MatePanelApplet-struct"></a><h3>struct MatePanelApplet</h3> +<pre class="programlisting">struct MatePanelApplet;</pre> +<p> +The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> struct contains private data only. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelAppletOrient"></a><h3>enum MatePanelAppletOrient</h3> +<pre class="programlisting">typedef enum { + MATE_PANEL_APPLET_ORIENT_UP, + MATE_PANEL_APPLET_ORIENT_DOWN, + MATE_PANEL_APPLET_ORIENT_LEFT, + MATE_PANEL_APPLET_ORIENT_RIGHT +} MatePanelAppletOrient; +</pre> +<p> +The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient" title="enum MatePanelAppletOrient"><span class="type">MatePanelAppletOrient</span></a> type specifies the orientation of the applet. The +values may seem backward (e.g. <code class="literal">MATE_PANEL_APPLET_ORIENT_LEFT</code> means the panel +is on the right hand side), but this is because the value is representative +of the applet's <span class="emphasis"><em>orientation</em></span>, not the panel's position. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelAppletBackgroundType"></a><h3>enum MatePanelAppletBackgroundType</h3> +<pre class="programlisting">typedef enum { + PANEL_NO_BACKGROUND, + PANEL_COLOR_BACKGROUND, + PANEL_PIXMAP_BACKGROUND +} MatePanelAppletBackgroundType; +</pre> +<p> +The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType" title="enum MatePanelAppletBackgroundType"><span class="type">MatePanelAppletBackgroundType</span></a> enumerated type specifies the type of +background of a panel. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="PANEL-NO-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_NO_BACKGROUND</code></span></p></td> +<td>The panel has no background, the default is used. +</td> +</tr> +<tr> +<td><p><a name="PANEL-COLOR-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_COLOR_BACKGROUND</code></span></p></td> +<td>The panel has a color, i.e rgb value, +background. +</td> +</tr> +<tr> +<td><p><a name="PANEL-PIXMAP-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_PIXMAP_BACKGROUND</code></span></p></td> +<td> The panel has either an image background +or is translucent. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelAppletFlags"></a><h3>enum MatePanelAppletFlags</h3> +<pre class="programlisting">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; +</pre> +<p> +The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a> associated with the applet are boolean flags which +the panel may read in order to figure out how to handle the applet. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="PANEL-APPLET-FLAGS-NONE:CAPS"></a><span class="term"><code class="literal">MATE_PANEL_APPLET_FLAGS_NONE</code></span></p></td> +<td>No flags are to be associated with the applet. +</td> +</tr> +<tr> +<td><p><a name="PANEL-APPLET-EXPAND-MAJOR:CAPS"></a><span class="term"><code class="literal">MATE_PANEL_APPLET_EXPAND_MAJOR</code></span></p></td> +<td>The applet should expand horizontally on an +horizontal panel and vertically on a vertical panel - e.g. the behaviour +of the Window List applet. +</td> +</tr> +<tr> +<td><p><a name="PANEL-APPLET-EXPAND-MINOR:CAPS"></a><span class="term"><code class="literal">MATE_PANEL_APPLET_EXPAND_MINOR</code></span></p></td> +<td>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. +</td> +</tr> +<tr> +<td><p><a name="PANEL-APPLET-HAS-HANDLE:CAPS"></a><span class="term"><code class="literal">MATE_PANEL_APPLET_HAS_HANDLE</code></span></p></td> +<td>The panel should draw a grab handle around the +applet - e.g. the Window List and Notification Area applets both set this +flag. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelAppletFactoryCallback"></a><h3>MatePanelAppletFactoryCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> (*MatePanelAppletFactoryCallback) (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +This callback is invoked when the applet is loaded onto the panel. Typically +the callback will check that <em class="parameter"><code>iid</code></em> matches and fill the <em class="parameter"><code>applet</code></em> with the +widgets which make up the applet. +</p> +<p> +Prior to the callback being invoked the <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> (or an instance of the +sub-class specified by the <span class="type">GType</span> passed to the factory macros) is instantiated +and initialized. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td> +<td>The MateComponent IID of the applet requested. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>The data passed to the factory macros. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-new"></a><h3>mate_panel_applet_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * mate_panel_applet_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. This function is typically not +useful as the applet is created before the <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFactoryCallback" title="MatePanelAppletFactoryCallback ()"><span class="type">MatePanelAppletFactoryCallback</span></a> +is invoked. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-get-orient"></a><h3>mate_panel_applet_get_orient ()</h3> +<pre class="programlisting"><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient" title="enum MatePanelAppletOrient"><span class="returnvalue">MatePanelAppletOrient</span></a> mate_panel_applet_get_orient (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>);</pre> +<p> +Get the current orientation of the applet. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The orientation of the applet. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-get-size"></a><h3>mate_panel_applet_get_size ()</h3> +<pre class="programlisting"><span class="returnvalue">guint</span> mate_panel_applet_get_size (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>);</pre> +<p> +Get the current size hint for the panel. The size hint is +not useful for most applets. +</p> +<p> +Note: The return value is <span class="emphasis"><em>not an integer value +specifying the pixel size of the panel.</em></span> 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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The panel's size hint. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-get-background"></a><h3>mate_panel_applet_get_background ()</h3> +<pre class="programlisting"><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType" title="enum MatePanelAppletBackgroundType"><span class="returnvalue">MatePanelAppletBackgroundType</span></a> mate_panel_applet_get_background (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code><span class="type">GdkColor</span> *color</code></em>, + <em class="parameter"><code><span class="type">GdkPixmap</span> **pixmap</code></em>);</pre> +<p> +Returns the current background type. If the background +type is <a class="link" href="mate-panel-applet-mate-panel-applet.html#PANEL-NO-BACKGROUND:CAPS"><code class="literal">PANEL_NO_BACKGROUND</code></a> both <em class="parameter"><code>color</code></em> and <em class="parameter"><code>pixmap</code></em> will +be unaffected. If the background type is <a class="link" href="mate-panel-applet-mate-panel-applet.html#PANEL-COLOR-BACKGROUND:CAPS"><code class="literal">PANEL_COLOR_BACKGROUND</code></a> +then <em class="parameter"><code>color</code></em> will contain the current panel background colour. +If the background type is <a class="link" href="mate-panel-applet-mate-panel-applet.html#PANEL-PIXMAP-BACKGROUND:CAPS"><code class="literal">PANEL_PIXMAP_BACKGROUND</code></a>, <em class="parameter"><code>pixmap</code></em> will +contain a pointer to a <span class="type">GdkPixmap</span> which is a copy of the applet's +portion of the panel's background pixmap. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>A <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td> +<td>A <span class="type">GdkColor</span> to be filled in. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td> +<td>Returned <span class="type">GdkPixmap</span>. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The background type. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-get-preferences-key"></a><h3>mate_panel_applet_get_preferences_key ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * mate_panel_applet_get_preferences_key (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>);</pre> +<p> +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 +<a class="xref" href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html" title="Panel Applet MateConf Utilities"><span class="refentrytitle"><a name="mate-panel-applet-Panel-Applet-MateConf-Utilities.top_of_page"></a>Panel Applet MateConf Utilities</span>(3)</a> for +more information. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>A MateConf path. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-add-preferences"></a><h3>mate_panel_applet_add_preferences ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_add_preferences (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *schema_dir</code></em>, + <em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre> +<p> +Associates each schema in <em class="parameter"><code>schema_dir</code></em> with a key in the applet's +preferences directory (i.e. the directory returned by +<a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-preferences-key" title="mate_panel_applet_get_preferences_key ()"><code class="function">mate_panel_applet_get_preferences_key()</code></a>). Each applet preference +should have an associated schema to ensure that the key has +a defined type, sane default and documentation. +</p> +<p> +If you pass <a href="/mate/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print +a warning message from any <span class="type">GError</span> which MateConf may return. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>schema_dir</code></em> :</span></p></td> +<td>The MateConf path where the applet's schemas are installed +e.g. /schemas/apps/my_applet +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td> +<td>Optional <span class="type">GError</span>. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-get-flags"></a><h3>mate_panel_applet_get_flags ()</h3> +<pre class="programlisting"><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="returnvalue">MatePanelAppletFlags</span></a> mate_panel_applet_get_flags (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>);</pre> +<p> +Retrieve the <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a> associated with the applet. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a>. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-set-flags"></a><h3>mate_panel_applet_set_flags ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_set_flags (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a> flags</code></em>);</pre> +<p> +Set the <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a> associated with the applet. See +<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a> for more details on the possible uses of +these flags. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags" title="enum MatePanelAppletFlags"><span class="type">MatePanelAppletFlags</span></a> to associate. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-set-size-hints"></a><h3>mate_panel_applet_set_size_hints ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_set_size_hints (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">int</span> *size_hints</code></em>, + <em class="parameter"><code><span class="type">int</span> n_elements</code></em>, + <em class="parameter"><code><span class="type">int</span> base_size</code></em>);</pre> +<p> +Set a list of desired size ranges for an applet with the +<a class="link" href="mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-EXPAND-MAJOR:CAPS"><span class="type">MATE_PANEL_APPLET_EXPAND_MAJOR</span></a> flags set. <em class="parameter"><code>size_hints</code></em> is an +array of (max, min) pairs where min(i) > max(i + 1). +</p> +<p> +The panel will endeavour to allocate the applet a size +in one of the (<em class="parameter"><code>base</code></em> + max, <em class="parameter"><code>base</code></em> + min) ranges. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>size_hints</code></em> :</span></p></td> +<td>Array of size_hints. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>n_elements</code></em> :</span></p></td> +<td>Number of elements in the array. <span class="emphasis"><em> +Not</em></span> the number of pairs. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>base_size</code></em> :</span></p></td> +<td>The base size of the applet. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-get-locked-down"></a><h3>mate_panel_applet_get_locked_down ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> mate_panel_applet_get_locked_down (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>);</pre> +<p> +Check if the <em class="parameter"><code>applet</code></em> is locked down. A locked down applet should not allow any change to its configuration. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the <em class="parameter"><code>applet</code></em> is locked down, <code class="literal">FALSE</code> otherwise. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-request-focus"></a><h3>mate_panel_applet_request_focus ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_request_focus (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre> +<p> +Set keyboard focus to <em class="parameter"><code>applet</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>The <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td> +<td>timestamp of the event triggering the window focus +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-setup-menu"></a><h3>mate_panel_applet_setup_menu ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_setup_menu (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *xml</code></em>, + <em class="parameter"><code><span class="type">GtkActionGroup</span> *action_group</code></em>);</pre> +<p> +Sets up a popup menu for <em class="parameter"><code>applet</code></em> described by the xml +string, <em class="parameter"><code>xml</code></em>. See <a class="xref" href="applet-writing.html" title="Writing Applets"><i>Writing Applets</i></a> section +for a description of the format of the xml. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>A <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>xml</code></em> :</span></p></td> +<td>The xml character string describing the popup menu. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>action_group</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-setup-menu-from-file"></a><h3>mate_panel_applet_setup_menu_from_file ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> mate_panel_applet_setup_menu_from_file (<em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *applet</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>, + <em class="parameter"><code><span class="type">GtkActionGroup</span> *action_group</code></em>);</pre> +<p> +Sets up a popup menu for <em class="parameter"><code>applet</code></em> described by the xml +file, <em class="parameter"><code>file</code></em>. See <a class="xref" href="applet-writing.html" title="Writing Applets"><i>Writing Applets</i></a> for a description of +the format of the xml. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td> +<td>A <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>action_group</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="mate-panel-applet-factory-main"></a><h3>mate_panel_applet_factory_main ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> mate_panel_applet_factory_main (<em class="parameter"><code>const <span class="type">gchar</span> *factory_id</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> out_process</code></em>, + <em class="parameter"><code><span class="type">GType</span> applet_type</code></em>, + <em class="parameter"><code><a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFactoryCallback" title="MatePanelAppletFactoryCallback ()"><span class="type">MatePanelAppletFactoryCallback</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p> +A generic 'main' routine for applets. This should not normally be +used directly because it is invoked by <span class="type">MATE_PANEL_APPLET_MATECOMPONENT_FACTORY</span>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>factory_id</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>out_process</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td> +<td>The <span class="type">GType</span> to instantiate. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td> +<td>The factory callback. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>The factory user data pointer. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>0 on success, 1 on failure. +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="MatePanelApplet--background"></a><h3>The <code class="literal">"background"</code> property</h3> +<pre class="programlisting"> "background" <span class="type">gchar</span>* : Read / Write</pre> +<p>Panel Applet Background.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--closure"></a><h3>The <code class="literal">"closure"</code> property</h3> +<pre class="programlisting"> "closure" <span class="type">gpointer</span> : Read / Write / Construct Only</pre> +<p>The Applet closure.</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--connection"></a><h3>The <code class="literal">"connection"</code> property</h3> +<pre class="programlisting"> "connection" <span class="type">GDBusConnection</span>* : Read / Write / Construct Only</pre> +<p>The DBus Connection.</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--flags"></a><h3>The <code class="literal">"flags"</code> property</h3> +<pre class="programlisting"> "flags" <span class="type">guint</span> : Read / Write</pre> +<p>Panel Applet flags.</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--id"></a><h3>The <code class="literal">"id"</code> property</h3> +<pre class="programlisting"> "id" <span class="type">gchar</span>* : Read / Write / Construct Only</pre> +<p>The Applet identifier.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--locked"></a><h3>The <code class="literal">"locked"</code> property</h3> +<pre class="programlisting"> "locked" <span class="type">gboolean</span> : Read / Write</pre> +<p>Whether Panel Applet is locked.</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--locked-down"></a><h3>The <code class="literal">"locked-down"</code> property</h3> +<pre class="programlisting"> "locked-down" <span class="type">gboolean</span> : Read / Write</pre> +<p>Whether Panel Applet is locked down.</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--orient"></a><h3>The <code class="literal">"orient"</code> property</h3> +<pre class="programlisting"> "orient" <span class="type">guint</span> : Read / Write</pre> +<p>Panel Applet Orientation.</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--prefs-key"></a><h3>The <code class="literal">"prefs-key"</code> property</h3> +<pre class="programlisting"> "prefs-key" <span class="type">gchar</span>* : Read / Write</pre> +<p>MateConf Preferences Key.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--size"></a><h3>The <code class="literal">"size"</code> property</h3> +<pre class="programlisting"> "size" <span class="type">guint</span> : Read / Write</pre> +<p>Panel Applet Size.</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet--size-hints"></a><h3>The <code class="literal">"size-hints"</code> property</h3> +<pre class="programlisting"> "size-hints" <span class="type">gpointer</span> : Read / Write</pre> +<p>Panel Applet Size Hints.</p> +</div> +</div> +<div class="refsect1"> +<a name="mate-panel-applet-mate-panel-applet.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="MatePanelApplet-change-background"></a><h3>The <code class="literal">"change-background"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *matepanelapplet, + <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType" title="enum MatePanelAppletBackgroundType"><span class="type">MatePanelAppletBackgroundType</span></a> arg1, + <span class="type">GdkColor</span> *arg2, + <span class="type">GdkPixmap</span> *arg3, + <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre> +<p> +Emitted when the background of the panel changes. Use <em class="parameter"><code>type</code></em> to +determine which, if any, of <em class="parameter"><code>color</code></em> and <em class="parameter"><code>pimxap</code></em> is valid. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>matepanelapplet</code></em> :</span></p></td> +<td>The object which received the signal. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet-change-orient"></a><h3>The <code class="literal">"change-orient"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *matepanelapplet, + <span class="type">guint</span> arg1, + <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre> +<p> +Emitted when the orientation of the panel changes. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>matepanelapplet</code></em> :</span></p></td> +<td>The object which received the signal. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>orient</code></em> :</span></p></td> +<td>The new <a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient" title="enum MatePanelAppletOrient"><span class="type">MatePanelAppletOrient</span></a> of the applet. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet-change-size"></a><h3>The <code class="literal">"change-size"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *matepanelapplet, + <span class="type">gint</span> arg1, + <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre> +<p> +Emitted when the size of the panel changes. +</p> +<p> +Note: this is different for size negotiation which is handled by +<code class="function">size_request()</code> and <code class="function">size_allocate()</code> 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 <a class="link" href="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-size" title="mate_panel_applet_get_size ()"><code class="function">mate_panel_applet_get_size()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>matepanelapplet</code></em> :</span></p></td> +<td>The object which received the signal. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td> +<td>The size hint of the panel. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="MatePanelApplet-move-focus-out-of-applet"></a><h3>The <code class="literal">"move-focus-out-of-applet"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="mate-panel-applet-mate-panel-applet.html#MatePanelApplet"><span class="type">MatePanelApplet</span></a> *matepanelapplet, + <span class="type">GtkDirectionType</span> arg1, + <span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre> +<p> +Emitted when the applet has lost focus. This signal is used internally and is not meant to be used by applets themselves. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>matepanelapplet</code></em> :</span></p></td> +<td>The object which received the signal. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td> +<td>The direction of focus movement. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="Panel Applet Library Reference Manual" link="index.html" author="Mark McLoughlin" name="mate-panel-applet"> + <chapters> + <sub name="Writing Applets" link="applet-writing.html"> + <sub name="Hello World Applet" link="applet-writing.html#hello-world"/> + <sub name="MateComponent Activation .server Files For Applets" link="server-files.html"/> + <sub name="Defining a Popup Context Menu" link="applet-popups.html"/> + <sub name="Detecting Changes in the Panel." link="panel-signals.html"/> + <sub name="Session/Preference Saving." link="session-saving.html"/> + <sub name="Multiple Applets" link="multi-applets.html"/> + </sub> + <sub name="Porting Applets from the MATE 1.x interfaces" link="applet-porting.html"/> + <sub name="The Panel Applet Library" link="mate-panel-applet.html"> + <sub name="MatePanelApplet" link="mate-panel-applet-mate-panel-applet.html"/> + <sub name="Panel Applet MateConf Utilities" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html"/> + </sub> + </chapters> + <functions> + <function name="struct MatePanelApplet" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-struct"/> + <function name="enum MatePanelAppletOrient" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient"/> + <function name="enum MatePanelAppletBackgroundType" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType"/> + <function name="enum MatePanelAppletFlags" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags"/> + <function name="MatePanelAppletFactoryCallback ()" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFactoryCallback"/> + <function name="mate_panel_applet_new ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-new"/> + <function name="mate_panel_applet_get_orient ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-orient"/> + <function name="mate_panel_applet_get_size ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-size"/> + <function name="mate_panel_applet_get_background ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-background"/> + <function name="mate_panel_applet_get_preferences_key ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-preferences-key"/> + <function name="mate_panel_applet_add_preferences ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-add-preferences"/> + <function name="mate_panel_applet_get_flags ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-flags"/> + <function name="mate_panel_applet_set_flags ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-flags"/> + <function name="mate_panel_applet_set_size_hints ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-size-hints"/> + <function name="mate_panel_applet_get_locked_down ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-locked-down"/> + <function name="mate_panel_applet_request_focus ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-request-focus"/> + <function name="mate_panel_applet_setup_menu ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu"/> + <function name="mate_panel_applet_setup_menu_from_file ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu-from-file"/> + <function name="mate_panel_applet_factory_main ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-factory-main"/> + <function name="The "background" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--background"/> + <function name="The "closure" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--closure"/> + <function name="The "connection" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--connection"/> + <function name="The "flags" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--flags"/> + <function name="The "id" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--id"/> + <function name="The "locked" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked"/> + <function name="The "locked-down" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked-down"/> + <function name="The "orient" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--orient"/> + <function name="The "prefs-key" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--prefs-key"/> + <function name="The "size" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size"/> + <function name="The "size-hints" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size-hints"/> + <function name="The "change-background" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-background"/> + <function name="The "change-orient" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-orient"/> + <function name="The "change-size" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-size"/> + <function name="The "move-focus-out-of-applet" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-move-focus-out-of-applet"/> + <function name="mate_panel_applet_mateconf_get_full_key ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-full-key"/> + <function name="mate_panel_applet_mateconf_get_bool ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-bool"/> + <function name="mate_panel_applet_mateconf_get_int ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-int"/> + <function name="mate_panel_applet_mateconf_get_string ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-string"/> + <function name="mate_panel_applet_mateconf_get_float ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-float"/> + <function name="mate_panel_applet_mateconf_get_list ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-list"/> + <function name="mate_panel_applet_mateconf_get_value ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-value"/> + <function name="mate_panel_applet_mateconf_set_bool ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-bool"/> + <function name="mate_panel_applet_mateconf_set_int ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-int"/> + <function name="mate_panel_applet_mateconf_set_string ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-string"/> + <function name="mate_panel_applet_mateconf_set_float ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-float"/> + <function name="mate_panel_applet_mateconf_set_list ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-list"/> + <function name="mate_panel_applet_mateconf_set_value ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-value"/> + </functions> +</book> 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 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="Panel Applet Library Reference Manual" link="index.html" author="Mark McLoughlin" name="mate-panel-applet" version="2" language="c"> + <chapters> + <sub name="Writing Applets" link="applet-writing.html"> + <sub name="Hello World Applet" link="applet-writing.html#hello-world"/> + <sub name="MateComponent Activation .server Files For Applets" link="server-files.html"/> + <sub name="Defining a Popup Context Menu" link="applet-popups.html"/> + <sub name="Detecting Changes in the Panel." link="panel-signals.html"/> + <sub name="Session/Preference Saving." link="session-saving.html"/> + <sub name="Multiple Applets" link="multi-applets.html"/> + </sub> + <sub name="Porting Applets from the MATE 1.x interfaces" link="applet-porting.html"/> + <sub name="The Panel Applet Library" link="mate-panel-applet.html"> + <sub name="MatePanelApplet" link="mate-panel-applet-mate-panel-applet.html"/> + <sub name="Panel Applet MateConf Utilities" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html"/> + </sub> + </chapters> + <functions> + <keyword type="struct" name="struct MatePanelApplet" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-struct"/> + <keyword type="enum" name="enum MatePanelAppletOrient" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletOrient"/> + <keyword type="enum" name="enum MatePanelAppletBackgroundType" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletBackgroundType"/> + <keyword type="enum" name="enum MatePanelAppletFlags" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFlags"/> + <keyword type="function" name="MatePanelAppletFactoryCallback ()" link="mate-panel-applet-mate-panel-applet.html#MatePanelAppletFactoryCallback"/> + <keyword type="function" name="mate_panel_applet_new ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-new"/> + <keyword type="function" name="mate_panel_applet_get_orient ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-orient"/> + <keyword type="function" name="mate_panel_applet_get_size ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-size"/> + <keyword type="function" name="mate_panel_applet_get_background ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-background"/> + <keyword type="function" name="mate_panel_applet_get_preferences_key ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-preferences-key"/> + <keyword type="function" name="mate_panel_applet_add_preferences ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-add-preferences"/> + <keyword type="function" name="mate_panel_applet_get_flags ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-flags"/> + <keyword type="function" name="mate_panel_applet_set_flags ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-flags"/> + <keyword type="function" name="mate_panel_applet_set_size_hints ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-set-size-hints"/> + <keyword type="function" name="mate_panel_applet_get_locked_down ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-get-locked-down"/> + <keyword type="function" name="mate_panel_applet_request_focus ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-request-focus"/> + <keyword type="function" name="mate_panel_applet_setup_menu ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu"/> + <keyword type="function" name="mate_panel_applet_setup_menu_from_file ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-setup-menu-from-file"/> + <keyword type="function" name="mate_panel_applet_factory_main ()" link="mate-panel-applet-mate-panel-applet.html#mate-panel-applet-factory-main"/> + <keyword type="property" name="The "background" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--background"/> + <keyword type="property" name="The "closure" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--closure"/> + <keyword type="property" name="The "connection" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--connection"/> + <keyword type="property" name="The "flags" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--flags"/> + <keyword type="property" name="The "id" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--id"/> + <keyword type="property" name="The "locked" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked"/> + <keyword type="property" name="The "locked-down" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--locked-down"/> + <keyword type="property" name="The "orient" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--orient"/> + <keyword type="property" name="The "prefs-key" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--prefs-key"/> + <keyword type="property" name="The "size" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size"/> + <keyword type="property" name="The "size-hints" property" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet--size-hints"/> + <keyword type="signal" name="The "change-background" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-background"/> + <keyword type="signal" name="The "change-orient" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-orient"/> + <keyword type="signal" name="The "change-size" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-change-size"/> + <keyword type="signal" name="The "move-focus-out-of-applet" signal" link="mate-panel-applet-mate-panel-applet.html#MatePanelApplet-move-focus-out-of-applet"/> + <keyword type="function" name="mate_panel_applet_mateconf_get_full_key ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-full-key"/> + <keyword type="function" name="mate_panel_applet_mateconf_get_bool ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-bool"/> + <keyword type="function" name="mate_panel_applet_mateconf_get_int ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-int"/> + <keyword type="function" name="mate_panel_applet_mateconf_get_string ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-string"/> + <keyword type="function" name="mate_panel_applet_mateconf_get_float ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-float"/> + <keyword type="function" name="mate_panel_applet_mateconf_get_list ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-list"/> + <keyword type="function" name="mate_panel_applet_mateconf_get_value ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-get-value"/> + <keyword type="function" name="mate_panel_applet_mateconf_set_bool ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-bool"/> + <keyword type="function" name="mate_panel_applet_mateconf_set_int ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-int"/> + <keyword type="function" name="mate_panel_applet_mateconf_set_string ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-string"/> + <keyword type="function" name="mate_panel_applet_mateconf_set_float ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-float"/> + <keyword type="function" name="mate_panel_applet_mateconf_set_list ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-list"/> + <keyword type="function" name="mate_panel_applet_mateconf_set_value ()" link="mate-panel-applet-Panel-Applet-MateConf-Utilities.html#mate-panel-applet-mateconf-set-value"/> + <keyword type="constant" name="PANEL_NO_BACKGROUND" link="mate-panel-applet-mate-panel-applet.html#PANEL-NO-BACKGROUND:CAPS"/> + <keyword type="constant" name="PANEL_COLOR_BACKGROUND" link="mate-panel-applet-mate-panel-applet.html#PANEL-COLOR-BACKGROUND:CAPS"/> + <keyword type="constant" name="PANEL_PIXMAP_BACKGROUND" link="mate-panel-applet-mate-panel-applet.html#PANEL-PIXMAP-BACKGROUND:CAPS"/> + <keyword type="constant" name="MATE_PANEL_APPLET_FLAGS_NONE" link="mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-FLAGS-NONE:CAPS"/> + <keyword type="constant" name="MATE_PANEL_APPLET_EXPAND_MAJOR" link="mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-EXPAND-MAJOR:CAPS"/> + <keyword type="constant" name="MATE_PANEL_APPLET_EXPAND_MINOR" link="mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-EXPAND-MINOR:CAPS"/> + <keyword type="constant" name="MATE_PANEL_APPLET_HAS_HANDLE" link="mate-panel-applet-mate-panel-applet.html#PANEL-APPLET-HAS-HANDLE:CAPS"/> + </functions> +</book> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>The Panel Applet Library</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="prev" href="applet-porting.html" title="Porting Applets from the MATE 1.x interfaces"> +<link rel="next" href="mate-panel-applet-mate-panel-applet.html" title="MatePanelApplet"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="applet-porting.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="mate-panel-applet-mate-panel-applet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="mate-panel-applet"></a>The Panel Applet Library</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="mate-panel-applet-mate-panel-applet.html">MatePanelApplet</a></span><span class="refpurpose"> — The MatePanelApplet object.</span> +</dt> +<dt> +<span class="refentrytitle"><a href="mate-panel-applet-Panel-Applet-MateConf-Utilities.html">Panel Applet MateConf Utilities</a></span><span class="refpurpose"> — Utility methods for manipulating per-applet MateConf preferences.</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Multiple Applets</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="applet-writing.html" title="Writing Applets"> +<link rel="prev" href="session-saving.html" title="Session/Preference Saving."> +<link rel="next" href="applet-porting.html" title="Porting Applets from the MATE 1.x interfaces"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="session-saving.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="applet-writing.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="applet-porting.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="multi-applets"></a>Multiple Applets</h2></div></div></div> +<p>FIXME: write</p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Detecting Changes in the Panel.</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="applet-writing.html" title="Writing Applets"> +<link rel="prev" href="applet-popups.html" title="Defining a Popup Context Menu"> +<link rel="next" href="session-saving.html" title="Session/Preference Saving."> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="applet-popups.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="applet-writing.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="session-saving.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="panel-signals"></a>Detecting Changes in the Panel.</h2></div></div></div> +<p>FIXME: write</p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 Binary files differnew file mode 100644 index 00000000..92832e3a --- /dev/null +++ b/doc/reference/mate-panel-applet/html/right.png 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MateComponent Activation .server Files For Applets</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="applet-writing.html" title="Writing Applets"> +<link rel="prev" href="applet-writing.html" title="Writing Applets"> +<link rel="next" href="applet-popups.html" title="Defining a Popup Context Menu"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="applet-writing.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="applet-writing.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="applet-popups.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="server-files"></a>MateComponent Activation .server Files For Applets</h2></div></div></div> +<p>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 ... + </p> +<pre class="programlisting"> +<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> + </pre> +<p>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. + </p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Session/Preference Saving.</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Panel Applet Library Reference Manual"> +<link rel="up" href="applet-writing.html" title="Writing Applets"> +<link rel="prev" href="panel-signals.html" title="Detecting Changes in the Panel."> +<link rel="next" href="multi-applets.html" title="Multiple Applets"> +<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="panel-signals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="applet-writing.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Panel Applet Library Reference Manual</th> +<td><a accesskey="n" href="multi-applets.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="sect1"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="session-saving"></a>Session/Preference Saving.</h2></div></div></div> +<p>FIXME: write</p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15.1</div> +</body> +</html>
\ 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 Binary files differnew file mode 100644 index 00000000..85b3e2a2 --- /dev/null +++ b/doc/reference/mate-panel-applet/html/up.png 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 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY MatePanelApplet SYSTEM "xml/mate-panel-applet.xml"> +<!ENTITY MatePanelAppletMateConf SYSTEM "xml/mate-panel-applet-mateconf.xml"> +]> + +<book id="libmate-panel-applet"> + <bookinfo> + <title>Panel Applet Library Reference Manual</title> + <authorgroup> + <author> + <firstname>Mark</firstname> + <surname>McLoughlin</surname> + <affiliation> + <address> + <email>[email protected]</email> + </address> + </affiliation> + </author> + </authorgroup> + + <copyright> + <year>2001</year> + <year>2003</year> + <holder>Sun Microsystems, Inc.</holder> + </copyright> + + <abstract> + <para> +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. + </para> + </abstract> + + </bookinfo> + + <chapter id="applet-writing"> + <title>Writing Applets</title> + + <para>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. + </para> + + <sect1 id="hello-world"> + <title>Hello World Applet</title> + + <para>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. + </para> + + <programlisting> +#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); + </programlisting> + + <para>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(). + </para> + + <para>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. + </para> + + </sect1> + + <sect1 id="server-files"> + <title>MateComponent Activation .server Files For Applets</title> + + <para>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 ... + </para> + + <programlisting> +<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> + </programlisting> + + <para>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. + </para> + </sect1> + + <sect1 id="applet-popups"> + <title>Defining a Popup Context Menu</title> + + <para>FIXME: write</para> + </sect1> + + <sect1 id="panel-signals"> + <title>Detecting Changes in the Panel.</title> + + <para>FIXME: write</para> + </sect1> + + <sect1 id="session-saving"> + <title>Session/Preference Saving.</title> + + <para>FIXME: write</para> + </sect1> + + <sect1 id="multi-applets"> + <title>Multiple Applets</title> + + <para>FIXME: write</para> + </sect1> + + </chapter> + + <chapter id="applet-porting"> + <title>Porting Applets from the MATE 1.x interfaces</title> + + <para>In MATE 1.x the applet interface lived in a header called +<filename>applet-widget.h</filename>. 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.</para> + + <simplesect id="applet-porting-activation"> + <title>Applet Activation</title> + + <para>The first thing to change when porting to the new API is +the header. Include <filename>mate-panel-applet.h</filename> instead of +<filename>applet-widget.h</filename>.</para> + + <para>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</para> + + <programlisting> +#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) + </programlisting> + + <para>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.</para> + + </simplesect> + + <simplesect id="applet-porting-activation-files"> + <title>Activation files</title> + + <para>The next thing to do may be to port from a +<filename>.gnorba</filename> file to a matecomponent-activation +<filename>.server</filename> file. You no longer need a .desktop file +for applets. A <filename>.gnorba</filename> looks something like this +:</para> + + <programlisting> +[blah] +type=exe +repo_id=IDL:MATE/Applet:1.0 +description=Blah +location_info=blah-de-blah + </programlisting> + + <para>Your <filename>.server</filename> file should look like +this :</para> + + <programlisting> +<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> + </programlisting> + + <para>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.</para> + + </simplesect> + + <simplesect id="applet-porting-menus"> + <title>Context Menu</title> + + <para>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</para> + + <itemizedlist> + <listitem><para>An xml desription of the popup menu must be +written.</para></listitem> + <listitem><para>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.</para></listitem> + <listitem><para>The menu is registered using a call to +mate_panel_applet_setup_menu.</para></listitem> + </itemizedlist> + + <para>The xml description should look something like this +:</para> + + <programlisting> +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"; + </programlisting> + + <para>This could also be in a seperate +<filename>.xml</filename> file and loaded with +mate_panel_applet_setup_menu_from_file. The description of the verbs should +look something like :</para> + + <programlisting> +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 +}; + </programlisting> + + <para>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 +<filename>matecomponent-ui-component.h</filename>.</para> + + <para>To actually register the menu you just do something like +:</para> + + <programlisting> + mate_panel_applet_setup_menu (MATE_PANEL_APPLET (blah->applet), + blah_menu_xml, + blah_menu_verbs, + blah); + </programlisting> + + <para>The last argument is the user_data argument passed back +to the callbacks.</para> + + </simplesect> + + </chapter> + + <chapter id="mate-panel-applet"> + <title>The Panel Applet Library</title> + + &MatePanelApplet; + &MatePanelAppletMateConf; + </chapter> + +</book> 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 --- /dev/null +++ b/doc/reference/mate-panel-applet/mate-panel-applet-overrides.txt 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 @@ +<INCLUDE>mate-panel-applet.h</INCLUDE> + +<SECTION> +<FILE>mate-panel-applet</FILE> +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 +<TITLE>MatePanelApplet</TITLE> +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 +<SUBSECTION Standard> +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 +<SUBSECTION Private> +MatePanelAppletClass +MatePanelAppletPrivate +</SECTION> + +<INCLUDE>mate-panel-applet-mateconf.h</INCLUDE> + +<SECTION> +<FILE>mate-panel-applet-mateconf</FILE> +<TITLE>Panel Applet MateConf Utilities</TITLE> +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 +</SECTION> 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.h> + +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 @@ +<!-- ##### SECTION Title ##### --> +Panel Applet MateConf Utilities + +<!-- ##### SECTION Short_Description ##### --> +Utility methods for manipulating per-applet MateConf preferences. + +<!-- ##### SECTION Long_Description ##### --> +<para> +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. +</para> + +<para> +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. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_get_full_key ##### --> +<para> +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. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@Returns: The full MateConf key - free using g_free(). + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_get_bool ##### --> +<para> +Convience wrapper for mateconf_client_get_bool() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_bool() +returns. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The bool value of the key. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_get_int ##### --> +<para> +Convience wrapper for mateconf_client_get_int() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_int() +returns. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The integer value of the key. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_get_string ##### --> +<para> +Convience wrapper for mateconf_client_get_string() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_string() +returns. +</para> + +@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. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_get_float ##### --> +<para> +Convience wrapper for mateconf_client_get_float() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_float() +returns. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The floating point value of the key. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_get_list ##### --> +<para> +Convience wrapper for mateconf_client_get_list() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_list() +returns. +</para> + +@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. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_get_value ##### --> +<para> +Convience wrapper for mateconf_client_get_value() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_get_value() +returns. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@opt_error: Optional #GError**. +@Returns: The MateConf value set for the key. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_set_bool ##### --> +<para> +Convience wrapper for mateconf_client_set_bool() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_bool() +returns. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@the_bool: The boolean value to set the key with. +@opt_error: Optional #GError**. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_set_int ##### --> +<para> +Convience wrapper for mateconf_client_set_int() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_int() +returns. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@the_int: The integer value to set the key with. +@opt_error: Optional #GError**. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_set_string ##### --> +<para> +Convience wrapper for mateconf_client_set_string() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_string() +returns. +</para> + +@applet: The #MatePanelApplet. +@key: The key name of the preference. +@the_string: The string value to set the key with. +@opt_error: Optional #GError**. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_set_float ##### --> +<para> +Convience wrapper for mateconf_client_set_float() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_float() +returns. +</para> + +@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**. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_set_list ##### --> +<para> +Convience wrapper for mateconf_client_set_list() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_list() +returns. +</para> + +@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**. + + +<!-- ##### FUNCTION mate_panel_applet_mateconf_set_value ##### --> +<para> +Convience wrapper for mateconf_client_set_value() which operates +on the individual per-applet key. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which mateconf_client_set_value() +returns. +</para> + +@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 @@ +<!-- ##### MACRO MATE_PANEL_APPLET_MATECOMPONENT_FACTORY ##### --> +<para> +Defines a 'main' routine for the applet factory. +</para> + +@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. + +<!-- ##### MACRO MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY ##### --> +<para> +Defines a MateComponent Activation shared library plugin and associated +factory callback. +</para> + +@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. + +<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_DOWN ##### --> +<para> +The applet is orientated down (i.e. the panel is at the top of the screen). +</para> + + +<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_LEFT ##### --> +<para> +The applet is orientated left (i.e. the panel is at the right hand side of the screen). +</para> + + +<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_RIGHT ##### --> +<para> +The applet is orientated right (i.e. the panel is at the left hand side of the screen). +</para> + + +<!-- ##### MACRO MATE_PANEL_APPLET_ORIENT_UP ##### --> +<para> +The applet is orientated up (i.e. the panel is at the bottom of the screen). +</para> + + +<!-- ##### FUNCTION mate_panel_applet_factory_main_closure ##### --> +<para> +A generic 'main' routine for applets. This should not normally be +used directly because it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_FACTORY. +</para> + +@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. + +<!-- ##### FUNCTION mate_panel_applet_get_control ##### --> +<para> +Retrieves the #MateComponentControl associated with @applet. +</para> + +@applet: The #MatePanelApplet. +@Returns: A #MateComponentControl. + +<!-- ##### FUNCTION mate_panel_applet_get_popup_component ##### --> +<para> +Retrieves the #MateComponentUIComponent used for popup menus associated +with @applet. +</para> + +@applet: The #MatePanelApplet. +@Returns: A #MateComponentUIComponent. + +<!-- ##### FUNCTION mate_panel_applet_shlib_factory ##### --> +<para> +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. +</para> + +@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. + +<!-- ##### FUNCTION mate_panel_applet_shlib_factory_closure ##### --> +<para> +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. +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +MatePanelApplet + +<!-- ##### SECTION Short_Description ##### --> +The MatePanelApplet object. + +<!-- ##### SECTION Long_Description ##### --> +<para> +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. +</para> + +<para> +A #MatePanelApplet is associated with a #MateComponentControl. The control makes +the cross process UI emmbedding required by applets possible. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT MatePanelApplet ##### --> +<para> +The #MatePanelApplet struct contains private data only. +</para> + + +<!-- ##### SIGNAL MatePanelApplet::change-background ##### --> +<para> +Emitted when the background of the panel changes. Use @type to +determine which, if any, of @color and @pimxap is valid. +</para> + +@matepanelapplet: The object which received the signal. +@arg1: +@arg2: +@arg3: +<!-- # Unused Parameters # --> +@type: The #MatePanelAppletBackgroundType. +@color: The #GdkColor if @type is #PANEL_COLOR_BACKGROUND. +@pixmap: The pixmap file name if @type is #PANEL_PIXMAP_BACKGROUND + +<!-- ##### SIGNAL MatePanelApplet::change-orient ##### --> +<para> +Emitted when the orientation of the panel changes. +</para> + +@matepanelapplet: The object which received the signal. +@orient: The new #MatePanelAppletOrient of the applet. + +<!-- ##### SIGNAL MatePanelApplet::change-size ##### --> +<para> +Emitted when the size of the panel changes. +</para> + +<para> +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(). +</para> + +@matepanelapplet: The object which received the signal. +@size: The size hint of the panel. + +<!-- ##### SIGNAL MatePanelApplet::move-focus-out-of-applet ##### --> +<para> +Emitted when the applet has lost focus. This signal is used internally and is not meant to be used by applets themselves. +</para> + +@matepanelapplet: The object which received the signal. +@direction: The direction of focus movement. + +<!-- ##### ARG MatePanelApplet:background ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:closure ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:connection ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:flags ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:id ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:locked ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:locked-down ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:orient ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:prefs-key ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:size ##### --> +<para> + +</para> + +<!-- ##### ARG MatePanelApplet:size-hints ##### --> +<para> + +</para> + +<!-- ##### ENUM MatePanelAppletOrient ##### --> +<para> +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 <emphasis>orientation</emphasis>, not the panel's position. +</para> + +@MATE_PANEL_APPLET_ORIENT_UP: +@MATE_PANEL_APPLET_ORIENT_DOWN: +@MATE_PANEL_APPLET_ORIENT_LEFT: +@MATE_PANEL_APPLET_ORIENT_RIGHT: + +<!-- ##### ENUM MatePanelAppletBackgroundType ##### --> +<para> +The #MatePanelAppletBackgroundType enumerated type specifies the type of +background of a panel. +</para> + +@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 ##### --> +<para> +The #MatePanelAppletFlags associated with the applet are boolean flags which +the panel may read in order to figure out how to handle the applet. +</para> + +@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. + +<!-- ##### USER_FUNCTION MatePanelAppletFactoryCallback ##### --> +<para> +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. +</para> + +<para> +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. +</para> + +@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. + + +<!-- ##### FUNCTION mate_panel_applet_new ##### --> +<para> +Creates a new #MatePanelApplet. This function is typically not +useful as the applet is created before the #MatePanelAppletFactoryCallback +is invoked. +</para> + +@void: +@Returns: The #MatePanelApplet. + + +<!-- ##### FUNCTION mate_panel_applet_get_orient ##### --> +<para> +Get the current orientation of the applet. +</para> + +@applet: The #MatePanelApplet. +@Returns: The orientation of the applet. + + +<!-- ##### FUNCTION mate_panel_applet_get_size ##### --> +<para> +Get the current size hint for the panel. The size hint is +not useful for most applets. +</para> + +<para> +Note: The return value is <emphasis>not an integer value +specifying the pixel size of the panel.</emphasis> 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. +</para> + +@applet: The #MatePanelApplet. +@Returns: The panel's size hint. + + +<!-- ##### FUNCTION mate_panel_applet_get_background ##### --> +<para> +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. +</para> + +<!-- FIXME: give an example of how to use this --> + +@applet: A #MatePanelApplet. +@color: A #GdkColor to be filled in. +@pixmap: Returned #GdkPixmap. +@Returns: The background type. + + +<!-- ##### FUNCTION mate_panel_applet_get_preferences_key ##### --> +<para> +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 +<xref linkend="mate-panel-applet-Panel-Applet-MateConf-Utilities" /> for +more information. +</para> + +@applet: The #MatePanelApplet. +@Returns: A MateConf path. + + +<!-- ##### FUNCTION mate_panel_applet_add_preferences ##### --> +<para> +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. +</para> + +<para> +If you pass %NULL for @opt_error, this function will print +a warning message from any #GError which MateConf may return. +</para> + +@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. + + +<!-- ##### FUNCTION mate_panel_applet_get_flags ##### --> +<para> +Retrieve the #MatePanelAppletFlags associated with the applet. +</para> + +@applet: The #MatePanelApplet. +@Returns: The #MatePanelAppletFlags. + + +<!-- ##### FUNCTION mate_panel_applet_set_flags ##### --> +<para> +Set the #MatePanelAppletFlags associated with the applet. See +#MatePanelAppletFlags for more details on the possible uses of +these flags. +</para> + +@applet: The #MatePanelApplet. +@flags: The #MatePanelAppletFlags to associate. + + +<!-- ##### FUNCTION mate_panel_applet_set_size_hints ##### --> +<para> +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). +</para> + +<para> +The panel will endeavour to allocate the applet a size +in one of the (@base + max, @base + min) ranges. +</para> + +@applet: The #MatePanelApplet. +@size_hints: Array of size_hints. +@n_elements: Number of elements in the array. <emphasis> +Not</emphasis> the number of pairs. +@base_size: The base size of the applet. + + +<!-- ##### FUNCTION mate_panel_applet_get_locked_down ##### --> +<para> +Check if the @applet is locked down. A locked down applet should not allow any change to its configuration. +</para> + +@applet: The #MatePanelApplet. +@Returns: %TRUE if the @applet is locked down, %FALSE otherwise. + + +<!-- ##### FUNCTION mate_panel_applet_request_focus ##### --> +<para> +Set keyboard focus to @applet. +</para> + +@applet: The #MatePanelApplet. +@timestamp: timestamp of the event triggering the window focus + + +<!-- ##### FUNCTION mate_panel_applet_setup_menu ##### --> +<para> +Sets up a popup menu for @applet described by the xml +string, @xml. See <xref linkend="applet-writing" /> section +for a description of the format of the xml. +</para> + +@applet: A #MatePanelApplet. +@xml: The xml character string describing the popup menu. +@action_group: +<!-- # Unused Parameters # --> +@verb_list: The list of #MateComponentUIVerbs for the menu. +@user_data: The user data pointer for the menu. + + +<!-- ##### FUNCTION mate_panel_applet_setup_menu_from_file ##### --> +<para> +Sets up a popup menu for @applet described by the xml +file, @file. See <xref linkend="applet-writing" /> for a description of +the format of the xml. +</para> + +@applet: A #MatePanelApplet. +@filename: +@action_group: +<!-- # Unused Parameters # --> +@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. + + +<!-- ##### FUNCTION mate_panel_applet_factory_main ##### --> +<para> +A generic 'main' routine for applets. This should not normally be +used directly because it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_FACTORY. +</para> + +@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. +<!-- # Unused Parameters # --> +@iid: The matecomponent-activation iid of the factory. + + |
