AwnIcon

AwnIcon

Functions

Properties

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

Signals

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

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkDrawingArea
                    ╰── AwnIcon
                        ╰── AwnThemedIcon

Implemented Interfaces

AwnIcon implements AtkImplementorIface, GtkBuildable and AwnOverlayable.

Description

Functions

awn_icon_new ()

GtkWidget *
awn_icon_new (void);

Creates new AwnIcon.

Returns

newly created AwnIcon.


awn_icon_set_pos_type ()

void
awn_icon_set_pos_type (AwnIcon *icon,
                       GtkPositionType position);

Sets position of the icon.

Parameters

icon

an AwnIcon.

 

position

position of the icon.

 

awn_icon_get_pos_type ()

GtkPositionType
awn_icon_get_pos_type (AwnIcon *icon);

Returns current position type set for the icon.

Parameters

icon

an AwnIcon.

 

awn_icon_set_offset ()

void
awn_icon_set_offset (AwnIcon *icon,
                     gint offset);

Sets offset of the icon.

Parameters

icon

an AwnIcon.

 

offset

new offset for the icon.

 

awn_icon_get_offset ()

gint
awn_icon_get_offset (AwnIcon *icon);

Returns current offset set for the icon.

Parameters

icon

an AwnIcon.

 

awn_icon_set_effect ()

void
awn_icon_set_effect (AwnIcon *icon,
                     AwnEffect effect);

Sets effect on the icon. Note that the effect will loop until awn_effects_stop() is called.

Parameters

icon

an AwnIcon.

 

effect

AwnEffect to start looping.

 

awn_icon_set_from_pixbuf ()

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

Sets the icon from the given pixbuf. Note that a copy of the pixbuf is made.

Parameters

icon

an AwnIcon.

 

pixbuf

a GdkPixbuf.

 

awn_icon_set_from_context ()

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

Extracts the icon from the cairo surface associated with given cairo context. Note that the surface is only referenced, so any later changes made to it will change the icon as well (after a call to gtk_widget_queue_draw()).

Parameters

icon

an AwnIcon.

 

ctx

a cairo_t.

 

awn_icon_set_from_surface ()

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

Sets the icon from the given cairo surface. Note that the surface is only referenced, so any later changes made to it will change the icon as well (after a call to gtk_widget_queue_draw()).

Parameters

icon

an AwnIcon.

 

surface

a cairo_surface_t.

 

awn_icon_set_custom_paint ()

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

Prepares the icon for custom painting (by overriding “expose-event”). Sets proper size requisition, tooltip position, parameters for AwnEffects and may emit size changed signal.

If there's already an icon set, it is not freed, so if you later disconnect from the “expose-event”, a second call to awn_icon_set_custom_paint() with the original dimensions of the icon will restore the icon.

Parameters

icon

an AwnIcon.

 

width

new width of the icon.

 

height

new height of the icon.

 

awn_icon_get_tooltip ()

AwnTooltip *
awn_icon_get_tooltip (AwnIcon *icon);

Gets the AwnTooltip associated with this icon.

Parameters

icon

an AwnIcon.

 

Returns

tooltip widget.


awn_icon_set_tooltip_text ()

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

Sets tooltip message.

Parameters

icon

an AwnIcon.

 

text

tooltip message.

 

awn_icon_get_tooltip_text ()

gchar *
awn_icon_get_tooltip_text (AwnIcon *icon);

Gets the message currently set for the associated AwnTooltip. The caller is responsible for freeing the string.

Parameters

icon

an AwnIcon.

 

Returns

currently used message by the associated AwnTooltip.


awn_icon_set_is_active ()

void
awn_icon_set_is_active (AwnIcon *icon,
                        gboolean is_active);

Sets whether the icon is active (if it is paints a rectangle around the icon by default).

Parameters

icon

an AwnIcon.

 

is_active

value.

 

awn_icon_get_is_active ()

gboolean
awn_icon_get_is_active (AwnIcon *icon);

Gets whether the icon is active.

Parameters

icon

an AwnIcon.

 

Returns

TRUE if the icon is active, FALSE otherwise.


awn_icon_set_indicator_count ()

void
awn_icon_set_indicator_count (AwnIcon *icon,
                              gint count);

Paints an indicator (or multiple) on the border of icon.

Parameters

icon

an AwnIcon.

 

count

indicator count.

 

awn_icon_get_indicator_count ()

gint
awn_icon_get_indicator_count (AwnIcon *icon);

Gets number of indicators set for this icon.

Parameters

icon

an AwnIcon.

 

Returns

number of indicators.


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_clicked ()

void
awn_icon_clicked (AwnIcon *icon);


awn_icon_middle_clicked ()

void
awn_icon_middle_clicked (AwnIcon *icon);

Types and Values

AwnIconPrivate

typedef struct _AwnIconPrivate AwnIconPrivate;


struct AwnIcon

struct AwnIcon;

Property Details

The “bind-effects” property

  “bind-effects”             gboolean

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

Flags: Read / Write / Construct Only

Default value: TRUE


The “icon-height” property

  “icon-height”              gint

Current icon height.

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “icon-width” property

  “icon-width”               gint

Current icon width.

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “long-press-timeout” property

  “long-press-timeout”       gint

Timeout after which long-press signal is emit.

Flags: Read / Write / Construct

Allowed values: [250,10000]

Default value: 750

Signal Details

The “clicked” signal

void
user_function (AwnIcon *awnicon,
               gpointer user_data)

Parameters

awnicon

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “context-menu-popup” signal

void
user_function (AwnIcon  *awnicon,
               GdkEvent *arg1,
               gpointer  user_data)

Parameters

awnicon

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “long-press” signal

void
user_function (AwnIcon *awnicon,
               gpointer user_data)

Parameters

awnicon

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “middle-clicked” signal

void
user_function (AwnIcon *awnicon,
               gpointer user_data)

Parameters

awnicon

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “size-changed” signal

void
user_function (AwnIcon *awnicon,
               gpointer user_data)

Parameters

awnicon

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First