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

event.h File Reference

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

Include dependency graph for event.h:

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

Go to the source code of this file.

Defines

#define ALARMD_TYPE_EVENT   (alarmd_event_get_type())
 This file is part of alarmd.
#define ALARMD_EVENT(object)   (G_TYPE_CHECK_INSTANCE_CAST((object), ALARMD_TYPE_EVENT, AlarmdEvent))
#define ALARMD_EVENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), ALARMD_TYPE_EVENT, AlarmdEventClass))
#define ALARMD_IS_EVENT(object)   (G_TYPE_CHECK_INSTANCE_TYPE((object), ALARMD_TYPE_EVENT))
#define ALARMD_IS_EVENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), ALARMD_TYPE_EVENT))
#define ALARMD_EVENT_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS((object), ALARMD_TYPE_EVENT, AlarmdEventClass))

Typedefs

typedef _AlarmdEvent AlarmdEvent
typedef _AlarmdEventClass AlarmdEventClass

Functions

GType alarmd_event_get_type (void)
 AlarmdEvent::snooze: : The AlarmdEvent that is being snoozed.
AlarmdEventalarmd_event_new (void)
 alarmd_event_new:
void alarmd_event_fire (AlarmdEvent *event, gboolean delayed)
 alarmd_event_fire: : Event that should be fired.
void alarmd_event_cancel (AlarmdEvent *event)
 alarmd_event_cancel: : Event that should be cancelled.
void alarmd_event_snooze (AlarmdEvent *event)
 alarmd_event_snooze: : Event that should be snoozed.
void alarmd_event_acknowledge (AlarmdEvent *event)
 alarmd_event_acknowledge: : Event that should be acknowledged.
void alarmd_event_queue (AlarmdEvent *event, TimerPlugin *plugin)
 alarmd_event_queue: : Event that should be put on a timer.
void alarmd_event_dequeue (AlarmdEvent *event)
 alarmd_event_dequeue: : Event that should be taken off a timer.
time_t alarmd_event_get_time (AlarmdEvent *event)
 alarmd_event_get_time: : AlarmdEvent to get the time from.
gboolean alarmd_event_need_power_up (AlarmdEvent *event)
 alarmd_event_need_power_up: : The AlarmdEvent that is being queried.
gint32 alarmd_event_get_flags (AlarmdEvent *event)
 alarmd_event_get_flags: : The AlarmdEvent that is being queried.


Define Documentation

#define ALARMD_EVENT object   )     (G_TYPE_CHECK_INSTANCE_CAST((object), ALARMD_TYPE_EVENT, AlarmdEvent))
 

Definition at line 31 of file event.h.

Referenced by _alarmd_event_recurring_time_changed(), _alarmd_event_time_changed(), _alarmd_queue_event_changed(), _alarmd_queue_find_event(), _alarmd_queue_find_first_event(), _alarmd_queue_real_add_event(), _alarmd_queue_real_query_events(), _dbus_message_in(), and init_queue().

#define ALARMD_EVENT_CLASS klass   )     (G_TYPE_CHECK_CLASS_CAST((klass), ALARMD_TYPE_EVENT, AlarmdEventClass))
 

Definition at line 32 of file event.h.

Referenced by alarmd_event_recurring_class_init().

#define ALARMD_EVENT_GET_CLASS object   )     (G_TYPE_INSTANCE_GET_CLASS((object), ALARMD_TYPE_EVENT, AlarmdEventClass))
 

Definition at line 35 of file event.h.

Referenced by alarmd_event_get_flags(), alarmd_event_get_time(), and alarmd_event_need_power_up().

#define ALARMD_IS_EVENT object   )     (G_TYPE_CHECK_INSTANCE_TYPE((object), ALARMD_TYPE_EVENT))
 

Definition at line 33 of file event.h.

Referenced by init_queue().

#define ALARMD_IS_EVENT_CLASS klass   )     (G_TYPE_CHECK_CLASS_TYPE((klass), ALARMD_TYPE_EVENT))
 

Definition at line 34 of file event.h.

#define ALARMD_TYPE_EVENT   (alarmd_event_get_type())
 

This file is part of alarmd.

Contact Person: David Weinehall <david.weinehall@nokia.com>

Copyright (C) 2006 Nokia Corporation alarmd and libalarm are free software; you can redistribute them and/or modify them under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation.

alarmd and libalarm are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this software; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Definition at line 30 of file event.h.

Referenced by _alarmd_event_finalize(), _alarmd_event_get_saved_properties(), _alarmd_queue_get_saved_properties(), alarmd_action_class_init(), alarmd_event_new(), and alarmd_event_recurring_get_type().


Typedef Documentation

typedef struct _AlarmdEvent AlarmdEvent
 

Definition at line 37 of file event.h.

typedef struct _AlarmdEventClass AlarmdEventClass
 

Definition at line 43 of file event.h.


Function Documentation

void alarmd_event_acknowledge AlarmdEvent event  ) 
 

alarmd_event_acknowledge: : Event that should be acknowledged.

