katze-throbber

katze-throbber

Synopsis

#include <katze/katze.h>

GtkWidget *         katze_throbber_new                  (void);
void                katze_throbber_set_icon_size        (KatzeThrobber *throbber,
                                                         GtkIconSize icon_size);
void                katze_throbber_set_icon_name        (KatzeThrobber *throbber,
                                                         const gchar *icon_size);
void                katze_throbber_set_pixbuf           (KatzeThrobber *throbber,
                                                         GdkPixbuf *pixbuf);
void                katze_throbber_set_animated         (KatzeThrobber *throbber,
                                                         gboolean animated);
void                katze_throbber_set_static_icon_name (KatzeThrobber *throbber,
                                                         const gchar *icon_name);
void                katze_throbber_set_static_pixbuf    (KatzeThrobber *throbber,
                                                         GdkPixbuf *pixbuf);
void                katze_throbber_set_static_stock_id  (KatzeThrobber *throbber,
                                                         const gchar *stock_id);
GtkIconSize         katze_throbber_get_icon_size        (KatzeThrobber *throbber);
const gchar *       katze_throbber_get_icon_name        (KatzeThrobber *throbber);
GdkPixbuf *         katze_throbber_get_pixbuf           (KatzeThrobber *throbber);
gboolean            katze_throbber_get_animated         (KatzeThrobber *throbber);
const gchar *       katze_throbber_get_static_icon_name (KatzeThrobber *throbber);
GdkPixbuf *         katze_throbber_get_static_pixbuf    (KatzeThrobber *throbber);
const gchar *       katze_throbber_get_static_stock_id  (KatzeThrobber *throbber);
                    KatzeThrobber;
                    KatzeThrobberClass;

Description

Details

katze_throbber_new ()

GtkWidget *         katze_throbber_new                  (void);

Creates a new throbber widget.

Returns :

a new KatzeThrobber

katze_throbber_set_icon_size ()

void                katze_throbber_set_icon_size        (KatzeThrobber *throbber,
                                                         GtkIconSize icon_size);

Sets the desired size of the throbber image. The animation and static image will be displayed in this size. If a pixbuf is used for the animation every single frame is assumed to have this size.

throbber :

a KatzeThrobber

icon_size :

the new icon size

katze_throbber_set_icon_name ()

void                katze_throbber_set_icon_name        (KatzeThrobber *throbber,
                                                         const gchar *icon_size);

Sets the name of an icon that should provide the animation frames.

The pixbuf is automatically invalidated.

throbber :

a KatzeThrobber

icon_name :

an icon name or NULL

katze_throbber_set_pixbuf ()

void                katze_throbber_set_pixbuf           (KatzeThrobber *throbber,
                                                         GdkPixbuf *pixbuf);

Sets the pixbuf that should provide the animation frames. Every frame is assumed to have the icon size of the throbber, which can be specified with katze_throbber_set_icon_size().

The icon name is automatically invalidated.

throbber :

a KatzeThrobber

pixbuf :

a GdkPixbuf or NULL

katze_throbber_set_animated ()

void                katze_throbber_set_animated         (KatzeThrobber *throbber,
                                                         gboolean animated);

Sets the animation state of the throbber.

throbber :

a KatzeThrobber

animated :

TRUE to animate the throbber

katze_throbber_set_static_icon_name ()

void                katze_throbber_set_static_icon_name (KatzeThrobber *throbber,
                                                         const gchar *icon_name);

Sets the name of an icon that should provide the static image.

The static pixbuf and stock ID are automatically invalidated.

throbber :

a KatzeThrobber

icon_name :

an icon name or NULL

katze_throbber_set_static_pixbuf ()

void                katze_throbber_set_static_pixbuf    (KatzeThrobber *throbber,
                                                         GdkPixbuf *pixbuf);

Sets the pixbuf that should provide the static image. The pixbuf is assumed to have the icon size of the throbber, which can be specified with katze_throbber_set_icon_size().

The static icon name and stock ID are automatically invalidated.

throbber :

a KatzeThrobber

pixbuf :

a GdkPixbuf or NULL

katze_throbber_set_static_stock_id ()

void                katze_throbber_set_static_stock_id  (KatzeThrobber *throbber,
                                                         const gchar *stock_id);

Sets the stock ID of an icon that should provide the static image.

The static icon name and pixbuf are automatically invalidated.

throbber :

a KatzeThrobber

stock_id :

a stock ID or NULL

katze_throbber_get_icon_size ()

GtkIconSize         katze_throbber_get_icon_size        (KatzeThrobber *throbber);

Retrieves the size of the throbber.

throbber :

a KatzeThrobber

Returns :

the size of the throbber

katze_throbber_get_icon_name ()

const gchar *       katze_throbber_get_icon_name        (KatzeThrobber *throbber);

Retrieves the name of the icon providing the animation frames.

throbber :

a KatzeThrobber

Returns :

the name of the icon providing the animation frames, or NULL

katze_throbber_get_pixbuf ()

GdkPixbuf *         katze_throbber_get_pixbuf           (KatzeThrobber *throbber);

Retrieves the GdkPixbuf providing the animation frames if an icon name or pixbuf is available. The caller of this function does not own a reference to the returned pixbuf.

throbber :

a KatzeThrobber

Returns :

the pixbuf providing the animation frames, or NULL

katze_throbber_get_animated ()

gboolean            katze_throbber_get_animated         (KatzeThrobber *throbber);

Retrieves the status of the animation, whcih can be animated or static.

throbber :

a KatzeThrobber

Returns :

TRUE if the throbber is animated

katze_throbber_get_static_icon_name ()

const gchar *       katze_throbber_get_static_icon_name (KatzeThrobber *throbber);

Retrieves the name of the icon providing the static image, if an icon name for the static image was specified.

throbber :

a KatzeThrobber

Returns :

the name of the icon providing the static image, or NULL

katze_throbber_get_static_pixbuf ()

GdkPixbuf *         katze_throbber_get_static_pixbuf    (KatzeThrobber *throbber);

katze_throbber_get_static_stock_id ()

const gchar *       katze_throbber_get_static_stock_id  (KatzeThrobber *throbber);

Retrieves the stock ID of the icon providing the static image, if a stock ID for the static image was specified.

throbber :

a KatzeThrobber

Returns :

the stock ID of the icon providing the static image, or NULL

KatzeThrobber

typedef struct _KatzeThrobber KatzeThrobber;

KatzeThrobberClass

typedef struct _KatzeThrobberClass KatzeThrobberClass;