calprintbase.h

Go to the documentation of this file.

/*
  This file is part of the PimPrint library.

  Copyright (C) 2012  Allen Winter <winter@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.
*/

//
// arguments:
//   <D> printer() (mPrinter)
//   <D> style
//   <D> calendar
//   <D> calendarsystem
//   <D> headertext
//   <D> flagsList
//
// properties:
//   <D>useColor()
//   <D>useLandscape()
//   <D>pageWidth()
//   <D>pageHeight()
//   <D>headerHeight()
//   <D>subheaderHeight()
//   <D>footerHeight()
//   TODO: headerBackgroundColor?
//   <D> margins()
//   <D> padding()
//   <D> timeLineWidth() (TIMELINE_WIDTH)
//   <D> boxBorderWidth() (BOX_BORDER_WIDTH)
//   <D> itemBoxBorderWidth() (EVENT_BORDER_WIDTH)
//
#ifndef PIMPRINT_CALPRINTBASE_H
#define PIMPRINT_CALPRINTBASE_H

#include "pimprint_calendar_export.h"
#include "cellitem.h"

#include <KCalCore/Calendar>
#include <KCalCore/Event>
#include <KCalCore/Incidence>

#include <QPainter>
#include <QPrinter>

class KCalendarSystem;

namespace PimPrint
{

namespace Calendar
{

class PIMPRINT_CALENDAR_EXPORT CalPrintBase : public QObject
{
    Q_OBJECT
    Q_ENUMS(Style)
    Q_FLAGS(InfoOptions)
    Q_FLAGS(TypeOptions)
    Q_FLAGS(RangeOptions)
    Q_FLAGS(ExtraOptions)

    Q_PROPERTY(bool useColor
               READ useColor WRITE setUseColor)

    Q_PROPERTY(bool useLandscape
               READ useLandscape WRITE setUseLandscape)

    Q_PROPERTY(int pageWidth
               READ pageWidth WRITE setPageWidth)

    Q_PROPERTY(int pageHeight
               READ pageHeight WRITE setPageHeight)

    Q_PROPERTY(int headerHeight
               READ headerHeight WRITE setHeaderHeight)

    Q_PROPERTY(int subheaderHeight
               READ subHeaderHeight WRITE setSubHeaderHeight)

    Q_PROPERTY(int footerHeight
               READ footerHeight WRITE setFooterHeight)

    Q_PROPERTY(int padding
               READ padding WRITE setPadding)

    Q_PROPERTY(int margins READ margins)

    Q_PROPERTY(int boxBorderWidth READ boxBorderWidth)

    Q_PROPERTY(int itemBoxBorderWidth READ itemBoxBorderWidth)

    Q_PROPERTY(int timeLineWidth READ timeLineWidth)

public:
    explicit CalPrintBase(QPrinter *printer);

    ~CalPrintBase();

    virtual void print(QPainter &p) = 0;

    enum Style {
        None,               //< No print type is set
        Incidence,          //< Generalized for Events, To-dos and Journals
        DayFiloFax,         //<
        DayTimeTable,       //<
        DaySingleTimeTable, //<
        WeekFiloFax,        //<
        WeekTimeTable,      //<
        WeekSplitWeek,      //<
        MonthClassic,       //<
        TodoList,           //<
        Journal,            //< (how is this different from Incidence for Journals?)
        Year                //<
    };

    void setUseColor(const bool useColor);

    bool useColor() const;

    void setUseLandscape(const bool landscape);

    bool useLandscape() const;

    void setPageHeight(const int height) const;

    int pageHeight() const;

    void setPageWidth(const int width) const;

    int pageWidth() const;

    void setHeaderHeight(const int height);

    int headerHeight() const;

    void setSubHeaderHeight(const int height);

    int subHeaderHeight() const;

    void setFooterHeight(const int height);

    int footerHeight() const;

    void setPadding(const int padding);

    int padding() const;

    int margins() const;

    int boxBorderWidth() const;

    int itemBoxBorderWidth() const;

    int timeLineWidth() const;

    enum InfoOption {
        InfoAll          = 0x00000001,
        InfoDescription  = 0x00000002,
        InfoLocation     = 0x00000004,
        InfoAttendees    = 0x00000008,
        InfoCategories   = 0x00000010,
        InfoPriority     = 0x00000020,
        InfoDueDate      = 0x00000040, // for to-dos only
        InfoPercentDone  = 0x00000080, // for to-dos only
        InfoTimeRange    = 0x00000100
    };
    Q_DECLARE_FLAGS(InfoOptions, InfoOption)

    enum TypeOption {
        TypeAll          = 0x00000001,
        TypeEvent        = 0x00000002,
        TypeTodo         = 0x00000004,
        TypeJournal      = 0x00000008,
        TypeConfidential = 0x00000010,
        TypePrivate      = 0x00000020
    };
    Q_DECLARE_FLAGS(TypeOptions, TypeOption)

    enum RangeOption {
        RangeTimeExpand  = 0x00000001,
        RangeRecurAny    = 0x00000002,
        RangeRecurDaily  = 0x00000004,
        RangeRecurWeekly = 0x00000008
    };
    Q_DECLARE_FLAGS(RangeOptions, RangeOption)

