summaryrefslogtreecommitdiffabout
path: root/libkcal/calendarlocal.h
Unidiff
Diffstat (limited to 'libkcal/calendarlocal.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/calendarlocal.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/libkcal/calendarlocal.h b/libkcal/calendarlocal.h
index a17cf11..a2e50e3 100644
--- a/libkcal/calendarlocal.h
+++ b/libkcal/calendarlocal.h
@@ -24,96 +24,97 @@
24 24
25#include "calendar.h" 25#include "calendar.h"
26 26
27namespace KCal { 27namespace KCal {
28 28
29class CalFormat; 29class CalFormat;
30 30
31/** 31/**
32 This class provides a calendar stored as a local file. 32 This class provides a calendar stored as a local file.
33*/ 33*/
34class CalendarLocal : public Calendar 34class CalendarLocal : public Calendar
35{ 35{
36 public: 36 public:
37 /** 37 /**
38 Constructs a new calendar, with variables initialized to sane values. 38 Constructs a new calendar, with variables initialized to sane values.
39 */ 39 */
40 CalendarLocal(); 40 CalendarLocal();
41 /** 41 /**
42 Constructs a new calendar, with variables initialized to sane values. 42 Constructs a new calendar, with variables initialized to sane values.
43 */ 43 */
44 CalendarLocal( const QString &timeZoneId ); 44 CalendarLocal( const QString &timeZoneId );
45 ~CalendarLocal(); 45 ~CalendarLocal();
46 46
47 /** 47 /**
48 Loads a calendar on disk in vCalendar or iCalendar format into the current 48 Loads a calendar on disk in vCalendar or iCalendar format into the current
49 calendar. Any information already present is lost. 49 calendar. Any information already present is lost.
50 @return true, if successfull, false on error. 50 @return true, if successfull, false on error.
51 @param fileName the name of the calendar on disk. 51 @param fileName the name of the calendar on disk.
52 */ 52 */
53 bool load( const QString &fileName ); 53 bool load( const QString &fileName );
54 /** 54 /**
55 Writes out the calendar to disk in the specified \a format. 55 Writes out the calendar to disk in the specified \a format.
56 CalendarLocal takes ownership of the CalFormat object. 56 CalendarLocal takes ownership of the CalFormat object.
57 @return true, if successfull, false on error. 57 @return true, if successfull, false on error.
58 @param fileName the name of the file 58 @param fileName the name of the file
59 */ 59 */
60 bool save( const QString &fileName, CalFormat *format = 0 ); 60 bool save( const QString &fileName, CalFormat *format = 0 );
61 61
62 /** 62 /**
63 Clears out the current calendar, freeing all used memory etc. etc. 63 Clears out the current calendar, freeing all used memory etc. etc.
64 */ 64 */
65 void close(); 65 void close();
66 66
67 void save() {} 67 void save() {}
68 68
69 /** 69 /**
70 Add Event to calendar. 70 Add Event to calendar.
71 */ 71 */
72 bool addAnniversaryNoDup( Event *event );
72 bool addEventNoDup( Event *event ); 73 bool addEventNoDup( Event *event );
73 bool addEvent( Event *event ); 74 bool addEvent( Event *event );
74 /** 75 /**
75 Deletes an event from this calendar. 76 Deletes an event from this calendar.
76 */ 77 */
77 void deleteEvent( Event *event ); 78 void deleteEvent( Event *event );
78 79
79 /** 80 /**
80 Retrieves an event on the basis of the unique string ID. 81 Retrieves an event on the basis of the unique string ID.
81 */ 82 */
82 Event *event( const QString &uid ); 83 Event *event( const QString &uid );
83 /** 84 /**
84 Return unfiltered list of all events in calendar. 85 Return unfiltered list of all events in calendar.
85 */ 86 */
86 QPtrList<Event> rawEvents(); 87 QPtrList<Event> rawEvents();
87 88
88 /** 89 /**
89 Add a todo to the todolist. 90 Add a todo to the todolist.
90 */ 91 */
91 bool addTodo( Todo *todo ); 92 bool addTodo( Todo *todo );
92 bool addTodoNoDup( Todo *todo ); 93 bool addTodoNoDup( Todo *todo );
93 /** 94 /**
94 Remove a todo from the todolist. 95 Remove a todo from the todolist.
95 */ 96 */
96 void deleteTodo( Todo * ); 97 void deleteTodo( Todo * );
97 /** 98 /**
98 Searches todolist for an event with this unique string identifier, 99 Searches todolist for an event with this unique string identifier,
99 returns a pointer or null. 100 returns a pointer or null.
100 */ 101 */
101 Todo *todo( const QString &uid ); 102 Todo *todo( const QString &uid );
102 /** 103 /**
103 Return list of all todos. 104 Return list of all todos.
104 */ 105 */
105 QPtrList<Todo> rawTodos(); 106 QPtrList<Todo> rawTodos();
106 /** 107 /**
107 Returns list of todos due on the specified date. 108 Returns list of todos due on the specified date.
108 */ 109 */
109 QPtrList<Todo> todos( const QDate &date ); 110 QPtrList<Todo> todos( const QDate &date );
110 /** 111 /**
111 Return list of all todos. 112 Return list of all todos.
112 113
113 Workaround because compiler does not recognize function of base class. 114 Workaround because compiler does not recognize function of base class.
114 */ 115 */
115 QPtrList<Todo> todos() { return Calendar::todos(); } 116 QPtrList<Todo> todos() { return Calendar::todos(); }
116 117
117 /** 118 /**
118 Add a Journal entry to calendar. 119 Add a Journal entry to calendar.
119 */ 120 */