Main Page | Data Structures | File List | Data Fields | Globals

action.h File Reference

#include <glib/gtypes.h>
#include <glib-object.h>
#include "object.h"
#include "include/timer-interface.h"

Include dependency graph for action.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define ALARMD_TYPE_ACTION   (alarmd_action_get_type())
#define ALARMD_ACTION(object)   (G_TYPE_CHECK_INSTANCE_CAST((object), ALARMD_TYPE_ACTION, AlarmdAction))
#define ALARMD_ACTION_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), ALARMD_TYPE_ACTION, AlarmdActionClass))
#define ALARMD_IS_ACTION(object)   (G_TYPE_CHECK_INSTANCE_TYPE((object), ALARMD_TYPE_ACTION))
#define ALARMD_IS_ACTION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), ALARMD_TYPE_ACTION))
#define ALARMD_ACTION_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS((object), ALARMD_TYPE_ACTION, AlarmdActionClass))

Typedefs

typedef _AlarmdAction AlarmdAction
typedef _AlarmdActionClass AlarmdActionClass

Enumerations

enum  AlarmdActionAckType {
  ACK_NORMAL,
  ACK_SNOOZE
}
 AlarmdActionAckType: : The action was normally acknowledged. More...

Functions

GType alarmd_action_get_type (void)
 AlarmdAction::run: : The action that is run.
AlarmdActionalarmd_action_new (void)
 alarmd_action_new:
void alarmd_action_run (AlarmdAction *action, gboolean delayed)
 alarmd_action_run: : A AlarmdAction that should be run.
void alarmd_action_acknowledge (AlarmdAction *action, AlarmdActionAckType ack_type)
 alarmd_action_acknowledge: : AlarmdAction that is acknowledged.
gboolean alarmd_action_need_power_up (AlarmdAction *action)
 alarmd_action_need_power_up: : AlarmdAction that is being queried.


Define Documentation

#define ALARMD_ACTION object   )     (G_TYPE_CHECK_INSTANCE_CAST((object), ALARMD_TYPE_ACTION, AlarmdAction))
 

Definition at line 52 of file action.h.

Referenced by _alarmd_action_dbus_do_action(), _alarmd_action_dialog_powerup(), _alarmd_action_dialog_real_do_action(), _alarmd_action_dialog_real_run(), _alarmd_action_dialog_snooze_powerup(), and _alarmd_action_exec_finished().

#define ALARMD_ACTION_CLASS klass   )     (G_TYPE_CHECK_CLASS_CAST((klass), ALARMD_TYPE_ACTION, AlarmdActionClass))
 

Definition at line 53 of file action.h.

Referenced by alarmd_action_dialog_class_init().

#define ALARMD_ACTION_GET_CLASS object   )     (G_TYPE_INSTANCE_GET_CLASS((object), ALARMD_TYPE_ACTION, AlarmdActionClass))
 

Definition at line 56 of file action.h.

Referenced by alarmd_action_need_power_up().

#define ALARMD_IS_ACTION object   )     (G_TYPE_CHECK_INSTANCE_TYPE((object), ALARMD_TYPE_ACTION))
 

Definition at line 54 of file action.h.

#define ALARMD_IS_ACTION_CLASS klass   )     (G_TYPE_CHECK_CLASS_TYPE((klass), ALARMD_TYPE_ACTION))
 

Definition at line 55 of file action.h.

#define ALARMD_TYPE_ACTION   (alarmd_action_get_type())
 

Definition at line 51 of file action.h.

Referenced by _alarmd_action_finalize(), _alarmd_action_get_saved_properties(), alarmd_action_dialog_get_type(), alarmd_action_new(), alarmd_event_class_init(), and alarmd_type_init().


Typedef Documentation

typedef struct _AlarmdAction AlarmdAction
 

Definition at line 58 of file action.h.

typedef struct _AlarmdActionClass AlarmdActionClass
 

Definition at line 64 of file action.h.


Enumeration Type Documentation

enum AlarmdActionAckType
 

AlarmdActionAckType: : The action was normally acknowledged.

: The action was snoozed.

Defines the ways a action can be acknowledged.

Enumeration values:
ACK_NORMAL 
ACK_SNOOZE 

Definition at line 46 of file action.h.


Function Documentation

void alarmd_action_acknowledge AlarmdAction action,
AlarmdActionAckType  ack_type
 

alarmd_action_acknowledge: : AlarmdAction that is acknowledged.

: ACK_NORMAL if the action was normally acknowledged or ACK_SNOOZE if it was snoozed.

Emits "acknowledge" -signal on the given AlarmdAction.

GType alarmd_action_get_type void   ) 
 

AlarmdAction::run: : The action that is run.

: Specifies if the execution of is delayed.

When an AlarmdAction should be run, this signal should be emitted.

Definition at line 82 of file action.c.

References alarmd_action_class_init(), alarmd_action_init(), and ALARMD_TYPE_OBJECT.

gboolean alarmd_action_need_power_up AlarmdAction action  ) 
 

alarmd_action_need_power_up: : AlarmdAction that is being queried.

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

Returns: TRUE if the AlarmdAction needs power up, FALSE otherwise.

Definition at line 281 of file action.c.

References ALARMD_ACTION_GET_CLASS, ENTER_FUNC, LEAVE_FUNC, and _AlarmdActionClass::need_power_up.

Referenced by _alarmd_event_real_need_power_up().

AlarmdAction* alarmd_action_new void   ) 
 

alarmd_action_new:

Creates new alarmd action. Returns: Newly created AlarmdAction.

Definition at line 110 of file action.c.

References ALARMD_TYPE_ACTION, ENTER_FUNC, and LEAVE_FUNC.

void alarmd_action_run AlarmdAction action,
gboolean  delayed
 

alarmd_action_run: : A AlarmdAction that should be run.

: Whether the AlarmdAction is run on time or after it.

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

Definition at line 119 of file action.c.

References action_signals, ENTER_FUNC, LEAVE_FUNC, and SIGNAL_RUN.

Referenced by _alarmd_event_real_fire().


Generated on Thu Dec 21 18:23:30 2006 for Alarmd by  doxygen 1.4.2