• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KCal Library

event.h

Go to the documentation of this file.
00001 /*
00002   This file is part of the kcal library.
00003 
00004   Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
00005 
00006   This library is free software; you can redistribute it and/or
00007   modify it under the terms of the GNU Library General Public
00008   License as published by the Free Software Foundation; either
00009   version 2 of the License, or (at your option) any later version.
00010 
00011   This library is distributed in the hope that it will be useful,
00012   but WITHOUT ANY WARRANTY; without even the implied warranty of
00013   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014   Library General Public License for more details.
00015 
00016   You should have received a copy of the GNU Library General Public License
00017   along with this library; see the file COPYING.LIB.  If not, write to
00018   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00019   Boston, MA 02110-1301, USA.
00020 */
00028 #ifndef KCAL_EVENT_H
00029 #define KCAL_EVENT_H
00030 
00031 #include "incidence.h"
00032 #include <kpimutils/supertrait.h>
00033 #include <QtCore/QByteArray>
00034 
00035 namespace KCal {
00036 
00041 class KCAL_EXPORT Event : public Incidence
00042 {
00043   public:
00047     enum Transparency {
00048       Opaque,      
00049       Transparent  
00050     };
00051 
00055     typedef ListBase<Event> List;
00056 
00060     typedef boost::shared_ptr<Event> Ptr;
00061 
00065     Event();
00066 
00071     Event( const Event &other );
00072 
00076     ~Event();
00077 
00082     Event &operator=( const Event &other );
00083 
00088     bool operator==( const Event &event ) const;
00089 
00093     QByteArray type() const;
00094 
00098     Event *clone();
00099 
00105     void setDtEnd( const KDateTime &dtEnd );
00106 
00111     virtual KDateTime dtEnd() const;
00112 
00118     QDate dateEnd() const;
00119 
00130     KDE_DEPRECATED QString dtEndTimeStr(
00131       bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;
00132 
00143     KDE_DEPRECATED QString dtEndDateStr(
00144       bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;
00145 
00156     KDE_DEPRECATED QString dtEndStr(
00157       bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;
00158 
00163     void setHasEndDate( bool b );
00164 
00168     bool hasEndDate() const;
00169 
00176     bool isMultiDay( const KDateTime::Spec &spec = KDateTime::Spec() ) const;
00177 
00182     virtual void shiftTimes( const KDateTime::Spec &oldSpec,
00183                              const KDateTime::Spec &newSpec );
00184 
00189     void setTransparency( Transparency transparency );
00190 
00194     Transparency transparency() const;
00195 
00200     void setDuration( const Duration &duration );
00201 
00202   protected:
00206     virtual KDateTime endDateRecurrenceBase() const;
00207 
00208   private:
00213     bool accept( Visitor &v ) { return v.visit( this ); }
00214 
00215     //@cond PRIVATE
00216     class Private;
00217     Private *const d;
00218     //@endcond
00219 };
00220 
00221 }
00222 
00223 //@cond PRIVATE
00224 // super class trait specialization
00225 namespace KPIMUtils {
00226   template <> struct SuperClass<KCal::Event> : public SuperClassTrait<KCal::Incidence>{};
00227 }
00228 //@endcond
00229 
00230 #endif

KCal Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal