Browse Source

Start initial references docs for libxfce4panel.

Still a lot to do here, but it's a start.
upstream/xfce4-panel-4.10.1
Nick Schermer 13 years ago
parent
commit
60ac91ab89
  1. 1
      Makefile.am
  2. 12
      configure.ac.in
  3. 9
      docs/Makefile.am
  4. 73
      docs/references/Makefile.am
  5. 83
      docs/references/libxfce4panel-docs.xml
  6. 0
      docs/references/libxfce4panel-overrides.txt
  7. 128
      docs/references/libxfce4panel-sections.txt
  8. 6
      docs/references/libxfce4panel.types
  9. 1
      docs/references/version.xml.in
  10. 8
      libxfce4panel/libxfce4panel-config.c
  11. 10
      libxfce4panel/xfce-arrow-button.c
  12. 4
      libxfce4panel/xfce-hvbox.c
  13. 8
      libxfce4panel/xfce-panel-macros.h
  14. 116
      libxfce4panel/xfce-panel-plugin.c

1
Makefile.am

@ -1,6 +1,7 @@
SUBDIRS = \
libxfce4panel \
docs \
common \
panel \
plugins \

12
configure.ac.in

@ -57,6 +57,7 @@ AM_PROG_CC_C_O()
AC_PROG_LD()
AC_PROG_INSTALL()
AC_PROG_INTLTOOL()
AC_PROG_LIBTOOL()
dnl **************************
dnl *** Initialize libtool ***
@ -118,7 +119,7 @@ XDT_CHECK_PACKAGE([LIBWNCK], [libwnck-1.0], [2.22])
dnl *************************
dnl *** Check for gtk-doc ***
dnl *************************
GTK_DOC_CHECK([1.0])
GTK_DOC_CHECK([1.9])
dnl ***********************************
dnl *** Check for debugging support ***
@ -164,6 +165,12 @@ if test x"$have_gnuc_visibility" = x"yes"; then
fi
AM_CONDITIONAL([HAVE_GNUC_VISIBILITY], [test x"$have_gnuc_visibility" = x"yes"])
dnl *************************************
dnl *** Compensate for broken gtk-doc ***
dnl *************************************
XDT_SUPPORTED_FLAGS([GTK_DOC_EXTRA_CFLAGS], [-Wno-sign-compare])
AC_SUBST([GTK_DOC_EXTRA_CFLAGS])
dnl *********************************
dnl *** Substitute platform flags ***
dnl *********************************
@ -180,6 +187,9 @@ AC_SUBST([PLATFORM_LDFLAGS])
AC_OUTPUT([
Makefile
common/Makefile
docs/Makefile
docs/references/Makefile
docs/references/version.xml
libxfce4panel/Makefile
libxfce4panel/libxfce4panel-1.0.pc
libxfce4panel/libxfce4panel-config.h

9
docs/Makefile.am

@ -0,0 +1,9 @@
SUBDIRS = \
references
docdir = $(datadir)/doc/xfce4/Panel
doc_DATA = \
README.gtkrc-2.0 \
README.libxfce4panel
# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:

73
docs/references/Makefile.am

@ -0,0 +1,73 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=libxfce4panel
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
DOC_MODULE_VERSION=$(LIBXFCE4PANEL_VERSION_API)
# The top-level SGML file.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS=--deprecated-guards="XFCE_DISABLE_DEPRECATED"
# The directory containing the source code. Relative to $(srcdir)
DOC_SOURCE_DIR=../../libxfce4panel
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--output-format=xml --sgml-mode --name-space=xfce
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=
# Used for dependencies
HFILE_GLOB=$(top_srcdir)/libxfce4panel/*.h
CFILE_GLOB=$(top_srcdir)/libxfce4panel/*.c
# Header files to ignore when scanning
IGNORE_HFILES= \
libxfce4panel-alias.h \
libxfce4panel-marshal.h \
xfce-panel-plugin-provider.h
# Extra files to add when scanning (relative to $srcdir)
EXTRA_HFILES=
# Images to copy into HTML directory
HTML_IMAGES =
# Extra SGML files that are included by DOC_MAIN_SGML_FILE
content_files = \
version.xml
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
INCLUDES = \
-I$(top_srcdir) \
-I$(top_builddir) \
$(GTK_CFLAGS) \
$(LIBXFCE4UTIL_CFLAGS) \
$(GTK_DOC_EXTRA_CFLAGS)
GTKDOC_LIBS = \
$(top_builddir)/libxfce4panel/libxfce4panel-$(LIBXFCE4PANEL_VERSION_API).la
include $(top_srcdir)/gtk-doc.make
# Other files to distribute
EXTRA_DIST += \
version.xml.in
# manual pages
man_MANS =
if MAINTAINER_MODE
%.1: %.xml
xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
endif
# required for gtk-doc
dist-hook: all
# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:

83
docs/references/libxfce4panel-docs.xml

@ -0,0 +1,83 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index" lang="en">
<bookinfo>
<title>Libxfce4panel Reference Manual</title>
<releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>
<pubdate>November 2009</pubdate>
<copyright>
<year>2006</year>
<year>2007</year>
<holder>Jasper Huijsmans</holder>
</copyright>
<copyright>
<year>2008</year>
<year>2009</year>
<holder>Nick Schermer</holder>
</copyright>
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. The complete license text is available from the <ulink
type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>.
</para>
</legalnotice>
<authorgroup>
<author>
<firstname>Nick</firstname>
<surname>Schermer</surname>
<affiliation>
<address><email>nick@xfce.org</email></address>
</affiliation>
</author>
</authorgroup>
</bookinfo>
<part id="libxfce4panel-panel">
<title>Panel Plugins</title>
<xi:include href="xml/xfce-panel-plugin.xml"/>
</part>
<part id="libxfce4panel-widgets">
<title>Additional Widgets</title>
<xi:include href="xml/xfce-arrow-button.xml"/>
<xi:include href="xml/xfce-hvbox.xml"/>
<xi:include href="xml/xfce-panel-image.xml"/>
</part>
<part id="libxfce4panel-miscelleanous">
<title>Miscelleanous</title>
<xi:include href="xml/libxfce4panel-config.xml"/>
<xi:include href="xml/xfce-panel-convenience.xml"/>
</part>
<!--
<part id="libxfce4panel-deprecated-widgets">
<title>Deprecated widgets</title>
</part>
-->
<index>
<title>Index</title>
</index>
</book>
<!--
vi:set ts=2 sw=2 et ai:
-->

0
docs/references/libxfce4panel-overrides.txt

128
docs/references/libxfce4panel-sections.txt

@ -0,0 +1,128 @@
<SECTION>
<FILE>libxfce4panel-config</FILE>
<TITLE>Version Information</TITLE>
libxfce4panel_major_version
libxfce4panel_minor_version
libxfce4panel_micro_version
libxfce4panel_check_version
<SUBSECTION>
LIBXFCE4PANEL_MAJOR_VERSION
LIBXFCE4PANEL_MINOR_VERSION
LIBXFCE4PANEL_MICRO_VERSION
LIBXFCE4PANEL_CHECK_VERSION
</SECTION>
<SECTION>
<FILE>xfce-arrow-button</FILE>
<TITLE>XfceArrowButton</TITLE>
XfceArrowButton
XfceArrowButtonClass
xfce_arrow_button_new
xfce_arrow_button_get_arrow_type
xfce_arrow_button_set_arrow_type
xfce_arrow_button_get_blinking
xfce_arrow_button_set_blinking
<SUBSECTION Standard>
XfceArrowButtonPrivate
XFCE_ARROW_BUTTON
XFCE_IS_ARROW_BUTTON
XFCE_ARROW_BUTTON_CLASS
XFCE_IS_ARROW_BUTTON_CLASS
XFCE_ARROW_BUTTON_GET_CLASS
<SUBSECTION Private>
xfce_arrow_button_get_type
</SECTION>
<SECTION>
<FILE>xfce-hvbox</FILE>
<TITLE>XfceHVBox</TITLE>
XfceHVBox
xfce_hvbox_new
xfce_hvbox_set_orientation
xfce_hvbox_get_orientation
<SUBSECTION Standard>
XfceHVBoxClass
XFCE_TYPE_HVBOX
XFCE_HVBOX
XFCE_HVBOX_CLASS
XFCE_IS_HVBOX
XFCE_IS_HVBOX_CLASS
XFCE_HVBOX_GET_CLASS
<SUBSECTION Private>
xfce_hvbox_get_type
</SECTION>
<SECTION>
<FILE>xfce-panel-convenience</FILE>
<TITLE>Convenience Functions</TITLE>
xfce_panel_create_button
xfce_panel_create_toggle_button
xfce_panel_allow_customization
</SECTION>
<SECTION>
<FILE>xfce-panel-image</FILE>
<TITLE>XfcePanelImage</TITLE>
XfcePanelImage
xfce_panel_image_new
xfce_panel_image_new_from_pixbuf
xfce_panel_image_new_from_source
xfce_panel_image_set_from_pixbuf
xfce_panel_image_set_from_source
xfce_panel_image_clear
<SUBSECTION Standard>
XfcePanelImageClass
XfcePanelImagePrivate
XFCE_TYPE_PANEL_IMAGE
XFCE_PANEL_IMAGE
XFCE_PANEL_IMAGE_CLASS
XFCE_IS_PANEL_IMAGE
XFCE_IS_PANEL_IMAGE_CLASS
XFCE_PANEL_IMAGE_GET_CLASS
<SUBSECTION Private>
xfce_panel_image_get_type
</SECTION>
<SECTION>
<FILE>xfce-panel-plugin</FILE>
<TITLE>XfcePanelPlugin</TITLE>
XfcePanelPlugin
XfcePanelPluginClass
xfce_panel_plugin_get_name
xfce_panel_plugin_get_display_name
xfce_panel_plugin_get_comment
xfce_panel_plugin_get_unique_id
xfce_panel_plugin_get_property_base
xfce_panel_plugin_get_arguments
xfce_panel_plugin_get_size
xfce_panel_plugin_get_expand
xfce_panel_plugin_set_expand
xfce_panel_plugin_get_orientation
xfce_panel_plugin_get_screen_position
xfce_panel_plugin_take_window
xfce_panel_plugin_add_action_widget
xfce_panel_plugin_menu_insert_item
xfce_panel_plugin_menu_show_configure
xfce_panel_plugin_menu_show_about
xfce_panel_plugin_block_menu
xfce_panel_plugin_unblock_menu
xfce_panel_plugin_register_menu
xfce_panel_plugin_arrow_type
xfce_panel_plugin_position_widget
xfce_panel_plugin_position_menu
xfce_panel_plugin_focus_widget
xfce_panel_plugin_block_autohide
xfce_panel_plugin_lookup_rc_file
xfce_panel_plugin_save_location
<SUBSECTION Standard>
XfcePanelPluginPrivate
XFCE_TYPE_PANEL_PLUGIN
XFCE_PANEL_PLUGIN
XFCE_PANEL_PLUGIN_CLASS
XFCE_IS_PANEL_PLUGIN
XFCE_IS_PANEL_PLUGIN_CLASS
XFCE_PANEL_PLUGIN_GET_CLASS
<SUBSECTION Private>
xfce_panel_plugin_get_type
</SECTION>

6
docs/references/libxfce4panel.types

@ -0,0 +1,6 @@
#include <libxfce4panel/libxfce4panel.h>
xfce_arrow_button_get_type
xfce_hvbox_get_type
xfce_panel_image_get_type
xfce_panel_plugin_get_type

1
docs/references/version.xml.in

@ -0,0 +1 @@
@VERSION@

8
libxfce4panel/libxfce4panel-config.c

@ -57,10 +57,10 @@ const guint libxfce4panel_micro_version = LIBXFCE4PANEL_MICRO_VERSION;
* </programlisting>
* </example>
*
* Return value: %NULL if the library is compatible with the given version,
* or a string describing the version mismatch. The returned
* string is owned by the library and must not be freed or
* modified by the caller.
* Returns: %NULL if the library is compatible with the given version,
* or a string describing the version mismatch. The returned
* string is owned by the library and must not be freed or
* modified by the caller.
**/
const gchar *
libxfce4panel_check_version (guint required_major,

10
libxfce4panel/xfce-arrow-button.c

@ -405,7 +405,7 @@ xfce_arrow_button_blinking_timeout_destroyed (gpointer user_data)
/**
* xfce_arrow_button_new:
* @type : #GtkArrowType for the arrow button
* @arrow_type : #GtkArrowType for the arrow button
*
* Creates a new #XfceArrowButton widget.
*
@ -440,8 +440,8 @@ xfce_arrow_button_get_arrow_type (XfceArrowButton *button)
/**
* xfce_arrow_button_set_arrow_type:
* @button : a #XfceArrowButton
* @type : a valid #GtkArrowType
* @button : a #XfceArrowButton
* @arrow_type : a valid #GtkArrowType
*
* Sets the arrow type for @button.
**/
@ -478,6 +478,8 @@ xfce_arrow_button_set_arrow_type (XfceArrowButton *button,
* Whether the button is blinking.
*
* Returns: %TRUE when @button is blinking.
*
* Since: 4.8.0
**/
gboolean
xfce_arrow_button_get_blinking (XfceArrowButton *button)
@ -495,6 +497,8 @@ xfce_arrow_button_get_blinking (XfceArrowButton *button)
* stop the blinking.
*
* Make the button blink.
*
* Since: 4.8.0
**/
void
xfce_arrow_button_set_blinking (XfceArrowButton *button,

4
libxfce4panel/xfce-hvbox.c

@ -203,7 +203,7 @@ xfce_hvbox_size_allocate (GtkWidget *widget,
*
* Creates a new #XfceHVBox container widget.
*
* Return value: the newly allocated #XfceHVBox container widget.
* Returns: the newly allocated #XfceHVBox container widget.
**/
GtkWidget *
xfce_hvbox_new (GtkOrientation orientation,
@ -260,7 +260,7 @@ xfce_hvbox_set_orientation (XfceHVBox *hvbox,
* xfce_hvbox_get_orientation:
* @hvbox : #XfceHVBox
*
* Returns the current orientation of the #XfceHVBox.
* Returns: the current orientation of the #XfceHVBox.
**/
GtkOrientation
xfce_hvbox_get_orientation (XfceHVBox *hvbox)

8
libxfce4panel/xfce-panel-macros.h

@ -99,7 +99,7 @@ typedef GTypeModule XfcePanelTypeModule;
xfce_panel_module_init (GTypeModule *type_module, \
gboolean *make_resident) \
{ \
typedef void (*XppRegFunc) (GTypeModule *module); \
typedef void (*XppRegFunc) (XfcePanelTypeModule *module); \
XppRegFunc reg_funcs[] = { type_name##_register_type, args }; \
guint i; \
\
@ -119,6 +119,8 @@ typedef GTypeModule XfcePanelTypeModule;
* construct_func : name of the function that points to an
* #XfcePanelPluginFunc function.
*
* TODO
*
* Since: 4.8
**/
#define XFCE_PANEL_PLUGIN_REGISTER(construct_func) \
@ -131,6 +133,8 @@ typedef GTypeModule XfcePanelTypeModule;
* check_func : name of the function that points to an
* #XfcePanelPluginCheck function.
*
* TODO
*
* Since: 4.8
**/
#define XFCE_PANEL_PLUGIN_REGISTER_WITH_CHECK(construct_func, check_func) \
@ -146,6 +150,8 @@ typedef GTypeModule XfcePanelTypeModule;
* check_func : name of the function that points to an
* #XfcePanelPluginCheck function.
*
* TODO
*
* Since: 4.8
**/
#define XFCE_PANEL_PLUGIN_REGISTER_FULL(construct_func, preinit_func, check_func) \

116
libxfce4panel/xfce-panel-plugin.c

@ -414,6 +414,7 @@ xfce_panel_plugin_class_init (XfcePanelPluginClass *klass)
/**
* XfcePanelPlugin:comment:
*
* TODO
*
* Since 4.8.0
**/
@ -461,6 +462,11 @@ xfce_panel_plugin_class_init (XfcePanelPluginClass *klass)
| G_PARAM_STATIC_STRINGS
| G_PARAM_CONSTRUCT_ONLY));
/**
* XfcePanelPlugin:orientation:
*
* TODO
**/
g_object_class_install_property (gobject_class,
PROP_ORIENTATION,
g_param_spec_enum ("orientation",
@ -471,6 +477,11 @@ xfce_panel_plugin_class_init (XfcePanelPluginClass *klass)
G_PARAM_READABLE
| G_PARAM_STATIC_STRINGS));
/**
* XfcePanelPlugin:size:
*
* TODO
**/
g_object_class_install_property (gobject_class,
PROP_SIZE,
g_param_spec_int ("size",
@ -480,6 +491,11 @@ xfce_panel_plugin_class_init (XfcePanelPluginClass *klass)
G_PARAM_READABLE
| G_PARAM_STATIC_STRINGS));
/**
* XfcePanelPlugin:screen-position:
*
* TODO
**/
g_object_class_install_property (gobject_class,
PROP_SCREEN_POSITION,
g_param_spec_enum ("screen-position",
@ -490,6 +506,11 @@ xfce_panel_plugin_class_init (XfcePanelPluginClass *klass)
G_PARAM_READABLE
| G_PARAM_STATIC_STRINGS));
/**
* XfcePanelPlugin:expand:
*
* TODO
**/
g_object_class_install_property (gobject_class,
PROP_EXPAND,
g_param_spec_boolean ("expand",
@ -1260,7 +1281,9 @@ xfce_panel_plugin_take_window_notify (gpointer data,
* xfce_panel_plugin_get_name:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the name of the panel plugin.
* TODO
*
* Returns: the name of the panel plugin.
**/
const gchar *
xfce_panel_plugin_get_name (XfcePanelPlugin *plugin)
@ -1277,7 +1300,7 @@ xfce_panel_plugin_get_name (XfcePanelPlugin *plugin)
* xfce_panel_plugin_get_display_name:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the (translated) display name of the plugin.
* Returns: the (translated) display name of the plugin.
**/
const gchar *
xfce_panel_plugin_get_display_name (XfcePanelPlugin *plugin)
@ -1293,6 +1316,14 @@ xfce_panel_plugin_get_display_name (XfcePanelPlugin *plugin)
/**
* xfce_panel_plugin_get_comment:
* @plugin : an #XfcePanelPlugin.
*
* TODO
*
* Returns: the (translated) comment of the plugin.
**/
const gchar *
xfce_panel_plugin_get_comment (XfcePanelPlugin *plugin)
{
@ -1308,7 +1339,9 @@ xfce_panel_plugin_get_comment (XfcePanelPlugin *plugin)
* xfce_panel_plugin_get_unique_id:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the unique id of the plugin.
* TODO
*
* Returns: the unique id of the plugin.
*
* Since 4.8
**/
@ -1325,9 +1358,11 @@ xfce_panel_plugin_get_unique_id (XfcePanelPlugin *plugin)
/**
* xfce_panel_plugin_get_property_base:
* @plugin :
* @plugin : an #XfcePanelPlugin.
*
* TODO
*
* Return value: the property base for the xfconf channel userd by a plugin.
* Returns: the property base for the xfconf channel userd by a plugin.
*
* See also: xfconf_channel_new_with_property_base() and
* XFCE_PANEL_PLUGIN_CHANNEL_NAME.
@ -1352,8 +1387,10 @@ xfce_panel_plugin_get_property_base (XfcePanelPlugin *plugin)
* xfce_panel_plugin_get_arguments:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the argument vector. The vector is owned by the plugin and
* should not be freed.
* TODO
*
* Returns: the argument vector. The vector is owned by the plugin and
* should not be freed.
*
* Since: 4.8.0
**/
@ -1372,7 +1409,9 @@ xfce_panel_plugin_get_arguments (XfcePanelPlugin *plugin)
* xfce_panel_plugin_get_size:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the current size of the panel.
* TODO
*
* Returns: the current size of the panel.
**/
gint
xfce_panel_plugin_get_size (XfcePanelPlugin *plugin)
@ -1390,8 +1429,10 @@ xfce_panel_plugin_get_size (XfcePanelPlugin *plugin)
* xfce_panel_plugin_get_expand:
* @plugin : an #XfcePanelPlugin.
*
* Return value: %TRUE when the plugin should expand,
* %FALSE otherwise.
* TODO
*
* Returns: %TRUE when the plugin should expand,
* %FALSE otherwise.
**/
gboolean
xfce_panel_plugin_get_expand (XfcePanelPlugin *plugin)
@ -1407,6 +1448,9 @@ xfce_panel_plugin_get_expand (XfcePanelPlugin *plugin)
/**
* xfce_panel_plugin_set_expand:
* @plugin : an #XfcePanelPlugin.
* @expand : TODO.
*
* TODO
**/
void
xfce_panel_plugin_set_expand (XfcePanelPlugin *plugin,
@ -1440,7 +1484,9 @@ xfce_panel_plugin_set_expand (XfcePanelPlugin *plugin,
* xfce_panel_plugin_get_orientation:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the current #GtkOrientation of the panel.
* TODO
*
* Returns: the current #GtkOrientation of the panel.
**/
GtkOrientation
xfce_panel_plugin_get_orientation (XfcePanelPlugin *plugin)
@ -1457,7 +1503,9 @@ xfce_panel_plugin_get_orientation (XfcePanelPlugin *plugin)
* xfce_panel_plugin_get_screen_position:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the current #XfceScreenPosition of the panel.
* TODO
*
* Returns: the current #XfceScreenPosition of the panel.
**/
XfceScreenPosition
xfce_panel_plugin_get_screen_position (XfcePanelPlugin *plugin)
@ -1475,6 +1523,8 @@ xfce_panel_plugin_get_screen_position (XfcePanelPlugin *plugin)
* @plugin : an #XfcePanelPlugin.
* @window : a #GtkWindow.
*
* TODO
*
* Since: 4.8.0
**/
void
@ -1497,6 +1547,8 @@ xfce_panel_plugin_take_window (XfcePanelPlugin *plugin,
* xfce_panel_plugin_add_action_widget:
* @plugin : an #XfcePanelPlugin.
* @widget : a #GtkWidget.
*
* TODO
**/
void
xfce_panel_plugin_add_action_widget (XfcePanelPlugin *plugin,
@ -1516,6 +1568,8 @@ xfce_panel_plugin_add_action_widget (XfcePanelPlugin *plugin,
* xfce_panel_plugin_menu_insert_item:
* @plugin : an #XfcePanelPlugin.
* @item : a #GtkMenuItem.
*
* TODO
**/
void
xfce_panel_plugin_menu_insert_item (XfcePanelPlugin *plugin,
@ -1538,6 +1592,8 @@ xfce_panel_plugin_menu_insert_item (XfcePanelPlugin *plugin,
/**
* xfce_panel_plugin_menu_show_configure:
* @plugin : an #XfcePanelPlugin.
*
* TODO
**/
void
xfce_panel_plugin_menu_show_configure (XfcePanelPlugin *plugin)
@ -1571,6 +1627,8 @@ xfce_panel_plugin_menu_show_configure (XfcePanelPlugin *plugin)
/**
* xfce_panel_plugin_menu_show_about:
* @plugin : an #XfcePanelPlugin.
*
* TODO
**/
void
xfce_panel_plugin_menu_show_about (XfcePanelPlugin *plugin)
@ -1604,6 +1662,8 @@ xfce_panel_plugin_menu_show_about (XfcePanelPlugin *plugin)
/**
* xfce_panel_plugin_block_menu:
* plugin : an #XfcePanelPlugin.
*
* TODO
**/
void
xfce_panel_plugin_block_menu (XfcePanelPlugin *plugin)
@ -1619,6 +1679,8 @@ xfce_panel_plugin_block_menu (XfcePanelPlugin *plugin)
/**
* xfce_panel_plugin_unblock_menu:
* plugin : an #XfcePanelPlugin.
*
* TODO
**/
void
xfce_panel_plugin_unblock_menu (XfcePanelPlugin *plugin)
@ -1637,6 +1699,8 @@ xfce_panel_plugin_unblock_menu (XfcePanelPlugin *plugin)
* xfce_panel_plugin_register_menu:
* @plugin : an #XfcePanelPlugin.
* @menu : a #GtkMenu.
*
* TODO
**/
void
xfce_panel_plugin_register_menu (XfcePanelPlugin *plugin,
@ -1665,7 +1729,9 @@ xfce_panel_plugin_register_menu (XfcePanelPlugin *plugin,
* xfce_panel_plugin_arrow_type:
* @plugin : an #XfcePanelPlugin.
*
* Return value: the #GtkArrowType to use.
* TODO
*
* Returns: the #GtkArrowType to use.
*
* Since: 4.6.0
**/
@ -1721,6 +1787,8 @@ xfce_panel_plugin_arrow_type (XfcePanelPlugin *plugin)
* @x : return location for the x coordinate.
* @y : return location for the x coordinate.
*
* TODO
*
* Since: 4.6.0
**/
void
@ -1809,10 +1877,12 @@ xfce_panel_plugin_position_widget (XfcePanelPlugin *plugin,
* xfce_panel_plugin_position_menu:
* @menu : a #GtkMenu.
* @x : return location for the x coordinate.
* @x : return location for the y coordinate.
* @y : return location for the y coordinate.
* @push_in : keep inside the screen (see #GtkMenuPositionFunc)
* @panel_plugin : an #XfcePanelPlugin.
*
* TODO
*
* Since: 4.6.0
**/
void
@ -1844,6 +1914,15 @@ xfce_panel_plugin_position_menu (GtkMenu *menu,
/**
* xfce_panel_plugin_focus_widget:
* @plugin : an #XfcePanelPlugin.
* @widget : a #GtkWidget inside the plugins that should be focussed.
*
* TODO
*
* Since: 4.6.0
**/
void
xfce_panel_plugin_focus_widget (XfcePanelPlugin *plugin,
GtkWidget *widget)
@ -1862,6 +1941,15 @@ xfce_panel_plugin_focus_widget (XfcePanelPlugin *plugin,
/**
* xfce_panel_plugin_block_autohide:
* @plugin : an #XfcePanelPlugin.
* @blocked : TODO
*
* TODO
*
* Since: 4.6.0
**/
void
xfce_panel_plugin_block_autohide (XfcePanelPlugin *plugin,
gboolean blocked)

Loading…
Cancel
Save