AlpPixbuf
[UI Utilities]

Functions

GdkPixbufAnimation * alp_pixbuf_animation_new_from_url (const gchar *bundle_name, const gchar *image_url)

Create and load a pixbuf animation from an URL reference.

GdkPixbuf * alp_pixbuf_new_badged_at_scale (GdkPixbuf *base_image, GtkWidget *context, const gchar *bundle_name, const gchar *badge_urls[], gint badge_count, const gchar *size, gboolean preserve_aspect_ratio)

Overlay badge images on the provided base image, scaling it to the desired size.

GdkPixbuf * alp_pixbuf_new_from_url_at_scale (GtkWidget *context, const gchar *bundle_name, const gchar *url, const gchar *size, gboolean preserve_aspect_ratio)

Create and load a pixbuf from an URL reference, scaling it to the desired size.

GdkPixbuf * alp_pixbuf_new_from_url_at_scale_badged (GtkWidget *context, const gchar *bundle_name, const gchar *url, const gchar *badge_urls[], gint badge_count, const gchar *size, gboolean preserve_aspect_ratio)

Create and load a pixbuf from an URL reference, scaling it to the desired size, with badge images overlaid on the base image.

void alp_pixbuf_simple_anim_add_url_sequence_at_scale (GdkPixbufSimpleAnim *anim, GtkWidget *context, const gchar *size, gboolean preserve_aspect_ratio, const gchar *bundle_name, const gchar *format, gint sequence_start, gint sequence_end, gint seqeunce_increment)

Append one or more images from numerically generated URL references to a simple pixbuf animation, and scaling them to the desired size.

void alp_pixbuf_simple_anim_add_urls (GdkPixbufSimpleAnim *anim, const gchar *bundle_name,...)

Append one or more images from URL references to a simple pixbuf animation.

void alp_pixbuf_simple_anim_add_urls_at_scale (GdkPixbufSimpleAnim *anim, GtkWidget *context, const gchar *size, gboolean preserve_aspect_ratio, const gchar *bundle_name,...)

Append one or more images from URL references to a simple pixbuf animation, scaling them to the desired size.

void alp_pixbuf_simple_anim_add_urls_at_scale_valist (GdkPixbufSimpleAnim *anim, GtkWidget *context, const gchar *size, gboolean preserve_aspect_ratio, const gchar *bundle_name, va_list valist)

Append one or more images from URL references to a simple pixbuf animation, using a vararg list, and scaling them to the desired size.

void alp_pixbuf_simple_anim_add_urls_valist (GdkPixbufSimpleAnim *anim, const gchar *bundle_name, va_list valist)

Append one or more images from URL references to a simple pixbuf animation, using a vararg list.

GdkPixbufSimpleAnim * alp_pixbuf_simple_anim_new_from_name (const gchar *size_name, float rate)

Create an empty simple pixbuf animation, sizing it to a standard icon size.

Function Documentation

GdkPixbufAnimation* alp_pixbuf_animation_new_from_url ( const gchar * bundle_name,

const gchar * image_url

)

Create and load a pixbuf animation from an URL reference.

Parameters:

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] url URL reference to file. May be relative if a reference bundle name is provided. Currently supported URLs are: relative, bar:, and file:.

Returns:
GdkPixbufAnimation * of newly allocated pixbuf animation with loaded animation.
NULL if unable to either create the pixbuf animation or load the file containing the animation.

GdkPixbuf* alp_pixbuf_new_badged_at_scale ( GdkPixbuf * base_image,

GtkWidget * context,

const gchar * bundle_name,

const gchar * badge_urls[],

gint badge_count,

const gchar * size,

gboolean preserve_aspect_ratio

)

Overlay badge images on the provided base image, scaling it to the desired size.

Parameters:

[in] base_image GdkPixbuf containing the base image, to which the badge images will be applied.

[in] context A widget pointer from which to get theme engine and rc file settings. Used in rendering the stock icons. Must not be NULL if URL is for a stock icon (stockicon:).

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] badge_urls Array of URL references for badge overlays. May be relative if reference bundle name is provided. Currently supported URLs are: relative, bar:, file:, and stockicon: .

