## AwnApplet AwnApplet |

## Functions

gboolean | (*AwnAppletInitFunc) ()
AwnApplet * | (*AwnAppletInitPFunc) ()
AwnApplet * | awn_applet_new ()
const gchar * | awn_applet_get_canonical_name ()
GtkPositionType | awn_applet_get_pos_type ()
void | awn_applet_set_pos_type ()
AwnPathType | awn_applet_get_path_type ()
void | awn_applet_set_path_type ()
gint | awn_applet_get_offset ()
gint | awn_applet_get_offset_at ()
void | awn_applet_set_offset ()
gint | awn_applet_get_size ()
void | awn_applet_set_size ()
const gchar * | awn_applet_get_uid ()
void | awn_applet_set_uid ()
AwnAppletFlags | awn_applet_get_behavior ()
void | awn_applet_set_behavior ()
GtkWidget * | awn_applet_create_default_menu ()
guint | awn_applet_inhibit_autohide ()
void | awn_applet_uninhibit_autohide ()
GdkNativeWindow | awn_applet_docklet_request ()
GtkWidget * | awn_applet_create_pref_item ()
GtkWidget * | awn_applet_create_about_item ()
GtkWidget * | awn_applet_create_about_item_simple ()
void | awn_applet_popup_gtk_menu ()

## Properties

gchar * | canonical-name | Read / Write / Construct Only
gchar * | display-name | Read / Write
gint | max-size | Read / Write
gint | offset | Read / Write
gfloat | offset-modifier | Read / Write
gint | panel-id | Read / Write / Construct Only
gint64 | panel-xid | Read
gint | path-type | Read / Write / Construct
GtkPositionType | position | Read / Write
gboolean | quit-on-delete | Read / Write
gboolean | show-all-on-embed | Read / Write
gint | size | Read / Write
gchar * | uid | Read / Write / Construct

## Signals

void | applet-deleted | Run First
void | flags-changed | Run First
void | menu-creation | Run First
void | offset-changed | Run First
void | origin-changed | Run Last
void | panel-configure-event | Run Last
void | position-changed | Run First
void | size-changed | Run First

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkObject
                ╰── GtkWidget
                    ╰── GtkContainer
                        ╰── GtkBin
                            ╰── GtkWindow
                                ╰── GtkPlug
                                    ╰── AwnApplet
                                        ╰── AwnAppletSimple

## Description

## Functions

### AwnAppletInitFunc ()

    gboolean
    (*AwnAppletInitFunc) (AwnApplet *applet);

Function prototype used as entry point for applets. Hook to have an AwnApplet built for you.

#### Parameters

applet | AwnApplet instance created for you. |

#### Returns

return TRUE if applet construction was successful, FALSE otherwise.

### AwnAppletInitPFunc ()

    AwnApplet *
    (*AwnAppletInitPFunc) (const gchar *canonical_name,
                           const gchar *uid,
                           gint panel_id);

Function prototype used as entry point for applets. Hook to build your own AwnApplet.

#### Parameters

canonical_name | applet's canonical name. |
uid | applet's unique ID. |
panel_id | ID of AwnPanel associated with this applet. |

#### Returns

return the constructed AwnApplet (or its subclass) or NULL.

### awn_applet_new ()

    AwnApplet *
    awn_applet_new (const gchar *canonical_name,
                    const gchar *uid,
                    gint panel_id);

### awn_applet_get_canonical_name ()

    const gchar *
    awn_applet_get_canonical_name (AwnApplet *applet);

### awn_applet_get_pos_type ()

    GtkPositionType
    awn_applet_get_pos_type (AwnApplet *applet);

### awn_applet_set_pos_type ()

    void
    awn_applet_set_pos_type (AwnApplet *applet,
                             GtkPositionType position);

### awn_applet_get_path_type ()

    AwnPathType
    awn_applet_get_path_type (AwnApplet *applet);

### awn_applet_set_path_type ()

    void
    awn_applet_set_path_type (AwnApplet *applet,
                              AwnPathType path);

### awn_applet_get_offset ()

    gint
    awn_applet_get_offset (AwnApplet *applet);

### awn_applet_get_offset_at ()

    gint
    awn_applet_get_offset_at (AwnApplet *applet,
                              gint x,
                              gint y);

### awn_applet_set_offset ()

    void
    awn_applet_set_offset (AwnApplet *applet,
                           gint offset);

### awn_applet_get_size ()

    gint
    awn_applet_get_size (AwnApplet *applet);

### awn_applet_set_size ()

    void
    awn_applet_set_size (AwnApplet *applet,
                         gint size);

### awn_applet_get_uid ()

    const gchar *
    awn_applet_get_uid (AwnApplet *applet);

### awn_applet_set_uid ()

    void
    awn_applet_set_uid (AwnApplet *applet,
                        const gchar *uid);

### awn_applet_get_behavior ()

    AwnAppletFlags
    awn_applet_get_behavior (AwnApplet *applet);

### awn_applet_set_behavior ()

    void
    awn_applet_set_behavior (AwnApplet *applet,
                             AwnAppletFlags flags);

