AwnIcon

AwnIcon

Synopsis

struct              AwnIcon;
struct              AwnIconClass;
GtkWidget *         awn_icon_new                        (void);
void                awn_icon_set_pos_type               (AwnIcon *icon,
                                                         GtkPositionType position);
GtkPositionType     awn_icon_get_pos_type               (AwnIcon *icon);
void                awn_icon_set_offset                 (AwnIcon *icon,
                                                         gint offset);
gint                awn_icon_get_offset                 (AwnIcon *icon);
void                awn_icon_set_effect                 (AwnIcon *icon,
                                                         AwnEffect effect);
void                awn_icon_set_from_pixbuf            (AwnIcon *icon,
                                                         GdkPixbuf *pixbuf);
void                awn_icon_set_from_context           (AwnIcon *icon,
                                                         cairo_t *ctx);
void                awn_icon_set_from_surface           (AwnIcon *icon,
                                                         cairo_surface_t *surface);
void                awn_icon_set_custom_paint           (AwnIcon *icon,
                                                         gint width,
                                                         gint height);
AwnTooltip *        awn_icon_get_tooltip                (AwnIcon *icon);
void                awn_icon_set_tooltip_text           (AwnIcon *icon,
                                                         const gchar *text);
gchar *             awn_icon_get_tooltip_text           (AwnIcon *icon);
void                awn_icon_set_is_active              (AwnIcon *icon,
                                                         gboolean is_active);
gboolean            awn_icon_get_is_active              (AwnIcon *icon);
void                awn_icon_set_indicator_count        (AwnIcon *icon,
                                                         gint count);
gint                awn_icon_get_indicator_count        (AwnIcon *icon);
gboolean            awn_icon_get_hover_effects          (AwnIcon *icon);
void                awn_icon_set_hover_effects          (AwnIcon *icon,
                                                         gboolean enable);
GdkRegion *         awn_icon_get_input_mask             (AwnIcon *icon);
void                awn_icon_clicked                    (AwnIcon *icon);
void                awn_icon_middle_clicked             (AwnIcon *icon);
void                awn_icon_popup_gtk_menu             (AwnIcon *icon,
                                                         GtkWidget *menu,
                                                         guint button,
                                                         guint32 activate_time);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkDrawingArea
                           +----AwnIcon
                                 +----AwnThemedIcon

Implemented Interfaces

AwnIcon implements AtkImplementorIface, GtkBuildable and AwnOverlayable.

Properties

  "bind-effects"             gboolean              : Read / Write / Construct Only
  "icon-height"              gint                  : Read / Write
  "icon-width"               gint                  : Read / Write
  "long-press-timeout"       gint                  : Read / Write / Construct

Signals

  "clicked"                                        : Action
  "context-menu-popup"                             : Action
  "long-press"                                     : Action
  "middle-clicked"                                 : Action
  "size-changed"                                   : Run First

Description

Details

struct AwnIcon

struct AwnIcon;


struct AwnIconClass

struct AwnIconClass {
    GtkDrawingAreaClass parent_class;

    void (*size_changed)(AwnIcon* icon);
    void (*clicked)(AwnIcon* icon);
    void (*middle_clicked)(AwnIcon* icon);
    void (*long_press)(AwnIcon* icon);
    void (*context_menu_popup)(AwnIcon* icon, GdkEventButton* event);

    void (*icon_padding0)(AwnIcon* icon);
    void (*icon_padding1)(AwnIcon* icon);
    void (*icon_padding2)(AwnIcon* icon);
    void (*icon_padding3)(AwnIcon* icon);
};


awn_icon_new ()

GtkWidget *         awn_icon_new                        (void);


awn_icon_set_pos_type ()

void                awn_icon_set_pos_type               (AwnIcon *icon,
                                                         GtkPositionType position);


awn_icon_get_pos_type ()

GtkPositionType     awn_icon_get_pos_type               (AwnIcon *icon);


awn_icon_set_offset ()