[in] badge_count Size of badge_urls array.

[in] size Defined size string for theme use.

See also:
icons.h. If NULL , a default side will be used.

Parameters:

[in] preserve_aspect_ratio Use TRUE to preserve the images's aspect ratio.

Returns:
GdkPixbuf * of newly allocated pixbuf with scaled and badged image
NULL if unable to either create copy base pixbuf or apply badges onto base image.

GdkPixbuf* alp_pixbuf_new_from_url_at_scale ( GtkWidget * context,

const gchar * bundle_name,

const gchar * url,

const gchar * size,

gboolean preserve_aspect_ratio

)

Create and load a pixbuf from an URL reference, scaling it to the desired size.

Parameters:

[in] context A widget pointer from which to get theme engine and rc file settings. Used in rendering the stock icons. Must not be NULL if URL is for a stock icon (stockicon:).

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] url URL reference to file. May be relative if a reference bundle name is provided. Currently supported URLs are: relative, bar:, file: and stockicon: .

[in] size Defined size string for theme use.

See also:
icons.h. If NULL , a default size will be used.

Parameters:

[in] preserve_aspect_ratio Use TRUE to preserve the image's aspect ratio.

Returns:
GdkPixbuf * of newly allocated pixbuf with loaded image
NULL if unable to either create pixbuf or load the file image into pixbuf.

GdkPixbuf* alp_pixbuf_new_from_url_at_scale_badged ( GtkWidget * context,

const gchar * bundle_name,

const gchar * url,

const gchar * badge_urls[],

gint badge_count,

const gchar * size,

gboolean preserve_aspect_ratio

)

Create and load a pixbuf from an URL reference, scaling it to the desired size, with badge images overlaid on the base image.

Parameters:

[in] context A widget pointer from which to get theme engine and rc file settings. Used in rendering the stock icons. Must not be NULL if URL is for a stock icon (stockicon:).

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] url URL reference to file for base image. May be relative if reference bundle name is provided. Currently supported URLs are: relative, bar:, file: and stockicon: .

[in] badge_urls Array of URL references for badge overlays. May be relative if reference bundle name is provided. Currently supported URLs are: relative, bar:, file:, and stockicon: .

[in] badge_count Size of badge_urls array.

[in] size Defined size string for theme use.

See also:
icons.h. If NULL , a default side will be used.

Parameters:

[in] preserve_aspect_ratio Use TRUE to preserve the images's aspect ratio.

Returns:
GdkPixbuf * of newly allocated pixbuf with loaded and badged image
NULL if unable to either create base image pixbuf or load the file image into pixbuf.

void alp_pixbuf_simple_anim_add_url_sequence_at_scale ( GdkPixbufSimpleAnim * anim,

GtkWidget * context,

const gchar * size,

gboolean preserve_aspect_ratio,

const gchar * bundle_name,

const gchar * format,

gint sequence_start,

gint sequence_end,

gint seqeunce_increment

)

Append one or more images from numerically generated URL references to a simple pixbuf animation, and scaling them to the desired size.

Parameters:

[in] anim The simple pixbuf animation, created using gdk_pixbuf_simple_anim_new()

[in] context A widget pointer from which to get theme engine and rc file settings. Used in rendering the stock icons. Must not be NULL if URL is for a stock icon (stockicon:).

[in] size Defined size string for theme use.

See also:
icons.h. If NULL , a default size will be used.

Parameters:

[in] preserve_aspect_ratio Use TRUE to preserve the image's aspect ratio.

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] format A printf-type format string containing an integer specifier.

[in] seqeunce_start A starting value for a numeric sequence

[in] seqeunce_end An ending value for a numeric sequence

[in] seqeunce_increment An increment value for a numeric sequence

Remarks:
See the remarks for alp_pixbuf_simple_anim_append_from_urls_at_scale().
A typical use would be with a format string = "MyIcon%02d", start_val = 1, end_val = 11, and increment = 2. This would generate successive URLs of "MyIcon01", "MyIcon03", "MyIcon05", "MyIcon07", "MyIcon09", and "MyIcon11"
sequence_start, sequence_end, and seqeunce_increment can be any gint values. For instance, if the increment is negative, the numbers in the format string will decrease, so the animation will play "backwards" compared to a positive increment. Also, sequence_start and/or sequence_end can be negative; just make sure to construct the format string correctly to get the desired result.

