RubricaTimeout

RubricaTimeout —

Synopsis




#define     RUBRICA_TIMEOUT_TYPE
#define     RUBRICA_TIMEOUT                 (obj)
#define     RUBRICA_TIMEOUT_CLASS           (klass)
#define     IS_RUBRICA_TIMEOUT              (obj)
#define     IS_RUBRICA_TIMEOUT_CLASS        (klass)
#define     RUBRICA_TIMEOUT_GET_CLASS       (obj)
            RubricaTimeoutPrivate;
GType       rubrica_timeout_get_type        (void);
RubricaTimeout* rubrica_timeout_new         (guint32 time);
void        rubrica_timeout_free            (RubricaTimeout *timeout);
void        rubrica_timeout_start           (RubricaTimeout *timeout);
void        rubrica_timeout_enable          (RubricaTimeout *timeout);
void        rubrica_timeout_disable         (RubricaTimeout *timeout);
void        rubrica_timeout_restart         (RubricaTimeout *timeout,
                                             guint32 time);
gboolean    rubrica_timeout_is_running      (RubricaTimeout *timeout);

Description

Details

RUBRICA_TIMEOUT_TYPE

#define RUBRICA_TIMEOUT_TYPE            (rubrica_timeout_get_type())


RUBRICA_TIMEOUT()

#define     RUBRICA_TIMEOUT(obj)

obj :

RUBRICA_TIMEOUT_CLASS()

#define     RUBRICA_TIMEOUT_CLASS(klass)

klass :

IS_RUBRICA_TIMEOUT()

#define     IS_RUBRICA_TIMEOUT(obj)

obj :

IS_RUBRICA_TIMEOUT_CLASS()

#define     IS_RUBRICA_TIMEOUT_CLASS(klass)

klass :

RUBRICA_TIMEOUT_GET_CLASS()

#define     RUBRICA_TIMEOUT_GET_CLASS(obj)

obj :

RubricaTimeoutPrivate

typedef struct _RubricaTimeoutPrivate RubricaTimeoutPrivate;


rubrica_timeout_get_type ()

GType       rubrica_timeout_get_type        (void);

Returns :

rubrica_timeout_new ()

RubricaTimeout* rubrica_timeout_new         (guint32 time);

Create a new timer. Timer will wait "time" seconds, when a "timeout" signal is emitted. If time is 0, then timer will wait 15 minutes, before emit signal.

time : time
Returns : a RubricaTimeout*

rubrica_timeout_free ()

void        rubrica_timeout_free            (RubricaTimeout *timeout);

free the RubricaTimeout object

timeout : a RubricaTimeout

rubrica_timeout_start ()

void        rubrica_timeout_start           (RubricaTimeout *timeout);

start the timeout object

timeout : RubricaTimeout

rubrica_timeout_enable ()

void        rubrica_timeout_enable          (RubricaTimeout *timeout);

enable the timeout

timeout : a RubricaTimeout

rubrica_timeout_disable ()

void        rubrica_timeout_disable         (RubricaTimeout *timeout);

disable the timeout

timeout : a RubricaTimeout

rubrica_timeout_restart ()

void        rubrica_timeout_restart         (RubricaTimeout *timeout,
                                             guint32 time);

restart the timeout, but waiting "time" seconds

timeout : a RubricaTimeout
time : anew time

rubrica_timeout_is_running ()

gboolean    rubrica_timeout_is_running      (RubricaTimeout *timeout);

check if timer is running or is disabled

timeout : a RubricaTimeout
Returns : a gboolean, TRUE if timeout is running, FALSE otherwise.