calprintpluginbase.h

/*
    This file is part of KOrganizer.
 
    Copyright (c) 1998 Preston Brown <pbrown@kde.org>
    Copyright (c) 2003 Reinhold Kainhofer <reinhold@kainhofer.com>
 
    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 TQt, and distribute the resulting executable,
    without including the source code for TQt in the source distribution.
*/
#ifndef CALPRINTPLUGINBASE_H
#define CALPRINTPLUGINBASE_H
// #define KORG_NOPRINTER
 
#ifndef KORG_NOPRINTER
 
#include <tqdatetime.h>
#include <kprinter.h>
#include <tdemacros.h>
#include <libkcal/calendar.h>
#include <libkcal/event.h>
#include <libkcal/todo.h>
#include "korganizer/printplugin.h"
#include "korganizer/corehelper.h"
 
 
class PrintCellItem;
 
class TQWidget;
 
using namespace KCal;
 
 
#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)

class TDE_EXPORT CalPrintPluginBase : public KOrg::PrintPlugin
{
  public:
    enum DisplayFlags {
      Text=0x0001,
      TimeBoxes=0x0002
    };
 
  public:
    CalPrintPluginBase();
    virtual ~CalPrintPluginBase();

    virtual TQWidget *createConfigWidget( TQWidget * );

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

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

    void doLoadConfig();
    void doSaveConfig();

  public:
    void setKOrgCoreHelper( KOrg::CoreHelper*helper );
    bool useColors() const;
    void setUseColors( bool useColors );

    TQColor categoryBgColor( Incidence *incidence );
    TQColor textColor( const TQColor &color );
    TQTime dayStart();
    bool isWorkingDay( const TQDate &dt );
    TQString holidayString( const TQDate &dt );
    Event *holiday( const TQDate &dt );

    static int weekdayColumn( int weekday );
    void setCategoryColors( TQPainter &p, Incidence *incidence );
 
    KPrinter::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() const;
    void setCalendarSystem( const KCalendarSystem *calsys );
 
 
  /*****************************************************************
   **               PRINTING HELPER FUNCTIONS                     **
   *****************************************************************/
  public:
    static void drawBox( TQPainter &p, int linewidth, const TQRect &rect );
    static void drawShadedBox( TQPainter &p, int linewidth, const TQBrush &brush, const TQRect &rect );

    void printEventString( TQPainter &p, const TQRect &box, const TQString &str, int flags = -1 );

    void showEventBox( TQPainter &p, int linewidth, const TQRect &box, Incidence *incidence,
                       const TQString &str, int flags = -1 );

    void drawSubHeaderBox(TQPainter &p, const TQString &str, const TQRect &box );

    void drawVerticalBox( TQPainter &p, int linewidth, const TQRect &box, const TQString &str,
                          int flags=-1 );

    int drawBoxWithCaption( TQPainter &p, const TQRect &box, const TQString &caption,
                            const TQString &contents,
                            bool sameLine, bool expand, const TQFont &captionFont, const TQFont &textFont );

    int drawHeader( TQPainter &p, TQString title,
                     const TQDate &month1, const TQDate &month2,
                     const TQRect &box, bool expand = false );

    int drawFooter( TQPainter &p, TQRect &box );

    void drawSmallMonth( TQPainter &p, const TQDate &qd, const TQRect &box );

    void drawDaysOfWeek( TQPainter &p,
                         const TQDate &fromDate, const TQDate &toDate,
                         const TQRect &box );
    void drawDaysOfWeekBox( TQPainter &p, const TQDate &qd, const TQRect &box );
    void drawTimeLine( TQPainter &p,
                       const TQTime &fromTime, const TQTime &toTime,
                       const TQRect &box );

    int drawAllDayBox( TQPainter &p, Event::List &eventList,
                        const TQDate &qd, bool expandable,
                        const TQRect &box );
    void drawAgendaDayBox( TQPainter &p, Event::List &eventList,
                           const TQDate &qd, bool expandable,
                           TQTime &fromTime, TQTime &toTime,
                           const TQRect &box );
 
    void drawAgendaItem( PrintCellItem *item, TQPainter &p,
                         const TQDateTime &startPrintDate,
                         const TQDateTime &endPrintDate,
                         float minlen, const TQRect &box );

    void drawDayBox( TQPainter &p, const TQDate &qd,
                     const TQRect &box,
                     bool fullDate = false, bool printRecurDaily = true,
                     bool printRecurWeekly = true );
    void drawWeek( TQPainter &p, const TQDate &qd,
                   const TQRect &box );
    void drawTimeTable( TQPainter &p, const TQDate &fromDate, const TQDate &toDate,
                        TQTime &fromTime, TQTime &toTime,
                        const TQRect &box );

    void drawMonthTable( TQPainter &p, const TQDate &qd, bool weeknumbers,
                    bool recurDaily, bool recurWeekly,
                    const TQRect &box );
    void drawMonth( TQPainter &p, const TQDate &dt, const TQRect &box, int maxdays = -1, int subDailyFlags = TimeBoxes, int holidaysFlags = Text );

    class TodoParentStart;

    void drawTodo( int &count, Todo *todo, TQPainter &p,
                   TodoSortField sortField, 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 Todo::List &todoList, TodoParentStart *r = 0 );

    void drawJournal( Journal * journal, TQPainter &p, int x, int &y,
                      int width, int pageHeight );
    void drawJournalField( TQPainter &p, TQString field, TQString text,
                           int x, int &y, int width, int pageHeight );
 
    void drawSplitHeaderRight( TQPainter &p, const TQDate &fd, const TQDate &td,
                               const TQDate &cd, int width, int height );
 
 
  protected:
    void drawIncidence( TQPainter &p, const TQRect &dayBox, const TQString &time,
                        const TQString &summary, int &textY );
 
  protected:
    bool mUseColors;
    int mHeaderHeight;
    int mSubHeaderHeight;
    int mFooterHeight;
    int mMargin;
    int mPadding;
    int mBorder;
    const KCalendarSystem *mCalSys;
 
  public:
};
 
#endif
 
#endif