libgaminggear
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Macros | Typedefs | Functions
gaminggear_timeout_bar.h File Reference

A progression bar counting down in an amount of seconds. More...

Macros

#define GAMINGGEAR_TIMEOUT_BAR_TYPE   (gaminggear_timeout_bar_get_type())
 
#define GAMINGGEAR_TIMEOUT_BAR(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj), GAMINGGEAR_TIMEOUT_BAR_TYPE, GaminggearTimeoutBar))
 
#define IS_GAMINGGEAR_TIMEOUT_BAR(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj), GAMINGGEAR_TIMEOUT_BAR_TYPE))
 

Typedefs

typedef struct
_GaminggearTimeoutBar 
GaminggearTimeoutBar
 

Functions

GType gaminggear_timeout_bar_get_type (void)
 
GtkWidget * gaminggear_timeout_bar_new (void)
 Creates new timeout bar. More...
 
void gaminggear_timeout_bar_start (GaminggearTimeoutBar *timeout_bar, guint interval, guint timeout)
 Starts a timeout bar. More...
 
void gaminggear_timeout_bar_stop (GaminggearTimeoutBar *timeout_bar)
 Stops a timeout bar. More...
 

Detailed Description

A progression bar counting down in an amount of seconds.

Macro Definition Documentation

#define GAMINGGEAR_TIMEOUT_BAR (   obj)    (G_TYPE_CHECK_INSTANCE_CAST((obj), GAMINGGEAR_TIMEOUT_BAR_TYPE, GaminggearTimeoutBar))
#define GAMINGGEAR_TIMEOUT_BAR_TYPE   (gaminggear_timeout_bar_get_type())
#define IS_GAMINGGEAR_TIMEOUT_BAR (   obj)    (G_TYPE_CHECK_INSTANCE_TYPE((obj), GAMINGGEAR_TIMEOUT_BAR_TYPE))

Typedef Documentation

typedef struct _GaminggearTimeoutBar GaminggearTimeoutBar

Function Documentation

GType gaminggear_timeout_bar_get_type ( void  )
GtkWidget* gaminggear_timeout_bar_new ( void  )

Creates new timeout bar.

Return values
widgetThe timeout bar.
Since
1.0
void gaminggear_timeout_bar_start ( GaminggearTimeoutBar timeout_bar,
guint  interval,
guint  timeout 
)

Starts a timeout bar.

The progress bar starts full and will decrease in timeout seconds to 0.0. A "timeout" signal will be emitted if 0.0 is reached.

Parameters
timeout_barA timeout bar.
intervalThe update interval in milliseconds.
timeoutThe time in seconds.
Since
1.0
void gaminggear_timeout_bar_stop ( GaminggearTimeoutBar timeout_bar)

Stops a timeout bar.

Parameters
timeout_barA timeout bar.
Since
1.0