From 1128f2d906d406377bd267c08480ed34886b0331 Mon Sep 17 00:00:00 2001 From: infirit Date: Tue, 22 Oct 2013 15:09:57 +0200 Subject: Remove autogenerated gtk doc files --- .../mate-panel-applet/html/applet-popups.html | 31 - .../mate-panel-applet/html/applet-porting.html | 207 ----- .../mate-panel-applet/html/applet-writing.html | 93 -- doc/reference/mate-panel-applet/html/home.png | Bin 654 -> 0 bytes doc/reference/mate-panel-applet/html/index.html | 64 -- doc/reference/mate-panel-applet/html/index.sgml | 69 -- doc/reference/mate-panel-applet/html/left.png | Bin 459 -> 0 bytes .../html/mate-panel-applet-mate-panel-applet.html | 948 --------------------- .../html/mate-panel-applet.devhelp | 68 -- .../html/mate-panel-applet.devhelp2 | 75 -- .../mate-panel-applet/html/mate-panel-applet.html | 38 - .../mate-panel-applet/html/multi-applets.html | 31 - .../mate-panel-applet/html/panel-signals.html | 31 - doc/reference/mate-panel-applet/html/right.png | Bin 472 -> 0 bytes .../mate-panel-applet/html/server-files.html | 67 -- .../mate-panel-applet/html/session-saving.html | 31 - doc/reference/mate-panel-applet/html/style.css | 265 ------ doc/reference/mate-panel-applet/html/up.png | Bin 406 -> 0 bytes .../tmpl/mate-panel-applet-unused.sgml | 109 --- .../mate-panel-applet/tmpl/mate-panel-applet.sgml | 393 --------- 20 files changed, 2520 deletions(-) delete mode 100644 doc/reference/mate-panel-applet/html/applet-popups.html delete mode 100644 doc/reference/mate-panel-applet/html/applet-porting.html delete mode 100644 doc/reference/mate-panel-applet/html/applet-writing.html delete mode 100644 doc/reference/mate-panel-applet/html/home.png delete mode 100644 doc/reference/mate-panel-applet/html/index.html delete mode 100644 doc/reference/mate-panel-applet/html/index.sgml delete mode 100644 doc/reference/mate-panel-applet/html/left.png delete mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html delete mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp delete mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet.devhelp2 delete mode 100644 doc/reference/mate-panel-applet/html/mate-panel-applet.html delete mode 100644 doc/reference/mate-panel-applet/html/multi-applets.html delete mode 100644 doc/reference/mate-panel-applet/html/panel-signals.html delete mode 100644 doc/reference/mate-panel-applet/html/right.png delete mode 100644 doc/reference/mate-panel-applet/html/server-files.html delete mode 100644 doc/reference/mate-panel-applet/html/session-saving.html delete mode 100644 doc/reference/mate-panel-applet/html/style.css delete mode 100644 doc/reference/mate-panel-applet/html/up.png delete mode 100644 doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml delete mode 100644 doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml (limited to 'doc') diff --git a/doc/reference/mate-panel-applet/html/applet-popups.html b/doc/reference/mate-panel-applet/html/applet-popups.html deleted file mode 100644 index a2002d8c..00000000 --- a/doc/reference/mate-panel-applet/html/applet-popups.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - -Defining a Popup Context Menu - - - - - - - - - - - - - - - - -
-

-Defining a Popup Context Menu

-

FIXME: write

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

-Porting Applets from the MATE 1.x interfaces

-

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

-
-

-Applet Activation

-

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

-

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

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

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

-
-
-

-Activation files

-

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

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

Your .server file should look like -this :

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

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

-
-
-

-Context Menu

-

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

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

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

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

  • -
-

The xml description should look something like this -:

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

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

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

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

-

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

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

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

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

-Writing Applets

- -

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

-
-

-Hello World Applet

-

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

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

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

-

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

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

-Mark McLoughlin -

-


-            
-          

-
-
-
-

Abstract

-

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

