summaryrefslogtreecommitdiffstats
path: root/libkcal/assignmentvisitor.h
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-09-01 00:37:02 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-09-01 00:37:02 +0000
commitcc29364f06178f8f6b457384f2ec37a042bd9d43 (patch)
tree7c77a3184c698bbf9d98cef09fb1ba8124daceba /libkcal/assignmentvisitor.h
parent4f6c584bacc8c3c694228f36ada3de77a76614a6 (diff)
downloadtdepim-cc29364f06178f8f6b457384f2ec37a042bd9d43.tar.gz
tdepim-cc29364f06178f8f6b457384f2ec37a042bd9d43.zip
* Massive set of changes to bring in all fixes and enhancements from the Enterprise PIM branch
* Ensured that the Trinity changes were applied on top of those enhancements, and any redundancy removed * Added journal read support to the CalDAV resource * Fixed CalDAV resource to use events URL for tasks and journals when separate URL checkbox unchecked git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1170461 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'libkcal/assignmentvisitor.h')
-rw-r--r--libkcal/assignmentvisitor.h122
1 files changed, 122 insertions, 0 deletions
diff --git a/libkcal/assignmentvisitor.h b/libkcal/assignmentvisitor.h
new file mode 100644
index 000000000..2be0215cc
--- /dev/null
+++ b/libkcal/assignmentvisitor.h
@@ -0,0 +1,122 @@
+/*
+ Copyright (c) 2009 Kevin Krammer <kevin.krammer@gmx.at>
+
+ This library is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Library General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or (at your
+ option) any later version.
+
+ This library is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
+ License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to the
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+*/
+
+#ifndef KCAL_ASSIGNMENTVISITOR_H
+#define KCAL_ASSIGNMENTVISITOR_H
+
+#include "incidencebase.h"
+
+namespace KCal {
+
+/**
+ Helper for type correct assignment of incidences via pointers.
+
+ This class provides a way of correctly assigning one incidence to another,
+ given two IncidenceBase derived pointers. It effectively provides a virtual
+ assignment method which first type checks the two pointers to ensure they
+ reference the same incidence type, before performing the assignment.
+
+ Usage example:
+ @code
+ KCal::Incidence *currentIncidence; // assume this is set somewhere else
+ KCal::Incidence *updatedIncidence; // assume this is set somewhere else
+
+ KCal::AssignmentVisitor visitor;
+
+ // assign
+ if ( !visitor.assign(currentIncidence, updatedIncidence) ) {
+ // not of same type
+ }
+ @endcode
+
+ @author Kevin Krammer \<kevin.krammer@gmx.at\>
+ */
+class AssignmentVisitor : public IncidenceBase::Visitor
+{
+ public:
+ /**
+ Creates a visitor instance.
+ */
+ AssignmentVisitor();
+
+ /**
+ Destroys the instance.
+ */
+ virtual ~AssignmentVisitor();
+
+ /**
+ Assigns the incidence referenced by @p source to the incidence referenced
+ by @p target, first ensuring that the @p source incidence can be cast to
+ the same class as the @p target incidence.
+
+ Basically it is a virtual equivalent of
+ @code
+ *target = *source
+ @endcode
+
+ @param target pointer to the instance to assign to
+ @param source pointer to the instance to assign from
+
+ @return @c false if the two objects are of different type
+ */
+ bool assign( IncidenceBase *target, const IncidenceBase *source );
+
+ /**
+ Tries to assign to the given @p event, using the source passed to
+ assign().
+
+ @return @c false if the source passed to assign() is not an Event
+ */
+ virtual bool visit( Event *event );
+
+ /**
+ Tries to assign to the given @p todo, using the source passed to
+ assign().
+
+ @return @c false if the source passed to assign() is not a Todo
+ */
+ virtual bool visit( Todo *todo );
+
+ /**
+ Tries to assign to the given @p journal, using the source passed to
+ assign().
+
+ @return @c false if the source passed to assign() is not a Journal
+ */
+ virtual bool visit( Journal *journal );
+
+ /**
+ Tries to assign to the given @p freebusy, using the source passed to
+ assign().
+
+ @return @c false if the source passed to assign() is not a FreeBusy
+ */
+ virtual bool visit( FreeBusy *freebusy );
+
+ private:
+ //@cond PRIVATE
+ class Private;
+ Private *const d;
+ //@endcond
+};
+
+}
+
+#endif
+// kate: space-indent on; indent-width 2; replace-tabs on;