CafePanelApplet: Panel Applet Library Reference Manual

CafePanelApplet

Functions

gboolean	(*CafePanelAppletFactoryCallback) ()
CtkWidget *	cafe_panel_applet_new ()
CafePanelAppletOrient	cafe_panel_applet_get_orient ()
guint	cafe_panel_applet_get_size ()
CafePanelAppletBackgroundType	cafe_panel_applet_get_background ()
CafePanelAppletFlags	cafe_panel_applet_get_flags ()
void	cafe_panel_applet_set_flags ()
void	cafe_panel_applet_set_size_hints ()
gboolean	cafe_panel_applet_get_locked_down ()
void	cafe_panel_applet_request_focus ()
void	cafe_panel_applet_setup_menu ()
void	cafe_panel_applet_setup_menu_from_file ()
int	cafe_panel_applet_factory_main ()

Properties

char *	background	Read / Write
gpointer	closure	Read / Write / Construct Only
GDBusConnection *	connection	Read / Write / Construct Only
guint	flags	Read / Write
char *	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
char *	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

struct	CafePanelApplet
enum	CafePanelAppletOrient
enum	CafePanelAppletBackgroundType
enum	CafePanelAppletFlags

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── CtkWidget
            ╰── CtkContainer
                ╰── CtkBin
                    ╰── CtkEventBox
                        ╰── CafePanelApplet

Implemented Interfaces

CafePanelApplet implements AtkImplementorIface and CtkBuildable.

Includes

#include <cafe-panel-applet.h>

Description

Functions

CafePanelAppletFactoryCallback ()

gboolean
(*CafePanelAppletFactoryCallback) (CafePanelApplet *applet,
                                   const gchar *iid,
                                   gpointer user_data);

cafe_panel_applet_new ()

CtkWidget *
cafe_panel_applet_new (void);

cafe_panel_applet_get_orient ()

CafePanelAppletOrient
cafe_panel_applet_get_orient (CafePanelApplet *applet);

cafe_panel_applet_get_size ()

guint
cafe_panel_applet_get_size (CafePanelApplet *applet);

cafe_panel_applet_get_background ()

CafePanelAppletBackgroundType
cafe_panel_applet_get_background (CafePanelApplet *applet,
                                  CdkRGBA *color,
                                  cairo_pattern_t **pattern);

cafe_panel_applet_get_flags ()

CafePanelAppletFlags
cafe_panel_applet_get_flags (CafePanelApplet *applet);

cafe_panel_applet_set_flags ()

void
cafe_panel_applet_set_flags (CafePanelApplet *applet,
                             CafePanelAppletFlags flags);

cafe_panel_applet_set_size_hints ()

void
cafe_panel_applet_set_size_hints (CafePanelApplet *applet,
                                  const int *size_hints,
                                  int n_elements,
                                  int base_size);

Parameters

applet	applet
size_hints	List of integers.	[array length=n_elements]
n_elements	Length of `size_hints`
base_size	base_size

cafe_panel_applet_get_locked_down ()

gboolean
cafe_panel_applet_get_locked_down (CafePanelApplet *applet);

cafe_panel_applet_request_focus ()

void
cafe_panel_applet_request_focus (CafePanelApplet *applet,
                                 guint32 timestamp);

cafe_panel_applet_setup_menu ()

void
cafe_panel_applet_setup_menu (CafePanelApplet *applet,
                              const gchar *xml,
                              CtkActionGroup *action_group);

cafe_panel_applet_setup_menu_from_file ()

void
cafe_panel_applet_setup_menu_from_file
                               (CafePanelApplet *applet,
                                const gchar *filename,
                                CtkActionGroup *action_group);

cafe_panel_applet_factory_main ()

int
cafe_panel_applet_factory_main (const gchar *factory_id,
                                gboolean out_process,
                                GType applet_type,
                                CafePanelAppletFactoryCallback 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 CafePanelApplet

struct CafePanelApplet;

enum CafePanelAppletOrient

Members

CAFE_PANEL_APPLET_ORIENT_UP
CAFE_PANEL_APPLET_ORIENT_DOWN
CAFE_PANEL_APPLET_ORIENT_LEFT
CAFE_PANEL_APPLET_ORIENT_RIGHT

enum CafePanelAppletBackgroundType

Members

PANEL_NO_BACKGROUND
PANEL_COLOR_BACKGROUND
PANEL_PIXMAP_BACKGROUND

enum CafePanelAppletFlags

Members

CAFE_PANEL_APPLET_FLAGS_NONE
CAFE_PANEL_APPLET_EXPAND_MAJOR
CAFE_PANEL_APPLET_EXPAND_MINOR
CAFE_PANEL_APPLET_HAS_HANDLE

Property Details

The `“background”` property

  “background”               char *

Panel Applet Background.

Owner: CafePanelApplet

Flags: Read / Write

Default value: NULL

The `“closure”` property

  “closure”                  gpointer

The Applet closure.

Owner: CafePanelApplet

Flags: Read / Write / Construct Only

The `“connection”` property

  “connection”               GDBusConnection *

The DBus Connection.

Owner: CafePanelApplet

Flags: Read / Write / Construct Only

The `“flags”` property

  “flags”                    guint

Panel Applet flags.

Owner: CafePanelApplet

Flags: Read / Write

Allowed values: <= 7

Default value: 0

The `“id”` property

  “id”                       char *

The Applet identifier.

Owner: CafePanelApplet

Flags: Read / Write / Construct Only

Default value: NULL

The `“locked”` property

  “locked”                   gboolean

Whether Panel Applet is locked.

Owner: CafePanelApplet

Flags: Read / Write

Default value: FALSE

The `“locked-down”` property

  “locked-down”              gboolean

Whether Panel Applet is locked down.

Owner: CafePanelApplet

Flags: Read / Write

Default value: FALSE

The `“orient”` property

  “orient”                   guint

Panel Applet Orientation.

Owner: CafePanelApplet

Flags: Read / Write

Allowed values: <= 3

Default value: 0

The `“out-of-process”` property

  “out-of-process”           gboolean

out-of-process.

Owner: CafePanelApplet

Flags: Read / Write / Construct Only

Default value: TRUE

The `“prefs-path”` property

  “prefs-path”               char *

GSettings Preferences Path.

Owner: CafePanelApplet

Flags: Read / Write

Default value: NULL

The `“size”` property

  “size”                     guint

Panel Applet Size.

Owner: CafePanelApplet

Flags: Read / Write

Default value: 0

The `“size-hints”` property

  “size-hints”               gpointer

Panel Applet Size Hints.

Owner: CafePanelApplet

Flags: Read / Write

Signal Details

The `“change-background”` signal

void
user_function (CafePanelApplet              *cafepanelapplet,
               CafePanelAppletBackgroundType arg1,
               CdkRGBA                      *arg2,
               CairoPattern                 *arg3,
               gpointer                      user_data)

Flags: Run Last

The `“change-orient”` signal

void
user_function (CafePanelApplet *cafepanelapplet,
               guint            arg1,
               gpointer         user_data)

Flags: Run Last

The `“change-size”` signal

void
user_function (CafePanelApplet *cafepanelapplet,
               int              arg1,
               gpointer         user_data)

Flags: Run Last

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

void
user_function (CafePanelApplet *cafepanelapplet,
               CtkDirectionType arg1,
               gpointer         user_data)

Flags: Action