void alp_pixbuf_simple_anim_add_urls ( GdkPixbufSimpleAnim * anim,

const gchar * bundle_name,

...

)

Append one or more images from URL references to a simple pixbuf animation.

Parameters:

[in] anim The simple pixbuf animation, created using gdk_pixbuf_simple_anim_new()

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] ... A NULL-terminated list of const gchar* containing URL references to files. May be relative if a reference bundle name is provided. Currently supported URLs are: relative, bar:, and file:

Remarks:
This can be called multiple times for the same simple pixbuf animation to assemble an animation from different bundles. It will emit glib warnings at runtime for invalid URLs.
Some tips on using GdkPixbufSimpleAnim: 1. The raster images in the animation must be the same size as the width and height specified when the animation was created. If an individual image has a different size, it will be inserted silently into the animation sequence. But if the animation is played, at the point in the sequence where a wrong-size image would normally be rendered, a glib warning will be issued, and nothing at all will be rendered. 2. If there are no images in a GdkPixbufSimpleAnim, and an attempt is made to render it, a glib error is triggered, which will cause the program to crash.

void alp_pixbuf_simple_anim_add_urls_at_scale ( GdkPixbufSimpleAnim * anim,

GtkWidget * context,

const gchar * size,

gboolean preserve_aspect_ratio,

const gchar * bundle_name,

...

)

Append one or more images from URL references to a simple pixbuf animation, scaling them to the desired size.

Parameters:

[in] anim The simple pixbuf animation, created using gdk_pixbuf_simple_anim_new()

[in] context A widget pointer from which to get theme engine and rc file settings. Used in rendering the stock icons. Must not be NULL if URL is for a stock icon (stockicon:).

[in] size Defined size string for theme use.

See also:
icons.h. If NULL , a default size will be used.

Parameters:

[in] preserve_aspect_ratio Use TRUE to preserve the image's aspect ratio.

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] ... A NULL-terminated list of const gchar* containing URL references to files. May be relative if a reference bundle name is provided. Currently supported URLs are: relative, bar:, file: and stockicon: .

Remarks:
See the remarks for alp_pixbuf_simple_anim_append_images_from_urls().
When this routine is used with stock icons, it's convenient to create the animation with alp_pixbuf_simple_anim_new_from_icon_size_name(), which takes a stock icon size name instead of numerical size parameters.
If the size parameter does not match the animation's existing height and width, a glib warning will be issued, but the images will still be appended.
When this routine is used with stock icons, it's convenient to create the animation with alp_pixbuf_simple_anim_new_from_name(), which takes a stock icon size name instead of numerical size parameters.

void alp_pixbuf_simple_anim_add_urls_at_scale_valist ( GdkPixbufSimpleAnim * anim,

GtkWidget * context,

const gchar * size,

gboolean preserve_aspect_ratio,

const gchar * bundle_name,

va_list valist

)

Append one or more images from URL references to a simple pixbuf animation, using a vararg list, and scaling them to the desired size.

Parameters:

[in] anim The simple pixbuf animation, created using gdk_pixbuf_simple_anim_new()

[in] context A widget pointer from which to get theme engine and rc file settings. Used in rendering the stock icons. Must not be NULL if URL is for a stock icon (stockicon:).

[in] size Defined size string for theme use.

See also:
icons.h. If NULL , a default size will be used.

Parameters:

[in] preserve_aspect_ratio Use TRUE to preserve the image's aspect ratio.

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] valist A vararg list containing pointers to URL strings. May be relative if a reference bundle name is provided. Currently supported URLs are: relative, bar:, file:, and stockicon: .

Remarks:
See the remarks for alp_pixbuf_simple_anim_append_from_urls_at_scale().

void alp_pixbuf_simple_anim_add_urls_valist ( GdkPixbufSimpleAnim * anim,

const gchar * bundle_name,

va_list valist

)