    enum ExtraOption {
        ExtraSingleLine      = 0x00000001,
        ExtraNoteLines       = 0x00000002,
        ExtraWeekNumbers     = 0x00000004,
        ExtraStrikeDoneTodos = 0x00000008, // for to-dos only, strikeout completed to-dos
        ExtraConnectSubTodos = 0x00000010, // for to-dos only, connect sub-to-dos with lines
        ExtraFooter          = 0x00000020
    };
    Q_DECLARE_FLAGS(ExtraOptions, ExtraOption)

    
    void setThePrinter(QPrinter *printer);

    QPrinter *thePrinter() const;

    void setPrintCalendar(const KCalCore::Calendar::Ptr &calendar);

    KCalCore::Calendar::Ptr printCalendar() const;

    void setCalendarSystem(KCalendarSystem *calSystem);

    KCalendarSystem *calendarSystem() const;

    void setPrintStyle(const Style style);

    Style printStyle() const;

    void setInfoOptions(InfoOptions flags);

    InfoOptions infoOptions() const;

    void setTypeOptions(TypeOptions flags);

    TypeOptions typeOptions() const;

    void setRangeOptions(RangeOptions flags);

    RangeOptions rangeOptions() const;

    void setExtraOptions(ExtraOptions flags);

    ExtraOptions extraOptions() const;

protected:
    int drawHeader(QPainter &p,
                   const QRect &box,
                   const QString &title,
                   const QDate &leftMonth = QDate(),
                   const QDate &rightMonth = QDate(),
                   const bool expand = false,
                   const QColor &backColor = QColor()) const;
    void drawSubHeader(QPainter &p, const QRect &box, const QString &str) const;

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

    //TODO: make box second arg
    void drawBox(QPainter &p, const int linewidth, const QRect &box) const;

    //TODO: make box second arg
    void drawShadedBox(QPainter &p, const int linewidth,
                       const QBrush &brush, const QRect &box) const;

    //TODO: make box second arg
    void drawVerticalBox(QPainter &p,
                         const int linewidth,
                         const QRect &box,
                         const QString &str,
                         int flags = -1) const;

    //TODO: make box the second arg
    void drawItemBox(QPainter &p,
                     int linewidth,
                     const QRect &box,
                     const KCalCore::Incidence::Ptr &incidence,
                     const QString &str,
                     int flags = -1) const;

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

    void drawDayBox(QPainter &p,
                    const QRect &box,
                    const QDate &date,
                    const QTime &startTime, const QTime &endTime,
                    bool fullDate = false) const;

    void drawAgendaDayBox(QPainter &p,
                          const QRect &box,
                          const QDate &date,
                          const KCalCore::Event::List &eventList,
                          const QTime &startTime,
                          const QTime &endTime,
                          const QList<QDate> &workDays) const;

    //TODO: make QPainter the first arg
    void drawAgendaItem(PrintCellItem *item, QPainter &p,
                        const KDateTime &startPrintDate,
                        const KDateTime &endPrintDate,
                        float minlen, const QRect &box) const;

    //TODO: make box the second arg
    void drawTimeLine(QPainter &p,
                      const QTime &startTime,
                      const QTime &endTime,
                      const QRect &box) const;

    void drawTimeTable(QPainter &p, const QRect &box,
                       const QDate &startDate, const QDate &endDate,
                       const QTime &startTime, const QTime &endTime,
                       bool expandAll = false) const;

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

    int weekdayColumn(int weekday) const;

    QString cleanString(const QString &str) const;

    QString toPlainText(const QString &htmlText) const;

private:
    //TODO: move to dpointer
    void init(QPrinter *printer) const;

    void finish() const;

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

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

    void drawDayIncidence(QPainter &p, const QRect &dayBox, const QString &time,
                          const QString &summary, const QString &description,
                          int &textY, bool richDescription) const;

    QColor categoryColor(const QStringList &categories) const;

    QColor categoryBgColor(const KCalCore::Incidence::Ptr &incidence) 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;

    void drawDaysOfWeekBox(QPainter &p, const QRect &box, const QDate &date) const;

    int drawAllDayBox(QPainter &p, const QRect &box,
                      const QDate &date,
                      const KCalCore::Event::List &eventList,
                      bool expandAll = false) const;

private:
    Q_DISABLE_COPY(CalPrintBase)
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

Q_DECLARE_OPERATORS_FOR_FLAGS(CalPrintBase::InfoOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(CalPrintBase::TypeOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(CalPrintBase::RangeOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(CalPrintBase::ExtraOptions)

}

}

#if 0
public:
enum DisplayFlags {
    Text = 0x0001,
    TimeBoxes = 0x0002
};

public:
Actually do the printing.

    @param p QPainter the print result is painted to
    @param width Width of printable area
    @param height Height of printable area
    * /
    virtual void print(QPainter &p, int width, int height) = 0;
virtual void doPrint(QPrinter *printer);

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

QTime dayStart();

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

/*****************************************************************
 **               PRINTING HELPER FUNCTIONS                     **
 *****************************************************************/

public:

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);
};

}

}
#endif //if 0

#endif