• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KCal Library

  • kcal
calendarnull.h
Go to the documentation of this file.
1/*
2 This file is part of the kcal library.
3
4 Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
28#ifndef KCAL_CALENDARNULL_H
29#define KCAL_CALENDARNULL_H
30
31#include "calendar.h"
32#include "kcal_export.h"
33
34namespace KCal {
35
48class KCAL_DEPRECATED_EXPORT CalendarNull : public Calendar
49{
50 public:
60 explicit CalendarNull( const KDateTime::Spec &timeSpec );
61
70 explicit CalendarNull( const QString &timeZoneId );
71
75 ~CalendarNull();
76
81 static CalendarNull *self();
82
87 void close();
88
93 bool save();
94
99 bool reload();
100
101 // Event Specific Methods //
102
107 bool addEvent( Event *event );
108
113 bool deleteEvent( Event *event );
114
119 void deleteAllEvents();
120
125 Event::List rawEvents( EventSortField sortField,
126 SortDirection sortDirection );
127
132 Event::List rawEvents( const QDate &start, const QDate &end,
133 const KDateTime::Spec &timeSpec = KDateTime::Spec(),
134 bool inclusive = false );
135
147 Event::List rawEventsForDate( const QDate &date,
148 const KDateTime::Spec &timeSpec = KDateTime::Spec(),
149 EventSortField sortField = EventSortUnsorted,
150 SortDirection sortDirection = SortDirectionAscending );
151
156 Event::List rawEventsForDate( const KDateTime &dt );
157
162 Event *event( const QString &uid );
163
164 // To-do Specific Methods //
165
170 bool addTodo( Todo *todo );
171
176 bool deleteTodo( Todo *todo );
177
182 void deleteAllTodos();
183
188 Todo::List rawTodos( TodoSortField sortField,
189 SortDirection sortDirection );
190
195 Todo::List rawTodosForDate( const QDate &date );
196
201 Todo *todo( const QString &uid );
202
203 // Journal Specific Methods //
204
209 bool addJournal( Journal *journal );
210
215 bool deleteJournal( Journal *journal );
216
221 void deleteAllJournals();
222
227 Journal::List rawJournals( JournalSortField sortField,
228 SortDirection sortDirection );
229
234 Journal::List rawJournalsForDate( const QDate &date );
235
240 Journal *journal( const QString &uid );
241
242 // Alarm Specific Methods //
243
248 Alarm::List alarms( const KDateTime &from, const KDateTime &to );
249
250 // Observer Specific Methods //
251
256 void incidenceUpdated( IncidenceBase *incidenceBase );
257
258 using QObject::event; // prevent warning about hidden virtual method
259
260 private:
261 //@cond PRIVATE
262 Q_DISABLE_COPY( CalendarNull )
263 class Private;
264 Private *const d;
265 //@endcond
266};
267
268}
269
270#endif
calendar.h
This file is part of the API for handling calendar data and defines the Calendar class.
KCal::TodoSortField
TodoSortField
Calendar Todo sort keys.
Definition calendar.h:79
KCal::JournalSortField
JournalSortField
Calendar Journal sort keys.
Definition calendar.h:91
KCal::EventSortField
EventSortField
Calendar Event sort keys.
Definition calendar.h:69
KCal::EventSortUnsorted
@ EventSortUnsorted
Do not sort Events.
Definition calendar.h:70
KCal::SortDirection
SortDirection
Calendar Incidence sort directions.
Definition calendar.h:61
KCal::SortDirectionAscending
@ SortDirectionAscending
Sort in ascending order (first to last)
Definition calendar.h:62
KCal::Alarm::List
ListBase< Alarm > List
List of alarms.
Definition alarm.h:83
KCal::CalendarNull::deleteAllTodos
void deleteAllTodos()
Definition calendarnull.cpp:156
KCal::CalendarNull::self
static CalendarNull * self()
Returns a pointer to the CalendarNull object, of which there can be only one.
Definition calendarnull.cpp:62
KCal::CalendarNull::rawTodosForDate
Todo::List rawTodosForDate(const QDate &date)
Definition calendarnull.cpp:168
KCal::CalendarNull::journal
Journal * journal(const QString &uid)
Definition calendarnull.cpp:210
KCal::CalendarNull::incidenceUpdated
void incidenceUpdated(IncidenceBase *incidenceBase)
Definition calendarnull.cpp:223
KCal::CalendarNull::deleteTodo
bool deleteTodo(Todo *todo)
Definition calendarnull.cpp:150
KCal::CalendarNull::rawEventsForDate
Event::List rawEventsForDate(const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Returns an unfiltered list of all Events which occur on the given date.
Definition calendarnull.cpp:120
KCal::CalendarNull::event
Event * event(const QString &uid)
Definition calendarnull.cpp:138
KCal::CalendarNull::rawTodos
Todo::List rawTodos(TodoSortField sortField, SortDirection sortDirection)
Definition calendarnull.cpp:160
KCal::CalendarNull::deleteAllJournals
void deleteAllJournals()
Definition calendarnull.cpp:192
KCal::CalendarNull::CalendarNull
CalendarNull(const KDateTime::Spec &timeSpec)
Construct Calendar object using a time specification (time zone, etc.).
Definition calendarnull.cpp:47
KCal::CalendarNull::addEvent
bool addEvent(Event *event)
Definition calendarnull.cpp:85
KCal::CalendarNull::deleteJournal
bool deleteJournal(Journal *journal)
Definition calendarnull.cpp:186
KCal::CalendarNull::reload
bool reload()
Definition calendarnull.cpp:80
KCal::CalendarNull::close
void close()
Definition calendarnull.cpp:71
KCal::CalendarNull::todo
Todo * todo(const QString &uid)
Definition calendarnull.cpp:174
KCal::CalendarNull::rawJournals
Journal::List rawJournals(JournalSortField sortField, SortDirection sortDirection)
Definition calendarnull.cpp:196
KCal::CalendarNull::addJournal
bool addJournal(Journal *journal)
Definition calendarnull.cpp:180
KCal::CalendarNull::addTodo
bool addTodo(Todo *todo)
Definition calendarnull.cpp:144
KCal::CalendarNull::rawJournalsForDate
Journal::List rawJournalsForDate(const QDate &date)
Definition calendarnull.cpp:204
KCal::CalendarNull::deleteEvent
bool deleteEvent(Event *event)
Definition calendarnull.cpp:91
KCal::CalendarNull::deleteAllEvents
void deleteAllEvents()
Definition calendarnull.cpp:97
KCal::CalendarNull::rawEvents
Event::List rawEvents(EventSortField sortField, SortDirection sortDirection)
Definition calendarnull.cpp:101
KCal::CalendarNull::save
bool save()
Definition calendarnull.cpp:75
KCal::CalendarNull::alarms
Alarm::List alarms(const KDateTime &from, const KDateTime &to)
Definition calendarnull.cpp:216
KCal::Calendar::Calendar
Calendar(const KDateTime::Spec &timeSpec)
Constructs a calendar with a specified time zone timeZoneid.
Definition calendar.cpp:106
KCal::Calendar::timeZoneId
QString timeZoneId() const
Returns the time zone ID used for creating or modifying incidences in the calendar.
Definition calendar.cpp:189
KCal::Calendar::timeSpec
KDateTime::Spec timeSpec() const
Get the time specification (time zone etc.) used for creating or modifying incidences in the Calendar...
Definition calendar.cpp:145
KCal::Event
This class provides an Event in the sense of RFC2445.
Definition event.h:42
KCal::Event::List
ListBase< Event > List
List of events.
Definition event.h:55
KCal::IncidenceBase
An abstract class that provides a common base for all calendar incidence classes.
Definition incidencebase.h:103
KCal::Journal
Provides a Journal in the sense of RFC2445.
Definition journal.h:44
KCal::Journal::List
ListBase< Journal > List
List of journals.
Definition journal.h:49
KCal::Todo
Provides a To-do in the sense of RFC2445.
Definition todo.h:45
KCal::Todo::List
ListBase< Todo > List
List of to-dos.
Definition todo.h:50
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal