diff options
Diffstat (limited to 'docs')
31 files changed, 0 insertions, 2856 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@ diff --git a/docs/Makefile.am b/docs/Makefile.am deleted file mode 100644 index 580d0454..00000000 --- a/docs/Makefile.am +++ /dev/null @@ -1,5 +0,0 @@ -SUBDIRS = API manual - -html: - make -C manual html - diff --git a/docs/manual/C/Makefile.am b/docs/manual/C/Makefile.am deleted file mode 100644 index 108029d2..00000000 --- a/docs/manual/C/Makefile.am +++ /dev/null @@ -1,16 +0,0 @@ -SUBDIRS = \ - images - -noinst_DATA = \ - xfce4-panel.xml - -docdir=$(datadir)/xfce4/doc/C - -doc_DATA= \ - xfce4-panel.html - -EXTRA_DIST = $(noinst_DATA) $(doc_DATA) - -html: $(srcdir)/xfce4-panel.xml - xsltproc $(srcdir)/../xfce-nochunk.xsl $(srcdir)/xfce4-panel.xml - diff --git a/docs/manual/C/images/Makefile.am b/docs/manual/C/images/Makefile.am deleted file mode 100644 index ab3652c6..00000000 --- a/docs/manual/C/images/Makefile.am +++ /dev/null @@ -1,11 +0,0 @@ -imagesdir = $(datadir)/xfce4/doc/C/images -images_DATA = \ - default_top_panel.png \ - default_bottom_panel.png \ - item_popup.png \ - add_item_dialog.png \ - launcher_properties.png \ - panel_manager.png - -EXTRA_DIST = $(images_DATA) - diff --git a/docs/manual/C/images/add_item_dialog.png b/docs/manual/C/images/add_item_dialog.png Binary files differdeleted file mode 100644 index 7878a8e3..00000000 --- a/docs/manual/C/images/add_item_dialog.png +++ /dev/null diff --git a/docs/manual/C/images/default_bottom_panel.png b/docs/manual/C/images/default_bottom_panel.png Binary files differdeleted file mode 100644 index cf974bb0..00000000 --- a/docs/manual/C/images/default_bottom_panel.png +++ /dev/null diff --git a/docs/manual/C/images/default_top_panel.png b/docs/manual/C/images/default_top_panel.png Binary files differdeleted file mode 100644 index 67809570..00000000 --- a/docs/manual/C/images/default_top_panel.png +++ /dev/null diff --git a/docs/manual/C/images/item_popup.png b/docs/manual/C/images/item_popup.png Binary files differdeleted file mode 100644 index c00fde71..00000000 --- a/docs/manual/C/images/item_popup.png +++ /dev/null diff --git a/docs/manual/C/images/launcher_properties.png b/docs/manual/C/images/launcher_properties.png Binary files differdeleted file mode 100644 index c3ee73b8..00000000 --- a/docs/manual/C/images/launcher_properties.png +++ /dev/null diff --git a/docs/manual/C/images/panel_manager.png b/docs/manual/C/images/panel_manager.png Binary files differdeleted file mode 100644 index daeab35e..00000000 --- a/docs/manual/C/images/panel_manager.png +++ /dev/null diff --git a/docs/manual/C/xfce4-panel.html b/docs/manual/C/xfce4-panel.html deleted file mode 100644 index dcfd7f13..00000000 --- a/docs/manual/C/xfce4-panel.html +++ /dev/null @@ -1,206 +0,0 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Xfce 4 Panel</title><link rel="stylesheet" href="../xfce.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="#xfce4-panel" title="Xfce 4 Panel"><link rel="next" href="#panel-intro" title="Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="xfce4-panel"></a>Xfce 4 Panel</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Jasper</span> <span class="surname">Huijsmans</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:jasper@xfce.org">jasper@xfce.org</a>></code></p></div></div></div></div></div><div><span xmlns="http://www.w3.org/TR/xhtml1/transitional" class="releaseinfo"> - This manual describes <strong xmlns="" class="application"><code>xfce4-panel</code></strong> version 4.4.0. - Last updated: December 2006 - <br></br></span></div><div><p class="copyright">Copyright � 2006 Jasper Huijsmans</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p> - This document is provided under the terms of the GNU GPL, version - 2 or (at your option) any later version. - </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#panel-intro">Introduction</a></span></dt><dd><dl><dt><span class="sect2"><a href="#panel-getting-started">Getting Started</a></span></dt><dt><span class="sect2"><a href="#panel-getting-started-mouse">Mouse Actions</a></span></dt><dt><span class="sect2"><a href="#panel-getting-started-configure">Customizing the Panel</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-getting-started-items">Panel Items</a></span></dt><dd><dl><dt><span class="sect2"><a href="#launcher-item-dialog">Add New Items</a></span></dt><dt><span class="sect2"><a href="#launcher-item">Launcher</a></span></dt><dt><span class="sect2"><a href="#other-items">Other Items</a></span></dt><dt><span class="sect2"><a href="#xfce-goodies">Xfce Goodies</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-manager">Panel Manager</a></span></dt><dd><dl><dt><span class="sect2"><a href="#panel-selector">Select Panel</a></span></dt><dt><span class="sect2"><a href="#panel-appearance">Appearance</a></span></dt><dt><span class="sect2"><a href="#panel-position">Position</a></span></dt><dt><span class="sect2"><a href="#panel-monitor">Select Monitor</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-advanced">Advanced Configuration</a></span></dt><dd><dl><dt><span class="sect2"><a href="#panel-config-files">Configuration Files</a></span></dt><dt><span class="sect2"><a href="#panel-data-files">Data Files</a></span></dt><dt><span class="sect2"><a href="#panel-kiosk">Kiosk Mode</a></span></dt></dl></dd><dt><span class="sect1"><a href="#panel-copyright">About <strong class="application"><code>xfce4-panel</code></strong></a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-intro"></a>Introduction</h2></div></div></div><p> - The Xfce 4 panel is part of the <a href="http://www.xfce.org" target="_top">Xfce 4 Desktop Environment</a> and features program - launchers, panel menus, a clock, a graphical pager and more. Many - aspects of the panel can be configured through graphical dialogs. This - manual should provide you with all necessary information on how to adjust - the panel to your liking. - </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-getting-started"></a>Getting Started</h3></div></div></div><p> - The panel will usually be started as part of your Xfce session. For - convenience, Xfce provides the <strong class="application"><code>startxfce4</code></strong> - script. The command for the panel is <strong class="application"><code>xfce4-panel</code></strong>. - </p><p> - When you first start the panel you will see a bar appearing at the top - of the screen and a smaller one at the bottom. Both panels are managed - by the same <strong class="application"><code>xfce4-panel</code></strong> program. You can add and remove panels from the - <a href="#panel-manager" target="_top">Panel Manager</a>. - </p><div class="figure"><a name="default-top-panel-fig"></a><p class="title"><b>Figure�1.�Default Top Panel</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/default_top_panel.png" alt="The default top panel configuration."></div></div></div></div><br class="figure-break"><div class="figure"><a name="default-bottom-panel-fig"></a><p class="title"><b>Figure�2.�Default Bottom Panel</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/default_bottom_panel.png" alt="The default bottom panel configuration."></div></div></div></div><br class="figure-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-getting-started-mouse"></a>Mouse Actions</h3></div></div></div><p> - The Xfce Panel makes extensive use of left and right mouse buttons. Left - clicking performs the default action of an item and right-clicking - brings up a context menu. Ctrl + left click may generally be used as - alternative for a right-click. Note that this manual assumes the use of a - right-handed mouse configuration. - </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-getting-started-configure"></a>Customizing the Panel</h3></div></div></div><p> - Right-clicking on an item will pop up a menu from which you can - configure the item, move it to a new location, or remove it from the - panel. The menu also allows you to configure the panel(s) or add new - items. - </p><div class="figure"><a name="item-popup-fig"></a><p class="title"><b>Figure�3.�Item Popup Menu</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/item_popup.png" alt="Popup menu of a launcher item."></div></div></div></div><br class="figure-break"></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-getting-started-items"></a>Panel Items</h2></div></div></div><p> - The Xfce 4 panel has the possibility to load external plugins as well - as builtin ones. In this section we will only describe panel items that - are installed with the panel. - </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="launcher-item-dialog"></a>Add New Items</h3></div></div></div><p> - When you choose the 'Add Items' option from the right-click mouse menu of - a panel item, a dialog is opened showing all available panel items. Some - items can appear only once on the panel, e.g. the system tray, and they - will appear greyed out when another instance is already present. A search - box allows you to type a filter term to limit the number of choices in - the list. - </p><div class="figure"><a name="add-item-dialog-fig"></a><p class="title"><b>Figure�4.�Add Item Dialog</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/add_item_dialog.png" alt="Dialog with all available panel items."></div></div></div></div><br class="figure-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="launcher-item"></a>Launcher</h3></div></div></div><p>The most common panel item is the launcher item. It allows you to - start programs from the panel. The properties dialog allows you to edit - or add one or more programs. - </p><p> - The first entry in the list is shown on the panel. When more programs - are added they are shown in a menu that can be accessed by clicking the - small arrow button that will appear next to the main launcher icon. - </p><p> - Every item has several options you can edit: name, comment (tooltip), - icon and command. You can select whether the command should be run in a - terminal and whether the program supports startup notification. This - last option allows the window manager to show an hourglass while the - program is loading. - </p><div class="figure"><a name="launcher-fig"></a><p class="title"><b>Figure�5.�Launcher Item Properties</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/launcher_properties.png" alt="Shows properties dialog for a launcher item."></div></div></div></div><br class="figure-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="other-items"></a>Other Items</h3></div></div></div><p> - Besides launchers the panel comes with several other items. We will - shortly list them here. As always, the best way to find out if they may - be useful is to try them. - </p><div class="variablelist"><dl><dt><span class="term">Xfce Clock</span></dt><dd><p> - Simple clock item. You can choose between LED, digital and analog - mode. - </p></dd><dt><span class="term">Graphical Pager</span></dt><dd><p> - Shows a miniature view of the workspaces and even allows you to - move windows to another workspace by dragging the mini-window in - the pager. You can change workspaces by using the mouse scroll - wheel when the mouse is over the pager. - </p></dd><dt><span class="term">Task List</span></dt><dd><p> - Shows running applications in a button with icon and application - name. Clicking on the button will focus or minimize the - application. There's also a right-click menu with more window - actions. - </p></dd><dt><span class="term">Window List</span></dt><dd><p> - Shows running applications in a popup menu. Optionally shows - active application on the panel. - </p></dd><dt><span class="term">Icon Box</span></dt><dd><p> - A third alternative to show running applications, in this case - using a button with only an icon. - </p></dd><dt><span class="term">System Tray</span></dt><dd><p> - Allows applications to show a so called notification or status - icon. This is used for example by some media players and instant - messaging clients. - </p></dd><dt><span class="term">Show Desktop Button</span></dt><dd><p> - When clicked it will show the desktop by minimizing all programs. - Clicking again will restore the windows to their previous state. - </p></dd><dt><span class="term">Action Buttons</span></dt><dd><p> - Show one or two small buttons that execute a special system action. - Two actions are available: quit the session and lock the screen. - </p></dd><dt><span class="term">Separator</span></dt><dd><p> - A separator item shows a line or an empty space between two other - items. Can optionally expand to fill all available space; this can - be used on a full width panel to have items on both ends of the - panel and empty space in between. - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfce-goodies"></a>Xfce Goodies</h3></div></div></div><p> - Many more plugins for the Xfce Panel are available from the - <a href="http://goodies.xfce.org" target="_top">Xfce Goodies</a> - project. - </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-manager"></a>Panel Manager</h2></div></div></div><p> - The Panel Manager can be opened from the Xfce Settings Manager or from the - right-click menu on one of the panel items. - </p><div class="figure"><a name="panel-manager-fig"></a><p class="title"><b>Figure�6.�Panel Manager</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/panel_manager.png" alt="Panel Manager dialog."></div></div></div></div><br class="figure-break"><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-selector"></a>Select Panel</h3></div></div></div><p> - The currently active panel is selected by default or the one that was - last active if there is no active panel. You can choose another panel - from the option menu. Next to this menu are two buttons to add a new - panel or remove the current panel. - </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-appearance"></a>Appearance</h3></div></div></div><div class="variablelist"><dl><dt><span class="term">Size</span></dt><dd><p> - Choose the size in pixels for the panel. This is the height - for horizontal panels and the width for vertical panels. - </p></dd><dt><span class="term">Transparency</span></dt><dd><p> - If your system and the window manager support it, you can set the - transparency level of the panel. You can also choose if you would - like the panel to become fully visible when the mouse moves over - it. - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-position"></a>Position</h3></div></div></div><p> - There are two ways to choose the position of a panel: use a fixed - position or make a panel freely moveable. - </p><div class="variablelist"><dl><dt><span class="term">Fixed Position</span></dt><dd><p> - A panel can be placed in one of twelve positions on the edge of - the screen. You can choose whether the panel should be stretched - to fit the entire width or height of the screen. When the autohide - option is selected the panel will collapse to a thin line and - reappear when the mouse is moved over it. - </p></dd><dt><span class="term">Freely Moveable</span></dt><dd><p> - A freely moveable panel has one or two move handles by which you - can drag the panel anywhere on the screen. You can select the - orientation and where to put a move handle (on one or both sides - of the panel). - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-monitor"></a>Select Monitor</h3></div></div></div><p> - If you use a Xinerama or multihead setup, you can choose on which - monitor you would like the panel to appear. - </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-advanced"></a>Advanced Configuration</h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-config-files"></a>Configuration Files</h3></div></div></div><p> - Xfce uses the Basedir Specification as defined on - <a href="http://freedesktop.org" target="_top">Freedesktop.org</a> to locate its - data and configuration files. This means that file locations will be - specified as a path relative to the directories described in the - specification. - </p><div class="variablelist"><dl><dt><span class="term">${XDG_CONFIG_HOME}</span></dt><dd><p> - The first base directory to look for configuration - files. By default this is set to <code class="filename">~/.config/</code>. - </p></dd><dt><span class="term">${XDG_CONFIG_DIRS}</span></dt><dd><p> - A list of system directories that contain configuration data. By - default the panel will look in <code class="filename">${sysconfdir}/xdg/</code> and - <code class="filename">/etc/xdg/</code>. The value of - ${sysconfdir} depends on how the program was build and will often be - <code class="filename">/etc/</code> for binary packages. - </p></dd><dt><span class="term"><basedir>/xfce4/panel/panels.xml</span></dt><dd><p> - This is the location of the xml configuration file that describes - the contents of the panel, relative to the base directories metioned - above. - </p></dd><dt><span class="term"><basedir>/xfce4/kiosk/kioskrc</span></dt><dd><p> - Kiosk Mode configuration file. See <a href="#panel-kiosk" target="_top">below</a> for an explanation. - </p></dd></dl></div><p> - None of the configuration files, except <code class="filename">kioskrc</code>, are - designed to be edited by hand; in fact the changes will be overwritten if - you edit them while the panel is running. - </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-data-files"></a>Data Files</h3></div></div></div><p> - The Xfce Panel will look under the data directories specified by the - Basedir Specification for data files, such as panel plugin description - files. - </p><div class="variablelist"><dl><dt><span class="term">${XDG_DATA_HOME}</span></dt><dd><p> - The first base directory to look for panel plugin files. By - default this is set to <code class="filename">~/.local/share/</code>. - </p></dd><dt><span class="term">${XDG_DATA_DIRS}</span></dt><dd><p> - A list of system directories that contain data files. By default - this is <code class="filename">/usr/share</code> and - <code class="filename">/usr/local/share</code>. - </p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="panel-kiosk"></a>Kiosk Mode</h3></div></div></div><p> - The panel now has support for Kiosk Mode, that will prevent users from - making changes to their panel configuration. To use it you have to edit - or create the file - <code class="filename">${sysconfdir}/xdg/xfce4/kiosk/kioskrc</code>. - </p><p> - The best way to explain the format of this file is by using an example. - The xfce4-panel section of your kioskrc might look like this: - </p><pre class="programlisting"> -[xfce4-panel] -CustomizePanel=%powerusers,foo -</pre><p> - This allows only users in the group powerusers and the user foo to - customize their panels. - </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="panel-copyright"></a>About <strong class="application"><code>xfce4-panel</code></strong></h2></div></div></div><p> - The maintainers of <strong class="application"><code>xfce4-panel</code></strong> are Jasper Huijsmans - <code class="email"><<a href="mailto:jasper@xfce.org">jasper@xfce.org</a>></code> and Nick Schermer - <code class="email"><<a href="mailto:nick@xfce.org">nick@xfce.org</a>></code>. For more information about Xfce and its - components, visit the - <a href="http://www.xfce.org" target="_top">Xfce web site</a>. - </p><p> - To report a bug or make a suggestion regarding this application or this - manual, please use the bug tracking system at - <a href="http://bugzilla.xfce.org/" target="_top">http://bugzilla.xfce.org/</a>. - </p><p> - If you have questions about the use or installation of this package, please - ask on the - <a href="http://foo-projects.org/mailman/listinfo/xfce" target="_top">xfce</a> mailing list. Development discussion takes - place on the - <a href="http://foo-projects.org/mailman/listinfo/xfce4-dev" target="_top">xfce4-dev</a> mailing list. - </p><p> - <strong class="application"><code>xfce4-panel</code></strong> is distributed under the terms of the GNU General Public License as - published by the Free Software Foundation; either version 2 of the License, - or (at your option) any later version. - </p><p> - You should have received a copy of the GNU General Public License along with - this program; if not, write to the Free Software Foundation, Inc., - 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - </p></div></div></body></html> diff --git a/docs/manual/C/xfce4-panel.xml b/docs/manual/C/xfce4-panel.xml deleted file mode 100644 index 12bb9e7e..00000000 --- a/docs/manual/C/xfce4-panel.xml +++ /dev/null @@ -1,650 +0,0 @@ -<?xml version='1.0'?> -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - <!ENTITY manrevision "1.0"> - <!ENTITY date "December 2006"> - <!ENTITY appversion "4.4.0"> - <!ENTITY app "<application>xfce4-panel</application>"> -]> - -<article id="xfce4-panel" lang="en"> - -<!-- Header --> -<articleinfo> - - <title>Xfce 4 Panel</title> - - <copyright> - <year>2006</year> <holder>Jasper Huijsmans</holder> - </copyright> - -<!-- translators: uncomment this: - - <copyright> - <year>2002</year> <holder>ME-THE-TRANSLATOR (Latin - translation)</holder> - </copyright> - - --> - -<!-- I don't know about this --> - <legalnotice id="legalnotice"> - <para> - This document is provided under the terms of the GNU GPL, version - 2 or (at your option) any later version. - </para> - </legalnotice> - - <authorgroup> - - <author> - <firstname>Jasper</firstname> <surname>Huijsmans</surname> - <affiliation> - <address><email>jasper@xfce.org</email></address> - </affiliation> - </author> - -<!-- This is appropriate place for other contributors: translators, -maintainers, etc. Commented out by default. - - <othercredit role="translator"> - <firstname>Latin</firstname> <surname>Translator 1</surname> - <affiliation> - <orgname>Latin Translation Team</orgname> - <address><email>translator@gnome.org</email> </address> - </affiliation> <contrib>Latin translation</contrib> - </othercredit> ---> - - </authorgroup> - - <!-- - <revhistory> - <revision> - <revnumber>1.0</revnumber> - <date>June 2006</date> - <authorinitials>jbh</authorinitials> - </revision> - </revhistory> - --> - - <releaseinfo> - This manual describes &app; version &appversion;. - Last updated: &date; - </releaseinfo> - -</articleinfo> - -<sect1 id="panel-intro"> - <title>Introduction</title> - - <para> - The Xfce 4 panel is part of the <ulink url="http://www.xfce.org" - type="html">Xfce 4 Desktop Environment</ulink> and features program - launchers, panel menus, a clock, a graphical pager and more. Many - aspects of the panel can be configured through graphical dialogs. This - manual should provide you with all necessary information on how to adjust - the panel to your liking. - </para> - - <sect2 id="panel-getting-started"> - <title>Getting Started</title> - - <para> - The panel will usually be started as part of your Xfce session. For - convenience, Xfce provides the <application>startxfce4</application> - script. The command for the panel is &app;. - </para> - - <para> - When you first start the panel you will see a bar appearing at the top - of the screen and a smaller one at the bottom. Both panels are managed - by the same &app; program. You can add and remove panels from the - <ulink url="#panel-manager">Panel Manager</ulink>. - </para> - - <figure id="default-top-panel-fig"> - <title>Default Top Panel</title> - <screenshot> - <mediaobject> - <imageobject> - <imagedata fileref="images/default_top_panel.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>The default top panel configuration.</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> - - <figure id="default-bottom-panel-fig"> - <title>Default Bottom Panel</title> - <screenshot> - <mediaobject> - <imageobject> - <imagedata fileref="images/default_bottom_panel.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>The default bottom panel configuration.</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> - </sect2> - - <sect2 id="panel-getting-started-mouse"> - <title>Mouse Actions</title> - - <para> - The Xfce Panel makes extensive use of left and right mouse buttons. Left - clicking performs the default action of an item and right-clicking - brings up a context menu. Ctrl + left click may generally be used as - alternative for a right-click. Note that this manual assumes the use of a - right-handed mouse configuration. - </para> - </sect2> - - <sect2 id="panel-getting-started-configure"> - <title>Customizing the Panel</title> - - <para> - Right-clicking on an item will pop up a menu from which you can - configure the item, move it to a new location, or remove it from the - panel. The menu also allows you to configure the panel(s) or add new - items. - </para> - - <figure id="item-popup-fig"> - <title>Item Popup Menu</title> - <screenshot> - <mediaobject> - <imageobject> - <imagedata fileref="images/item_popup.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Popup menu of a launcher item.</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> - </sect2> - -</sect1> - -<sect1 id="panel-getting-started-items"> - <title>Panel Items</title> - - <para> - The Xfce 4 panel has the possibility to load external plugins as well - as builtin ones. In this section we will only describe panel items that - are installed with the panel. - </para> - - <sect2 id="launcher-item-dialog"> - <title>Add New Items</title> - - <para> - When you choose the 'Add Items' option from the right-click mouse menu of - a panel item, a dialog is opened showing all available panel items. Some - items can appear only once on the panel, e.g. the system tray, and they - will appear greyed out when another instance is already present. A search - box allows you to type a filter term to limit the number of choices in - the list. - </para> - - <figure id="add-item-dialog-fig"> - <title>Add Item Dialog</title> - <screenshot> - <mediaobject> - <imageobject> - <imagedata fileref="images/add_item_dialog.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Dialog with all available panel items.</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> - </sect2> - - <sect2 id="launcher-item"> - <title>Launcher</title> - - <para>The most common panel item is the launcher item. It allows you to - start programs from the panel. The properties dialog allows you to edit - or add one or more programs. - </para> - - <para> - The first entry in the list is shown on the panel. When more programs - are added they are shown in a menu that can be accessed by clicking the - small arrow button that will appear next to the main launcher icon. - </para> - - <para> - Every item has several options you can edit: name, comment (tooltip), - icon and command. You can select whether the command should be run in a - terminal and whether the program supports startup notification. This - last option allows the window manager to show an hourglass while the - program is loading. - </para> - - <figure id="launcher-fig"> - <title>Launcher Item Properties</title> - <screenshot> - <mediaobject> - <imageobject> - <imagedata fileref="images/launcher_properties.png" - format="PNG"/> - </imageobject> - <textobject> - <phrase>Shows properties dialog for a launcher item.</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> - </sect2> - - <sect2 id="other-items"> - <title>Other Items</title> - - <para> - Besides launchers the panel comes with several other items. We will - shortly list them here. As always, the best way to find out if they may - be useful is to try them. - </para> - - <variablelist> - - <varlistentry> - <term>Xfce Clock</term> - <listitem> - <para> - Simple clock item. You can choose between LED, digital and analog - mode. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Graphical Pager</term> - <listitem> - <para> - Shows a miniature view of the workspaces and even allows you to - move windows to another workspace by dragging the mini-window in - the pager. You can change workspaces by using the mouse scroll - wheel when the mouse is over the pager. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Task List</term> - <listitem> - <para> - Shows running applications in a button with icon and application - name. Clicking on the button will focus or minimize the - application. There's also a right-click menu with more window - actions. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Window List</term> - <listitem> - <para> - Shows running applications in a popup menu. Optionally shows - active application on the panel. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Icon Box</term> - <listitem> - <para> - A third alternative to show running applications, in this case - using a button with only an icon. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>System Tray</term> - <listitem> - <para> - Allows applications to show a so called notification or status - icon. This is used for example by some media players and instant - messaging clients. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Show Desktop Button</term> - <listitem> - <para> - When clicked it will show the desktop by minimizing all programs. - Clicking again will restore the windows to their previous state. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Action Buttons</term> - <listitem> - <para> - Show one or two small buttons that execute a special system action. - Two actions are available: quit the session and lock the screen. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Separator</term> - <listitem> - <para> - A separator item shows a line or an empty space between two other - items. Can optionally expand to fill all available space; this can - be used on a full width panel to have items on both ends of the - panel and empty space in between. - </para> - </listitem> - </varlistentry> - - </variablelist> - </sect2> - - <sect2 id="xfce-goodies"> - <title>Xfce Goodies</title> - - <para> - Many more plugins for the Xfce Panel are available from the - <ulink url="http://goodies.xfce.org" type="html">Xfce Goodies</ulink> - project. - </para> - </sect2> - -</sect1> - -<sect1 id="panel-manager"> - <title>Panel Manager</title> - - <para> - The Panel Manager can be opened from the Xfce Settings Manager or from the - right-click menu on one of the panel items. - </para> - - <figure id="panel-manager-fig"> - <title>Panel Manager</title> - <screenshot> - <mediaobject> - <imageobject> - <imagedata fileref="images/panel_manager.png" - format="PNG"/> - </imageobject> - <textobject> - <phrase>Panel Manager dialog.</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> - - <sect2 id="panel-selector"> - <title>Select Panel</title> - - <para> - The currently active panel is selected by default or the one that was - last active if there is no active panel. You can choose another panel - from the option menu. Next to this menu are two buttons to add a new - panel or remove the current panel. - </para> - </sect2> - - <sect2 id="panel-appearance"> - <title>Appearance</title> - - <variablelist> - <varlistentry> - <term>Size</term> - <listitem> - <para> - Choose the size in pixels for the panel. This is the height - for horizontal panels and the width for vertical panels. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Transparency</term> - <listitem> - <para> - If your system and the window manager support it, you can set the - transparency level of the panel. You can also choose if you would - like the panel to become fully visible when the mouse moves over - it. - </para> - </listitem> - </varlistentry> - </variablelist> - </sect2> - - <sect2 id="panel-position"> - <title>Position</title> - - <para> - There are two ways to choose the position of a panel: use a fixed - position or make a panel freely moveable. - </para> - - <variablelist> - <varlistentry> - <term>Fixed Position</term> - <listitem> - <para> - A panel can be placed in one of twelve positions on the edge of - the screen. You can choose whether the panel should be stretched - to fit the entire width or height of the screen. When the autohide - option is selected the panel will collapse to a thin line and - reappear when the mouse is moved over it. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Freely Moveable</term> - <listitem> - <para> - A freely moveable panel has one or two move handles by which you - can drag the panel anywhere on the screen. You can select the - orientation and where to put a move handle (on one or both sides - of the panel). - </para> - </listitem> - </varlistentry> - </variablelist> - </sect2> - - <sect2 id="panel-monitor"> - <title>Select Monitor</title> - - <para> - If you use a Xinerama or multihead setup, you can choose on which - monitor you would like the panel to appear. - </para> - </sect2> - -</sect1> - -<sect1 id="panel-advanced"> - <title>Advanced Configuration</title> - - <sect2 id="panel-config-files"> - <title>Configuration Files</title> - - <para> - Xfce uses the Basedir Specification as defined on - <ulink url="http://freedesktop.org">Freedesktop.org</ulink> to locate its - data and configuration files. This means that file locations will be - specified as a path relative to the directories described in the - specification. - </para> - - <variablelist> - <varlistentry> - <term>${XDG_CONFIG_HOME}</term> - <listitem> - <para> - The first base directory to look for configuration - files. By default this is set to <filename - role="directory">~/.config/</filename>. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>${XDG_CONFIG_DIRS}</term> - <listitem> - <para> - A list of system directories that contain configuration data. By - default the panel will look in <filename - role="directory">${sysconfdir}/xdg/</filename> and - <filename role="directory">/etc/xdg/</filename>. The value of - ${sysconfdir} depends on how the program was build and will often be - <filename role="directory">/etc/</filename> for binary packages. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><basedir>/xfce4/panel/panels.xml</term> - <listitem> - <para> - This is the location of the xml configuration file that describes - the contents of the panel, relative to the base directories metioned - above. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><basedir>/xfce4/kiosk/kioskrc</term> - <listitem> - <para> - Kiosk Mode configuration file. See <ulink - url="#panel-kiosk">below</ulink> for an explanation. - </para> - </listitem> - </varlistentry> - </variablelist> - - <para> - None of the configuration files, except <filename>kioskrc</filename>, are - designed to be edited by hand; in fact the changes will be overwritten if - you edit them while the panel is running. - </para> - </sect2> - - <sect2 id="panel-data-files"> - <title>Data Files</title> - - <para> - The Xfce Panel will look under the data directories specified by the - Basedir Specification for data files, such as panel plugin description - files. - </para> - - <variablelist> - <varlistentry> - <term>${XDG_DATA_HOME}</term> - <listitem> - <para> - The first base directory to look for panel plugin files. By - default this is set to <filename - role="directory">~/.local/share/</filename>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>${XDG_DATA_DIRS}</term> - <listitem> - <para> - A list of system directories that contain data files. By default - this is <filename role="directory">/usr/share</filename> and - <filename role="directory">/usr/local/share</filename>. - </para> - </listitem> - </varlistentry> - </variablelist> - </sect2> - - <sect2 id="panel-kiosk"> - <title>Kiosk Mode</title> - - <para> - The panel now has support for Kiosk Mode, that will prevent users from - making changes to their panel configuration. To use it you have to edit - or create the file - <filename>${sysconfdir}/xdg/xfce4/kiosk/kioskrc</filename>. - </para> - - <para> - The best way to explain the format of this file is by using an example. - The xfce4-panel section of your kioskrc might look like this: - </para> - -<programlisting> -[xfce4-panel] -CustomizePanel=%powerusers,foo -</programlisting> - - <para> - This allows only users in the group powerusers and the user foo to - customize their panels. - </para> - </sect2> - -</sect1> - -<sect1 id="panel-copyright"> - <title>About &app;</title> - - <para> - The maintainers of &app; are Jasper Huijsmans - <email>jasper@xfce.org</email> and Nick Schermer - <email>nick@xfce.org</email>. For more information about Xfce and its - components, visit the - <ulink url="http://www.xfce.org" type="http">Xfce web site</ulink>. - </para> - - <para> - To report a bug or make a suggestion regarding this application or this - manual, please use the bug tracking system at - <ulink url="http://bugzilla.xfce.org/" - type="http">http://bugzilla.xfce.org/</ulink>. - </para> - - <para> - If you have questions about the use or installation of this package, please - ask on the - <ulink url="http://foo-projects.org/mailman/listinfo/xfce" - type="http">xfce</ulink> mailing list. Development discussion takes - place on the - <ulink url="http://foo-projects.org/mailman/listinfo/xfce4-dev" - type="http">xfce4-dev</ulink> mailing list. - </para> - - <para> - &app; is distributed under the terms of the GNU General Public License as - published by the Free Software Foundation; either version 2 of the License, - or (at your option) any later version. - </para> - - <para> - You should have received a copy of the GNU General Public License along with - this program; if not, write to the Free Software Foundation, Inc., - 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - </para> - -</sect1> - -</article> diff --git a/docs/manual/Makefile.am b/docs/manual/Makefile.am deleted file mode 100644 index c4e8a560..00000000 --- a/docs/manual/Makefile.am +++ /dev/null @@ -1,11 +0,0 @@ -SUBDIRS = \ - C - -noinst_DATA = \ - xfce-nochunk.xsl - -EXTRA_DIST = $(noinst_DATA) - -html: Makefile - for i in $(SUBDIRS); do make -C $$i html; done - diff --git a/docs/manual/xfce-nochunk.xsl b/docs/manual/xfce-nochunk.xsl deleted file mode 100644 index cb8ce725..00000000 --- a/docs/manual/xfce-nochunk.xsl +++ /dev/null @@ -1,262 +0,0 @@ -<?xml version='1.0'?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - version='1.0' - xmlns="http://www.w3.org/TR/xhtml1/transitional" - exclude-result-prefixes="#default"> - -<!-- Load onechunk.xsl stylesheet - TODO: how can I put a location independent link here? -This should work. The url can be translated to a local one in the catalog -file" ---> -<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/onechunk.xsl"/> - -<xsl:param name="suppress.navigation">1</xsl:param> - -<!-- Use stylesheet --> -<xsl:param name="html.stylesheet" select="'../xfce.css'"/> - -<!-- labels and numbering --> -<xsl:param name="autotoc.label.separator" select="'. '"/> -<xsl:param name="chapter.autolabel" select="1"/> - -<!-- Don't force the use of index.html as root filename --> -<xsl:param name="root.filename" select="''"/> - -<!-- Use element id (if present) as file name --> -<xsl:variable name="use.id.as.filename">1</xsl:variable> - -<xsl:template match="releaseinfo" mode="titlepage.mode"> - <span class="{name(.)}"> - <xsl:apply-templates mode="titlepage.mode"/> - <br/> - </span> -</xsl:template> - -<!-- Use graphics in admonitions (note, warning, etc) --> -<xsl:variable name="admon.graphics">0</xsl:variable> - -<xsl:param name="admon.style"> - <xsl:text>text-align: left;</xsl:text></xsl:param> - -<xsl:variable name="admon.graphics.path">stylesheet-images/</xsl:variable> - -<xsl:variable name="admon.graphics.extension">.gif</xsl:variable> - -<xsl:param name="table.border.thickness" select="'0.2pt'"/> - -<xsl:param name="graphic.default.extension" select="png"/> - -<!-- Addition by Jasper Huijsmans to be able to set background color --> -<!-- and cell attributes. --> -<!-- This requires an adapted template for tgroup (see end of stylesheet) --> -<xsl:attribute-set name="table.style"> - <xsl:attribute name="bgcolor">#F8F9FD</xsl:attribute> - <xsl:attribute name="cellspacing">0</xsl:attribute> - <xsl:attribute name="cellpadding">4</xsl:attribute> -</xsl:attribute-set> - - -<xsl:param name="generate.legalnotice.link" select="0"/> - -<!-- set font styles for various tags --> -<xsl:template match="guibutton"> -<xsl:call-template name="inline.boldseq"/> -</xsl:template> - -<xsl:template match="guiicon"> -<xsl:call-template name="inline.boldseq"/> -</xsl:template> - -<xsl:template match="guilabel"> -<xsl:call-template name="inline.boldseq"/> -</xsl:template> - -<xsl:template match="guimenu"> -<xsl:call-template name="inline.boldseq"/> -</xsl:template> - -<xsl:template match="guimenuitem"> -<xsl:call-template name="inline.boldseq"/> -</xsl:template> - -<xsl:template match="guisubmenu"> -<xsl:call-template name="inline.boldseq"/> -</xsl:template> - -<xsl:template match="application"> -<xsl:call-template name="inline.boldmonoseq"/> -</xsl:template> - -<xsl:template match="caption"> -<xsl:call-template name="inline.boldseq"/> -</xsl:template> - -<!-- Adapted template for tgroup. The only change is the addition of --> -<!-- table.style attributes --> -<xsl:template match="tgroup"> - <table xsl:use-attribute-sets="table.style"> - <xsl:choose> - <!-- If there's a <?dbhtml table-summary="foo"?> PI, use it for - the HTML table summary attribute --> - <xsl:when test="processing-instruction('dbhtml')"> - <xsl:variable name="summary"> - <xsl:call-template name="dbhtml-attribute"> - <xsl:with-param name="pis" - select="processing-instruction('dbhtml')[1]"/> - <xsl:with-param name="attribute" select="'table-summary'"/> - </xsl:call-template> - </xsl:variable> - <xsl:if test="$summary != ''"> - <xsl:attribute name="summary"> - <xsl:value-of select="$summary"/> - </xsl:attribute> - </xsl:if> - </xsl:when> - <!-- Otherwise, if there's a title, use that --> - <xsl:when test="../title"> - <xsl:attribute name="summary"> - <xsl:value-of select="string(../title)"/> - </xsl:attribute> - </xsl:when> - <!-- Otherwise, forget the whole idea --> - <xsl:otherwise><!-- nevermind --></xsl:otherwise> - </xsl:choose> - - <xsl:if test="../@pgwide=1"> - <xsl:attribute name="width">100%</xsl:attribute> - </xsl:if> - - <xsl:choose> - <xsl:when test="../@frame='none'"> - <xsl:attribute name="border">0</xsl:attribute> - </xsl:when> - <xsl:when test="$table.borders.with.css != 0"> - <xsl:attribute name="border">0</xsl:attribute> - <xsl:choose> - <xsl:when test="../@frame='topbot' or ../@frame='top'"> - <xsl:attribute name="style"> - <xsl:call-template name="border"> - <xsl:with-param name="side" select="'top'"/> - </xsl:call-template> - </xsl:attribute> - </xsl:when> - <xsl:when test="../@frame='sides'"> - <xsl:attribute name="style"> - <xsl:call-template name="border"> - <xsl:with-param name="side" select="'left'"/> - </xsl:call-template> - <xsl:call-template name="border"> - <xsl:with-param name="side" select="'right'"/> - </xsl:call-template> - </xsl:attribute> - </xsl:when> - </xsl:choose> - </xsl:when> - <xsl:otherwise> - <xsl:attribute name="border">1</xsl:attribute> - </xsl:otherwise> - </xsl:choose> - - <xsl:variable name="colgroup"> - <colgroup> - <xsl:call-template name="generate.colgroup"> - <xsl:with-param name="cols" select="@cols"/> - </xsl:call-template> - </colgroup> - </xsl:variable> - - <xsl:variable name="explicit.table.width"> - <xsl:call-template name="dbhtml-attribute"> - <xsl:with-param name="pis" - select="../processing-instruction('dbhtml')[1]"/> - <xsl:with-param name="attribute" select="'table-width'"/> - </xsl:call-template> - </xsl:variable> - - <xsl:variable name="table.width"> - <xsl:choose> - <xsl:when test="$explicit.table.width != ''"> - <xsl:value-of select="$explicit.table.width"/> - </xsl:when> - <xsl:when test="$default.table.width = ''"> - <xsl:text>100%</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="$default.table.width"/> - </xsl:otherwise> - </xsl:choose> - </xsl:variable> - - <xsl:if test="$default.table.width != '' - or $explicit.table.width != ''"> - <xsl:attribute name="width"> - <xsl:choose> - <xsl:when test="contains($table.width, '%')"> - <xsl:value-of select="$table.width"/> - </xsl:when> - <xsl:when test="$use.extensions != 0 - and $tablecolumns.extension != 0"> - <xsl:choose> - <xsl:when test="function-available('stbl:convertLength')"> - <xsl:value-of select="stbl:convertLength($table.width)"/> - </xsl:when> - <xsl:when test="function-available('xtbl:convertLength')"> - <xsl:value-of select="xtbl:convertLength($table.width)"/> - </xsl:when> - <xsl:otherwise> - <xsl:message terminate="yes"> - <xsl:text>No convertLength function available.</xsl:text> - </xsl:message> - </xsl:otherwise> - </xsl:choose> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="$table.width"/> - </xsl:otherwise> - </xsl:choose> - </xsl:attribute> - </xsl:if> - - <xsl:choose> - <xsl:when test="$use.extensions != 0 - and $tablecolumns.extension != 0"> - <xsl:choose> - <xsl:when test="function-available('stbl:adjustColumnWidths')"> - <xsl:copy-of select="stbl:adjustColumnWidths($colgroup)"/> - </xsl:when> - <xsl:when test="function-available('xtbl:adjustColumnWidths')"> - <xsl:copy-of select="xtbl:adjustColumnWidths($colgroup)"/> - </xsl:when> - <xsl:otherwise> - <xsl:message terminate="yes"> - <xsl:text>No adjustColumnWidths function available.</xsl:text> - </xsl:message> - </xsl:otherwise> - </xsl:choose> - </xsl:when> - <xsl:otherwise> - <xsl:copy-of select="$colgroup"/> - </xsl:otherwise> - </xsl:choose> - - <xsl:apply-templates select="thead"/> - <xsl:apply-templates select="tbody"/> - <xsl:apply-templates select="tfoot"/> - - <xsl:if test=".//footnote"> - <tbody class="footnotes"> - <tr> - <td colspan="{@cols}"> - <xsl:apply-templates select=".//footnote" - mode="table.footnote.mode"/> - </td> - </tr> - </tbody> - </xsl:if> - </table> -</xsl:template> - - -</xsl:stylesheet> - |