AlarmdAction

AlarmdAction — Base class for any actions done on events.

Synopsis



enum        AlarmdActionAckType;
            AlarmdAction;
AlarmdAction* alarmd_action_new             (void);
void        alarmd_action_run               (AlarmdAction *action,
                                             gboolean delayed);
void        alarmd_action_acknowledge       (AlarmdAction *action,
                                             AlarmdActionAckType ack_type);
gboolean    alarmd_action_need_power_up     (AlarmdAction *action);

Description

AlarmdAction is a base class for objects that define the action run when event is due. It itself does nothing, and should not be used as-is.

Details

enum AlarmdActionAckType

typedef enum {
	ACK_NORMAL,
	ACK_SNOOZE
} AlarmdActionAckType;

Defines the ways a action can be acknowledged.

ACK_NORMAL The action was normally acknowledged.
ACK_SNOOZE The action was snoozed.

AlarmdAction

typedef struct {
	AlarmdObject parent_instance;
} AlarmdAction;

alarmd_action_new ()

AlarmdAction* alarmd_action_new             (void);

Creates new alarmd action.

Returns : Newly created AlarmdAction.

alarmd_action_run ()

void        alarmd_action_run               (AlarmdAction *action,
                                             gboolean delayed);

Emits "run" signal on the given AlarmdAction. The interpretion of the delayed flag depends on the action type.

action : A AlarmdAction that should be run.
delayed : Whether the AlarmdAction is run on time or after it.

alarmd_action_acknowledge ()

void        alarmd_action_acknowledge       (AlarmdAction *action,
                                             AlarmdActionAckType ack_type);

Emits "acknowledge" -signal on the given AlarmdAction.

action : AlarmdAction that is acknowledged.
ack_type : ACK_NORMAL if the action was normally acknowledged or ACK_SNOOZE if it was snoozed.

alarmd_action_need_power_up ()

gboolean    alarmd_action_need_power_up     (AlarmdAction *action);

Queries the given AlarmdAction, if it needs power up functionality.

action : AlarmdAction that is being queried.
Returns : TRUE if the AlarmdAction needs power up, FALSE otherwise.

See Also

AlarmdActionDialog, AlarmdActionExec, AlarmdActionDbus.