diff options
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/Makefile.am | 64 | ||||
| -rw-r--r-- | docs/API/libxfce4panel-docs.sgml | 78 | ||||
| -rw-r--r-- | docs/API/libxfce4panel-overrides.txt | 0 | ||||
| -rw-r--r-- | docs/API/libxfce4panel-sections.txt | 216 | ||||
| -rw-r--r-- | docs/API/libxfce4panel.types | 13 | ||||
| -rw-r--r-- | docs/API/tmpl/libxfce4panel-macros.sgml | 98 | ||||
| -rw-r--r-- | docs/API/tmpl/libxfce4panel-unused.sgml | 82 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-arrow-button.sgml | 67 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-hvbox.sgml | 47 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-itembar.sgml | 222 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-panel-convenience.sgml | 42 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-panel-enums.sgml | 113 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-panel-external-plugin.sgml | 39 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-panel-internal-plugin.sgml | 42 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-panel-plugin-iface.sgml | 306 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-panel-plugin.sgml | 65 | ||||
| -rw-r--r-- | docs/API/tmpl/xfce-panel-window.sgml | 200 | ||||
| -rw-r--r-- | docs/API/version.xml.in | 1 |
18 files changed, 0 insertions, 1695 deletions
diff --git a/docs/API/Makefile.am b/docs/API/Makefile.am deleted file mode 100644 index a0613408..00000000 --- a/docs/API/Makefile.am +++ /dev/null @@ -1,64 +0,0 @@ -# $Id$ - -AUTOMAKE_OPTIONS = 1.8 - -# The name of the module. -DOC_MODULE=libxfce4panel - -# The top-level SGML file. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir) -DOC_SOURCE_DIR=../../libxfce4panel - -# Extra options to pass to gtkdoc-scangobj -SCANGOBJ_OPTIONS= - -# Extra options to supply to gtkdoc-scan -SCAN_OPTIONS=--type-init-func="gtk_type_init(0);g_type_class_ref(G_TYPE_OBJECT)" - -# Extra options to supply to gtkdoc-mkdb -MKDB_OPTIONS=--sgml-mode --output-format=xml - -# 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= \ - xfce-marshal.h \ - xfce-panel-external-item.h \ - xfce-panel-item-iface.h \ - xfce-panel-plugin-iface-private.h \ - xfce-panel-plugin-messages.h - -# 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) \ - $(LIBXFCEGUI4_CFLAGS) - -GTKDOC_LIBS= \ - $(top_builddir)/libxfce4panel/libxfce4panel.la \ - $(LIBXFCEGUI4_LIBS) - -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.make - -# Other files to distribute -EXTRA_DIST += \ - version.xml.in - -# required for gtk-doc -dist-hook: all diff --git a/docs/API/libxfce4panel-docs.sgml b/docs/API/libxfce4panel-docs.sgml deleted file mode 100644 index 7c473e59..00000000 --- a/docs/API/libxfce4panel-docs.sgml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - -<!ENTITY XfcePanelMacros SYSTEM "xml/libxfce4panel-macros.xml"> -<!ENTITY StandardEnumerations SYSTEM "xml/xfce-panel-enums.xml"> -<!ENTITY RegisterPanelPlugin SYSTEM "xml/xfce-panel-plugin.xml"> -<!ENTITY XfcePanelPlugin SYSTEM "xml/xfce-panel-plugin-iface.xml"> -<!ENTITY XfceExternalPanelPlugin SYSTEM "xml/xfce-panel-external-plugin.xml"> -<!ENTITY XfceInternalPanelPlugin SYSTEM "xml/xfce-panel-internal-plugin.xml"> -<!ENTITY XfceHVBox SYSTEM "xml/xfce-hvbox.xml"> -<!ENTITY XfceArrowButton SYSTEM "xml/xfce-arrow-button.xml"> -<!ENTITY XfcePanelWindow SYSTEM "xml/xfce-panel-window.xml"> -<!ENTITY XfceItembar SYSTEM "xml/xfce-itembar.xml"> -<!ENTITY PanelConvenience SYSTEM "xml/xfce-panel-convenience.xml"> - -<!ENTITY version SYSTEM "version.xml"> -<!ENTITY date "July 2007"> -]> - -<book id="index"> - <bookinfo> - <title>Libxfce4panel Reference Manual</title> - <releaseinfo>Version &version;</releaseinfo> - <pubdate>&date;</pubdate> - - <copyright> - <year>2006</year> - <year>2007</year> - <holder>Jasper Huijsmans</holder> - <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> - </bookinfo> - - <chapter id="libxfce4panel-fundamentals"> - <title>Fundamentals</title> - - &XfcePanelMacros; - &StandardEnumerations; - </chapter> - - <chapter id="libxfce4panel-panel"> - <title>Panel Plugins</title> - - &RegisterPanelPlugin; - &XfcePanelPlugin; - &XfceExternalPanelPlugin; - &XfceInternalPanelPlugin; - </chapter> - - <chapter id="libxfce4panel-widgets"> - <title>Widgets</title> - - &XfceArrowButton; - &XfceHVBox; - &XfceItembar; - &XfcePanelWindow; - &PanelConvenience; - </chapter> - - <index> - <title>Index</title> - </index> - <index role="4.5"> - <title>Index of new symbols in 4.5</title> - </index> -</book> diff --git a/docs/API/libxfce4panel-overrides.txt b/docs/API/libxfce4panel-overrides.txt deleted file mode 100644 index e69de29b..00000000 --- a/docs/API/libxfce4panel-overrides.txt +++ /dev/null diff --git a/docs/API/libxfce4panel-sections.txt b/docs/API/libxfce4panel-sections.txt deleted file mode 100644 index 2143d533..00000000 --- a/docs/API/libxfce4panel-sections.txt +++ /dev/null @@ -1,216 +0,0 @@ -<INCLUDE>libxfce4panel/libxfce4panel.h</INCLUDE> - -<SECTION> -<FILE>libxfce4panel-macros</FILE> -<TITLE>Common macros</TITLE> -panel_slice_alloc -panel_slice_alloc0 -panel_slice_free -panel_slice_free1 -panel_slice_new -panel_slice_new0 -PANEL_PARAM_READABLE -PANEL_PARAM_READWRITE -PANEL_PARAM_WRITABLE -I_ -</SECTION> - -<SECTION> -<FILE>xfce-panel-enums</FILE> -<TITLE>Standard Enumerations</TITLE> -XfceScreenPosition -xfce_screen_position_is_horizontal -xfce_screen_position_get_orientation -xfce_screen_position_is_floating -xfce_screen_position_is_top -xfce_screen_position_is_left -xfce_screen_position_is_right -xfce_screen_position_is_bottom -XfceHandleStyle -<SUBSECTION Standard> -XFCE_TYPE_SCREEN_POSITION -xfce_screen_position_get_type -XFCE_TYPE_HANDLE_STYLE -xfce_handle_style_get_type -</SECTION> - -<SECTION> -<FILE>xfce-panel-plugin</FILE> -<TITLE>Register Plugins</TITLE> -XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL -XFCE_PANEL_PLUGIN_REGISTER_INTERNAL -XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_FULL -XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK -XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK -</SECTION> - -<SECTION> -<FILE>xfce-panel-plugin-iface</FILE> -<TITLE>XfcePanelPlugin</TITLE> -XfcePanelPlugin -XfcePanelPluginFunc -XfcePanelPluginCheck -XfcePanelPluginPreInit -xfce_panel_plugin_get_name -xfce_panel_plugin_get_id -xfce_panel_plugin_get_display_name -xfce_panel_plugin_get_size -xfce_panel_plugin_get_screen_position -xfce_panel_plugin_set_expand -xfce_panel_plugin_get_expand -xfce_panel_plugin_get_orientation -xfce_panel_plugin_add_action_widget -xfce_panel_plugin_menu_insert_item -xfce_panel_plugin_menu_show_about -xfce_panel_plugin_menu_show_configure -xfce_panel_plugin_block_menu -xfce_panel_plugin_unblock_menu -xfce_panel_plugin_register_menu -xfce_panel_plugin_lookup_rc_file -xfce_panel_plugin_save_location -xfce_panel_plugin_focus_widget -xfce_panel_plugin_set_panel_hidden -<SUBSECTION Standard> -XfcePanelPluginInterface -XFCE_PANEL_PLUGIN_GET_INTERFACE -XFCE_PANEL_PLUGIN -XFCE_IS_PANEL_PLUGIN -XFCE_TYPE_PANEL_PLUGIN -xfce_panel_plugin_get_type -</SECTION> - -<SECTION> -<FILE>xfce-panel-external-plugin</FILE> -<TITLE>XfceExternalPanelPlugin</TITLE> -XfceExternalPanelPlugin -xfce_external_panel_plugin_new -<SUBSECTION Standard> -XfceExternalPanelPluginClass -XFCE_EXTERNAL_PANEL_PLUGIN -XFCE_IS_EXTERNAL_PANEL_PLUGIN -XFCE_TYPE_EXTERNAL_PANEL_PLUGIN -xfce_external_panel_plugin_get_type -XFCE_EXTERNAL_PANEL_PLUGIN_CLASS -XFCE_IS_EXTERNAL_PANEL_PLUGIN_CLASS -XFCE_EXTERNAL_PANEL_PLUGIN_GET_CLASS -</SECTION> - -<SECTION> -<FILE>xfce-panel-internal-plugin</FILE> -<TITLE>XfceInternalPanelPlugin</TITLE> -XfceInternalPanelPlugin -xfce_internal_panel_plugin_new -<SUBSECTION Standard> -XfceInternalPanelPluginClass -XFCE_INTERNAL_PANEL_PLUGIN -XFCE_IS_INTERNAL_PANEL_PLUGIN -XFCE_TYPE_INTERNAL_PANEL_PLUGIN -xfce_internal_panel_plugin_get_type -XFCE_INTERNAL_PANEL_PLUGIN_CLASS -XFCE_IS_INTERNAL_PANEL_PLUGIN_CLASS -XFCE_INTERNAL_PANEL_PLUGIN_GET_CLASS -</SECTION> - -<SECTION> -<FILE>xfce-arrow-button</FILE> -<TITLE>XfceArrowButton</TITLE> -XfceArrowButton -xfce_arrow_button_new -xfce_arrow_button_set_arrow_type -xfce_arrow_button_get_arrow_type -<SUBSECTION Standard> -XfceArrowButtonClass -XFCE_ARROW_BUTTON -XFCE_IS_ARROW_BUTTON -XFCE_TYPE_ARROW_BUTTON -xfce_arrow_button_get_type -XFCE_ARROW_BUTTON_CLASS -XFCE_IS_ARROW_BUTTON_CLASS -XFCE_ARROW_BUTTON_GET_CLASS -</SECTION> - -<SECTION> -<FILE>xfce-hvbox</FILE> -<TITLE>XfceHVBox</TITLE> -XfceHVBox -xfce_hvbox_new -xfce_hvbox_set_orientation -<SUBSECTION Standard> -XfceHVBoxClass -XFCE_HVBOX -XFCE_IS_HVBOX -XFCE_TYPE_HVBOX -xfce_hvbox_get_type -XFCE_HVBOX_CLASS -XFCE_IS_HVBOX_CLASS -XFCE_HVBOX_GET_CLASS -</SECTION> - -<SECTION> -<FILE>xfce-itembar</FILE> -<TITLE>XfceItembar</TITLE> -XfceItembar -xfce_itembar_new -xfce_itembar_set_orientation -xfce_itembar_get_orientation -xfce_itembar_insert -xfce_itembar_append -xfce_itembar_prepend -xfce_itembar_reorder_child -xfce_itembar_set_child_expand -xfce_itembar_get_child_expand -xfce_itembar_set_allow_expand -xfce_itembar_get_n_items -xfce_itembar_get_item_index -xfce_itembar_get_nth_item -xfce_itembar_raise_event_window -xfce_itembar_lower_event_window -xfce_itembar_event_window_is_raised -xfce_itembar_get_item_at_point -xfce_itembar_get_drop_index -<SUBSECTION Standard> -XfceItembarClass -XFCE_ITEMBAR -XFCE_IS_ITEMBAR -XFCE_TYPE_ITEMBAR -xfce_itembar_get_type -XFCE_ITEMBAR_CLASS -XFCE_IS_ITEMBAR_CLASS -XFCE_ITEMBAR_GET_CLASS -</SECTION> - -<SECTION> -<FILE>xfce-panel-window</FILE> -<TITLE>XfcePanelWindow</TITLE> -XfcePanelWindow -XfcePanelWindowMoveFunc -XfcePanelWindowResizeFunc -xfce_panel_window_new -xfce_panel_window_set_orientation -xfce_panel_window_get_orientation -xfce_panel_window_set_handle_style -xfce_panel_window_get_handle_style -xfce_panel_window_set_show_border -xfce_panel_window_get_show_border -xfce_panel_window_set_resize_function -xfce_panel_window_set_move_function -xfce_panel_window_set_movable -xfce_panel_window_get_movable -<SUBSECTION Standard> -XfcePanelWindowClass -XFCE_PANEL_WINDOW -XFCE_IS_PANEL_WINDOW -XFCE_TYPE_PANEL_WINDOW -xfce_panel_window_get_type -XFCE_PANEL_WINDOW_CLASS -XFCE_IS_PANEL_WINDOW_CLASS -XFCE_PANEL_WINDOW_GET_CLASS -</SECTION> - -<SECTION> -<FILE>xfce-panel-convenience</FILE> -<TITLE>Convenience Widgets</TITLE> -xfce_create_panel_button -xfce_create_panel_toggle_button -xfce_allow_panel_customization -</SECTION> diff --git a/docs/API/libxfce4panel.types b/docs/API/libxfce4panel.types deleted file mode 100644 index dd42e3fa..00000000 --- a/docs/API/libxfce4panel.types +++ /dev/null @@ -1,13 +0,0 @@ -#include <libxfce4panel/xfce-panel-plugin.h> -#include <libxfce4panel/xfce-arrow-button.h> -#include <libxfce4panel/xfce-hvbox.h> -#include <libxfce4panel/xfce-panel-window.h> -#include <libxfce4panel/xfce-itembar.h> - -xfce_arrow_button_get_type -xfce_hvbox_get_type -xfce_panel_plugin_get_type -xfce_panel_window_get_type -xfce_itembar_get_type -xfce_external_panel_plugin_get_type -xfce_internal_panel_plugin_get_type diff --git a/docs/API/tmpl/libxfce4panel-macros.sgml b/docs/API/tmpl/libxfce4panel-macros.sgml deleted file mode 100644 index 353d9a35..00000000 --- a/docs/API/tmpl/libxfce4panel-macros.sgml +++ /dev/null @@ -1,98 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Common macros - -<!-- ##### SECTION Short_Description ##### --> -Macros to work glib version independent. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Macros for plugin writers to use new features in Glib 2.8 and 2.10 without -breaking old versions of Glib. It is recommended to use those macros -when possible. -</para> - -<!-- ##### SECTION See_Also ##### --> - - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO panel_slice_alloc ##### --> -<para> -Use #g_slice_alloc when available, fallback to #g_malloc. -</para> - -@block_size: the number of bytes to allocate - - -<!-- ##### MACRO panel_slice_alloc0 ##### --> -<para> -Use #g_slice_alloc0 when available, fallback to #g_malloc0. -</para> - -@block_size: the number of bytes to allocate - - -<!-- ##### MACRO panel_slice_free ##### --> -<para> -Use #g_slice_free when available, fallback to #g_free. -</para> - -@type: the type to allocate, typically a structure name -@ptr: a pointer to the block to free - - -<!-- ##### MACRO panel_slice_free1 ##### --> -<para> -Use #g_slice_free1 when available, fallback to #g_free. -</para> - -@block_size: the number of bytes to allocate -@mem_block: a pointer to the block to free - - -<!-- ##### MACRO panel_slice_new ##### --> -<para> -Use #g_slice_new when available, fallback to #g_new. -</para> - -@type: the type to allocate, typically a structure name - - -<!-- ##### MACRO panel_slice_new0 ##### --> -<para> -Use #g_slice_new0 when available, fallback to #g_new0. -</para> - -@type: the type to allocate, typically a structure name - - -<!-- ##### MACRO PANEL_PARAM_READABLE ##### --> -<para> -Alias for #G_PARAM_READABLE | #G_PARAM_STATIC_NAME | #G_PARAM_STATIC_NICK | #G_PARAM_STATIC_BLURB -</para> - - - -<!-- ##### MACRO PANEL_PARAM_READWRITE ##### --> -<para> -Alias for #G_PARAM_WRITABLE | #G_PARAM_STATIC_NAME | #G_PARAM_STATIC_NICK | #G_PARAM_STATIC_BLURB -</para> - - - -<!-- ##### MACRO PANEL_PARAM_WRITABLE ##### --> -<para> -Alias for #G_PARAM_READWRITE | #G_PARAM_STATIC_NAME | #G_PARAM_STATIC_NICK | #G_PARAM_STATIC_BLURB -</para> - - - -<!-- ##### MACRO I_ ##### --> -<para> -Canonical representation for @string. This can be use in functions like #g_object_get_data. -</para> - -@string: a string - - diff --git a/docs/API/tmpl/libxfce4panel-unused.sgml b/docs/API/tmpl/libxfce4panel-unused.sgml deleted file mode 100644 index 09ceda91..00000000 --- a/docs/API/tmpl/libxfce4panel-unused.sgml +++ /dev/null @@ -1,82 +0,0 @@ -<!-- ##### STRUCT XfceArrowButtonClass ##### --> -<para> -</para> - -@parent_class: -@arrow_type_changed: -@_xfce_reserved1: -@_xfce_reserved2: -@_xfce_reserved3: - -<!-- ##### STRUCT XfceExternalPanelPluginClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### STRUCT XfceInternalPanelPluginClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### STRUCT XfceItembarClass ##### --> -<para> - -</para> - -@parent_class: -@orientation_changed: -@icon_size_changed: -@toolbar_style_changed: -@_xfce_reserved1: -@_xfce_reserved2: -@_xfce_reserved3: - -<!-- ##### STRUCT XfcePanelPluginInterface ##### --> -<para> - -</para> - - -<!-- ##### STRUCT XfcePanelWindowClass ##### --> -<para> - -</para> - -@parent_class: -@orientation_changed: -@move_start: -@move: -@move_end: -@_xfce_reserved1: -@_xfce_reserved2: -@_xfce_reserved3: - -<!-- ##### FUNCTION xfce_panel_plugin_get_data ##### --> -<para> - -</para> - -@plugin: -@Returns: - -<!-- ##### FUNCTION xfce_panel_plugin_get_rc_file ##### --> -<para> - -</para> - -@plugin: -@read_only: -@Returns: - -<!-- ##### FUNCTION xfce_panel_plugin_set_data ##### --> -<para> - -</para> - -@plugin: -@data: - diff --git a/docs/API/tmpl/xfce-arrow-button.sgml b/docs/API/tmpl/xfce-arrow-button.sgml deleted file mode 100644 index e335e87b..00000000 --- a/docs/API/tmpl/xfce-arrow-button.sgml +++ /dev/null @@ -1,67 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfceArrowButton - -<!-- ##### SECTION Short_Description ##### --> -Toggle button with arrow. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Toggle button with arrow. The arrow direction will be inverted when the button -is toggled. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#GtkToggleButton -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT XfceArrowButton ##### --> -<para> -The #XfceArrowButton-struct struct contains private data only, and -should be accessed using the functions below. -</para> - - -<!-- ##### SIGNAL XfceArrowButton::arrow-type-changed ##### --> -<para> - -</para> - -@xfcearrowbutton: the object which received the signal. -@arg1: - -<!-- ##### ARG XfceArrowButton:arrow-type ##### --> -<para> - -</para> - -<!-- ##### FUNCTION xfce_arrow_button_new ##### --> -<para> - -</para> - -@type: -@Returns: - - -<!-- ##### FUNCTION xfce_arrow_button_set_arrow_type ##### --> -<para> - -</para> - -@button: -@type: - - -<!-- ##### FUNCTION xfce_arrow_button_get_arrow_type ##### --> -<para> - -</para> - -@button: -@Returns: - - diff --git a/docs/API/tmpl/xfce-hvbox.sgml b/docs/API/tmpl/xfce-hvbox.sgml deleted file mode 100644 index 57c3da61..00000000 --- a/docs/API/tmpl/xfce-hvbox.sgml +++ /dev/null @@ -1,47 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfceHVBox - -<!-- ##### SECTION Short_Description ##### --> -Container widget with configurable orienation. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#XfceHVBox is a #GtkBox widget that allows the user to change its orientation. -It is in fact a combination of #GtkHBox and #GtkVBox. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT XfceHVBox ##### --> -<para> -The #XfceHVBox struct contains private data only, and -should be accessed using the functions below. -</para> - - -<!-- ##### FUNCTION xfce_hvbox_new ##### --> -<para> - -</para> - -@orientation: -@homogeneous: -@spacing: -@Returns: - - -<!-- ##### FUNCTION xfce_hvbox_set_orientation ##### --> -<para> - -</para> - -@hvbox: -@orientation: - - diff --git a/docs/API/tmpl/xfce-itembar.sgml b/docs/API/tmpl/xfce-itembar.sgml deleted file mode 100644 index af54efd1..00000000 --- a/docs/API/tmpl/xfce-itembar.sgml +++ /dev/null @@ -1,222 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfceItembar - -<!-- ##### SECTION Short_Description ##### --> -Container widget with configurable orientation. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#XfceItembar is a container widget that can hold multiple widgets. The -orientation of the bar is configurable and can be changed at any time. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#GtkHBox and #GtkVBox. -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT XfceItembar ##### --> -<para> -The #XfceItembar-struct struct contains private data only, and -should be accessed using the functions below. -</para> - - -<!-- ##### SIGNAL XfceItembar::contents-changed ##### --> -<para> - -</para> - -@xfceitembar: the object which received the signal. - -<!-- ##### SIGNAL XfceItembar::orientation-changed ##### --> -<para> - -</para> - -@xfceitembar: the object which received the signal. -@arg1: - -<!-- ##### ARG XfceItembar:orientation ##### --> -<para> - -</para> - -<!-- ##### ARG XfceItembar:expand ##### --> -<para> - -</para> - -<!-- ##### FUNCTION xfce_itembar_new ##### --> -<para> - -</para> - -@orientation: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_set_orientation ##### --> -<para> - -</para> - -@itembar: -@orientation: - - -<!-- ##### FUNCTION xfce_itembar_get_orientation ##### --> -<para> - -</para> - -@itembar: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_insert ##### --> -<para> - -</para> - -@itembar: -@item: -@position: - - -<!-- ##### FUNCTION xfce_itembar_append ##### --> -<para> - -</para> - -@itembar: -@item: - - -<!-- ##### FUNCTION xfce_itembar_prepend ##### --> -<para> - -</para> - -@itembar: -@item: - - -<!-- ##### FUNCTION xfce_itembar_reorder_child ##### --> -<para> - -</para> - -@itembar: -@item: -@position: - - -<!-- ##### FUNCTION xfce_itembar_set_child_expand ##### --> -<para> - -</para> - -@itembar: -@item: -@expand: - - -<!-- ##### FUNCTION xfce_itembar_get_child_expand ##### --> -<para> - -</para> - -@itembar: -@item: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_set_allow_expand ##### --> -<para> - -</para> - -@itembar: -@allow: - - -<!-- ##### FUNCTION xfce_itembar_get_n_items ##### --> -<para> - -</para> - -@itembar: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_get_item_index ##### --> -<para> - -</para> - -@itembar: -@item: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_get_nth_item ##### --> -<para> - -</para> - -@itembar: -@n: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_raise_event_window ##### --> -<para> - -</para> - -@itembar: - - -<!-- ##### FUNCTION xfce_itembar_lower_event_window ##### --> -<para> - -</para> - -@itembar: - - -<!-- ##### FUNCTION xfce_itembar_event_window_is_raised ##### --> -<para> - -</para> - -@itembar: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_get_item_at_point ##### --> -<para> - -</para> - -@itembar: -@x: -@y: -@Returns: - - -<!-- ##### FUNCTION xfce_itembar_get_drop_index ##### --> -<para> - -</para> - -@itembar: -@x: -@y: -@Returns: - - diff --git a/docs/API/tmpl/xfce-panel-convenience.sgml b/docs/API/tmpl/xfce-panel-convenience.sgml deleted file mode 100644 index b226efc2..00000000 --- a/docs/API/tmpl/xfce-panel-convenience.sgml +++ /dev/null @@ -1,42 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Convenience Functions - -<!-- ##### SECTION Short_Description ##### --> -Special purpose widgets and utilities. - -<!-- ##### SECTION Long_Description ##### --> -This section describes a number of functions that were created to help -developers of Xfce Panel plugins. - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION xfce_create_panel_button ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION xfce_create_panel_toggle_button ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION xfce_allow_panel_customization ##### --> -<para> - -</para> - -@Returns: - - diff --git a/docs/API/tmpl/xfce-panel-enums.sgml b/docs/API/tmpl/xfce-panel-enums.sgml deleted file mode 100644 index 56bf4c85..00000000 --- a/docs/API/tmpl/xfce-panel-enums.sgml +++ /dev/null @@ -1,113 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Standard Enumerations - -<!-- ##### SECTION Short_Description ##### --> -Standard enumerations used by the Xfce Panel. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Currently only contains the definition of #XfceScreenPosition. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM XfceScreenPosition ##### --> -<para> - -</para> - -@XFCE_SCREEN_POSITION_NONE: -@XFCE_SCREEN_POSITION_NW_H: -@XFCE_SCREEN_POSITION_N: -@XFCE_SCREEN_POSITION_NE_H: -@XFCE_SCREEN_POSITION_NW_V: -@XFCE_SCREEN_POSITION_W: -@XFCE_SCREEN_POSITION_SW_V: -@XFCE_SCREEN_POSITION_NE_V: -@XFCE_SCREEN_POSITION_E: -@XFCE_SCREEN_POSITION_SE_V: -@XFCE_SCREEN_POSITION_SW_H: -@XFCE_SCREEN_POSITION_S: -@XFCE_SCREEN_POSITION_SE_H: -@XFCE_SCREEN_POSITION_FLOATING_H: -@XFCE_SCREEN_POSITION_FLOATING_V: - -<!-- ##### MACRO xfce_screen_position_is_horizontal ##### --> -<para> - -</para> - -@position: -@Returns: - - -<!-- ##### MACRO xfce_screen_position_get_orientation ##### --> -<para> - -</para> - -@position: -@Returns: - - -<!-- ##### MACRO xfce_screen_position_is_floating ##### --> -<para> - -</para> - -@position: -@Returns: - - -<!-- ##### MACRO xfce_screen_position_is_top ##### --> -<para> - -</para> - -@position: -@Returns: - - -<!-- ##### MACRO xfce_screen_position_is_left ##### --> -<para> - -</para> - -@position: -@Returns: - - -<!-- ##### MACRO xfce_screen_position_is_right ##### --> -<para> - -</para> - -@position: -@Returns: - - -<!-- ##### MACRO xfce_screen_position_is_bottom ##### --> -<para> - -</para> - -@position: -@Returns: - - -<!-- ##### ENUM XfceHandleStyle ##### --> -<para> - -</para> - -@XFCE_HANDLE_STYLE_NONE: -@XFCE_HANDLE_STYLE_BOTH: -@XFCE_HANDLE_STYLE_START: -@XFCE_HANDLE_STYLE_END: - diff --git a/docs/API/tmpl/xfce-panel-external-plugin.sgml b/docs/API/tmpl/xfce-panel-external-plugin.sgml deleted file mode 100644 index f26ea2cd..00000000 --- a/docs/API/tmpl/xfce-panel-external-plugin.sgml +++ /dev/null @@ -1,39 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfceExternalPanelPlugin - -<!-- ##### SECTION Short_Description ##### --> -External plugin widget. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Implements the <link linkend="XfcePanelPlugin">Panel Plugin interface</link> -for external plugins. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT XfceExternalPanelPlugin ##### --> -<para> -The #XfceExternalPanelPlugin-struct struct contains private data only, and -should be accessed using the functions for the -<link linkend="XfcePanelPlugin">XfcePanelPlugin Interface</link>. -</para> - - -<!-- ##### FUNCTION xfce_external_panel_plugin_new ##### --> -<para> - -</para> - -@argc: -@argv: -@construct: -@Returns: - - diff --git a/docs/API/tmpl/xfce-panel-internal-plugin.sgml b/docs/API/tmpl/xfce-panel-internal-plugin.sgml deleted file mode 100644 index 1fdf6ef2..00000000 --- a/docs/API/tmpl/xfce-panel-internal-plugin.sgml +++ /dev/null @@ -1,42 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfceInternalPanelPlugin - -<!-- ##### SECTION Short_Description ##### --> -Internal panel plugin. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Implements the <link linkend="XfcePanelPlugin">Panel Plugin interface</link> -for internal plugins (loadable modules). -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT XfceInternalPanelPlugin ##### --> -<para> -The #XfceInternalPanelPlugin-struct struct contains private data only, and -should be accessed using the functions for the -<link linkend="XfcePanelPlugin">XfcePanelPlugin Interface</link>. -</para> - - -<!-- ##### FUNCTION xfce_internal_panel_plugin_new ##### --> -<para> - -</para> - -@name: -@id: -@display_name: -@size: -@position: -@construct: -@Returns: - - diff --git a/docs/API/tmpl/xfce-panel-plugin-iface.sgml b/docs/API/tmpl/xfce-panel-plugin-iface.sgml deleted file mode 100644 index 9a6504b2..00000000 --- a/docs/API/tmpl/xfce-panel-plugin-iface.sgml +++ /dev/null @@ -1,306 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfcePanelPlugin - -<!-- ##### SECTION Short_Description ##### --> -Panel plugin interface. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The interface implemented by both internal and external plugins. Plugin -writers may use the functions described below to interact with the plugin -widget. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -<link linkend="libxfce4panel-Register-Plugins">Register Plugins</link> -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT XfcePanelPlugin ##### --> -<para> -The #XfcePanelPlugin-struct is a purely virtual object to describe an instance -of a widget implementing the panel plugin interface. -</para> - - -<!-- ##### SIGNAL XfcePanelPlugin::about ##### --> -<para> - -</para> - -@xfcepanelplugin: the object which received the signal. - -<!-- ##### SIGNAL XfcePanelPlugin::configure-plugin ##### --> -<para> - -</para> - -@xfcepanelplugin: the object which received the signal. - -<!-- ##### SIGNAL XfcePanelPlugin::free-data ##### --> -<para> - -</para> - -@xfcepanelplugin: the object which received the signal. - -<!-- ##### SIGNAL XfcePanelPlugin::orientation-changed ##### --> -<para> - -</para> - -@xfcepanelplugin: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL XfcePanelPlugin::save ##### --> -<para> - -</para> - -@xfcepanelplugin: the object which received the signal. - -<!-- ##### SIGNAL XfcePanelPlugin::screen-position-changed ##### --> -<para> - -</para> - -@xfcepanelplugin: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL XfcePanelPlugin::size-changed ##### --> -<para> - -</para> - -@xfcepanelplugin: the object which received the signal. -@arg1: -@Returns: - -<!-- ##### ARG XfcePanelPlugin:display-name ##### --> -<para> - -</para> - -<!-- ##### ARG XfcePanelPlugin:expand ##### --> -<para> - -</para> - -<!-- ##### ARG XfcePanelPlugin:id ##### --> -<para> - -</para> - -<!-- ##### ARG XfcePanelPlugin:name ##### --> -<para> - -</para> - -<!-- ##### ARG XfcePanelPlugin:screen-position ##### --> -<para> - -</para> - -<!-- ##### ARG XfcePanelPlugin:size ##### --> -<para> - -</para> - -<!-- ##### USER_FUNCTION XfcePanelPluginFunc ##### --> -<para> - -</para> - -@plugin: - - -<!-- ##### USER_FUNCTION XfcePanelPluginCheck ##### --> -<para> - -</para> - -@screen: -@Returns: - - -<!-- ##### USER_FUNCTION XfcePanelPluginPreInit ##### --> -<para> - -</para> - -@argc: -@argv: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_get_name ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_get_id ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_get_display_name ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_get_size ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_get_screen_position ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_set_expand ##### --> -<para> - -</para> - -@plugin: -@expand: - - -<!-- ##### FUNCTION xfce_panel_plugin_get_expand ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_get_orientation ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_add_action_widget ##### --> -<para> - -</para> - -@plugin: -@widget: - - -<!-- ##### FUNCTION xfce_panel_plugin_menu_insert_item ##### --> -<para> - -</para> - -@plugin: -@item: - - -<!-- ##### FUNCTION xfce_panel_plugin_menu_show_about ##### --> -<para> - -</para> - -@plugin: - - -<!-- ##### FUNCTION xfce_panel_plugin_menu_show_configure ##### --> -<para> - -</para> - -@plugin: - - -<!-- ##### FUNCTION xfce_panel_plugin_block_menu ##### --> -<para> - -</para> - -@plugin: - - -<!-- ##### FUNCTION xfce_panel_plugin_unblock_menu ##### --> -<para> - -</para> - -@plugin: - - -<!-- ##### FUNCTION xfce_panel_plugin_register_menu ##### --> -<para> - -</para> - -@plugin: -@menu: - - -<!-- ##### FUNCTION xfce_panel_plugin_lookup_rc_file ##### --> -<para> - -</para> - -@plugin: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_save_location ##### --> -<para> - -</para> - -@plugin: -@create: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_plugin_focus_widget ##### --> -<para> - -</para> - -@plugin: -@widget: - - -<!-- ##### FUNCTION xfce_panel_plugin_set_panel_hidden ##### --> -<para> - -</para> - -@plugin: -@hidden: - - diff --git a/docs/API/tmpl/xfce-panel-plugin.sgml b/docs/API/tmpl/xfce-panel-plugin.sgml deleted file mode 100644 index d5607341..00000000 --- a/docs/API/tmpl/xfce-panel-plugin.sgml +++ /dev/null @@ -1,65 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Register Plugins - -<!-- ##### SECTION Short_Description ##### --> -Macros to register a plugin with the Xfce Panel - -<!-- ##### SECTION Long_Description ##### --> -<para> -Each plugin needs a macro to register with the panel. Since a plugin -can be internal or external, you have to choose the appropriate macro -from the 4 below. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL ##### --> -<para> - -</para> - -@construct: - - -<!-- ##### MACRO XFCE_PANEL_PLUGIN_REGISTER_INTERNAL ##### --> -<para> - -</para> - -@construct: - - -<!-- ##### MACRO XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_FULL ##### --> -<para> - -</para> - -@construct: -@init: -@check: - - -<!-- ##### MACRO XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK ##### --> -<para> - -</para> - -@construct: -@check: - - -<!-- ##### MACRO XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK ##### --> -<para> - -</para> - -@construct: -@check: - - diff --git a/docs/API/tmpl/xfce-panel-window.sgml b/docs/API/tmpl/xfce-panel-window.sgml deleted file mode 100644 index 4037b508..00000000 --- a/docs/API/tmpl/xfce-panel-window.sgml +++ /dev/null @@ -1,200 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfcePanelWindow - -<!-- ##### SECTION Short_Description ##### --> -A toplevel borderless window with optional move handles. - -<!-- ##### SECTION Long_Description ##### --> -<para> -A widget derived from #GtkWindow that implements a toplevel window for panels. -It optionally can have one or two move handles. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT XfcePanelWindow ##### --> -<para> -The #XfcePanelWindow-struct struct contains private data only, and -should be accessed using the functions below. -</para> - - -<!-- ##### SIGNAL XfcePanelWindow::move ##### --> -<para> - -</para> - -@xfcepanelwindow: the object which received the signal. -@arg1: -@arg2: - -<!-- ##### SIGNAL XfcePanelWindow::move-end ##### --> -<para> - -</para> - -@xfcepanelwindow: the object which received the signal. -@arg1: -@arg2: - -<!-- ##### SIGNAL XfcePanelWindow::move-start ##### --> -<para> - -</para> - -@xfcepanelwindow: the object which received the signal. - -<!-- ##### SIGNAL XfcePanelWindow::orientation-changed ##### --> -<para> - -</para> - -@xfcepanelwindow: the object which received the signal. -@arg1: - -<!-- ##### ARG XfcePanelWindow:handle-style ##### --> -<para> - -</para> - -<!-- ##### ARG XfcePanelWindow:orientation ##### --> -<para> - -</para> - -<!-- ##### USER_FUNCTION XfcePanelWindowMoveFunc ##### --> -<para> - -</para> - -@widget: -@data: -@x: -@y: - - -<!-- ##### USER_FUNCTION XfcePanelWindowResizeFunc ##### --> -<para> - -</para> - -@widget: -@data: -@previous: -@allocation: -@x: -@y: - - -<!-- ##### FUNCTION xfce_panel_window_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION xfce_panel_window_set_orientation ##### --> -<para> - -</para> - -@window: -@orientation: - - -<!-- ##### FUNCTION xfce_panel_window_get_orientation ##### --> -<para> - -</para> - -@window: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_window_set_handle_style ##### --> -<para> - -</para> - -@window: -@handle_style: - - -<!-- ##### FUNCTION xfce_panel_window_get_handle_style ##### --> -<para> - -</para> - -@window: -@Returns: - - -<!-- ##### FUNCTION xfce_panel_window_set_show_border ##### --> -<para> - -</para> - -@window: -@top_border: -@bottom_border: -@left_border: -@right_border: - - -<!-- ##### FUNCTION xfce_panel_window_get_show_border ##### --> -<para> - -</para> - -@window: -@top_border: -@bottom_border: -@left_border: -@right_border: - - -<!-- ##### FUNCTION xfce_panel_window_set_resize_function ##### --> -<para> - -</para> - -@window: -@function: -@data: - - -<!-- ##### FUNCTION xfce_panel_window_set_move_function ##### --> -<para> - -</para> - -@window: -@function: -@data: - - -<!-- ##### FUNCTION xfce_panel_window_set_movable ##### --> -<para> - -</para> - -@window: -@movable: - - -<!-- ##### FUNCTION xfce_panel_window_get_movable ##### --> -<para> - -</para> - -@window: -@Returns: - - diff --git a/docs/API/version.xml.in b/docs/API/version.xml.in deleted file mode 100644 index d78bda93..00000000 --- a/docs/API/version.xml.in +++ /dev/null @@ -1 +0,0 @@ -@VERSION@ |