File: Task.h

package info (click to toggle)
charmtimetracker 1.12.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,340 kB
  • sloc: cpp: 19,176; xml: 284; python: 120; makefile: 14
file content (133 lines) | stat: -rw-r--r-- 3,317 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
  Task.h

  This file is part of Charm, a task-based time tracking application.

  Copyright (C) 2007-2018 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com

  Author: Mirko Boehm <mirko.boehm@kdab.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, see <http://www.gnu.org/licenses/>.
*/

#ifndef TASK_H
#define TASK_H

#include <map>

#include <QList>
#include <QString>
#include <QtDebug>
#include <QMetaType>
#include <QDomElement>
#include <QDomDocument>
#include <QDateTime>

typedef int TaskId;
Q_DECLARE_METATYPE(TaskId)

class Task;
/** A task list is a list of tasks that belong together.
    Example: All tasks for one user. */
typedef QList<Task> TaskList;
typedef QList<TaskId> TaskIdList;

/** A task is a category under which events are filed.
    It has a unique identifier and a name. */
class Task
{
public:
    Task();
    /** Convenience constructor. */
    Task(TaskId id, const QString &name, TaskId parent = 0, bool subscribed = false);

    bool isValid() const;

    bool operator ==(const Task &other) const;
    bool operator !=(const Task &other) const
    {
        return !operator==(other);
    }

    TaskId id() const;

    void setId(TaskId id);

    QString name() const;

    void setName(const QString &name);

    TaskId parent() const;

    void setParent(TaskId parent);

    bool subscribed() const;

    void setSubscribed(bool value);

    QDateTime validFrom() const;

    void setValidFrom(const QDateTime &);

    QDateTime validUntil() const;

    void setValidUntil(const QDateTime &);

    bool isCurrentlyValid() const;

    void setTrackable(bool trackable);
    bool trackable() const;

    QString comment() const;
    void setComment(const QString &comment);

    void dump() const;

    static QString tagName();
    static QString taskListTagName();

    QDomElement toXml(QDomDocument) const;

    static Task fromXml(const QDomElement &, int databaseSchemaVersion = 1);

    static TaskList readTasksElement(const QDomElement &, int databaseSchemaVersion = 1);

    static QDomElement makeTasksElement(QDomDocument, const TaskList &);

    static bool checkForUniqueTaskIds(const TaskList &tasks);

    static bool checkForTreeness(const TaskList &tasks);

    static bool lowerTaskId(const Task &left, const Task &right);

private:
    int m_id = 0;
    int m_parent = 0;
    QString m_name;
    bool m_subscribed = false;
    bool m_trackable = true;
    /** The timestamp from which the task is valid. */
    QDateTime m_validFrom;
    /** The timestamp after which the task becomes invalid. */
    QDateTime m_validUntil;
    QString m_comment;
};

Q_DECLARE_METATYPE(TaskIdList)
Q_DECLARE_METATYPE(TaskList)
Q_DECLARE_METATYPE(Task)

void dumpTaskList(const TaskList &tasks);

#endif