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

KCalCore Library

  • kcalcore
event.h
Go to the documentation of this file.
1 /*
2  This file is part of the kcalcore library.
3 
4  Copyright (c) 2001-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 KCALCORE_EVENT_H
29 #define KCALCORE_EVENT_H
30 
31 #include "kcalcore_export.h"
32 #include "incidence.h"
33 #include "supertrait.h"
34 
35 namespace KCalCore {
36 
41 class KCALCORE_EXPORT Event : public Incidence
42 {
43  public:
47  enum Transparency {
48  Opaque,
49  Transparent
50  };
51 
55  typedef QSharedPointer<Event> Ptr;
56 
60  typedef QVector<Ptr> List;
61 
65  Event();
66 
71  Event( const Event &other );
72 
76  ~Event();
77 
82  IncidenceType type() const;
83 
88  QByteArray typeStr() const;
89 
93  Event *clone() const;
94 
101  virtual void setDtStart( const KDateTime &dt );
102 
111  void setDtEnd( const KDateTime &dtEnd );
112 
120  virtual KDateTime dtEnd() const;
121 
127  QDate dateEnd() const;
128 
133  void setHasEndDate( bool b );
134 
138  bool hasEndDate() const;
139 
150  bool isMultiDay( const KDateTime::Spec &spec = KDateTime::Spec() ) const;
151 
156  virtual void shiftTimes( const KDateTime::Spec &oldSpec,
157  const KDateTime::Spec &newSpec );
158 
163  void setTransparency( Transparency transparency );
164 
168  Transparency transparency() const;
169 
174  void setDuration( const Duration &duration );
175 
180  void setAllDay( bool allDay );
181 
186  KDateTime dateTime( DateTimeRole role ) const;
187 
192  void setDateTime( const KDateTime &dateTime, DateTimeRole role );
193 
198  QLatin1String mimeType() const;
199 
204  QLatin1String iconName( const KDateTime &recurrenceId = KDateTime() ) const;
205 
209  static QLatin1String eventMimeType();
210 
211  protected:
216  virtual bool equals( const IncidenceBase &event ) const;
217 
222  virtual IncidenceBase &assign( const IncidenceBase &other );
223 
228  virtual void virtual_hook( int id, void *data );
229 
230  private:
235  bool accept( Visitor &v, IncidenceBase::Ptr incidence );
236 
243  Event &operator=( const Event &other );
244 
245  //@cond PRIVATE
246  class Private;
247  Private *const d;
248  //@endcond
249 };
250 
251 } // namespace KCalCore
252 
253 Q_DECLARE_TYPEINFO( KCalCore::Event::Ptr, Q_MOVABLE_TYPE );
254 
255 //@cond PRIVATE
256 namespace KPIMUtils {
257  // super class trait specialization
258  template <> struct SuperClass<KCalCore::Event> : public SuperClassTrait<KCalCore::Incidence>{};
259 }
260 //@endcond
261 
262 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:24:51 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

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

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 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