summaryrefslogtreecommitdiff
path: root/libopie/pim/opimnotifymanager.h
blob: f3c22f9c19c89af373d72395408ecf1a6c483f17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
#ifndef OPIE_PIM_NOTIFY_MANAGER_H
#define OPIE_PIM_NOTIFY_MANAGER_H

#include <qvaluelist.h>

#include <opie/opimnotify.h>

/**
 * The notify manager keeps track of the Notifiers....
 */
class OPimNotifyManager {
public:
    typedef QValueList<OPimReminder> Reminders;
    typedef QValueList<OPimAlarm>    Alarms;
    OPimNotifyManager( const Reminders& rems = Reminders(), const Alarms& alarms = Alarms() );
    ~OPimNotifyManager();

    /* we will cast it for you ;) */
    void add( const OPimNotify& );
    void remove( const OPimNotify& );
    /* replaces all with this one! */
    void replace( const OPimNotify& );

    Reminders reminders()const;

    /**
     * Return 
     */
    Alarms    alarms()const;

    /**
     * Return alarm at DateTime "when". If more than one is registered at this
     * DateTime, the first one is returned.
     * If none was found, an empty Alarm is returned.
     * @param when The date and time of the returned alarm
     * @param found Returns true if anything was found.
     * @return Returns the found alarm at given DateTime. It is empty if found is false 
     * (nothing could be found at given date and time)
     */
    OPimAlarm alarmAtDateTime( const QDateTime& when, bool& found ) const;

    void setAlarms( const Alarms& );
    void setReminders( const Reminders& );

    /* register is a Ansi C keyword... */
    /**
     * This function will register the Notify to the Alarm Server
     * or datebook depending on the type of the notify
     */
    void registerNotify( const OPimNotify& );

    /**
     * this will do the opposite..
     */
    void deregister( const OPimNotify& );

    bool isEmpty()const;

    /** 
     * Return all alarms as string
     */
    QString alarmsToString() const;
    /** 
     * Return all notifiers as string
     */
    QString remindersToString() const;

    /**
     * Convert string to alarms 
     * @param str String created by alarmsToString()
     */
    void alarmsFromString( const QString& str );

    /**
     * Convert string to reminders
     * @param str String created by remindersToString()
     */
    void remindersFromString( const QString& str );



private:
    Reminders m_rem;
    Alarms m_al;

    class Private;
    Private *d;

};

#endif