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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*
Copyright 2009 Ingo Klöcker <kloecker@kde.org>
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_COMPARISONVISITOR_H
#define KCAL_COMPARISONVISITOR_H
#include "incidencebase.h"
namespace KCal {
/**
Helper for type correct comparison of incidences via pointers.
This class provides a way of correctly comparing one incidence to another,
given two IncidenceBase derived pointers. It effectively provides a virtual
comparison method which first type checks the two pointers to ensure they
reference the same incidence type, before performing the comparison.
Usage example:
@code
KCal::Incidence *incidence; // assume this is set somewhere else
KCal::Incidence *referenceIncidence; // assume this is set somewhere else
KCal::ComparisonVisitor visitor;
// compare
if ( visitor.compare( incidence, referenceIncidence ) ) {
// incidence and referenceIncidence point to identical incidences
}
@endcode
@author Ingo Klöcker <kloecker@kde.org>
*/
class ComparisonVisitor : public IncidenceBase::Visitor
{
public:
/**
Creates a visitor instance.
*/
ComparisonVisitor();
/**
Destroys the instance.
*/
virtual ~ComparisonVisitor();
/**
Compares the incidence referenced by @p incidence to the incidence
referenced by @p reference. Returns true, if the incidence referenced
by @p incidence is identical to the incidence referenced by @p reference.
Also returns true, if @p incidence and @p reference are both @c 0.
Basically it is a virtual equivalent of
@code
*incidence == *reference
@endcode
@param incidence pointer to the incidence to compare with the reference incidence
@param reference pointer to the reference incidence
@return @c true if the two incidences are identical or both @c 0
*/
bool compare( IncidenceBase *incidence, const IncidenceBase *reference );
/**
Compares the event referenced by @p event to the incidence passed to
compare().
@return @c true if the event is identical to the reference incidence
*/
virtual bool visit( Event *event );
/**
Compares the todo referenced by @p todo to the incidence passed to
compare().
@return @c true if the todo is identical to the reference incidence
*/
virtual bool visit( Todo *todo );
/**
Compares the journal referenced by @p journal to the incidence passed to
compare().
@return @c true if the journal is identical to the reference incidence
*/
virtual bool visit( Journal *journal );
/**
Compares the freebusy object referenced by @p freebusy to the incidence passed to
compare().
@return @c true if the freebusy object is identical to the reference incidence
*/
virtual bool visit( FreeBusy *freebusy );
private:
//@cond PRIVATE
class Private;
Private *const d;
//@endcond
};
}
#endif // KCAL_COMPARISONVISITOR_H
|
