calprintpluginbase.h

Go to the documentation of this file.

/*
  Copyright (c) 1998 Preston Brown <pbrown@kde.org>
  Copyright (C) 2003 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (C) 2008 Ron Goodheart <rong.dev@gmail.com>
  Copyright (c) 2012-2013 Allen Winter <winter@kde.org>

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

#include "calendarsupport_export.h"
#include "printplugin.h"

#include <Akonadi/Calendar/ETMCalendar>
#include <KCalendarSystem>

#include <KCalCore/Event>
#include <KCalCore/Journal>
#include <KCalCore/Todo>
#include <KDateTime>

#include <QPainter>

class PrintCellItem;
class QWidget;

#define PORTRAIT_HEADER_HEIGHT 72   // header height, for portrait orientation
#define LANDSCAPE_HEADER_HEIGHT 54  // header height, for landscape orientation
#define SUBHEADER_HEIGHT 20         // subheader height, for all orientations
#define PORTRAIT_FOOTER_HEIGHT 16   // footer height, for portrait orientation
#define LANDSCAPE_FOOTER_HEIGHT 14  // footer height, for landscape orientation
#define MARGIN_SIZE 36              // margins, for all orientations
#define PADDING_SIZE 7              // padding between the various top-level boxes
#define BOX_BORDER_WIDTH 2          // width of the border of all top-level boxes
#define EVENT_BORDER_WIDTH 0        // with of the border of all incidence boxes

#define TIMELINE_WIDTH 50           // width of timeline (day and timetable)

namespace CalendarSupport {

class CALENDARSUPPORT_EXPORT CalPrintPluginBase : public PrintPlugin
{
  public:
    enum DisplayFlags {
      Text=0x0001,
      TimeBoxes=0x0002
    };

  public:
    CalPrintPluginBase();
    virtual ~CalPrintPluginBase();

    virtual QWidget *createConfigWidget( QWidget * );

    virtual void print( QPainter &p, int width, int height ) = 0;
    virtual void doPrint( QPrinter *printer );

    virtual void loadConfig() = 0;
    virtual void saveConfig() = 0;

    void doLoadConfig();
    void doSaveConfig();

  public:
    bool useColors() const;
    void setUseColors( bool useColors );

    bool printFooter() const;
    void setPrintFooter( bool printFooter );

    static int weekdayColumn( int weekday );

    QPrinter::Orientation orientation() const;

    int headerHeight() const;
    void setHeaderHeight( const int height );

    int subHeaderHeight() const;
    void setSubHeaderHeight( const int height );
    int footerHeight() const;
    void setFooterHeight( const int height );

    int margin() const;
    void setMargin( const int margin );

    int padding() const;
    void setPadding( const int margin );

    int borderWidth() const;
    void setBorderWidth( const int border );

    const KCalendarSystem *calendarSystem();
    void setCalendarSystem( const KCalendarSystem *calsys );

  /*****************************************************************
   **               PRINTING HELPER FUNCTIONS                     **
   *****************************************************************/
  public:
    static void drawBox( QPainter &p, int linewidth, const QRect &rect );
    static void drawShadedBox( QPainter &p, int linewidth, const QBrush &brush, const QRect &rect );

    void printEventString( QPainter &p, const QRect &box, const QString &str, int flags = -1 );
    void showEventBox( QPainter &p, int linewidth, const QRect &box,
                       const KCalCore::Incidence::Ptr &incidence, const QString &str, int flags = -1 );

    void drawSubHeaderBox( QPainter &p, const QString &str, const QRect &box );

    void drawVerticalBox( QPainter &p, int linewidth, const QRect &box, const QString &str,
                          int flags=-1 );

    int drawBoxWithCaption( QPainter &p, const QRect &box, const QString &caption,
                            const QString &contents, bool sameLine, bool expand,
                            const QFont &captionFont, const QFont &textFont,
                            bool richContents = false );

    int drawHeader( QPainter &p, const QString &title,
                     const QDate &month1, const QDate &month2,
                     const QRect &box, bool expand = false,
                     QColor backColor = QColor() );

    int drawFooter( QPainter &p, const QRect &box );

    void drawSmallMonth( QPainter &p, const QDate &qd, const QRect &box );

    void drawDaysOfWeek( QPainter &p,
                         const QDate &fromDate, const QDate &toDate,
                         const QRect &box );
    void drawDaysOfWeekBox( QPainter &p, const QDate &qd, const QRect &box );

    void drawTimeLine( QPainter &p,
                       const QTime &fromTime, const QTime &toTime,
                       const QRect &box );

    int drawAllDayBox( QPainter &p, const KCalCore::Event::List &eventList,
                        const QDate &qd, bool expandable,
                        const QRect &box,
                        bool excludeConfidential, bool excludePrivate );
    void drawAgendaDayBox( QPainter &p, const KCalCore::Event::List &eventList,
                           const QDate &qd, bool expandable,
                           const QTime &fromTime, const QTime &toTime,
                           const QRect &box,
                           bool includeDescription, bool excludeTime,
                           bool excludeConfidential, bool excludePrivate,
                           const QList<QDate> &workDays );

    void drawAgendaItem( PrintCellItem *item, QPainter &p,
                         const KDateTime &startPrintDate,
                         const KDateTime &endPrintDate,
                         float minlen, const QRect &box,
                         bool includeDescription, bool excludeTime );

    void drawDayBox( QPainter &p, const QDate &qd,
                     const QTime &fromTime, const QTime &toTime,
                     const QRect &box,
                     bool fullDate = false, bool printRecurDaily = true,
                     bool printRecurWeekly = true,
                     bool singleLineLimit = true,
                     bool showNoteLines = false,
                     bool includeDescription = false,
                     bool excludeDescription = true,
                     bool excludePrivate = true );
    void drawWeek( QPainter &p, const QDate &qd,
                   const QTime &fromTime, const QTime &toTime,
                   const QRect &box, bool singleLineLimit,
                   bool showNoteLines, bool includeDescription,
                   bool excludeConfidential, bool excludePrivate );
    void drawDays( QPainter &p, const QDate &start, const QDate &end,
                   const QTime &fromTime, const QTime &toTime,
                   const QRect &box, bool singleLineLimit, bool showNoteLines,
                   bool includeDescription, bool excludeConfidential,
                   bool excludePrivate );
    void drawTimeTable( QPainter &p, const QDate &fromDate, const QDate &toDate,
                        bool expandable, const QTime &fromTime, const QTime &toTime,
                        const QRect &box, bool includeDescription,
                        bool excludeTime, bool excludeConfidential,
                        bool excludePrivate );

    void drawMonthTable( QPainter &p, const QDate &qd,
                         const QTime &fromTime, const QTime &toTime,
                         bool weeknumbers,
                         bool recurDaily, bool recurWeekly, bool singleLineLimit,
                         bool showNoteLines, bool includeDescription,
                         bool excludeConfidential, bool excludePrivate,
                         const QRect &box );
    void drawMonth( QPainter &p, const QDate &dt, const QRect &box,
                    int maxdays = -1, int subDailyFlags = TimeBoxes,
                    int holidaysFlags = Text,
                    bool excludeConfidential = false, bool excludePrivate = false );

    class TodoParentStart;

    void drawTodo( int &count, const KCalCore::Todo::Ptr &todo, QPainter &p,
                   KCalCore::TodoSortField sortField,
                   KCalCore::SortDirection sortDir,
                   bool connectSubTodos, bool strikeoutCompleted, bool desc,
                   int posPriority, int posSummary, int posDueDt,
                   int posPercentComplete, int level, int x, int &y,
                   int width, int pageHeight,
                   const KCalCore::Todo::List &todoList, TodoParentStart *r,
                   bool excludeConfidential, bool excludePrivate );

    void drawJournal( const KCalCore::Journal::Ptr &journal, QPainter &p, int x, int &y,
                      int width, int pageHeight );
    void drawTextLines( QPainter &p, const QString &entry,
                        int x, int &y, int width, int pageHeight,
                        bool richTextEntry );

    void drawSplitHeaderRight( QPainter &p, const QDate &fd, const QDate &td,
                               const QDate &cd, int width, int height );

    void drawNoteLines( QPainter &p, const QRect &box, int startY );

  protected:
    QTime dayStart() const;
    QColor categoryBgColor( const KCalCore::Incidence::Ptr &incidence ) const;

    void drawIncidence( QPainter &p, const QRect &dayBox, const QString &time,
                        const QString &summary, const QString &description,
                        int &textY, bool singleLineLimit,
                        bool includeDescription, bool richDescription );
    QString toPlainText( const QString &htmlText );
    void drawTodoLines( QPainter &p, const QString &entry,
                        int x, int &y, int width, int pageHeight,
                        bool richTextEntry, QList<TodoParentStart *> &startPoints,
                        bool connectSubTodos );

  protected:
    bool mUseColors;
    bool mPrintFooter;
    bool mShowNoteLines;
    int mHeaderHeight;
    int mSubHeaderHeight;
    int mFooterHeight;
    int mMargin;
    int mPadding;
    int mBorder;
    const KCalendarSystem *mCalSys;

  private:
    QColor categoryColor( const QStringList &categories ) const;

    void setColorsByIncidenceCategory( QPainter &p,
                                       const KCalCore::Incidence::Ptr &incidence ) const;


    QString holidayString( const QDate &date ) const;

    KCalCore::Event::Ptr holidayEvent( const QDate &date ) const;

    QColor getTextColor( const QColor &c ) const;
};

}

#endif