MatePanelApplet

MatePanelApplet

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,
                                                         GdkRGBA *color,
                                                         cairo_pattern_t **pattern);
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-path"               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

Details

struct MatePanelApplet

struct MatePanelApplet;


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;

MATE_PANEL_APPLET_ORIENT_UP

MATE_PANEL_APPLET_ORIENT_DOWN

MATE_PANEL_APPLET_ORIENT_LEFT

MATE_PANEL_APPLET_ORIENT_RIGHT


enum MatePanelAppletBackgroundType

typedef enum {
	PANEL_NO_BACKGROUND,
	PANEL_COLOR_BACKGROUND,
	PANEL_PIXMAP_BACKGROUND
} MatePanelAppletBackgroundType;

PANEL_NO_BACKGROUND

PANEL_COLOR_BACKGROUND

PANEL_PIXMAP_BACKGROUND


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;

MATE_PANEL_APPLET_FLAGS_NONE

MATE_PANEL_APPLET_EXPAND_MAJOR

MATE_PANEL_APPLET_EXPAND_MINOR

MATE_PANEL_APPLET_HAS_HANDLE


MatePanelAppletFactoryCallback ()

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


mate_panel_applet_new ()

GtkWidget *         mate_panel_applet_new               (void);


mate_panel_applet_get_orient ()

MatePanelAppletOrient mate_panel_applet_get_orient      (MatePanelApplet *applet);


mate_panel_applet_get_size ()

guint               mate_panel_applet_get_size          (MatePanelApplet *applet);


mate_panel_applet_get_background ()

MatePanelAppletBackgroundType mate_panel_applet_get_background
                                                        (MatePanelApplet *applet,
                                                         GdkRGBA *color,
                                                         cairo_pattern_t **pattern);


mate_panel_applet_get_flags ()

MatePanelAppletFlags mate_panel_applet_get_flags        (MatePanelApplet *applet);


mate_panel_applet_set_flags ()

void                mate_panel_applet_set_flags         (MatePanelApplet *applet,
                                                         MatePanelAppletFlags flags);


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);


mate_panel_applet_get_locked_down ()

gboolean            mate_panel_applet_get_locked_down   (MatePanelApplet *applet);


mate_panel_applet_request_focus ()

void                mate_panel_applet_request_focus     (MatePanelApplet *applet,
                                                         guint32 timestamp);


mate_panel_applet_setup_menu ()

void                mate_panel_applet_setup_menu        (MatePanelApplet *applet,
                                                         const gchar *xml,
                                                         GtkActionGroup *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);


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);

factory_id :

Factory ID.

out_process :

If the factory is on a separate process or not.

applet_type :

GType of the applet this factory creates.

callback :

Callback to be called when a new applet is to be created. [scope call]

data :

Callback data. [closure]

Returns :

0 on success, 1 if there is an error.

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-path" property

  "prefs-path"               gchar*                : Read / Write

GSettings Preferences Path.

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

matepanelapplet :

the object which received the signal.

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

matepanelapplet :

the object which received the signal.

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

matepanelapplet :

the object which received the signal.

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

matepanelapplet :

the object which received the signal.

user_data :

user data set when the signal handler was connected.