calendarview.h

Go to the documentation of this file.

/*
  This file is part of KOrganizer.

  Copyright (c) 2000,2001,2003,2004 Cornelius Schumacher <schumacher@kde.org>
  Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (c) 2005 Rafal Rzepecki <divide@users.sourceforge.net>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program 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 General Public License for more details.

  You should have received a copy of the GNU General Public License along
  with this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

  As a special exception, permission is given to link this program
  with any edition of Qt, and distribute the resulting executable,
  without including the source code for Qt in the source distribution.
*/

#ifndef KORG_CALENDARVIEW_H
#define KORG_CALENDARVIEW_H

#include "korganizer_export.h"
#include "interfaces/korganizer/calendarviewbase.h"

#include <KCalCore/Incidence>
#include <KCalCore/Visitor>
#include <KCalCore/ScheduleMessage>

#include <akonadi/calendar/itiphandler.h>

#include <calendarsupport/messagewidget.h>

class CalPrinter;
class DateChecker;
class DateNavigator;
class DateNavigatorContainer;
class KODialogManager;
class KOTodoView;
class KOViewManager;
class NavigatorBar;
class KOCheckableProxyModel;
class AkonadiCollectionView;
namespace KOrg {
  class HTMLExportSettings;
}

namespace CalendarSupport {
  class IncidenceViewer;
}

namespace IncidenceEditorNG {
  class IncidenceDialog;
}

namespace Akonadi {
  class History;
  class IncidenceChanger;
  class CalendarClipboard;
  class TodoPurger;
}

class KVBox;

class QSplitter;
class QStackedWidget;

using namespace KOrg;

class CalendarViewExtension : public QWidget
{
  public:
    explicit CalendarViewExtension( QWidget *parent ) : QWidget( parent ) {}

    class Factory
    {
      public:
        virtual ~Factory() {}
        virtual CalendarViewExtension *create( QWidget *parent ) = 0;
    };
};

