UkuiPanelApplet

UkuiPanelApplet

Functions

Properties

gchar * background Read / Write
gpointer closure Read / Write / Construct Only
GDBusConnection * connection Read / Write / Construct Only
guint flags Read / Write
gchar * id Read / Write / Construct Only
gboolean locked Read / Write
gboolean locked-down Read / Write
guint orient Read / Write
gboolean out-of-process Read / Write / Construct Only
gchar * prefs-path Read / Write
guint size Read / Write
gpointer size-hints Read / Write

Signals

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

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkEventBox
                        ╰── UkuiPanelApplet

Implemented Interfaces

UkuiPanelApplet implements AtkImplementorIface and GtkBuildable.

Includes

#include <ukui-panel-applet.h>

Description

Functions

UkuiPanelAppletFactoryCallback ()

gboolean
(*UkuiPanelAppletFactoryCallback) (UkuiPanelApplet *applet,
                                   const gchar *iid,
                                   gpointer user_data);

ukui_panel_applet_new ()

GtkWidget *
ukui_panel_applet_new (void);

ukui_panel_applet_get_orient ()

UkuiPanelAppletOrient
ukui_panel_applet_get_orient (UkuiPanelApplet *applet);

ukui_panel_applet_get_size ()

guint
ukui_panel_applet_get_size (UkuiPanelApplet *applet);

ukui_panel_applet_get_background ()

UkuiPanelAppletBackgroundType
ukui_panel_applet_get_background (UkuiPanelApplet *applet,
                                  GdkRGBA *color,
                                  cairo_pattern_t **pattern);

ukui_panel_applet_get_flags ()

UkuiPanelAppletFlags
ukui_panel_applet_get_flags (UkuiPanelApplet *applet);

ukui_panel_applet_set_flags ()

void
ukui_panel_applet_set_flags (UkuiPanelApplet *applet,
                             UkuiPanelAppletFlags flags);

ukui_panel_applet_set_size_hints ()

void
ukui_panel_applet_set_size_hints (UkuiPanelApplet *applet,
                                  const int *size_hints,
                                  int n_elements,
                                  int base_size);

ukui_panel_applet_get_locked_down ()

gboolean
ukui_panel_applet_get_locked_down (UkuiPanelApplet *applet);

ukui_panel_applet_request_focus ()

void
ukui_panel_applet_request_focus (UkuiPanelApplet *applet,
                                 guint32 timestamp);

ukui_panel_applet_setup_menu ()

void
ukui_panel_applet_setup_menu (UkuiPanelApplet *applet,
                              const gchar *xml,
                              GtkActionGroup *action_group);

ukui_panel_applet_setup_menu_from_file ()

void
ukui_panel_applet_setup_menu_from_file
                               (UkuiPanelApplet *applet,
                                const gchar *filename,
                                GtkActionGroup *action_group);

ukui_panel_applet_factory_main ()

int
ukui_panel_applet_factory_main (const gchar *factory_id,
                                gboolean out_process,
                                GType applet_type,
                                UkuiPanelAppletFactoryCallback callback,
                                gpointer data);

Parameters

out_process

boolean, dummy to support applets sending it

 

factory_id

Factory ID.

 

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.

Types and Values

struct UkuiPanelApplet

struct UkuiPanelApplet;

enum UkuiPanelAppletOrient

Members

UKUI_PANEL_APPLET_ORIENT_UP

   

UKUI_PANEL_APPLET_ORIENT_DOWN

   

UKUI_PANEL_APPLET_ORIENT_LEFT

   

enum UkuiPanelAppletBackgroundType

Members

PANEL_NO_BACKGROUND

   

PANEL_COLOR_BACKGROUND

   

PANEL_PIXMAP_BACKGROUND

   

enum UkuiPanelAppletFlags

Members

UKUI_PANEL_APPLET_FLAGS_NONE

   

UKUI_PANEL_APPLET_EXPAND_MAJOR

   

UKUI_PANEL_APPLET_EXPAND_MINOR

   

Property Details

The “background” property

  “background”               gchar *

Panel Applet Background.

Flags: Read / Write

Default value: NULL


The “closure” property

  “closure”                  gpointer

The Applet closure.

Flags: Read / Write / Construct Only


The “connection” property

  “connection”               GDBusConnection *

The DBus Connection.

Flags: Read / Write / Construct Only


The “flags” property

  “flags”                    guint

Panel Applet flags.

Flags: Read / Write

Allowed values: <= 7

Default value: 0


The “id” property

  “id”                       gchar *

The Applet identifier.

Flags: Read / Write / Construct Only

Default value: NULL


The “locked” property

  “locked”                   gboolean

Whether Panel Applet is locked.

Flags: Read / Write

Default value: FALSE


The “locked-down” property

  “locked-down”              gboolean

Whether Panel Applet is locked down.

Flags: Read / Write

Default value: FALSE


The “orient” property

  “orient”                   guint

Panel Applet Orientation.

Flags: Read / Write

Allowed values: <= 3

Default value: 0


The “out-of-process” property

  “out-of-process”           gboolean

out-of-process.

Flags: Read / Write / Construct Only

Default value: TRUE


The “prefs-path” property

  “prefs-path”               gchar *

GSettings Preferences Path.

Flags: Read / Write

Default value: NULL


The “size” property

  “size”                     guint

Panel Applet Size.

Flags: Read / Write

Default value: 0


The “size-hints” property

  “size-hints”               gpointer

Panel Applet Size Hints.

Flags: Read / Write

Signal Details

The “change-background” signal

void
user_function (UkuiPanelApplet              *ukuipanelapplet,
               UkuiPanelAppletBackgroundType arg1,
               GdkRGBA                      *arg2,
               CairoPattern                 *arg3,
               gpointer                      user_data)

Flags: Run Last


The “change-orient” signal

void
user_function (UkuiPanelApplet *ukuipanelapplet,
               guint            arg1,
               gpointer         user_data)

Flags: Run Last


The “change-size” signal

void
user_function (UkuiPanelApplet *ukuipanelapplet,
               gint             arg1,
               gpointer         user_data)

Flags: Run Last


The “move-focus-out-of-applet” signal

void
user_function (UkuiPanelApplet *ukuipanelapplet,
               GtkDirectionType arg1,
               gpointer         user_data)

Flags: Action