![]() |
![]() |
![]() |
Awn Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
AwnIconPrivate; struct AwnIcon; 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
); void awn_icon_clicked (AwnIcon *icon
); void awn_icon_middle_clicked (AwnIcon *icon
);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkDrawingArea +----AwnIcon +----AwnThemedIcon
"bind-effects" gboolean : Read / Write / Construct Only "icon-height" gint : Read / Write "icon-width" gint : Read / Write "long-press-timeout" gint : Read / Write / Construct
"clicked" :Action
"context-menu-popup" :Action
"long-press" :Action
"middle-clicked" :Action
"size-changed" :Run First
GtkWidget * awn_icon_new (void
);
Creates new AwnIcon.
Returns : |
newly created AwnIcon. |
void awn_icon_set_pos_type (AwnIcon *icon
,GtkPositionType position
);
Sets position of the icon.
|
an AwnIcon. |
|
position of the icon. |
GtkPositionType awn_icon_get_pos_type (AwnIcon *icon
);
|
an AwnIcon. |
Returns : |
current position type set for the icon. |
void awn_icon_set_offset (AwnIcon *icon
,gint offset
);
Sets offset of the icon.
|
an AwnIcon. |
|
new offset for the icon. |
gint awn_icon_get_offset (AwnIcon *icon
);
|
an AwnIcon. |
Returns : |
current offset set for the icon. |
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.
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.
|
an AwnIcon. |
|
a GdkPixbuf. |
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()
).
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()
).
|
an AwnIcon. |
|
a cairo_surface_t. |
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.
awn_icon_set_custom_paint()
with the original dimensions of the icon will
restore the icon.
|
an AwnIcon. |
|
new width of the icon. |
|
new height of the icon. |
AwnTooltip * awn_icon_get_tooltip (AwnIcon *icon
);
Gets the AwnTooltip associated with this icon.
|
an AwnIcon. |
Returns : |
tooltip widget. |
void awn_icon_set_tooltip_text (AwnIcon *icon
,const gchar *text
);
Sets tooltip message.
|
an AwnIcon. |
|
tooltip message. |
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.
|
an AwnIcon. |
Returns : |
currently used message by the associated AwnTooltip. |
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).
|
an AwnIcon. |
|
value. |
gboolean awn_icon_get_is_active (AwnIcon *icon
);
Gets whether the icon is active.
|
an AwnIcon. |
Returns : |
TRUE if the icon is active, FALSE otherwise. |
void awn_icon_set_indicator_count (AwnIcon *icon
,gint count
);
Paints an indicator (or multiple) on the border of icon.
|
an AwnIcon. |
|
indicator count. |
gint awn_icon_get_indicator_count (AwnIcon *icon
);
Gets number of indicators set for this icon.
|
an AwnIcon. |
Returns : |
number of indicators. |
"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
"icon-height"
property"icon-height" gint : Read / Write
Current icon height.
Allowed values: >= 0
Default value: 0
"icon-width"
property"icon-width" gint : Read / Write
Current icon width.
Allowed values: >= 0
Default value: 0
"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
"clicked"
signalvoid user_function (AwnIcon *awnicon,
gpointer user_data) : Action
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"context-menu-popup"
signalvoid user_function (AwnIcon *awnicon,
GdkEvent *arg1,
gpointer user_data) : Action
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"long-press"
signalvoid user_function (AwnIcon *awnicon,
gpointer user_data) : Action
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"middle-clicked"
signalvoid user_function (AwnIcon *awnicon,
gpointer user_data) : Action
|
the object which received the signal. |
|
user data set when the signal handler was connected. |