void                awn_icon_set_offset                 (AwnIcon *icon,
                                                         gint offset);


awn_icon_get_offset ()

gint                awn_icon_get_offset                 (AwnIcon *icon);


awn_icon_set_effect ()

void                awn_icon_set_effect                 (AwnIcon *icon,
                                                         AwnEffect effect);


awn_icon_set_from_pixbuf ()

void                awn_icon_set_from_pixbuf            (AwnIcon *icon,
                                                         GdkPixbuf *pixbuf);


awn_icon_set_from_context ()

void                awn_icon_set_from_context           (AwnIcon *icon,
                                                         cairo_t *ctx);


awn_icon_set_from_surface ()

void                awn_icon_set_from_surface           (AwnIcon *icon,
                                                         cairo_surface_t *surface);


awn_icon_set_custom_paint ()

void                awn_icon_set_custom_paint           (AwnIcon *icon,
                                                         gint width,
                                                         gint height);


awn_icon_get_tooltip ()

AwnTooltip *        awn_icon_get_tooltip                (AwnIcon *icon);


awn_icon_set_tooltip_text ()

void                awn_icon_set_tooltip_text           (AwnIcon *icon,
                                                         const gchar *text);


awn_icon_get_tooltip_text ()

gchar *             awn_icon_get_tooltip_text           (AwnIcon *icon);


awn_icon_set_is_active ()

void                awn_icon_set_is_active              (AwnIcon *icon,
                                                         gboolean is_active);


awn_icon_get_is_active ()

gboolean            awn_icon_get_is_active              (AwnIcon *icon);


awn_icon_set_indicator_count ()

void                awn_icon_set_indicator_count        (AwnIcon *icon,
                                                         gint count);


awn_icon_get_indicator_count ()

gint                awn_icon_get_indicator_count        (AwnIcon *icon);


awn_icon_get_hover_effects ()

gboolean            awn_icon_get_hover_effects          (AwnIcon *icon);


awn_icon_set_hover_effects ()

void                awn_icon_set_hover_effects          (AwnIcon *icon,
                                                         gboolean enable);


awn_icon_get_input_mask ()

GdkRegion *         awn_icon_get_input_mask             (AwnIcon *icon);


awn_icon_clicked ()

void                awn_icon_clicked                    (AwnIcon *icon);


awn_icon_middle_clicked ()

void                awn_icon_middle_clicked             (AwnIcon *icon);


awn_icon_popup_gtk_menu ()

void                awn_icon_popup_gtk_menu             (AwnIcon *icon,
                                                         GtkWidget *menu,
                                                         guint button,
                                                         guint32 activate_time);

Property Details

The "bind-effects" property

  "bind-effects"             gboolean              : Read / Write / Construct Only

If set to true, will load and bind effect property values from config client.

Default value: TRUE


The "icon-height" property

  "icon-height"              gint                  : Read / Write

Current icon height.

Allowed values: >= 0

Default value: 0


The "icon-width" property

  "icon-width"               gint                  : Read / Write

Current icon width.

Allowed values: >= 0

Default value: 0


The "long-press-timeout" property

  "long-press-timeout"       gint                  : Read / Write / Construct

Timeout after which long-press signal is emit.

Allowed values: [250,10000]

Default value: 750

Signal Details

The "clicked" signal

void                user_function                      (AwnIcon *awnicon,
                                                        gpointer user_data)      : Action

awnicon :

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                      (AwnIcon  *awnicon,
                                                        GdkEvent *arg1,
                                                        gpointer  user_data)      : Action

awnicon :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "long-press" signal

void                user_function                      (AwnIcon *awnicon,
                                                        gpointer user_data)      : Action

awnicon :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "middle-clicked" signal

void                user_function                      (AwnIcon *awnicon,
                                                        gpointer user_data)      : Action

awnicon :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "size-changed" signal

void                user_function                      (AwnIcon *awnicon,
                                                        gpointer user_data)      : Run First

awnicon :

the object which received the signal.

user_data :

user data set when the signal handler was connected.