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

KCal Library

  • kcal
resourcelocaldir.h
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*/
21#ifndef KCAL_RESOURCELOCALDIRDIR_H
22#define KCAL_RESOURCELOCALDIRDIR_H
23
24#include "kcal_export.h"
25#include "resourcecached.h"
26
27namespace KCal {
28
33class KCAL_DEPRECATED_EXPORT ResourceLocalDir : public ResourceCached
34{
35 Q_OBJECT
36 friend class ResourceLocalDirConfig;
37
38 public:
39 ResourceLocalDir();
40 explicit ResourceLocalDir( const KConfigGroup &group );
41 explicit ResourceLocalDir( const QString &fileName );
42 virtual ~ResourceLocalDir();
43
44 void readConfig( const KConfigGroup &group );
45 void writeConfig( KConfigGroup &group );
46
47 KABC::Lock *lock();
48
50 bool deleteEvent( Event *event );
51
53 void deleteAllEvents();
54
58 bool deleteTodo( Todo *todo );
59
63 void deleteAllTodos();
64
68 bool deleteJournal( Journal *journal );
69
73 void deleteAllJournals();
74
75 void dump() const;
76
77 protected Q_SLOTS:
78 void reload( const QString &file );
79
80 protected:
81 bool doOpen();
82 virtual bool doLoad( bool syncCache );
83 virtual bool doSave( bool syncCache );
84 bool doSave( bool syncCache, Incidence *incidence );
85 virtual bool doFileLoad( CalendarLocal &cal, const QString &fileName );
86
87 private:
88 // Inherited virtual methods which should not be used by derived classes.
89 using ResourceCalendar::doLoad;
90 using ResourceCalendar::doSave;
91
92 //@cond PRIVATE
93 Q_DISABLE_COPY( ResourceLocalDir )
94 class Private;
95 Private *const d;
96 //@endcond
97};
98
99}
100
101#endif
KCal::CalendarLocal
This class provides a calendar stored as a local file.
Definition calendarlocal.h:44
KCal::Event
This class provides an Event in the sense of RFC2445.
Definition event.h:42
KCal::Incidence
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition incidence.h:70
KCal::Journal
Provides a Journal in the sense of RFC2445.
Definition journal.h:44
KCal::ResourceCached::journal
virtual Journal * journal(const QString &uid)
Return Journal with given unique id.
Definition resourcecached.cpp:325
KCal::ResourceCached::event
Event * event(const QString &UniqueStr)
Retrieves an event on the basis of the unique string ID.
Definition resourcecached.cpp:250
KCal::ResourceCached::todo
Todo * todo(const QString &uid)
Searches todolist for an event with this unique string identifier, returns a pointer or null.
Definition resourcecached.cpp:310
KCal::ResourceCalendar::doLoad
virtual bool doLoad(bool syncCache)=0
Do the actual loading of the resource data.
KCal::ResourceCalendar::incidence
Incidence * incidence(const QString &uid)
Return incidence with given unique id.
Definition resourcecalendar.cpp:99
KCal::ResourceCalendar::doSave
virtual bool doSave(bool syncCache)=0
Do the actual saving of the resource data.
KCal::ResourceLocalDir::deleteJournal
bool deleteJournal(Journal *journal)
Remove a journal from the journallist.
Definition resourcelocaldir.cpp:264
KCal::ResourceLocalDir::lock
KABC::Lock * lock()
Return object for locking the resource.
Definition resourcelocaldir.cpp:215
KCal::ResourceLocalDir::doSave
virtual bool doSave(bool syncCache)
Do the actual saving of the resource data.
Definition resourcelocaldir.cpp:176
KCal::ResourceLocalDir::deleteTodo
bool deleteTodo(Todo *todo)
Remove a todo from the todolist.
Definition resourcelocaldir.cpp:245
KCal::ResourceLocalDir::deleteAllJournals
void deleteAllJournals()
Removes all journals from this calendar.
Definition resourcelocaldir.cpp:278
KCal::ResourceLocalDir::deleteAllTodos
void deleteAllTodos()
Removes all todos from this calendar.
Definition resourcelocaldir.cpp:259
KCal::ResourceLocalDir::doLoad
virtual bool doLoad(bool syncCache)
Do the actual loading of the resource data.
Definition resourcelocaldir.cpp:126
KCal::ResourceLocalDir::doOpen
bool doOpen()
Opens the resource.
Definition resourcelocaldir.cpp:119
KCal::ResourceLocalDir::deleteEvent
bool deleteEvent(Event *event)
deletes an event from this calendar.
Definition resourcelocaldir.cpp:225
KCal::ResourceLocalDir::deleteAllEvents
void deleteAllEvents()
Removes all Events from this calendar.
Definition resourcelocaldir.cpp:240
KCal::Todo
Provides a To-do in the sense of RFC2445.
Definition todo.h:45
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