event.h

Go to the documentation of this file.

/*
  This file is part of the kcal library.

  Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@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_EVENT_H
#define KCAL_EVENT_H

#include "incidence.h"
#include <kpimutils/supertrait.h>
#include <QtCore/QByteArray>

namespace KCal {

class KCAL_DEPRECATED_EXPORT Event : public Incidence
{
  public:
    enum Transparency {
      Opaque,      
      Transparent  
    };

    typedef ListBase<Event> List;

    typedef boost::shared_ptr<Event> Ptr;

    typedef boost::shared_ptr<const Event> ConstPtr;

    Event();

    Event( const Event &other );

    ~Event();

    Event &operator=( const Event &other );

    bool operator==( const Event &event ) const;

    QByteArray type() const;

    //KDE5: QString typeStr() const;

    Event *clone();

    void setDtEnd( const KDateTime &dtEnd );

    virtual KDateTime dtEnd() const;

    QDate dateEnd() const;

    KCAL_DEPRECATED QString dtEndTimeStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    KCAL_DEPRECATED QString dtEndDateStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    KCAL_DEPRECATED QString dtEndStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    void setHasEndDate( bool b );

    bool hasEndDate() const;

    bool isMultiDay( const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    virtual void shiftTimes( const KDateTime::Spec &oldSpec,
                             const KDateTime::Spec &newSpec );

    void setTransparency( Transparency transparency );

    Transparency transparency() const;

    void setDuration( const Duration &duration );

  protected:
    virtual KDateTime endDateRecurrenceBase() const;

  private:
    bool accept( Visitor &v ) { return v.visit( this ); }

    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

}

//@cond PRIVATE
// super class trait specialization
namespace KPIMUtils {
  template <> struct SuperClass<KCal::Event> : public SuperClassTrait<KCal::Incidence>{};
}
//@endcond

#endif