Emits a #AlarmdEvent::acknowledge signal on the given .

Definition at line 169 of file event.c.

References ALARMD_OBJECT, ENTER_FUNC, event_signals, LEAVE_FUNC, and SIGNAL_ACKNOWLEDGE.

void alarmd_event_cancel AlarmdEvent event  ) 
 

alarmd_event_cancel: : Event that should be cancelled.

Emits a #AlarmdEvent::cancel signal on the given .

Definition at line 162 of file event.c.

References ALARMD_OBJECT, ENTER_FUNC, event_signals, LEAVE_FUNC, and SIGNAL_CANCEL.

Referenced by _alarmd_event_recurring_real_acknowledge(), and _alarmd_queue_real_remove_event().

void alarmd_event_dequeue AlarmdEvent event  ) 
 

alarmd_event_dequeue: : Event that should be taken off a timer.

Emits a #AlarmdEvent::dequeue signal on the given .

Definition at line 190 of file event.c.

References ALARMD_OBJECT, ENTER_FUNC, event_signals, LEAVE_FUNC, and SIGNAL_DEQUEUE.

Referenced by _alarmd_event_real_dequeued(), _alarmd_queue_event_changed(), _alarmd_queue_real_add_event(), and _alarmd_queue_set_property().

void alarmd_event_fire AlarmdEvent event,
gboolean  delayed
 

alarmd_event_fire: : Event that should be fired.

: TRUE if the event is fired delayed.

Emits a #AlarmdEvent::fire signal on the given .

Definition at line 155 of file event.c.

References ALARMD_OBJECT, ENTER_FUNC, event_signals, LEAVE_FUNC, and SIGNAL_FIRE.

Referenced by _alarmd_event_fired(), and _alarmd_event_time_changed().

gint32 alarmd_event_get_flags AlarmdEvent event  ) 
 

alarmd_event_get_flags: : The AlarmdEvent that is being queried.

Queries an event for its flags. Returns: The bitfield for the flags.

Definition at line 712 of file event.c.

References ALARMD_EVENT_GET_CLASS, ENTER_FUNC, _AlarmdEventClass::get_flags, and LEAVE_FUNC.

Referenced by _alarmd_queue_real_query_events().

time_t alarmd_event_get_time AlarmdEvent event  ) 
 

alarmd_event_get_time: : AlarmdEvent to get the time from.

Gets the next time an event should be run. Returns: The time that the event should next be run.

Definition at line 197 of file event.c.

References ALARMD_EVENT_GET_CLASS, ENTER_FUNC, _AlarmdEventClass::get_time, and LEAVE_FUNC.

Referenced by _alarmd_action_dialog_connected(), _alarmd_action_dialog_run(), _alarmd_event_compare_func(), _alarmd_event_real_queue(), _alarmd_event_recurring_time_changed(), _alarmd_event_time_changed(), _alarmd_queue_real_query_events(), and _real_write_data().

GType alarmd_event_get_type void   ) 
 

AlarmdEvent::snooze: : The AlarmdEvent that is being snoozed.

Whenever an AlarmdEvent is snoozed, a #AlarmdEvent::snooze signal is emitted.

Definition at line 118 of file event.c.

References alarmd_event_class_init(), alarmd_event_init(), and ALARMD_TYPE_OBJECT.

gboolean alarmd_event_need_power_up AlarmdEvent event  ) 
 

alarmd_event_need_power_up: : The AlarmdEvent that is being queried.

Queries an event, if it needs the "power up" feature. Returns: TRUE if the power up feature is needed.

Definition at line 702 of file event.c.

References ALARMD_EVENT_GET_CLASS, ENTER_FUNC, LEAVE_FUNC, and _AlarmdEventClass::need_power_up.

Referenced by _alarmd_queue_find_first_event(), _alarmd_queue_real_add_event(), and _alarmd_queue_set_property().

AlarmdEvent* alarmd_event_new void   ) 
 

alarmd_event_new:

Creates new alarmd event. Returns: Newly created AlarmdEvent

Definition at line 146 of file event.c.

References ALARMD_TYPE_EVENT, ENTER_FUNC, and LEAVE_FUNC.

void alarmd_event_queue AlarmdEvent event,
TimerPlugin plugin
 

alarmd_event_queue: : Event that should be put on a timer.

: The timer the event should be put on.

Emits a #AlarmdEvent::queue signal on the given .

Definition at line 183 of file event.c.

References ALARMD_OBJECT, ENTER_FUNC, event_signals, LEAVE_FUNC, and SIGNAL_QUEUE.

Referenced by _alarmd_queue_event_dequeued().

void alarmd_event_snooze AlarmdEvent event  ) 
 

alarmd_event_snooze: : Event that should be snoozed.

Emits a #AlarmdEvent::snooze signal on the given .

Definition at line 176 of file event.c.

References ALARMD_OBJECT, ENTER_FUNC, event_signals, LEAVE_FUNC, and SIGNAL_SNOOZE.


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