libgaminggear
Data Structures | Macros | Typedefs | Functions
gaminggear_timeout_dialog.h File Reference

Dialog that views a message and issues a cancel on timeout. More...

Data Structures

struct  _GaminggearTimeoutDialog
 

Macros

#define GAMINGGEAR_TIMEOUT_DIALOG_TYPE   (gaminggear_timeout_dialog_get_type())
 
#define GAMINGGEAR_TIMEOUT_DIALOG(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj), GAMINGGEAR_TIMEOUT_DIALOG_TYPE, GaminggearTimeoutDialog))
 
#define IS_GAMINGGEAR_TIMEOUT_DIALOG(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj), GAMINGGEAR_TIMEOUT_DIALOG_TYPE))
 

Typedefs

typedef struct _GaminggearTimeoutDialog GaminggearTimeoutDialog
 
typedef struct _GaminggearTimeoutDialogPrivate GaminggearTimeoutDialogPrivate
 

Functions

GType gaminggear_timeout_dialog_get_type (void)
 
GtkWidget * gaminggear_timeout_dialog_new (GtkWindow *parent, gchar const *title, gchar const *text)
 Creates new timeout dialog. More...
 
gboolean gaminggear_timeout_dialog_run (GaminggearTimeoutDialog *timeout_dialog, guint timeout)
 Run a timeout dialog. More...
 
gboolean gaminggear_timeout_dialog (GtkWindow *parent, gchar const *title, gchar const *text, guint timeout)
 Show a timeout dialog. More...
 

Detailed Description

Dialog that views a message and issues a cancel on timeout.

Macro Definition Documentation

◆ GAMINGGEAR_TIMEOUT_DIALOG

#define GAMINGGEAR_TIMEOUT_DIALOG (   obj)    (G_TYPE_CHECK_INSTANCE_CAST((obj), GAMINGGEAR_TIMEOUT_DIALOG_TYPE, GaminggearTimeoutDialog))

◆ GAMINGGEAR_TIMEOUT_DIALOG_TYPE

#define GAMINGGEAR_TIMEOUT_DIALOG_TYPE   (gaminggear_timeout_dialog_get_type())

◆ IS_GAMINGGEAR_TIMEOUT_DIALOG

#define IS_GAMINGGEAR_TIMEOUT_DIALOG (   obj)    (G_TYPE_CHECK_INSTANCE_TYPE((obj), GAMINGGEAR_TIMEOUT_DIALOG_TYPE))

Typedef Documentation

◆ GaminggearTimeoutDialog

◆ GaminggearTimeoutDialogPrivate

typedef struct _GaminggearTimeoutDialogPrivate GaminggearTimeoutDialogPrivate

Function Documentation

◆ gaminggear_timeout_dialog()

gboolean gaminggear_timeout_dialog ( GtkWindow *  parent,
gchar const *  title,
gchar const *  text,
guint  timeout 
)

Show a timeout dialog.

Convenience function that creates, runs and destroys a timeout dialog.

Parameters
parentParent window or NULL.
titleTitle of dialog.
textCaption of dialog.
timeoutThe time in seconds.
Return values
booleanTRUE if accepted, FALSE if dialog was canceled or time ran out.
Since
1.0

◆ gaminggear_timeout_dialog_get_type()

GType gaminggear_timeout_dialog_get_type ( void  )

◆ gaminggear_timeout_dialog_new()

GtkWidget* gaminggear_timeout_dialog_new ( GtkWindow *  parent,
gchar const *  title,
gchar const *  text 
)

Creates new timeout dialog.

Parameters
parentParent window or NULL.
titleTitle of dialog.
textCaption of dialog.
Return values
widgetThe timeout dialog.
Since
1.0

◆ gaminggear_timeout_dialog_run()

gboolean gaminggear_timeout_dialog_run ( GaminggearTimeoutDialog timeout_dialog,
guint  timeout 
)

Run a timeout dialog.

Parameters
timeout_dialogA timeout dialog.
timeoutThe time in seconds.
Return values
booleanTRUE if accepted, FALSE if dialog was canceled or time ran out.
Since
1.0