-
-
-
-
- -
- - - \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/index.sgml b/doc/reference/mate-panel-applet/html/index.sgml deleted file mode 100644 index 19974235..00000000 --- a/doc/reference/mate-panel-applet/html/index.sgml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/reference/mate-panel-applet/html/left.png b/doc/reference/mate-panel-applet/html/left.png deleted file mode 100644 index 2d05b3d5..00000000 Binary files a/doc/reference/mate-panel-applet/html/left.png and /dev/null differ diff --git a/doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html b/doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html deleted file mode 100644 index 4086c6ad..00000000 --- a/doc/reference/mate-panel-applet/html/mate-panel-applet-mate-panel-applet.html +++ /dev/null @@ -1,948 +0,0 @@ - - - - -MatePanelApplet - - - - - - - - - - - - - - - - - - - -
-
-
- - -
-

MatePanelApplet

-

MatePanelApplet — The MatePanelApplet object.

-
-
-

Synopsis

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

Object Hierarchy

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

Implemented Interfaces

-

-MatePanelApplet implements - AtkImplementorIface and GtkBuildable.

-
-
-

Properties

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

Signals

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

Description

-

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

-

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

-
-
-

Details

-
-

struct MatePanelApplet

-
struct MatePanelApplet;
-

-The MatePanelApplet struct contains private data only. -

-
-
-
-

enum MatePanelAppletOrient

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

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

-
-
-
-

enum MatePanelAppletBackgroundType

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

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

-
-- - - - - - - - - - - - - - -

PANEL_NO_BACKGROUND

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

PANEL_COLOR_BACKGROUND

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

PANEL_PIXMAP_BACKGROUND

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

enum MatePanelAppletFlags

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

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

-
-- - - - - - - - - - - - - - - - - - -

MATE_PANEL_APPLET_FLAGS_NONE

No flags are to be associated with the applet. -

MATE_PANEL_APPLET_EXPAND_MAJOR

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

MATE_PANEL_APPLET_EXPAND_MINOR

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

MATE_PANEL_APPLET_HAS_HANDLE

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

MatePanelAppletFactoryCallback ()

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

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

-

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

-
-- - - - - - - - - - - - - - - - - - -

applet :

The MatePanelApplet. -

iid :

The MateComponent IID of the applet requested. -

user_data :

The data passed to the factory macros. -

Returns :

-TRUE on success, FALSE on failure. -
-
-
-
-

mate_panel_applet_new ()

-
GtkWidget *         mate_panel_applet_new                    (void);
-

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

-
-- - - - -

Returns :

The MatePanelApplet. -
-
-
-
-

mate_panel_applet_get_orient ()

-
MatePanelAppletOrient   mate_panel_applet_get_orient             (MatePanelApplet *applet);
-

-Get the current orientation of the applet. -

-
-- - - - - - - - - - -

applet :

The MatePanelApplet. -

Returns :

The orientation of the applet. -
-
-
-
-

mate_panel_applet_get_size ()

-
guint               mate_panel_applet_get_size               (MatePanelApplet *applet);
-

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

-

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

-
-- - - - - - - - - - -

applet :

The MatePanelApplet. -

Returns :

The panel's size hint. -
-
-
-
-

mate_panel_applet_get_background ()

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

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

-
-- - - - - - - - - - - - - - - - - - -

applet :

A MatePanelApplet. -

color :

A GdkColor to be filled in. -

pixmap :

Returned GdkPixmap. -

Returns :

The background type. -
-
-
-
-

mate_panel_applet_get_preferences_key ()

-
gchar *             mate_panel_applet_get_preferences_key    (MatePanelApplet *applet);
-

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

-
-- - - - - - - - - - -

applet :

The MatePanelApplet. -

Returns :

A MateConf path. -
-
-
-
-

mate_panel_applet_add_preferences ()

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

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

-

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

-
-- - - - - - - - - - - - - - -

applet :

The MatePanelApplet. -

schema_dir :

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

opt_error :

Optional GError. -
-
-
-
-

mate_panel_applet_get_flags ()

-
MatePanelAppletFlags    mate_panel_applet_get_flags              (MatePanelApplet *applet);
-

-Retrieve the MatePanelAppletFlags associated with the applet. -

-
-- - - - - - - - - - -

applet :

The MatePanelApplet. -

