include/alp/progress.h File Reference


Detailed Description

ALP Progress Interface (API).

#include <gtk/gtkwidget.h>

Go to the source code of this file.

AlpProgress Object and Class Definitions

#define ALP_IS_PROGRESS(object)   (G_TYPE_CHECK_INSTANCE_TYPE ((object), ALP_TYPE_PROGRESS))
#define ALP_PROGRESS(object)   (G_TYPE_CHECK_INSTANCE_CAST ((object), ALP_TYPE_PROGRESS, AlpProgress))
#define ALP_TYPE_PROGRESS   (alp_progress_get_type ())
typedef _AlpProgress AlpProgress
GType alp_progress_get_type (void) G_GNUC_CONST
 get_type method for AlpProgress interface
#define ALP_PROGRESS_CANCEL_BUTTON   ((GtkWidget *)0x4)
#define ALP_PROGRESS_DEF_WIDGETS   ALP_PROGRESS_LABEL , ALP_PROGRESS_SECONDARY , ALP_PROGRESS_PBAR, ALP_PROGRESS_CANCEL_BUTTON
#define ALP_PROGRESS_LABEL   ((GtkWidget *)0x1)
 Widgets that are special to the progress API.
#define ALP_PROGRESS_PBAR   ((GtkWidget *)0x3)
#define ALP_PROGRESS_SECONDARY   ((GtkWidget *)0x2)

Interface API

Interface API calls for image and the well known progress widgets: label, secondary and pbar

void alp_progress_add_action_widget (AlpProgress *self, GtkWidget *child, gint response_id)
 Add widget to the button box of the action area.
GtkWidget * alp_progress_add_button (AlpProgress *self, const gchar *button_text, gint response_id)
 Add a button to the action area.
GtkWidget * alp_progress_add_widget (AlpProgress *self, GtkWidget *child)
 Add widget to widget area.
GtkWidget * alp_progress_get_image (AlpProgress *self)
 Return image widget being used in the AlpProgressDialog or AlpProgressWidget.
GtkWidget * alp_progress_get_label (AlpProgress *self)
 Return label widget being used for the AlpProgress's primary label.
void GtkWidget * alp_progress_get_pbar (AlpProgress *self)
 Return progress bar widget being used for the AlpProgress's progress bar.
void GtkWidget * alp_progress_get_secondary (AlpProgress *self)
 Return label widget being used for the AlpProgressDialog's secondary label.
void alp_progress_image_set_from_animation (AlpProgress *self, GdkPixbufAnimation *pixbuf_animation)
 Set image from a pixbuf animation.
void alp_progress_image_set_from_file (AlpProgress *self, const gchar *filename)
 Set the image from a file.
void alp_progress_image_set_from_pixbuf (AlpProgress *self, GdkPixbuf *pixbuf)
 Set the image from a pixbuf.
void alp_progress_image_set_from_stock (AlpProgress *self, const gchar *stock_id)
 Set image from a stock icon.
void alp_progress_label_format_markup (AlpProgress *self, const gchar *format,...) G_GNUC_PRINTF(2
 Format markup text for the primary label.
void alp_progress_label_format_text (AlpProgress *self, const gchar *format,...) G_GNUC_PRINTF(2
 Format text for the primary label.
void void alp_progress_label_set_markup (AlpProgress *self, const gchar *text)
 Set the markup text of the primary label.
void alp_progress_label_set_text (AlpProgress *self, const gchar *text)
 Set the text of the primary label.
void alp_progress_pbar_format_text (AlpProgress *self, const gchar *format,...) G_GNUC_PRINTF(2
 Format the text to appear superimposed on the progress bar.
void alp_progress_pbar_pulse (AlpProgress *self)
 Indicates that some progress is made, but you don't know how much.
void alp_progress_pbar_set_fraction (AlpProgress *self, gdouble fraction)
 Set the fraction of "completedness" of the progress bar.
void alp_progress_pbar_set_pulse_step (AlpProgress *self, gdouble fraction)
 Set the fraction to move the bouncing block.
void alp_progress_pbar_set_text (AlpProgress *self, const gchar *text)
 See the text to appear superimposed on the progress bar.
void alp_progress_pbar_start_pulse (AlpProgress *self, guint interval)
 Automatically pulse the progress bar at the specified rate.
void alp_progress_pbar_stop_pulse (AlpProgress *self)
 Stop automatic pulsing of the progress bar.
void alp_progress_response (AlpProgress *self, gint response_id)
 Generate "cancel" or "response" signal for the given widget and response id to simulate an user press on the widget.
void alp_progress_secondary_format_markup (AlpProgress *self, const gchar *format,...) G_GNUC_PRINTF(2
 Format markup text for the secondary label.
void alp_progress_secondary_format_text (AlpProgress *self, const gchar *format,...) G_GNUC_PRINTF(2
 Format text for the secondary label.
void void alp_progress_secondary_set_markup (AlpProgress *self, const gchar *text)
 Set the markup text of the secondary label.
void alp_progress_secondary_set_text (AlpProgress *self, const gchar *text)
 Set the text of the secondary label.


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

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.