Append one or more images from URL references to a simple pixbuf animation, using a vararg list.

Parameters:

[in] anim The simple pixbuf animation, created using gdk_pixbuf_simple_anim_new()

[in] bundle_name Name of bundle to use as reference for relative URLs.

[in] valist A vararg list containing pointers to URL strings. May be relative if a reference bundle name is provided. Currently supported URLs are: relative, bar:, and file:

Remarks:
See the remarks for alp_pixbuf_simple_anim_append_images_from_urls().

GdkPixbufSimpleAnim* alp_pixbuf_simple_anim_new_from_name ( const gchar * size_name,

float rate

)

Create an empty simple pixbuf animation, sizing it to a standard icon size.

Parameters:

[in] size_name Defined size string for theme use.

See also:
icons.h. If NULL , a default size will be used.

Parameters:

[in] rate The speed of the animation, in frames per second

Returns:
GdkPixbufSimpleAnim * of newly allocated pixbuf simple animation
NULL if unable to create the simple pixbuf animation

Remarks:
If the size string does not correspond to a valid icon size, a glib CRITICAL message will be issued

Generated on Wed Jul 30 07:06:41 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Functions
GdkPixbufAnimation *	alp_pixbuf_animation_new_from_url (const gchar bundle_name, const gchar image_url)
	Create and load a pixbuf animation from an URL reference.
GdkPixbuf *	alp_pixbuf_new_badged_at_scale (GdkPixbuf base_image, GtkWidget context, const gchar bundle_name, const gchar badge_urls[], gint badge_count, const gchar *size, gboolean preserve_aspect_ratio)
	Overlay badge images on the provided base image, scaling it to the desired size.
GdkPixbuf *	alp_pixbuf_new_from_url_at_scale (GtkWidget context, const gchar bundle_name, const gchar url, const gchar size, gboolean preserve_aspect_ratio)
	Create and load a pixbuf from an URL reference, scaling it to the desired size.
GdkPixbuf *	alp_pixbuf_new_from_url_at_scale_badged (GtkWidget context, const gchar bundle_name, const gchar url, const gchar badge_urls[], gint badge_count, const gchar *size, gboolean preserve_aspect_ratio)
	Create and load a pixbuf from an URL reference, scaling it to the desired size, with badge images overlaid on the base image.
void	alp_pixbuf_simple_anim_add_url_sequence_at_scale (GdkPixbufSimpleAnim anim, GtkWidget context, const gchar size, gboolean preserve_aspect_ratio, const gchar bundle_name, const gchar *format, gint sequence_start, gint sequence_end, gint seqeunce_increment)
	Append one or more images from numerically generated URL references to a simple pixbuf animation, and scaling them to the desired size.
void	alp_pixbuf_simple_anim_add_urls (GdkPixbufSimpleAnim anim, const gchar bundle_name,...)
	Append one or more images from URL references to a simple pixbuf animation.
void	alp_pixbuf_simple_anim_add_urls_at_scale (GdkPixbufSimpleAnim anim, GtkWidget context, const gchar size, gboolean preserve_aspect_ratio, const gchar bundle_name,...)
	Append one or more images from URL references to a simple pixbuf animation, scaling them to the desired size.
void	alp_pixbuf_simple_anim_add_urls_at_scale_valist (GdkPixbufSimpleAnim anim, GtkWidget context, const gchar size, gboolean preserve_aspect_ratio, const gchar bundle_name, va_list valist)
	Append one or more images from URL references to a simple pixbuf animation, using a vararg list, and scaling them to the desired size.
void	alp_pixbuf_simple_anim_add_urls_valist (GdkPixbufSimpleAnim anim, const gchar bundle_name, va_list valist)
	Append one or more images from URL references to a simple pixbuf animation, using a vararg list.
GdkPixbufSimpleAnim *	alp_pixbuf_simple_anim_new_from_name (const gchar *size_name, float rate)
	Create an empty simple pixbuf animation, sizing it to a standard icon size.

AlpPixbuf [UI Utilities]

Functions

Function Documentation

AlpPixbuf
[UI Utilities]