AwnAppletSimple

AwnAppletSimple

Synopsis




                    AwnAppletSimplePrivate;
                    AwnAppletSimple;
GtkWidget*          awn_applet_simple_new               (const gchar *uid,
                                                         gint orient,
                                                         gint height);
void                awn_applet_simple_set_icon          (AwnAppletSimple *simple,
                                                         GdkPixbuf *pixbuf);
void                awn_applet_simple_set_temp_icon     (AwnAppletSimple *simple,
                                                         GdkPixbuf *pixbuf);
AwnEffects*         awn_applet_simple_get_effects       (AwnAppletSimple *simple);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkEventBox
                                       +----AwnApplet
                                             +----AwnAppletSimple

Implemented Interfaces

AwnAppletSimple implements AtkImplementorIface and GtkBuildable.

Description

Details

AwnAppletSimplePrivate

typedef struct _AwnAppletSimplePrivate AwnAppletSimplePrivate;

AwnAppletSimple

typedef struct _AwnAppletSimple AwnAppletSimple;

awn_applet_simple_new ()

GtkWidget*          awn_applet_simple_new               (const gchar *uid,
                                                         gint orient,
                                                         gint height);

Creates a new AwnAppletSimple object. This applet will have awn-effects effects applied to its icon automatically if awn_applet_simple_set_icon() or awn_applet_simple_set_temp_icon() are used to specify the applet icon.

uid : The unique identifier of the instance of the applet on the dock.
orient : The orientation of the applet - see AwnOrientation.
height : The height of the applet.
Returns : a new instance of an applet.

awn_applet_simple_set_icon ()

void                awn_applet_simple_set_icon          (AwnAppletSimple *simple,
                                                         GdkPixbuf *pixbuf);

Sets the applet icon to the pixbuf provided as an argument. A private copy of the pixbuf argument is made by awn_applet_simple_set_icon() and the original argument is left unchanged. The caller retains ownership of pixbuf and is required to unref it when it is no longer required.

simple : The applet whose icon is being set.
pixbuf : The pixbuf image to use as the icon.

awn_applet_simple_set_temp_icon ()

void                awn_applet_simple_set_temp_icon     (AwnAppletSimple *simple,
                                                         GdkPixbuf *pixbuf);

A convenience function that sets the applet icon to the pixbuf provided as an argument. A private copy of the pixbuf argument is made by the function, and the argument is unreferenced. The caller should not reference pixbuf after calling this function. If the pixbuf needs to be retained, then awn_applet_simple_set_icon() should be used.

simple : The applet whose icon is being set.
pixbuf : The pixbuf image to use as the icon.

awn_applet_simple_get_effects ()

AwnEffects*         awn_applet_simple_get_effects       (AwnAppletSimple *simple);

Retrieves the AwnEffects object associated with the applet.

simple : The applet whose properties are being queried.
Returns : a pointer to an AwnEffects object associated with the applet. The caller does not own this object.