class KORGANIZERPRIVATE_EXPORT CalendarView : public KOrg::CalendarViewBase,
                                              public Akonadi::ETMCalendar::CalendarObserver
{
  Q_OBJECT
  public:
    explicit CalendarView( QWidget *parent=0 );
    virtual ~CalendarView();

    class CalendarViewVisitor : public KCalCore::Visitor
    {
      public:
        CalendarViewVisitor() : mView( 0 )
        {
        }

        bool act( KCalCore::IncidenceBase::Ptr &incidence, CalendarView *view )
        {
          mView = view;
          return incidence->accept( *this, incidence );
        }

      protected:
        CalendarView *mView;
    };

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

    void showMessage(const QString &message, KMessageWidget::MessageType);

    Akonadi::History *history() const;
    void setCheckableProxyModel( KOCheckableProxyModel * );

    KOViewManager *viewManager() const { return mViewManager; }
    KODialogManager *dialogManager() const { return mDialogManager; }

    QStackedWidget *viewStack() const { return mRightFrame; }
    QWidget *leftFrame() const { return mLeftFrame; }
    NavigatorBar *navigatorBar() const { return mNavigatorBar; }
    DateNavigator *dateNavigator() const { return mDateNavigator; }
    // TODO_NG
    //IncidenceEditors::IncidenceEditor *editorDialog( const Akonadi::Item &item ) const;
    virtual Akonadi::IncidenceChanger *incidenceChanger() const { return mChanger; }

    void updateHighlightModes();

    QDate startDate();
    QDate endDate();

    KOrg::BaseView *currentView() const;
    void addView( KOrg::BaseView * );
    void showView( KOrg::BaseView * );

    void addExtension( CalendarViewExtension::Factory * );

    Akonadi::Item currentSelection();

    Akonadi::Item selectedIncidence();

    bool isFiltered() const;

    QString currentFilterName() const;

  signals:
    void configChanged();

    void categoriesChanged();

    void categoryConfigChanged();

    void closed( QWidget * );

    void modifiedChanged( bool );

    void readOnlyChanged( bool );

    void changeNavStringPrev( const QString & );
    void changeNavStringNext( const QString & );

    void organizerEventsSelected( bool );
    void groupEventsSelected( bool );
    void incidenceSelected( const Akonadi::Item &incidence, const QDate &date );
    void todoSelected( bool );
    void subtodoSelected( bool );

    void dayPassed( const QDate & );

    void pasteEnabled( bool );
    void statusMessage( const QString & );

    void calendarViewExpanded( bool );

    void autoArchivingSettingsModified();

    void newIncidenceChanger( Akonadi::IncidenceChanger * );
    void exportHTML( KOrg::HTMLExportSettings * );

    void filtersUpdated( const QStringList &, int );
    void filterChanged();

  public slots:
    void updateConfig();
    void updateConfig( const QByteArray & );

    void updateCategories();
    void handleIncidenceCreated(const Akonadi::Item &item);

    bool saveCalendar( const QString &filename );

    void archiveCalendar();

    void newEvent( const QDate & );

    void newEvent();

    void newEvent( const QDateTime &startDt );

    void newEvent( const QDateTime &startDt, const QDateTime &EndDt, bool allDay=false );

    void newEvent( const QString &summary,
                   const QString &description=QString(),
                   const QStringList &attachment=QStringList(),
                   const QStringList &attendees=QStringList(),
                   const QStringList &attachmentMimetypes=QStringList(),
                   bool inlineAttachment=false );
    void newFloatingEvent();

    void showIncidence( const Akonadi::Item &item );
    bool showIncidence( Akonadi::Item::Id id );
    void showIncidence();

    void showIncidenceContext( const Akonadi::Item &incidence );
    bool showIncidenceContext( Akonadi::Item::Id id );

    bool editIncidence( const Akonadi::Item &item, bool isCounter = false );
    bool editIncidence( Akonadi::Item::Id id );
    void editIncidence();

    bool deleteIncidence( const Akonadi::Item &item, bool force=false );
    bool deleteIncidence( Akonadi::Item::Id id, bool force=false );
    void deleteIncidence();

    bool addIncidence( const QString &ical );
    bool addIncidence( const KCalCore::Incidence::Ptr &incidence );

    void cutIncidence( const Akonadi::Item & );

    void copyIncidence( const Akonadi::Item & );

    void pasteIncidence();

    void deleteSubTodosIncidence ( const Akonadi::Item &todo );

    void deleteTodoIncidence ( const Akonadi::Item &todo, bool force=false );

    void newTodo();

    void newTodo( const QDate &date );

    void newTodo( const Akonadi::Collection &collection );

    void newSubTodo();

    void newSubTodo( const Akonadi::Item &todo );

    void newSubTodo( const Akonadi::Collection &collection );

    void newTodo( const QString &summary, const QString &description=QString(),
                  const QStringList &attachments=QStringList(),
                  const QStringList &attendees=QStringList(),
                  const QStringList &attachmentMimetypes=QStringList(),
                  bool inlineAttachment=false );

    void newJournal();
    void newJournal( const QDate &date );
    void newJournal( const QString &text, const QDate &date=QDate() );
    void newJournal( const Akonadi::Collection &collection );

    void configureCurrentView();

    void toggleAlarm( const Akonadi::Item &incidence );
    void toggleTodoCompleted( const Akonadi::Item &incidence );
    void copyIncidenceToResource( const Akonadi::Item &incidence, const QString &resourceId );
    void moveIncidenceToResource( const Akonadi::Item &incidence, const QString &resourceId );
    void dissociateOccurrences( const Akonadi::Item &incidence, const QDate &date );

    void checkClipboard();

    void readSettings();

    void writeSettings();

    void readFilterSettings( KConfig *config );

    void writeFilterSettings( KConfig *config );

    void changeIncidenceDisplay( const Akonadi::Item &incidence,
                                 Akonadi::IncidenceChanger::ChangeType );

    void slotCreateFinished( int changeId,
                             const Akonadi::Item &item,
                             Akonadi::IncidenceChanger::ResultCode resultCode,
                             const QString &errorString );

    void slotModifyFinished( int changeId,
                             const Akonadi::Item &item,
                             Akonadi::IncidenceChanger::ResultCode resultCode,
                             const QString &errorString );

    void slotDeleteFinished( int changeId,
                             const QVector<Akonadi::Item::Id> &itemIdList,
                             Akonadi::IncidenceChanger::ResultCode resultCode,
                             const QString &errorString );

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

    void updateView( const QDate &start, const QDate &end,
                     const QDate &preferredMonth, const bool updateTodos=true );
    void updateView();

    void updateUnmanagedViews();

    void edit_cut();

    void edit_copy();

    void edit_paste();

    void onCutFinished();

    void edit_options();

    void print();
    void printPreview();

    void exportWeb();

    void exportICalendar();

    void exportVCalendar();

    void appointment_show();
    void appointment_edit();

    void appointment_delete();

    void todo_unsub();

    /* Frees an incidence's children from it's relation, without the view update
       Works with any incidence type, although currently we only pass to-dos
    */
    bool incidence_unsub( const Akonadi::Item &item );

    bool makeSubTodosIndependent( );

    bool makeChildrenIndependent( const Akonadi::Item &item );

    void takeOverEvent();

    bool isReadOnly() const;

    void setReadOnly( bool readOnly=true );

    void eventUpdated( const Akonadi::Item &incidence );

    /* iTIP scheduling actions */
    void schedule_publish( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_request( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_refresh( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_cancel( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_add( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_reply( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_counter( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_declinecounter( const Akonadi::Item &incidence=Akonadi::Item() );
    void schedule_forward( const Akonadi::Item &incidence=Akonadi::Item() );
    void mailFreeBusy( int daysToPublish=30 );
    void uploadFreeBusy();

    void openAddressbook();

    void editFilters();

    void updateFilter();

    void showIntro();

    void showDateNavigator( bool );
    void showTodoView( bool );
    void showEventViewer( bool );

    void goDate( const QDate &date );

    void showDate( const QDate &date );

    void goToday();

    void goNext();

    void goPrevious();

    void showLeftFrame( bool show=true );

    void dialogClosing( const Akonadi::Item &incidence );

    void processMainViewSelection( const Akonadi::Item &incidence, const QDate &date );
    void processTodoListSelection( const Akonadi::Item &incidence, const QDate &date );

    void processIncidenceSelection( const Akonadi::Item &incidence, const QDate &date );

    void purgeCompleted();

    void slotAutoArchivingSettingsModified() { emit autoArchivingSettingsModified(); }

    void showErrorMessage( const QString & );
    void schedule( KCalCore::iTIPMethod, const Akonadi::Item &incidence );
    void addIncidenceOn( const Akonadi::Item &incidence, const QDate & );
    void moveIncidenceTo( const Akonadi::Item &incidence, const QDate & );
    void filterActivated( int filterNum );

    void resourcesChanged();

    void selectWeek( const QDate &week, const QDate &preferredMonth );

    void changeFullView( bool fullView );

  protected slots:
    void showDates( const KCalCore::DateList &, const QDate &preferredMonth = QDate() );

  public:
    int msgCalModified();

    void adaptNavigationUnits();

    QDate activeIncidenceDate();

    QDate activeDate( bool fallbackToToday = false );

  protected:
    int msgItemDelete( const Akonadi::Item &incidence );

    Akonadi::Item selectedTodo();
    IncidenceEditorNG::IncidenceDialog *incidenceDialog(const Akonadi::Item &);

    void warningChangeFailed( const Akonadi::Item & );
    void checkForFilteredChange( const Akonadi::Item &incidence );

    void dateTimesForNewEvent( QDateTime &startDt, QDateTime &endDt, bool &allDay );
    IncidenceEditorNG::IncidenceDialog *newEventEditor( const KCalCore::Event::Ptr &event );

    bool eventFilter( QObject *watched, QEvent *event );

  private Q_SLOTS:
    void onCheckableProxyAboutToToggle( bool newState );
    void onCheckableProxyToggled( bool newState );
    void onTodosPurged(bool success, int numDeleted, int numIgnored);

  private:
    void init();
    Akonadi::Collection selectedCollection() const;
    Akonadi::Collection::List checkedCollections() const;

    void createPrinter();

    void dissociateOccurrence( const Akonadi::Item &incidence, const QDate & , bool futureOccurrences);

    Akonadi::Collection defaultCollection(
      const QLatin1String &mimeType = QLatin1String( "" ) ) const;

    IncidenceEditorNG::IncidenceDialog *createIncidenceEditor(
      const Akonadi::Item &item, const Akonadi::Collection &collection = Akonadi::Collection() );

    CalPrinter *mCalPrinter;
    Akonadi::TodoPurger *mTodoPurger;

    QSplitter *mPanner;
    QSplitter *mLeftSplitter;
    QWidget *mLeftFrame;
    QStackedWidget *mRightFrame;
    CalendarSupport::MessageWidget *mMessageWidget;

    // This navigator bar is used when in full window month view
    // It has nothing to do with the date navigator
    NavigatorBar *mNavigatorBar;

    DateNavigatorContainer *mDateNavigatorContainer;

    QList<CalendarViewExtension*> mExtensions;

    Akonadi::ETMCalendar::Ptr mCalendar;

    DateNavigator *mDateNavigator;
    DateChecker *mDateChecker;

    KVBox *mEventViewerBox;
    CalendarSupport::IncidenceViewer *mEventViewer;
    KOViewManager *mViewManager;
    KODialogManager *mDialogManager;

    // Calendar filters
    QList<KCalCore::CalFilter*> mFilters;
    KCalCore::CalFilter *mCurrentFilter;

    // various housekeeping variables.
    bool  mReadOnly; // flag indicating if calendar is read-only

    Akonadi::Item mSelectedIncidence;
    QDate mSaveDate;

    KOTodoView *mTodoList;
    Akonadi::IncidenceChanger *mChanger;
    Akonadi::ITIPHandler *mITIPHandler;
    QList<int> mMainSplitterSizes; // temp store for main splitter sizes while left frame is hidden
    bool mSplitterSizesValid;
    bool mCreatingEnabled;

    Akonadi::CalendarClipboard *mCalendarClipboard;
    KOCheckableProxyModel *mCheckableProxyModel;
    AkonadiCollectionView *mETMCollectionView;
};

#endif