baseview.h

Go to the documentation of this file.

/*
  This file is part of the KOrganizer interfaces.

  Copyright (c) 1999,2001,2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (C) 2004 Reinhold Kainhofer   <reinhold@kainhofer.com>

  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 KORG_INTERFACES_BASEVIEW_H
#define KORG_INTERFACES_BASEVIEW_H

#include "korganizer/korganizer_export.h"
#include "printplugin.h"

#include <Akonadi/Calendar/IncidenceChanger>
#include <Akonadi/Calendar/ETMCalendar>
#include <calendarviews/eventview.h>

#include <Akonadi/Collection>
#include <Akonadi/Item>

#include <QWidget>

namespace KOrg {

class KORGANIZER_INTERFACES_EXPORT BaseView : public QWidget
{
  Q_OBJECT
  public:
    explicit BaseView( QWidget *parent = 0 );

    virtual ~BaseView();

    virtual void setCalendar( const Akonadi::ETMCalendar::Ptr &cal );
    virtual Akonadi::ETMCalendar::Ptr calendar();

    virtual Akonadi::Item::List selectedIncidences() = 0;

    virtual KCalCore::DateList selectedIncidenceDates() = 0;

    virtual QDateTime selectionStart() { return QDateTime(); }

    virtual QDateTime selectionEnd() { return QDateTime(); }

    virtual CalPrinterBase::PrintType printType() const;

    virtual int currentDateCount() const = 0;

    virtual bool isEventView();

    virtual void getHighlightMode( bool &highlightEvents,
                                   bool &highlightTodos,
                                   bool &highlightJournals );

    virtual bool usesFullWindow();

    virtual bool supportsZoom();

    virtual bool supportsDateRangeSelection();

    virtual bool hasConfigurationDialog() const;

    virtual void showConfigurationDialog( QWidget *parent );

    QByteArray identifier() const;
    virtual void setIdentifier( const QByteArray &identifier );

    virtual void restoreConfig( const KConfigGroup &configGroup );

    virtual void saveConfig( KConfigGroup &configGroup );

    virtual BaseView *viewAt( const QPoint &p );

    virtual void setDateRange( const KDateTime &start, const KDateTime &end,
                               const QDate &preferredMonth = QDate() );

    KDateTime startDateTime() const;
    KDateTime endDateTime() const;

    KDateTime actualStartDateTime() const;
    KDateTime actualEndDateTime() const;

    virtual bool supportsDateNavigation() const { return false; }

    virtual Akonadi::Collection::Id collectionId() const { return -1; }

  public Q_SLOTS:
    virtual void showIncidences( const Akonadi::Item::List &incidenceList, const QDate &date ) = 0;

    virtual void updateView() = 0;
    virtual void dayPassed( const QDate & );

    virtual void setIncidenceChanger( Akonadi::IncidenceChanger *changer );

    virtual void flushView();

    virtual void changeIncidenceDisplay( const Akonadi::Item &,
                                         Akonadi::IncidenceChanger::ChangeType ) = 0;

    virtual void updateConfig();

    virtual void clearSelection();

    virtual bool eventDurationHint( QDateTime &startDt, QDateTime &endDt, bool &allDay );

  Q_SIGNALS:
    void incidenceSelected( const Akonadi::Item &, const QDate );

    void showIncidenceSignal( const Akonadi::Item & );

    void editIncidenceSignal( const Akonadi::Item & );

    void deleteIncidenceSignal( const Akonadi::Item & );

    void cutIncidenceSignal( const Akonadi::Item & );

    void copyIncidenceSignal( const Akonadi::Item & );

    void pasteIncidenceSignal();

    void toggleAlarmSignal( const Akonadi::Item & );

    void toggleTodoCompletedSignal( const Akonadi::Item & );

    void copyIncidenceToResourceSignal( const Akonadi::Item &, const QString & );

    void moveIncidenceToResourceSignal( const Akonadi::Item &, const QString & );

    void dissociateOccurrencesSignal( const Akonadi::Item &, const QDate & );

    void startMultiModify( const QString & );
    void endMultiModify();

    void newEventSignal();

    void newEventSignal( const QDate & );

    void newEventSignal( const QDateTime & );

    void newEventSignal( const QDateTime &, const QDateTime & );

    void newTodoSignal( const QDate & );
    void newSubTodoSignal( const Akonadi::Item & );

    void newJournalSignal( const QDate & );

  public:

    virtual void setChanges( EventViews::EventView::Changes changes );

    EventViews::EventView::Changes changes() const;

  protected:
    virtual void doRestoreConfig( const KConfigGroup &configGroup );

    virtual void doSaveConfig( KConfigGroup &configGroup );

    virtual void showDates( const QDate &start, const QDate &end,
                            const QDate &preferredMonth = QDate() ) = 0;

    virtual QPair<KDateTime,KDateTime> actualDateRange(
      const KDateTime &start,
      const KDateTime &end,
      const QDate &preferredMonth = QDate() ) const;

  protected Q_SLOTS:
    virtual void calendarReset();

  protected:
    Akonadi::IncidenceChanger *mChanger;

  private:
    class Private;
    Private *const d;
    friend class KOrg::BaseView::Private;
};

}

#endif