### awn_applet_create_default_menu ()

    GtkWidget *
    awn_applet_create_default_menu (AwnApplet *applet);

### awn_applet_inhibit_autohide ()

    guint
    awn_applet_inhibit_autohide (AwnApplet *applet,
                                 const gchar *reason);

### awn_applet_uninhibit_autohide ()

    void
    awn_applet_uninhibit_autohide (AwnApplet *applet,
                                   guint cookie);

### awn_applet_docklet_request ()

    GdkNativeWindow
    awn_applet_docklet_request (AwnApplet *applet,
                                gint min_size,
                                gboolean shrink,
                                gboolean expand);

### awn_applet_create_pref_item ()

    GtkWidget *
    awn_applet_create_pref_item (void);

### awn_applet_create_about_item ()

    GtkWidget *
    awn_applet_create_about_item (AwnApplet *applet,
                                  const gchar *copyright,
                                  AwnAppletLicense license,
                                  const gchar *version,
                                  const gchar *comments,
                                  const gchar *website,
                                  const gchar *website_label,
                                  const gchar *icon_name,
                                  const gchar *translator_credits,
                                  const gchar **authors,
                                  const gchar **artists,
                                  const gchar **documenters);

### awn_applet_create_about_item_simple ()

    GtkWidget *
    awn_applet_create_about_item_simple (AwnApplet *applet,
                                         const gchar *copyright,
                                         AwnAppletLicense license,
                                         const gchar *version);

### awn_applet_popup_gtk_menu ()

    void
    awn_applet_popup_gtk_menu (AwnApplet *applet,
                               GtkWidget *menu,
                               guint button,
                               guint32 activate_time);

## Types and Values

## Property Details

### The `“canonical-name”` property

      “canonical-name”           gchar *

Canonical name for the applet, this should be also be the name of the directory the applet is in.

Flags: Read / Write / Construct Only

Default value: NULL

### The `“display-name”` property

      “display-name”             gchar *

Display name for the applet.

Flags: Read / Write

Default value: NULL

### The `“max-size”` property

      “max-size”                 gint

The maximum visible size of the applet.

Flags: Read / Write

Allowed values: >= 0

Default value: 48

### The `“offset”` property

      “offset”                   gint

Icon offset set on the bar.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

### The `“offset-modifier”` property

      “offset-modifier”          gfloat

Offset modifier for non-linear path types.

Flags: Read / Write

Default value: 1

### The `“panel-id”` property

      “panel-id”                 gint

The id of AwnPanel this applet connects to.

Flags: Read / Write / Construct Only

Allowed values: >= 0

Default value: 0

### The `“panel-xid”` property

      “panel-xid”                gint64

The XID of AwnPanel this applet is connected to.

Flags: Read

Default value: 0

### The `“path-type”` property

      “path-type”                gint

Path used on the panel.

Flags: Read / Write / Construct

Allowed values: [0,1]

Default value: 0

### The `“position”` property

      “position”                 GtkPositionType

The current bar position.

Flags: Read / Write

Default value: GTK_POS_BOTTOM

### The `“quit-on-delete”` property

      “quit-on-delete”           gboolean

Quit the applet when it's socket is destroyed.

Flags: Read / Write

Default value: TRUE

### The `“show-all-on-embed”` property

      “show-all-on-embed”        gboolean

The applet will automatically call show_all when it's embedded in the socket.

Flags: Read / Write

Default value: TRUE

### The `“size”` property

      “size”                     gint

The current visible size of the bar.

Flags: Read / Write

Allowed values: >= 0

Default value: 48

### The `“uid”` property

      “uid”                      gchar *

Awn's Unique ID for this applet instance.

Flags: Read / Write / Construct

Default value: NULL

## Signal Details

### The `“applet-deleted”` signal

    void
    user_function (AwnApplet *awnapplet,
                   gpointer   user_data)

Flags: Run First

### The `“flags-changed”` signal

    void
    user_function (AwnApplet *awnapplet,
                   gint       arg1,
                   gpointer   user_data)

Flags: Run First

### The `“menu-creation”` signal

    void
    user_function (AwnApplet *awnapplet,
                   GtkMenu   *arg1,
                   gpointer   user_data)

Flags: Run First

### The `“offset-changed”` signal

    void
    user_function (AwnApplet *awnapplet,
                   gint       arg1,
                   gpointer   user_data)

Flags: Run First

### The `“origin-changed”` signal

    void
    user_function (AwnApplet    *awnapplet,
                   GdkRectangle *arg1,
                   gpointer      user_data)

Flags: Run Last

### The `“panel-configure-event”` signal

    void
    user_function (AwnApplet *awnapplet,
                   GdkEvent  *arg1,
                   gpointer   user_data)

Flags: Run Last

### The `“position-changed”` signal

    void
    user_function (AwnApplet      *awnapplet,
                   GtkPositionType arg1,
                   gpointer        user_data)

Flags: Run First

### The `“size-changed”` signal

    void
    user_function (AwnApplet *awnapplet,
                   gint       arg1,
                   gpointer   user_data)

Flags: Run First