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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
'''
Task Coach - Your friendly task manager
Copyright (C) 2004-2014 Task Coach developers <developers@taskcoach.org>
Task Coach 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 3 of the License, or
(at your option) any later version.
Task Coach 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/>.
'''
from taskcoachlib import patterns
from taskcoachlib.domain import base
from taskcoachlib.domain.attribute import font, color
class CategorizableCompositeObject(base.CompositeObject):
''' CategorizableCompositeObjects are composite objects that can be
categorized by adding them to one or more categories. Examples of
categorizable composite objects are tasks and notes. '''
def __init__(self, *args, **kwargs):
self.__categories = base.SetAttribute(kwargs.pop('categories', set()),
self,
self.addCategoryEvent,
self.removeCategoryEvent)
super(CategorizableCompositeObject, self).__init__(*args, **kwargs)
def __getstate__(self):
state = super(CategorizableCompositeObject, self).__getstate__()
state.update(dict(categories=self.categories()))
return state
@patterns.eventSource
def __setstate__(self, state, event=None):
super(CategorizableCompositeObject, self).__setstate__(state, event=event)
self.setCategories(state['categories'], event=event)
def __getcopystate__(self):
state = super(CategorizableCompositeObject, self).__getcopystate__()
state.update(dict(categories=self.categories()))
return state
def categories(self, recursive=False, upwards=False):
result = self.__categories.get()
if recursive and upwards and self.parent() is not None:
result |= self.parent().categories(recursive=True, upwards=True)
elif recursive and not upwards:
for child in self.children(recursive=True):
result |= child.categories()
return result
@classmethod
def categoryAddedEventType(class_):
return 'categorizable.category.add'
def addCategory(self, *categories, **kwargs):
return self.__categories.add(set(categories), event=kwargs.pop('event', None))
def addCategoryEvent(self, event, *categories):
event.addSource(self, *categories, **dict(type=self.categoryAddedEventType()))
for child in self.children(recursive=True):
event.addSource(child, *categories,
**dict(type=child.categoryAddedEventType()))
if self.categoriesChangeAppearance(categories):
self.appearanceChangedEvent(event)
def categoriesChangeAppearance(self, categories):
return self.categoriesChangeFgColor(categories) or \
self.categoriesChangeBgColor(categories) or \
self.categoriesChangeFont(categories) or \
self.categoriesChangeIcon(categories)
def categoriesChangeFgColor(self, categories):
return not self.foregroundColor() and any(category.foregroundColor(recursive=True) for category in categories)
def categoriesChangeBgColor(self, categories):
return not self.backgroundColor() and any(category.backgroundColor(recursive=True) for category in categories)
def categoriesChangeFont(self, categories):
return not self.font() and any(category.font(recursive=True) for category in categories)
def categoriesChangeIcon(self, categories):
return not self.icon() and any(category.icon(recursive=True) for category in categories)
@classmethod
def categoryRemovedEventType(class_):
return 'categorizable.category.remove'
def removeCategory(self, *categories, **kwargs):
return self.__categories.remove(set(categories), event=kwargs.pop('event', None))
def removeCategoryEvent(self, event, *categories):
event.addSource(self, *categories, **dict(type=self.categoryRemovedEventType()))
for child in self.children(recursive=True):
event.addSource(child, *categories,
**dict(type=child.categoryRemovedEventType()))
if self.categoriesChangeAppearance(categories):
self.appearanceChangedEvent(event)
def setCategories(self, categories, event=None):
return self.__categories.set(set(categories), event=event)
@staticmethod
def categoriesSortFunction(**kwargs):
''' Return a sort key for sorting by categories. Since a categorizable
can have multiple categories we first sort the categories by their
subjects. If the sorter is in tree mode, we also take the categories
of the children of the categorizable into account, after the
categories of the categorizable itself. If the sorter is in list
mode we also take the categories of the parent (recursively) into
account, again after the categories of the categorizable itself. '''
def sortKeyFunction(categorizable):
def sortedSubjects(items):
return sorted([item.subject(recursive=True) for item in items])
categories = categorizable.categories()
sortedCategorySubjects = sortedSubjects(categories)
isListMode = not kwargs.get('treeMode', False)
childCategories = categorizable.categories(recursive=True, upwards=isListMode) - categories
sortedCategorySubjects.extend(sortedSubjects(childCategories))
return sortedCategorySubjects
return sortKeyFunction
@classmethod
def categoriesSortEventTypes(class_):
''' The event types that influence the categories sort order. '''
return (class_.categoryAddedEventType(),
class_.categoryRemovedEventType())
def foregroundColor(self, recursive=False):
myOwnFgColor = super(CategorizableCompositeObject, self).foregroundColor()
if myOwnFgColor or not recursive:
return myOwnFgColor
categoryBasedFgColor = self._categoryForegroundColor()
if categoryBasedFgColor:
return categoryBasedFgColor
else:
return super(CategorizableCompositeObject, self).foregroundColor(recursive=True)
def backgroundColor(self, recursive=False):
myOwnBgColor = super(CategorizableCompositeObject, self).backgroundColor()
if myOwnBgColor or not recursive:
return myOwnBgColor
categoryBasedBgColor = self._categoryBackgroundColor()
if categoryBasedBgColor:
return categoryBasedBgColor
else:
return super(CategorizableCompositeObject, self).backgroundColor(recursive=True)
def _categoryForegroundColor(self):
''' If a categorizable object belongs to a category that has a
foreground color associated with it, the categorizable object is
colored accordingly. When a categorizable object belongs to
multiple categories, the color is mixed. If a categorizable
composite object has no foreground color of its own, it uses its
parent's foreground color. '''
colors = [category.foregroundColor(recursive=True) \
for category in self.categories()]
if not colors and self.parent():
return self.parent()._categoryForegroundColor()
else:
return color.ColorMixer.mix(colors)
def _categoryBackgroundColor(self):
''' If a categorizable object belongs to a category that has a
background color associated with it, the categorizable object is
colored accordingly. When a categorizable object belongs to
multiple categories, the color is mixed. If a categorizable
composite object has no background color of its own, it uses its
parent's background color. '''
colors = [category.backgroundColor(recursive=True) \
for category in self.categories()]
if not colors and self.parent():
return self.parent()._categoryBackgroundColor()
else:
return color.ColorMixer.mix(colors)
def font(self, recursive=False):
myFont = super(CategorizableCompositeObject, self).font()
if myFont or not recursive:
return myFont
categoryBasedFont = self._categoryFont()
if categoryBasedFont:
return categoryBasedFont
else:
return super(CategorizableCompositeObject, self).font(recursive=True)
def _categoryFont(self):
''' If a categorizable object belongs to a category that has a
font associated with it, the categorizable object uses that font.
When a categorizable object belongs to multiple categories, the
font is mixed. If a categorizable composite object has no font of
its own, it uses its parent's font. '''
fonts = [category.font(recursive=True) \
for category in self.categories()]
if not fonts and self.parent():
return self.parent()._categoryFont()
else:
return font.FontMixer.mix(*fonts) # pylint: disable=W0142
def icon(self, recursive=False):
icon = super(CategorizableCompositeObject, self).icon()
if not icon and recursive:
icon = self.categoryIcon() or super(CategorizableCompositeObject, self).icon(recursive=True)
return icon
def categoryIcon(self):
icon = ''
for category in self.categories():
icon = category.icon(recursive=True)
if icon:
return icon
if self.parent():
return self.parent().categoryIcon()
else:
return ''
def selectedIcon(self, recursive=False):
icon = super(CategorizableCompositeObject, self).selectedIcon()
if not icon and recursive:
icon = self.categorySelectedIcon() or super(CategorizableCompositeObject, self).selectedIcon(recursive=True)
return icon
def categorySelectedIcon(self):
icon = ''
for category in self.categories():
icon = category.selectedIcon(recursive=True)
if icon:
return icon
if self.parent():
return self.parent().categorySelectedIcon()
else:
return ''
@classmethod
def categorySubjectChangedEventType(class_):
return 'categorizable.category.subject'
def categorySubjectChangedEvent(self, event, subject):
for categorizable in [self] + self.children(recursive=True):
event.addSource(categorizable, subject,
type=categorizable.categorySubjectChangedEventType())
@classmethod
def modificationEventTypes(class_):
eventTypes = super(CategorizableCompositeObject, class_).modificationEventTypes()
return eventTypes + [class_.categoryAddedEventType(),
class_.categoryRemovedEventType()]
|