Returns :

The MatePanelAppletFlags. -
-
-
-
-

mate_panel_applet_set_flags ()

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

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

-
-- - - - - - - - - - -

applet :

The MatePanelApplet. -

flags :

The MatePanelAppletFlags to associate. -
-
-
-
-

mate_panel_applet_set_size_hints ()

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

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

-

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

-
-- - - - - - - - - - - - - - - - - - -

applet :

The MatePanelApplet. -

size_hints :

Array of size_hints. -

n_elements :

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

base_size :

The base size of the applet. -
-
-
-
-

mate_panel_applet_get_locked_down ()

-
gboolean            mate_panel_applet_get_locked_down        (MatePanelApplet *applet);
-

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

-
-- - - - - - - - - - -

applet :

The MatePanelApplet. -

Returns :

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

mate_panel_applet_request_focus ()

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

-Set keyboard focus to applet. -

-
-- - - - - - - - - - -

applet :

The MatePanelApplet. -

timestamp :

timestamp of the event triggering the window focus -
-
-
-
-

mate_panel_applet_setup_menu ()

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

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

-
-- - - - - - - - - - - - - - -

applet :

A MatePanelApplet. -

xml :

The xml character string describing the popup menu. -

action_group :

-
-
-
-
-

mate_panel_applet_setup_menu_from_file ()

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

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

-
-- - - - - - - - - - - - - - -

applet :

A MatePanelApplet. -

filename :

-

action_group :

-
-
-
-
-

mate_panel_applet_factory_main ()

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

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

-
-- - - - - - - - - - - - - - - - - - - - - - - - - - -

factory_id :

-

out_process :

-

applet_type :

The GType to instantiate. -

callback :

The factory callback. -

data :

The factory user data pointer. -

Returns :

0 on success, 1 on failure. -
-
-
-
-

Property Details

-
-

The "background" property

-
  "background"               gchar*                : Read / Write
-

Panel Applet Background.

-

Default value: NULL

-
-
-
-

The "closure" property

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

The Applet closure.

-
-
-
-

The "connection" property

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

The DBus Connection.

-
-
-
-

The "flags" property

-
  "flags"                    guint                 : Read / Write
-

Panel Applet flags.

-

Default value: 0

-
-
-
-

The "id" property

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

The Applet identifier.

-

Default value: NULL

-
-
-
-

The "locked" property

-
  "locked"                   gboolean              : Read / Write
-

Whether Panel Applet is locked.

-

Default value: FALSE

-
-
-
-

The "locked-down" property

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

Whether Panel Applet is locked down.

-

Default value: FALSE

-
-
-
-

The "orient" property

-
  "orient"                   guint                 : Read / Write
-

Panel Applet Orientation.

-

Default value: 0

-
-
-
-

The "prefs-key" property

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

MateConf Preferences Key.

-

Default value: NULL

-
-
-
-

The "size" property

-
  "size"                     guint                 : Read / Write
-

Panel Applet Size.

-

Default value: 0

-
-
-
-

The "size-hints" property

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

Panel Applet Size Hints.

-
-
-
-

Signal Details

-
-

The "change-background" signal

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

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

-
-- - - - - - - - - - - - - - - - - - - - - - -

matepanelapplet :

The object which received the signal. -

arg1 :

-

arg2 :

-

arg3 :

-

user_data :

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

The "change-orient" signal

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

-Emitted when the orientation of the panel changes. -

-
-- - - - - - - - - - - - - - -

matepanelapplet :

The object which received the signal. -

orient :

The new MatePanelAppletOrient of the applet. -

user_data :

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

The "change-size" signal

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

-Emitted when the size of the panel changes. -

-

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

-
-- - - - - - - - - - - - - - -

matepanelapplet :

The object which received the signal. -

size :

The size hint of the panel. -

user_data :

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

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

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

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

-
-- - - - - - - - - - - - - - -

matepanelapplet :

The object which received the signal. -

direction :

The direction of focus movement. -

user_data :

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

-The Panel Applet Library

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

-Multiple Applets

-

FIXME: write

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

-Detecting Changes in the Panel.

-

FIXME: write

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

