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
|
'''
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/>.
'''
import wx, re, sre_constants
from taskcoachlib.widgets import tooltip
from taskcoachlib.i18n import _
class SearchCtrl(tooltip.ToolTipMixin, wx.SearchCtrl):
def __init__(self, *args, **kwargs):
self.__callback = kwargs.pop('callback')
self.__matchCase = kwargs.pop('matchCase', False)
self.__includeSubItems = kwargs.pop('includeSubItems', False)
self.__searchDescription = kwargs.pop('searchDescription', False)
self.__regularExpression = kwargs.pop('regularExpression', False)
self.__bitmapSize = kwargs.pop('size', (16, 16))
value = kwargs.pop('value', u'')
super(SearchCtrl, self).__init__(*args, **kwargs)
self.SetSearchMenuBitmap(self.getBitmap('magnifier_glass_dropdown_icon'))
self.SetSearchBitmap(self.getBitmap('magnifier_glass_icon'))
self.SetCancelBitmap(self.getBitmap('cross_red_icon'))
self.__timer = wx.Timer(self)
self.__recentSearches = []
self.__maxRecentSearches = 5
self.__tooltip = tooltip.SimpleToolTip(self)
self.createMenu()
self.bindEventHandlers()
self.SetValue(value)
def GetMainWindow(self):
return self
def getTextCtrl(self):
textCtrl = [child for child in self.GetChildren() if isinstance(child, wx.TextCtrl)]
return textCtrl[0] if textCtrl else self
def getBitmap(self, bitmap):
return wx.ArtProvider_GetBitmap(bitmap, wx.ART_TOOLBAR,
self.__bitmapSize)
def createMenu(self):
# pylint: disable=W0201
menu = wx.Menu()
self.__matchCaseMenuItem = menu.AppendCheckItem(wx.ID_ANY,
_('&Match case'), _('Match case when filtering'))
self.__matchCaseMenuItem.Check(self.__matchCase)
self.__includeSubItemsMenuItem = menu.AppendCheckItem(wx.ID_ANY,
_('&Include sub items'),
_('Include sub items of matching items in the search results'))
self.__includeSubItemsMenuItem.Check(self.__includeSubItems)
self.__searchDescriptionMenuItem = menu.AppendCheckItem(wx.ID_ANY,
_('&Search description too'),
_('Search both subject and description'))
self.__searchDescriptionMenuItem.Check(self.__searchDescription)
self.__regularExpressionMenuItem = menu.AppendCheckItem(wx.ID_ANY,
_('&Regular Expression'),
_('Consider search text as a regular expression'))
self.__regularExpressionMenuItem.Check(self.__regularExpression)
self.SetMenu(menu)
def PopupMenu(self): # pylint: disable=W0221
rect = self.GetClientRect()
x, y = rect[0], rect[1] + rect[3] + 3
self.PopupMenuXY(self.GetMenu(), x, y)
def bindEventHandlers(self):
# pylint: disable=W0142,W0612,W0201
for args in [(wx.EVT_TIMER, self.onFind, self.__timer),
(wx.EVT_TEXT_ENTER, self.onFind),
(wx.EVT_TEXT, self.onFindLater),
(wx.EVT_SEARCHCTRL_CANCEL_BTN, self.onCancel),
(wx.EVT_MENU, self.onMatchCaseMenuItem,
self.__matchCaseMenuItem),
(wx.EVT_MENU, self.onIncludeSubItemsMenuItem,
self.__includeSubItemsMenuItem),
(wx.EVT_MENU, self.onSearchDescriptionMenuItem,
self.__searchDescriptionMenuItem),
(wx.EVT_MENU, self.onRegularExpressionMenuItem,
self.__regularExpressionMenuItem)]:
self.Bind(*args)
# Precreate menu item ids for the recent searches and bind the event
# handler for those menu item ids. It's no problem that the actual menu
# items don't exist yet.
self.__recentSearchMenuItemIds = \
[wx.NewId() for dummy in range(self.__maxRecentSearches)]
self.Bind(wx.EVT_MENU_RANGE, self.onRecentSearchMenuItem,
id=self.__recentSearchMenuItemIds[0],
id2=self.__recentSearchMenuItemIds[-1])
def setMatchCase(self, matchCase):
self.__matchCase = matchCase
self.__matchCaseMenuItem.Check(matchCase)
def setIncludeSubItems(self, includeSubItems):
self.__includeSubItems = includeSubItems
self.__includeSubItemsMenuItem.Check(includeSubItems)
def setSearchDescription(self, searchDescription):
self.__searchDescription = searchDescription
self.__searchDescriptionMenuItem.Check(searchDescription)
def setRegularExpression(self, regularExpression):
self.__regularExpression = regularExpression
self.__regularExpressionMenuItem.Check(regularExpression)
def isValid(self):
if self.__regularExpression:
try:
re.compile(self.GetValue())
except sre_constants.error:
return False
return True
def onFindLater(self, event): # pylint: disable=W0613
# Start the timer so that the actual filtering will be done
# only when the user pauses typing (at least 0.5 second)
self.__timer.Start(500, oneShot=True)
def onFind(self, event): # pylint: disable=W0613
if self.__timer.IsRunning():
self.__timer.Stop()
if not self.IsEnabled():
return
if not self.isValid():
self.__tooltip.SetData([(None,
[_('This is an invalid regular expression.'),
_('Defaulting to substring search.')])])
x, y = self.GetParent().ClientToScreenXY(*self.GetPosition())
height = self.GetClientSizeTuple()[1]
self.DoShowTip(x + 3, y + height + 4, self.__tooltip)
else:
self.HideTip()
searchString = self.GetValue()
if searchString:
self.rememberSearchString(searchString)
self.ShowCancelButton(bool(searchString))
self.__callback(searchString, self.__matchCase, self.__includeSubItems,
self.__searchDescription, self.__regularExpression)
def onCancel(self, event):
self.SetValue('')
self.onFind(event)
event.Skip()
def onMatchCaseMenuItem(self, event):
self.__matchCase = self._isMenuItemChecked(event)
self.onFind(event)
# XXXFIXME: when skipping on OS X, we receive several events with different
# IsChecked(), the last one being False. I can't reproduce this in a unit
# test. Not skipping the event doesn't harm on other platforms (tested by
# hand)
def onIncludeSubItemsMenuItem(self, event):
self.__includeSubItems = self._isMenuItemChecked(event)
self.onFind(event)
def onSearchDescriptionMenuItem(self, event):
self.__searchDescription = self._isMenuItemChecked(event)
self.onFind(event)
def onRegularExpressionMenuItem(self, event):
self.__regularExpression = self._isMenuItemChecked(event)
self.onFind(event)
def onRecentSearchMenuItem(self, event):
self.SetValue(self.__recentSearches[event.GetId()-self.__recentSearchMenuItemIds[0]])
self.onFind(event)
# Don't call event.Skip(). It will result in this event handler being
# called again with the next menu item since wxPython thinks the
# event has not been dealt with (on Mac OS X at least).
def rememberSearchString(self, searchString):
if searchString in self.__recentSearches:
self.__recentSearches.remove(searchString)
self.__recentSearches.insert(0, searchString)
if len(self.__recentSearches) > self.__maxRecentSearches:
self.__recentSearches.pop()
self.updateRecentSearches()
def updateRecentSearches(self):
menu = self.GetMenu()
self.removeRecentSearches(menu)
self.addRecentSearches(menu)
def removeRecentSearches(self, menu):
while menu.GetMenuItemCount() > 4:
item = menu.FindItemByPosition(4)
menu.DestroyItem(item)
def addRecentSearches(self, menu):
menu.AppendSeparator()
item = menu.Append(wx.ID_ANY, _('Recent searches'))
item.Enable(False)
for index, searchString in enumerate(self.__recentSearches):
menu.Append(self.__recentSearchMenuItemIds[index], searchString)
def Enable(self, enable=True): # pylint: disable=W0221
''' When wx.SearchCtrl is disabled it doesn't grey out the buttons,
so we remove those. '''
self.SetValue('' if enable else _('Viewer not searchable'))
super(SearchCtrl, self).Enable(enable)
self.ShowCancelButton(enable and bool(self.GetValue()))
self.ShowSearchButton(enable)
def _isMenuItemChecked(self, event):
# There's a bug in wxPython 2.8.3 on Windows XP that causes
# event.IsChecked() to return the wrong value in the context menu.
# The menu on the main window works fine. So we first try to access the
# context menu to get the checked state from the menu item itself.
# This will fail if the event is coming from the window, but in that
# case we can event.IsChecked() expect to work so we use that.
try:
return event.GetEventObject().FindItemById(event.GetId()).IsChecked()
except AttributeError:
return event.IsChecked()
def OnBeforeShowToolTip(self, x, y):
return None
|
