PanelApplet

typedef struct _PanelApplet PanelApplet;

The PanelApplet struct contains private data only.

PanelAppletOrient

typedef GNOME_Vertigo_PanelOrient PanelAppletOrient;

The PanelAppletOrient type specifies the orientation of the applet. The values may seem backward (e.g. 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.

PANEL_APPLET_ORIENT_UP

#define PANEL_APPLET_ORIENT_UP    GNOME_Vertigo_PANEL_ORIENT_UP

The applet is orientated up (i.e. the panel is at the bottom of the screen).

PANEL_APPLET_ORIENT_DOWN

#define PANEL_APPLET_ORIENT_DOWN  GNOME_Vertigo_PANEL_ORIENT_DOWN

The applet is orientated down (i.e. the panel is at the top of the screen).

PANEL_APPLET_ORIENT_LEFT

#define PANEL_APPLET_ORIENT_LEFT  GNOME_Vertigo_PANEL_ORIENT_LEFT

The applet is orientated left (i.e. the panel is at the right hand side of the screen).

PANEL_APPLET_ORIENT_RIGHT

#define PANEL_APPLET_ORIENT_RIGHT GNOME_Vertigo_PANEL_ORIENT_RIGHT

The applet is orientated right (i.e. the panel is at the left hand side of the screen).

enum PanelAppletBackgroundType

typedef enum {
	PANEL_NO_BACKGROUND,
	PANEL_COLOR_BACKGROUND,
	PANEL_PIXMAP_BACKGROUND
} PanelAppletBackgroundType;

The PanelAppletBackgroundType enumerated type specifies the type of background of a panel.

enum PanelAppletFlags

typedef enum {
	PANEL_APPLET_FLAGS_NONE   = 0,
	PANEL_APPLET_EXPAND_MAJOR = 1 << 0,
	PANEL_APPLET_EXPAND_MINOR = 1 << 1,
	PANEL_APPLET_HAS_HANDLE   = 1 << 2
} PanelAppletFlags;

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

PanelAppletFactoryCallback ()

gboolean    (*PanelAppletFactoryCallback)   (PanelApplet *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 PanelApplet (or an instance of the sub-class specified by the GType passed to the factory macros) is instantiated and initialized.

panel_applet_new ()

GtkWidget*  panel_applet_new                (void);

Creates a new PanelApplet. This function is typically not useful as the applet is created before the PanelAppletFactoryCallback is invoked.

panel_applet_get_orient ()

PanelAppletOrient panel_applet_get_orient   (PanelApplet *applet);

Get the current orientation of the applet.

panel_applet_get_size ()

guint       panel_applet_get_size           (PanelApplet *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.

panel_applet_get_background ()

PanelAppletBackgroundType panel_applet_get_background
                                            (PanelApplet *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.

panel_applet_get_preferences_key ()

gchar*      panel_applet_get_preferences_key
                                            (PanelApplet *applet);

Returns the GConf 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 GConf Utilities(3) for more information.

panel_applet_add_preferences ()

void        panel_applet_add_preferences    (PanelApplet *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 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 GConf may return.

panel_applet_get_flags ()

PanelAppletFlags panel_applet_get_flags     (PanelApplet *applet);

Retrieve the PanelAppletFlags associated with the applet.

panel_applet_set_flags ()

void        panel_applet_set_flags          (PanelApplet *applet,
                                             PanelAppletFlags flags);

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

panel_applet_set_size_hints ()

void        panel_applet_set_size_hints     (PanelApplet *applet,
                                             const int *size_hints,
                                             int n_elements,
                                             int base_size);

Set a list of desired size ranges for an applet with the 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.

panel_applet_get_locked_down ()

gboolean    panel_applet_get_locked_down    (PanelApplet *applet);

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

panel_applet_request_focus ()

void        panel_applet_request_focus      (PanelApplet *applet,
                                             guint32 timestamp);

Set keyboard focus to applet.

panel_applet_get_control ()

BonoboControl* panel_applet_get_control     (PanelApplet *applet);

Retrieves the BonoboControl associated with applet.

panel_applet_get_popup_component ()

BonoboUIComponent* panel_applet_get_popup_component
                                            (PanelApplet *applet);

Retrieves the BonoboUIComponent used for popup menus associated with applet.

panel_applet_setup_menu ()

void        panel_applet_setup_menu         (PanelApplet *applet,
                                             const gchar *xml,
                                             const BonoboUIVerb *verb_list,
                                             gpointer user_data);

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.

panel_applet_setup_menu_from_file ()

void        panel_applet_setup_menu_from_file
                                            (PanelApplet *applet,
                                             const gchar *opt_datadir,
                                             const gchar *file,
                                             const gchar *opt_app_name,
                                             const BonoboUIVerb *verb_list,
                                             gpointer user_data);

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.

panel_applet_factory_main ()

int         panel_applet_factory_main       (const gchar *iid,
                                             GType applet_type,
                                             PanelAppletFactoryCallback callback,
                                             gpointer data);

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

panel_applet_factory_main_closure ()

int         panel_applet_factory_main_closure
                                            (const gchar *iid,
                                             GType applet_type,
                                             GClosure *closure);

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

PANEL_APPLET_BONOBO_FACTORY()

#define     PANEL_APPLET_BONOBO_FACTORY(iid, type, name, version, callback, data)

Defines a 'main' routine for the applet factory.

panel_applet_shlib_factory ()

Bonobo_Unknown panel_applet_shlib_factory   (const char *iid,
                                             GType applet_type,
                                             PortableServer_POA poa,
                                             gpointer impl_ptr,
                                             PanelAppletFactoryCallback callback,
                                             gpointer user_data,
                                             CORBA_Environment *ev);

A generic shared library factory routine for applets. This should not normally be used directly as it is invoked by PANEL_APPLET_BONOBO_SHLIB_FACTORY.

panel_applet_shlib_factory_closure ()

Bonobo_Unknown panel_applet_shlib_factory_closure
                                            (const char *iid,
                                             GType applet_type,
                                             PortableServer_POA poa,
                                             gpointer impl_ptr,
                                             GClosure *closure,
                                             CORBA_Environment *ev);

A generic shared library factory routine for applets. This should not normally be used directly as it is invoked by PANEL_APPLET_BONOBO_SHLIB_FACTORY.

PANEL_APPLET_BONOBO_SHLIB_FACTORY()

#define     PANEL_APPLET_BONOBO_SHLIB_FACTORY(iid, type, descr, callback, data)

Defines a Bonobo Activation shared library plugin and associated factory callback.

The "change-background" signal

void        user_function                  (PanelApplet *panelapplet,
                                            PanelAppletBackgroundType arg1,
                                            GdkColor *arg2,
                                            GdkPixmap *arg3,
                                            gpointer user_data);

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

The "change-orient" signal

void        user_function                  (PanelApplet *panelapplet,
                                            guint arg1,
                                            gpointer user_data);

Emitted when the orientation of the panel changes.

The "change-size" signal

void        user_function                  (PanelApplet *panelapplet,
                                            gint arg1,
                                            gpointer user_data);

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 panel_applet_get_size().

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

void        user_function                  (PanelApplet *panelapplet,
                                            GtkDirectionType arg1,
                                            gpointer user_data);

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