include/alp/progress.h

Go to the documentation of this file.
00001 /******************************************************************************
00002  * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
00003  * Copyright (c) 2006, 2007 ACCESS Systems Americas, Inc. All rights reserved.
00004  *****************************************************************************/
00010 #ifndef __ALP_PROGRESS_H__
00011 #define __ALP_PROGRESS_H__
00012 
00013 #include <gtk/gtkwidget.h>
00014 
00015 G_BEGIN_DECLS
00016 
00027 #define ALP_TYPE_PROGRESS            (alp_progress_get_type ())
00028 #define ALP_PROGRESS(object)         (G_TYPE_CHECK_INSTANCE_CAST ((object), ALP_TYPE_PROGRESS, AlpProgress))
00029 #define ALP_IS_PROGRESS(object)      (G_TYPE_CHECK_INSTANCE_TYPE ((object), ALP_TYPE_PROGRESS))
00030 
00031 typedef struct _AlpProgress        AlpProgress;  /* Dummy typedef */
00032 
00038 GType        alp_progress_get_type          (void) G_GNUC_CONST;
00039 
00055 #define ALP_PROGRESS_LABEL             ((GtkWidget *)0x1)
00056 
00057 #define ALP_PROGRESS_SECONDARY         ((GtkWidget *)0x2)
00058 
00059 #define ALP_PROGRESS_PBAR              ((GtkWidget *)0x3)
00060 
00061 #define ALP_PROGRESS_CANCEL_BUTTON     ((GtkWidget *)0x4)
00062 /*
00063  * List specifying order and of kind of "default" widgets
00064  * to use in progress dialog's widget area.
00065  */
00066 #define ALP_PROGRESS_DEF_WIDGETS     ALP_PROGRESS_LABEL , ALP_PROGRESS_SECONDARY , ALP_PROGRESS_PBAR, ALP_PROGRESS_CANCEL_BUTTON
00067 
00083 void alp_progress_response (AlpProgress *self, gint response_id);
00084 
00092 GtkWidget *alp_progress_add_widget        (AlpProgress *self,
00093                                            GtkWidget         *child);
00094 
00102 GtkWidget *alp_progress_add_button        (AlpProgress *self,
00103                                            const gchar *button_text,
00104                                            gint         response_id);
00105 
00120 void alp_progress_add_action_widget       (AlpProgress *self,
00121                                            GtkWidget   *child,
00122                                            gint         response_id);
00123 
00130 GtkWidget   *alp_progress_get_image       (AlpProgress *self);
00131 
00150 void alp_progress_image_set_from_file     (AlpProgress *self,
00151                                            const gchar *filename);
00152 
00170 void alp_progress_image_set_from_pixbuf   (AlpProgress *self,
00171                                            GdkPixbuf   *pixbuf);
00185 void alp_progress_image_set_from_stock    (AlpProgress *self,
00186                                            const gchar *stock_id);
00187 
00206 void alp_progress_image_set_from_animation (AlpProgress *self,
00207                                             GdkPixbufAnimation         *pixbuf_animation);
00208 
00217 GtkWidget   *alp_progress_get_label       (AlpProgress *self);
00218 
00226 void alp_progress_label_set_text          (AlpProgress *self,
00227                                            const gchar *text);
00228 
00243 void alp_progress_label_format_text       (AlpProgress *self,
00244                                            const gchar *format,
00245                                            ...) G_GNUC_PRINTF (2, 3);
00246 
00254 void alp_progress_label_set_markup        (AlpProgress *self,
00255                                            const gchar *text);
00256 
00275 void alp_progress_label_format_markup     (AlpProgress *self,
00276                                            const gchar *format,
00277                                            ...) G_GNUC_PRINTF (2, 3);
00278 
00286 GtkWidget   *alp_progress_get_secondary   (AlpProgress *self);
00287 
00295 void alp_progress_secondary_set_text      (AlpProgress *self,
00296                                            const gchar *text);
00297 
00315 void alp_progress_secondary_format_text   (AlpProgress *self,
00316                                            const gchar *format,
00317                                            ...) G_GNUC_PRINTF (2, 3);
00318 
00326 void alp_progress_secondary_set_markup    (AlpProgress *self,
00327                                            const gchar *text);
00328 
00347 void alp_progress_secondary_format_markup (AlpProgress *self,
00348                                            const gchar *format,
00349                                            ...) G_GNUC_PRINTF (2, 3);
00350 
00359 GtkWidget   *alp_progress_get_pbar        (AlpProgress *self);
00360 
00373 void alp_progress_pbar_pulse              (AlpProgress *self);
00374 
00385 void alp_progress_pbar_set_pulse_step     (AlpProgress *self,
00386                                            gdouble      fraction);
00387 
00395 void alp_progress_pbar_start_pulse        (AlpProgress *self, guint interval);
00396 
00403 void alp_progress_pbar_stop_pulse         (AlpProgress *self);
00404 
00416 void alp_progress_pbar_set_fraction       (AlpProgress *self,
00417                                            gdouble      fraction);
00418 
00426 void alp_progress_pbar_set_text           (AlpProgress *self,
00427                                            const gchar *text);
00428 
00441 void alp_progress_pbar_format_text        (AlpProgress *self,
00442                                            const gchar *format,
00443                                            ...) G_GNUC_PRINTF (2, 3);
00444 
00447 G_END_DECLS
00448 
00449 #endif /* __ALP_PROGRESS_DIALOG_H__ */

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

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