GtranslatorStatusbar

GtranslatorStatusbar

Synopsis

                    GtranslatorStatusbarPrivate;
                    GtranslatorStatusbar;
GtkWidget *         gtranslator_statusbar_new           (void);
void                gtranslator_statusbar_push_default  (GtranslatorStatusbar *statusbar,
                                                         const gchar *text);
void                gtranslator_statusbar_pop_default   (GtranslatorStatusbar *statusbar);
guint               gtranslator_statusbar_push          (GtranslatorStatusbar *statusbar,
                                                         guint context_id,
                                                         const gchar *text);
void                gtranslator_statusbar_pop           (GtranslatorStatusbar *statusbar,
                                                         guint context_id);
guint               gtranslator_statusbar_get_context_id
                                                        (GtranslatorStatusbar *statusbar,
                                                         const gchar *context_description);
void                gtranslator_statusbar_set_overwrite (GtranslatorStatusbar *statusbar,
                                                         gboolean overwrite);
void                gtranslator_statusbar_clear_overwrite
                                                        (GtranslatorStatusbar *statusbar);
void                gtranslator_statusbar_flash_message (GtranslatorStatusbar *statusbar,
                                                         guint context_id,
                                                         const gchar *format,
                                                         ...);
void                gtranslator_statusbar_update_progress_bar
                                                        (GtranslatorStatusbar *statusbar,
                                                         gdouble translated_count,
                                                         gdouble messages_count);
void                gtranslator_statusbar_clear_progress_bar
                                                        (GtranslatorStatusbar *statusbar);

Description

Details

GtranslatorStatusbarPrivate

typedef struct _GtranslatorStatusbarPrivate GtranslatorStatusbarPrivate;


GtranslatorStatusbar

typedef struct {
        GtkHBox parent;

	/* <private/> */
        GtranslatorStatusbarPrivate *priv;
} GtranslatorStatusbar;


gtranslator_statusbar_new ()

GtkWidget *         gtranslator_statusbar_new           (void);

Creates a new GtranslatorStatusbar.

Returns :

the new GtranslatorStatusbar object

gtranslator_statusbar_push_default ()

void                gtranslator_statusbar_push_default  (GtranslatorStatusbar *statusbar,
                                                         const gchar *text);

Pushes a text onto the statusbar in the default context id.

statusbar :

a GtranslatorStatusbar

text :

the text to push in the statusbar

gtranslator_statusbar_pop_default ()

void                gtranslator_statusbar_pop_default   (GtranslatorStatusbar *statusbar);

Pops the text in the statusbar of the default context id.

statusbar :

a GtranslatorStatusbar

gtranslator_statusbar_push ()

guint               gtranslator_statusbar_push          (GtranslatorStatusbar *statusbar,
                                                         guint context_id,
                                                         const gchar *text);

Pushes a new message onto a statusbar's stack.

statusbar :

a GtranslatorStatusbar

context_id :

the message's context id, as returned by gtk_statusbar_get_context_id()

text :

the text to push in the statusbar

Returns :

a message id that can be used with gtk_statusbar_remove()

gtranslator_statusbar_pop ()

void                gtranslator_statusbar_pop           (GtranslatorStatusbar *statusbar,
                                                         guint context_id);

Removes the first message in the GtkStatusBar's stack with the given context id.

statusbar :

a GtranslatorStatusbar

context_id :

a context identifier

gtranslator_statusbar_get_context_id ()

guint               gtranslator_statusbar_get_context_id
                                                        (GtranslatorStatusbar *statusbar,
                                                         const gchar *context_description);

Returns a new context identifier, given a description of the actual context. Note that the description is not shown in the UI.

statusbar :

a GtranslatorStatusbar

context_description :

textual description of what context the new message is being used in

Returns :

an integer id

gtranslator_statusbar_set_overwrite ()

void                gtranslator_statusbar_set_overwrite (GtranslatorStatusbar *statusbar,
                                                         gboolean overwrite);

Sets the overwrite mode on the statusbar.

statusbar :

a GtranslatorStatusbar

overwrite :

if the overwrite mode is set

gtranslator_statusbar_clear_overwrite ()

void                gtranslator_statusbar_clear_overwrite
                                                        (GtranslatorStatusbar *statusbar);

Clears the statusbar overwrite label.

statusbar :

a GtranslatorStatusbar

gtranslator_statusbar_flash_message ()

void                gtranslator_statusbar_flash_message (GtranslatorStatusbar *statusbar,
                                                         guint context_id,
                                                         const gchar *format,
                                                         ...);

Flash a temporary message on the statusbar.

statusbar :

a GtranslatorStatusbar

context_id :

message context_id

format :

message to flash on the statusbar

... :


gtranslator_statusbar_update_progress_bar ()

void                gtranslator_statusbar_update_progress_bar
                                                        (GtranslatorStatusbar *statusbar,
                                                         gdouble translated_count,
                                                         gdouble messages_count);

Updates the state of the progress bar with the given values.

statusbar :

a GtranslatorStatusbar

translated_count :

the number of translated messages

messages_count :

the number of messages

gtranslator_statusbar_clear_progress_bar ()

void                gtranslator_statusbar_clear_progress_bar
                                                        (GtranslatorStatusbar *statusbar);

Clear the progress bar

statusbar :

a GtranslatorStatusbar