-MateComponent Activation .server Files For Applets

-

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

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

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

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

-Session/Preference Saving.

-

FIXME: write

-
- - - \ No newline at end of file diff --git a/doc/reference/mate-panel-applet/html/style.css b/doc/reference/mate-panel-applet/html/style.css deleted file mode 100644 index d544a2c2..00000000 --- a/doc/reference/mate-panel-applet/html/style.css +++ /dev/null @@ -1,265 +0,0 @@ -.synopsis, .classsynopsis -{ - /* tango:aluminium 1/2 */ - background: #eeeeec; - border: solid 1px #d3d7cf; - padding: 0.5em; -} -.programlisting -{ - /* tango:sky blue 0/1 */ - background: #e6f3ff; - border: solid 1px #729fcf; - padding: 0.5em; -} -.variablelist -{ - padding: 4px; - margin-left: 3em; -} -.variablelist td:first-child -{ - vertical-align: top; -} - -@media screen { - sup a.footnote - { - position: relative; - top: 0em ! important; - - } - /* this is needed so that the local anchors are displayed below the naviagtion */ - div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] - { - position: relative; - padding-top:4.5em; - } - /* this seems to be a bug in the xsl style sheets when generating indexes */ - div.index div.index - { - top: 0em; - } - /* make space for the fixed navigation bar and add space at the bottom so that - * link targets appear somewhat close to top - */ - body - { - padding-top: 3.2em; - padding-bottom: 20em; - } - /* style and size the navigation bar */ - table.navigation#top - { - position: fixed; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - z-index: 10; - } - .navigation a, .navigation a:visited - { - /* tango:scarlet red 3 */ - color: #a40000; - } - .navigation a:hover - { - /* tango:scarlet red 1 */ - color: #ef2929; - } - td.shortcuts - { - /* tango:scarlet red 1 */ - color: #ef2929; - font-size: 80%; - white-space: nowrap; - } -} -@media print { - table.navigation { - visibility: collapse; - display: none; - } - div.titlepage table.navigation { - visibility: visible; - display: table; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - } -} - -.navigation .title -{ - font-size: 200%; -} - -div.gallery-float -{ - float: left; - padding: 10px; -} -div.gallery-float img -{ - border-style: none; -} -div.gallery-spacer -{ - clear: both; -} - -a, a:visited -{ - text-decoration: none; - /* tango:sky blue 2 */ - color: #3465a4; -} -a:hover -{ - text-decoration: underline; - /* tango:sky blue 1 */ - color: #729fcf; -} - -div.table table -{ - border-collapse: collapse; - border-spacing: 0px; - /* tango:aluminium 3 */ - border: solid 1px #babdb6; -} - -div.table table td, div.table table th -{ - /* tango:aluminium 3 */ - border: solid 1px #babdb6; - padding: 3px; - vertical-align: top; -} - -div.table table th -{ - /* tango:aluminium 2 */ - background-color: #d3d7cf; -} - -hr -{ - /* tango:aluminium 3 */ - color: #babdb6; - background: #babdb6; - border: none 0px; - height: 1px; - clear: both; -} - -.footer -{ - padding-top: 3.5em; - /* tango:aluminium 3 */ - color: #babdb6; - text-align: center; - font-size: 80%; -} - -.warning -{ - /* tango:orange 0/1 */ - background: #ffeed9; - border-color: #ffb04f; -} -.note -{ - /* tango:chameleon 0/0.5 */ - background: #d8ffb2; - border-color: #abf562; -} -.note, .warning -{ - padding: 0.5em; - border-width: 1px; - border-style: solid; -} -.note h3, .warning h3 -{ - margin-top: 0.0em -} -.note p, .warning p -{ - margin-bottom: 0.0em -} - -/* blob links */ -h2 .extralinks, h3 .extralinks -{ - float: right; - /* tango:aluminium 3 */ - color: #babdb6; - font-size: 80%; - font-weight: normal; -} - -.annotation -{ - /* tango:aluminium 5 */ - color: #555753; - font-size: 80%; - font-weight: normal; -} - -/* code listings */ - -.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ -.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ -.listing_code .programlisting .function { color: #000000; font-weight: bold; } -.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ -.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ -.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ -.listing_code .programlisting .normal { color: #000000; } -.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ -.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ -.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ -.listing_code .programlisting .type { color: #000000; } -.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ -.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ - -.listing_frame { - /* tango:sky blue 1 */ - border: solid 1px #729fcf; - padding: 0px; -} - -.listing_lines, .listing_code { - margin-top: 0px; - margin-bottom: 0px; - padding: 0.5em; -} -.listing_lines { - /* tango:sky blue 0.5 */ - background: #a6c5e3; - /* tango:aluminium 6 */ - color: #2e3436; -} -.listing_code { - /* tango:sky blue 0 */ - background: #e6f3ff; -} -.listing_code .programlisting { - /* override from previous */ - border: none 0px; - padding: 0px; -} -.listing_lines pre, .listing_code pre { - margin: 0px; -} - diff --git a/doc/reference/mate-panel-applet/html/up.png b/doc/reference/mate-panel-applet/html/up.png deleted file mode 100644 index 85b3e2a2..00000000 Binary files a/doc/reference/mate-panel-applet/html/up.png and /dev/null differ diff --git a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml deleted file mode 100644 index f184f7f2..00000000 --- a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet-unused.sgml +++ /dev/null @@ -1,109 +0,0 @@ - - -Defines a 'main' routine for the applet factory. - - -@iid: The matecomponent-activation iid of the factory. -@type: The #GType to instantiate. -@name: The applet ID string. -@version: The applet version string. -@callback: The factory callback. -@data: The factory user data pointer. - - - -Defines a MateComponent Activation shared library plugin and associated -factory callback. - - -@iid: The matecomponent-activation iid of the factory. -@type: The #GType to instantiate. -@descr: A description of the applet. -@callback: The factory callback. -@data: The factory user data pointer. - - - -The applet is orientated down (i.e. the panel is at the top of the screen). - - - - - -The applet is orientated left (i.e. the panel is at the right hand side of the screen). - - - - - -The applet is orientated right (i.e. the panel is at the left hand side of the screen). - - - - - -The applet is orientated up (i.e. the panel is at the bottom of the screen). - - - - - -A generic 'main' routine for applets. This should not normally be -used directly because it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_FACTORY. - - -@iid: The matecomponent-activation iid of the factory. -@applet_type: The #GType to instantiate. -@closure: The factory callback closure. -@Returns: 0 on success, 1 on failure. - - - -Retrieves the #MateComponentControl associated with @applet. - - -@applet: The #MatePanelApplet. -@Returns: A #MateComponentControl. - - - -Retrieves the #MateComponentUIComponent used for popup menus associated -with @applet. - - -@applet: The #MatePanelApplet. -@Returns: A #MateComponentUIComponent. - - - -A generic shared library factory routine for applets. This should not -normally be used directly as it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY. - - -@iid: The matecomponent-activation iid of the factory. -@applet_type: The #GType to instantiate. -@poa: The #PortableServer_POA passed to the shlib factory -callback. -@impl_ptr: The #gpointer passed to the shlib factory callback. -@callback: The applet factory callback. -@user_data: The factory user data pointer. -@ev: The $CORBA_Environment passed to the shlib factory callback. -@Returns: A #MateComponent_Unknown to return from the shlib factory -callback. - - - -A generic shared library factory routine for applets. This should not -normally be used directly as it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_SHLIB_FACTORY. - - -@iid: The matecomponent-activation iid of the factory. -@applet_type: The #GType to instantiate. -@poa: The #PortableServer_POA passed to the shlib factory -callback. -@impl_ptr: The #gpointer passed to the shlib factory callback. -@closure: The applet factory closure. -@ev: The $CORBA_Environment passed to the shlib factory callback. -@Returns: A #MateComponent_Unknown to return from the shlib factory -callback. - diff --git a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml b/doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml deleted file mode 100644 index 01d72e2d..00000000 --- a/doc/reference/mate-panel-applet/tmpl/mate-panel-applet.sgml +++ /dev/null @@ -1,393 +0,0 @@ - -MatePanelApplet - - -The MatePanelApplet object. - - - -The #MatePanelApplet object is an object which encapsulates an applet. It -is a #GtkContainer which may contain a single widget. This widget, in -turn, should contain all widgets exposed by the applet. - - - -A #MatePanelApplet is associated with a #MateComponentControl. The control makes -the cross process UI emmbedding required by applets possible. - - - - - - - - - - - - - - - -The #MatePanelApplet struct contains private data only. - - - - - -Emitted when the background of the panel changes. Use @type to -determine which, if any, of @color and @pimxap is valid. - - -@matepanelapplet: The object which received the signal. -@arg1: -@arg2: -@arg3: - -@type: The #MatePanelAppletBackgroundType. -@color: The #GdkColor if @type is #PANEL_COLOR_BACKGROUND. -@pixmap: The pixmap file name if @type is #PANEL_PIXMAP_BACKGROUND - - - -Emitted when the orientation of the panel changes. - - -@matepanelapplet: The object which received the signal. -@orient: The new #MatePanelAppletOrient of the applet. - - - -Emitted when the size of the panel changes. - - - -Note: this is different for size negotiation which is handled by -size_request() and size_allocate() as usual. This signal should -be used to determine what font size or widget layout to use -depending on the size of the panel. See mate_panel_applet_get_size(). - - -@matepanelapplet: The object which received the signal. -@size: The size hint of the panel. - - - -Emitted when the applet has lost focus. This signal is used internally and is not meant to be used by applets themselves. - - -@matepanelapplet: The object which received the signal. -@direction: The direction of focus movement. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The #MatePanelAppletOrient type specifies the orientation of the applet. The -values may seem backward (e.g. %MATE_PANEL_APPLET_ORIENT_LEFT means the panel -is on the right hand side), but this is because the value is representative -of the applet's orientation, not the panel's position. - - -@MATE_PANEL_APPLET_ORIENT_UP: -@MATE_PANEL_APPLET_ORIENT_DOWN: -@MATE_PANEL_APPLET_ORIENT_LEFT: -@MATE_PANEL_APPLET_ORIENT_RIGHT: - - - -The #MatePanelAppletBackgroundType enumerated type specifies the type of -background of a panel. - - -@PANEL_NO_BACKGROUND: The panel has no background, the default is used. -@PANEL_COLOR_BACKGROUND: The panel has a color, i.e rgb value, -background. -@PANEL_PIXMAP_BACKGROUND: The panel has either an image background -or is translucent. - - - -The #MatePanelAppletFlags associated with the applet are boolean flags which -the panel may read in order to figure out how to handle the applet. - - -@MATE_PANEL_APPLET_FLAGS_NONE: No flags are to be associated with the applet. -@MATE_PANEL_APPLET_EXPAND_MAJOR: The applet should expand horizontally on an -horizontal panel and vertically on a vertical panel - e.g. the behaviour -of the Window List applet. -@MATE_PANEL_APPLET_EXPAND_MINOR: The applet should expand vertically on an -horizontal panel and horizontally on a vertical panel. Most applets should -set this flag in order to utilise the full panel width and allow the applet -to be Fitt's Law compliant. -@MATE_PANEL_APPLET_HAS_HANDLE: The panel should draw a grab handle around the -applet - e.g. the Window List and Notification Area applets both set this -flag. - - - -This callback is invoked when the applet is loaded onto the panel. Typically -the callback will check that @iid matches and fill the @applet with the -widgets which make up the applet. - - - -Prior to the callback being invoked the #MatePanelApplet (or an instance of the -sub-class specified by the #GType passed to the factory macros) is instantiated -and initialized. - - -@applet: The #MatePanelApplet. -@iid: The MateComponent IID of the applet requested. -@user_data: The data passed to the factory macros. -@Returns: %TRUE on success, %FALSE on failure. - - - - -Creates a new #MatePanelApplet. This function is typically not -useful as the applet is created before the #MatePanelAppletFactoryCallback -is invoked. - - -@void: -@Returns: The #MatePanelApplet. - - - - -Get the current orientation of the applet. - - -@applet: The #MatePanelApplet. -@Returns: The orientation of the applet. - - - - -Get the current size hint for the panel. The size hint is -not useful for most applets. - - - -Note: The return value is not an integer value -specifying the pixel size of the panel. Do not -use this value to calculate the size of the applet. Use it -only as a hint by which to decide the applet's layout. - - -@applet: The #MatePanelApplet. -@Returns: The panel's size hint. - - - - -Returns the current background type. If the background -type is %PANEL_NO_BACKGROUND both @color and @pixmap will -be unaffected. If the background type is %PANEL_COLOR_BACKGROUND -then @color will contain the current panel background colour. -If the background type is %PANEL_PIXMAP_BACKGROUND, @pixmap will -contain a pointer to a #GdkPixmap which is a copy of the applet's -portion of the panel's background pixmap. - - - - -@applet: A #MatePanelApplet. -@color: A #GdkColor to be filled in. -@pixmap: Returned #GdkPixmap. -@Returns: The background type. - - - - -Returns the MateConf path to the directory containing the applet's -per-instance preference keys. Using this you may construct the -full path for the applet's preference keys. See - for -more information. - - -@applet: The #MatePanelApplet. -@Returns: A MateConf path. - - - - -Associates each schema in @schema_dir with a key in the applet's -preferences directory (i.e. the directory returned by -mate_panel_applet_get_preferences_key()). Each applet preference -should have an associated schema to ensure that the key has -a defined type, sane default and documentation. - - - -If you pass %NULL for @opt_error, this function will print -a warning message from any #GError which MateConf may return. - - -@applet: The #MatePanelApplet. -@schema_dir: The MateConf path where the applet's schemas are installed -e.g. /schemas/apps/my_applet -@opt_error: Optional #GError. - - - - -Retrieve the #MatePanelAppletFlags associated with the applet. - - -@applet: The #MatePanelApplet. -@Returns: The #MatePanelAppletFlags. - - - - -Set the #MatePanelAppletFlags associated with the applet. See -#MatePanelAppletFlags for more details on the possible uses of -these flags. - - -@applet: The #MatePanelApplet. -@flags: The #MatePanelAppletFlags to associate. - - - - -Set a list of desired size ranges for an applet with the -#MATE_PANEL_APPLET_EXPAND_MAJOR flags set. @size_hints is an -array of (max, min) pairs where min(i) > max(i + 1). - - - -The panel will endeavour to allocate the applet a size -in one of the (@base + max, @base + min) ranges. - - -@applet: The #MatePanelApplet. -@size_hints: Array of size_hints. -@n_elements: Number of elements in the array. -Not the number of pairs. -@base_size: The base size of the applet. - - - - -Check if the @applet is locked down. A locked down applet should not allow any change to its configuration. - - -@applet: The #MatePanelApplet. -@Returns: %TRUE if the @applet is locked down, %FALSE otherwise. - - - - -Set keyboard focus to @applet. - - -@applet: The #MatePanelApplet. -@timestamp: timestamp of the event triggering the window focus - - - - -Sets up a popup menu for @applet described by the xml -string, @xml. See section -for a description of the format of the xml. - - -@applet: A #MatePanelApplet. -@xml: The xml character string describing the popup menu. -@action_group: - -@verb_list: The list of #MateComponentUIVerbs for the menu. -@user_data: The user data pointer for the menu. - - - - -Sets up a popup menu for @applet described by the xml -file, @file. See for a description of -the format of the xml. - - -@applet: A #MatePanelApplet. -@filename: -@action_group: - -@opt_datadir: The data directory - i.e. ${prefix}/share (optional). -@file: The file's name. -@opt_app_name: The application's name (optional). -@verb_list: The list of #MateComponentUIVerbs for the menu. -@user_data: The user data pointer for the menu. - - - - -A generic 'main' routine for applets. This should not normally be -used directly because it is invoked by #MATE_PANEL_APPLET_MATECOMPONENT_FACTORY. - - -@factory_id: -@out_process: -@applet_type: The #GType to instantiate. -@callback: The factory callback. -@data: The factory user data pointer. -@Returns: 0 on success, 1 on failure. - -@iid: The matecomponent-activation iid of the factory. - - -- cgit v1.2.1