ktimetracker/timekard.h

   1 /*
   2  *     Copyright (C) 2003 by Mark Bucciarelli <mark@hubcapconsutling.com>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation; either version 2 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License along
  15  *   with this program; if not, write to the
  16  *      Free Software Foundation, Inc.
  17  *      51 Franklin Street, Fifth Floor
  18  *      Boston, MA  02110-1301  USA.
  19  *
  20  */
  21
  22 #ifndef KTIMETRACKER_TIMEKARD_H
  23 #define KTIMETRACKER_TIMEKARD_H
  24
  25 #undef Color // X11 headers
  26 #undef GrayScale // X11 headers
  27
  28 #include <QList>
  29
  30 #include "reportcriteria.h"
  31
  32 class QString;
  33 class QDate;
  34
  35 class Task;
  36 class TaskView;
  37
  38 /**
  39  *  Seven consecutive days.
  40  *
  41  *  The timecard report prints out one table for each week of data.  The first
  42  *  day of the week should be read from the KControlPanel.  Currently, it is
  43  *  hardcoded to Sunday.
  44  */
  45 class Week
  46 {
  47   public:
  48     /** Need an empty constructor to use in a QValueList. */
  49     Week();
  50     explicit Week( const QDate &from );
  51     QDate start() const;
  52     QDate end() const;
  53     QList<QDate> days() const;
  54
  55     /**
  56      * Returns a list of weeks for the given date range.
  57      *
  58      * The first day of the week is picked up from the settings in the
  59      * KontrolPanel.
  60      *
  61      * The list is inclusive; for example, if you pass in a date range of two
  62      * days, one being a Sunday and the other being a Monday, you will get two
  63      * weeks back in the list.
  64      */
  65     static QList<Week> weeksFromDateRange(const QDate& from,
  66         const QDate& to);
  67
  68     /**
  69      *  Return the name of the week.
  70      *
  71      *  Uses whatever the user has set up for the long date format in
  72      *  KControlPanel, prefixed by "Week of".
  73      */
  74     QString name() const;
  75
  76
  77   private:
  78     QDate _start;
  79 };
  80
  81 /**
  82  *  Routines to output timecard data.
  83  */
  84 class TimeKard
  85 {
  86   public:
  87     /**
  88       Empty constructor
  89      */
  90     TimeKard() {}
  91
  92     /**
  93      * Generates ascii text of task totals, for current task on down.
  94      *
  95      * Formatted for pasting into clipboard.
  96      *
  97      * @param taskview The view whose tasks need to be formatted.
  98      *
  99      * @param rc Criteria which filters the task information.
 100      */
 101     QString totalsAsText(TaskView* taskview, ReportCriteria rc);
 102
 103     /**
 104      * Generates ascii text of weekly task history, for current task on down.
 105      *
 106      * Formatted for pasting into clipboard.
 107      */
 108     QString historyAsText(TaskView* taskview, const QDate& from,
 109         const QDate& to, bool justThisTask, bool perWeek, bool totalsOnly);
 110
 111 private:
 112     void printTask(Task *t, QString &s, int level, const ReportCriteria &rc);
 113
 114     void printTaskHistory(const Task *t, const QMap<QString, long>& datamap,
 115                           QMap<QString, long>& daytotals,
 116                           const QDate& from, const QDate& to,
 117                           const int level, QString& retval, bool totalsOnly);
 118
 119     QString sectionHistoryAsText(TaskView* taskview,
 120                                  const QDate& sectionFrom, const QDate& sectionTo,
 121                                  const QDate& from, const QDate& to,
 122                                  const QString& name,
 123                                  bool justThisTask, bool totalsOnly);
 124
 125   };
 126 #endif // KTIMETRACKER_TIMEKARD_H