AwnAppletSimple

## AwnAppletSimple AwnAppletSimple |

## Synopsis

                        AwnAppletSimplePrivate;
                        AwnAppletSimple;
    GtkWidget *         awn_applet_simple_new               (const gchar *canonical_name,
                                                             const gchar *uid,
                                                             gint panel_id);
    void                awn_applet_simple_set_icon_pixbuf   (AwnAppletSimple *applet,
                                                             GdkPixbuf *pixbuf);
    void                awn_applet_simple_set_icon_context  (AwnAppletSimple *applet,
                                                             cairo_t *cr);
    void                awn_applet_simple_set_icon_surface  (AwnAppletSimple *applet,
                                                             cairo_surface_t *surface);
    void                awn_applet_simple_set_icon_name     (AwnAppletSimple *applet,
                                                             const gchar *icon_name);
    void                awn_applet_simple_set_icon_info     (AwnAppletSimple *applet,
                                                             GStrv states,
                                                             GStrv icon_names);
    void                awn_applet_simple_set_icon_state    (AwnAppletSimple *applet,
                                                             const gchar *state);
    void                awn_applet_simple_set_tooltip_text  (AwnAppletSimple *applet,
                                                             const gchar *text);
    gchar *             awn_applet_simple_get_tooltip_text  (AwnAppletSimple *applet);
    void                awn_applet_simple_set_message       (AwnAppletSimple *applet,
                                                             const gchar *message);
    gchar *             awn_applet_simple_get_message       (AwnAppletSimple *applet);
    void                awn_applet_simple_set_progress      (AwnAppletSimple *applet,
                                                             gfloat progress);
    gfloat              awn_applet_simple_get_progress      (AwnAppletSimple *applet);
    AwnIcon *           awn_applet_simple_get_icon          (AwnAppletSimple *applet);
    void                awn_applet_simple_set_effect        (AwnAppletSimple *applet,
                                                             AwnEffect effect);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBin
                                     +----GtkWindow
                                           +----GtkPlug
                                                 +----AwnApplet
                                                       +----AwnAppletSimple

## Implemented Interfaces

AwnAppletSimple implements AtkImplementorIface, GtkBuildable and AwnOverlayable.

## Signals

      "clicked"                                        : Run First / Action
      "context-menu-popup"                             : Run First / Action
      "middle-clicked"                                 : Run First / Action

## Description

## Details

### AwnAppletSimplePrivate

    typedef struct _AwnAppletSimplePrivate AwnAppletSimplePrivate;

### AwnAppletSimple

    typedef struct _AwnAppletSimple AwnAppletSimple;

### awn_applet_simple_new ()

    GtkWidget *         awn_applet_simple_new               (const gchar *canonical_name,
                                                             const gchar *uid,
                                                             gint panel_id);

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.

`canonical_name` : | The canonical name of the applet (see "canonical-name").
`uid` : | The unique identifier of the instance of the applet on the dock.
`panel_id` : | The ID of the panel to connect to.
Returns : | a new instance of an applet.

### awn_applet_simple_set_icon_pixbuf ()

    void                awn_applet_simple_set_icon_pixbuf   (AwnAppletSimple *applet,
                                                             GdkPixbuf *pixbuf);

`applet` : |
`pixbuf` : |

### awn_applet_simple_set_icon_context ()

    void                awn_applet_simple_set_icon_context  (AwnAppletSimple *applet,
                                                             cairo_t *cr);

`applet` : |
`cr` : |

### awn_applet_simple_set_icon_surface ()

    void                awn_applet_simple_set_icon_surface  (AwnAppletSimple *applet,
                                                             cairo_surface_t *surface);

`applet` : |
`surface` : |

### awn_applet_simple_set_icon_name ()

    void                awn_applet_simple_set_icon_name     (AwnAppletSimple *applet,
                                                             const gchar *icon_name);

`applet` : |
`icon_name` : |

### awn_applet_simple_set_icon_info ()

    void                awn_applet_simple_set_icon_info     (AwnAppletSimple *applet,
                                                             GStrv states,
                                                             GStrv icon_names);

`applet` : |
`states` : |
`icon_names` : |

### awn_applet_simple_set_icon_state ()

    void                awn_applet_simple_set_icon_state    (AwnAppletSimple *applet,
                                                             const gchar *state);

`applet` : |
`state` : |

### awn_applet_simple_set_tooltip_text ()

    void                awn_applet_simple_set_tooltip_text  (AwnAppletSimple *applet,
                                                             const gchar *text);

`applet` : |
`text` : |

### awn_applet_simple_get_tooltip_text ()

    gchar *             awn_applet_simple_get_tooltip_text  (AwnAppletSimple *applet);

`applet` : |
Returns : |

### awn_applet_simple_set_message ()

    void                awn_applet_simple_set_message       (AwnAppletSimple *applet,
                                                             const gchar *message);

`applet` : |
`message` : |

### awn_applet_simple_get_message ()

    gchar *             awn_applet_simple_get_message       (AwnAppletSimple *applet);

`applet` : |
Returns : |

### awn_applet_simple_set_progress ()

    void                awn_applet_simple_set_progress      (AwnAppletSimple *applet,
                                                             gfloat progress);

`applet` : |
`progress` : |

### awn_applet_simple_get_progress ()

    gfloat              awn_applet_simple_get_progress      (AwnAppletSimple *applet);

`applet` : |
Returns : |

### awn_applet_simple_get_icon ()

    AwnIcon *           awn_applet_simple_get_icon          (AwnAppletSimple *applet);

`applet` : |
Returns : |

### awn_applet_simple_set_effect ()

    void                awn_applet_simple_set_effect        (AwnAppletSimple *applet,
                                                             AwnEffect effect);

`applet` : |
`effect` : |

## Signal Details

### The `"clicked"` signal

    void                user_function                      (AwnAppletSimple *awnappletsimple,
                                                            gpointer         user_data)            : Run First / Action

`awnappletsimple` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"context-menu-popup"` signal

    void                user_function                      (AwnAppletSimple *applet,
                                                            GdkEvent        *event,
                                                            gpointer         user_data)      : Run First / Action

The ::context-menu-popup signal will be emitted when right mouse button is pressed on the icon.

`applet` : | the object which received the signal.
`event` : | the GdkEventButton which triggered this signal.
`user_data` : | user data set when the signal handler was connected.

### The `"middle-clicked"` signal

    void                user_function                      (AwnAppletSimple *awnappletsimple,
                                                            gpointer         user_data)            : Run First / Action

`awnappletsimple` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.