32 |
32 |
33 #------------------------------------------------------------------------------- |
33 #------------------------------------------------------------------------------- |
34 # Library Panel |
34 # Library Panel |
35 #------------------------------------------------------------------------------- |
35 #------------------------------------------------------------------------------- |
36 |
36 |
|
37 """ |
|
38 Class that implements a panel displaying a tree containing an hierarchical list |
|
39 of functions and function blocks available in project an a search control for |
|
40 quickly find one functions or function blocks in this list and a text control |
|
41 displaying informations about selected functions or function blocks |
|
42 """ |
|
43 |
37 class LibraryPanel(wx.Panel): |
44 class LibraryPanel(wx.Panel): |
38 |
45 |
39 def __init__(self, parent, enable_drag=False): |
46 def __init__(self, parent, enable_drag=False): |
|
47 """ |
|
48 Constructor |
|
49 @param parent: Parent wx.Window of LibraryPanel |
|
50 @param enable_drag: Flag indicating that function or function block can |
|
51 be drag'n drop from LibraryPanel (default: False) |
|
52 """ |
40 wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL) |
53 wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL) |
41 |
54 |
|
55 # Define LibraryPanel main sizer |
42 main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0) |
56 main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0) |
43 main_sizer.AddGrowableCol(0) |
57 main_sizer.AddGrowableCol(0) |
44 main_sizer.AddGrowableRow(1) |
58 main_sizer.AddGrowableRow(1) |
45 |
59 |
|
60 # Add SearchCtrl to main sizer |
46 self.SearchCtrl = wx.SearchCtrl(self) |
61 self.SearchCtrl = wx.SearchCtrl(self) |
|
62 # Add a button with a magnifying glass, essentially to show that this |
|
63 # control is for searching in tree |
47 self.SearchCtrl.ShowSearchButton(True) |
64 self.SearchCtrl.ShowSearchButton(True) |
48 self.Bind(wx.EVT_TEXT, self.OnSearchCtrlChanged, self.SearchCtrl) |
65 self.Bind(wx.EVT_TEXT, self.OnSearchCtrlChanged, self.SearchCtrl) |
49 self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN, |
66 self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN, |
50 self.OnSearchButtonClick, self.SearchCtrl) |
67 self.OnSearchButtonClick, self.SearchCtrl) |
|
68 # Bind keyboard event on SearchCtrl text control to catch UP and DOWN |
|
69 # for search previous and next occurrence |
51 search_textctrl = self.SearchCtrl.GetChildren()[0] |
70 search_textctrl = self.SearchCtrl.GetChildren()[0] |
52 search_textctrl.Bind(wx.EVT_CHAR, self.OnKeyDown) |
71 search_textctrl.Bind(wx.EVT_CHAR, self.OnKeyDown) |
53 main_sizer.AddWindow(self.SearchCtrl, flag=wx.GROW) |
72 main_sizer.AddWindow(self.SearchCtrl, flag=wx.GROW) |
54 |
73 |
|
74 # Add Splitter window for tree and block comment to main sizer |
55 splitter_window = wx.SplitterWindow(self) |
75 splitter_window = wx.SplitterWindow(self) |
56 splitter_window.SetSashGravity(1.0) |
76 splitter_window.SetSashGravity(1.0) |
57 main_sizer.AddWindow(splitter_window, flag=wx.GROW) |
77 main_sizer.AddWindow(splitter_window, flag=wx.GROW) |
58 |
78 |
|
79 # Add TreeCtrl for functions and function blocks library in splitter |
|
80 # window |
59 self.Tree = wx.TreeCtrl(splitter_window, |
81 self.Tree = wx.TreeCtrl(splitter_window, |
60 size=wx.Size(0, 0), |
82 size=wx.Size(0, 0), |
61 style=wx.TR_HAS_BUTTONS| |
83 style=wx.TR_HAS_BUTTONS| |
62 wx.TR_SINGLE| |
84 wx.TR_SINGLE| |
63 wx.SUNKEN_BORDER| |
85 wx.SUNKEN_BORDER| |
64 wx.TR_HIDE_ROOT| |
86 wx.TR_HIDE_ROOT| |
65 wx.TR_LINES_AT_ROOT) |
87 wx.TR_LINES_AT_ROOT) |
66 self.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeItemSelected, self.Tree) |
88 self.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeItemSelected, self.Tree) |
67 self.Tree.Bind(wx.EVT_CHAR, self.OnKeyDown) |
89 self.Tree.Bind(wx.EVT_CHAR, self.OnKeyDown) |
|
90 # If drag'n drop is enabled, bind event generated when a drag begins on |
|
91 # tree to start a drag'n drop |
68 if enable_drag: |
92 if enable_drag: |
69 self.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag, self.Tree) |
93 self.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag, self.Tree) |
70 |
94 |
|
95 # Add TextCtrl for function and function block informations |
71 self.Comment = wx.TextCtrl(splitter_window, size=wx.Size(0, 80), |
96 self.Comment = wx.TextCtrl(splitter_window, size=wx.Size(0, 80), |
72 style=wx.TE_READONLY|wx.TE_MULTILINE) |
97 style=wx.TE_READONLY|wx.TE_MULTILINE) |
73 |
98 |
74 splitter_window.SplitHorizontally(self.Tree, self.Comment, -80) |
99 splitter_window.SplitHorizontally(self.Tree, self.Comment, -80) |
75 |
100 |
76 self.SetSizer(main_sizer) |
101 self.SetSizer(main_sizer) |
77 |
102 |
|
103 # Reference to the project controller |
78 self.Controller = None |
104 self.Controller = None |
79 |
105 |
|
106 # Variable storing functions and function blocks library to display |
80 self.BlockList = None |
107 self.BlockList = None |
81 |
108 |
82 def __del__(self): |
109 def __del__(self): |
|
110 """ |
|
111 Destructor |
|
112 """ |
|
113 # Remove reference to project controller |
83 self.Controller = None |
114 self.Controller = None |
84 |
115 |
85 def SetController(self, controller): |
116 def SetController(self, controller): |
|
117 """ |
|
118 Set reference to project controller |
|
119 @param controller: Reference to project controller |
|
120 """ |
86 self.Controller = controller |
121 self.Controller = controller |
87 |
122 |
88 def SetBlockList(self, blocklist): |
123 def SetBlockList(self, blocklist): |
|
124 """ |
|
125 Set function and function block library to display in TreeCtrl |
|
126 @param blocklist: Function and function block library |
|
127 """ |
|
128 # Save functions and function blocks library |
89 self.BlockList = blocklist |
129 self.BlockList = blocklist |
|
130 # Refresh TreeCtrl values |
90 self.RefreshTree() |
131 self.RefreshTree() |
91 |
132 |
92 def SetFocus(self): |
133 def SetFocus(self): |
|
134 """ |
|
135 Called to give focus to LibraryPanel |
|
136 Override wx.Window SetFocus method |
|
137 """ |
|
138 # Give focus to SearchCtrl |
93 self.SearchCtrl.SetFocus() |
139 self.SearchCtrl.SetFocus() |
94 |
140 |
95 def ResetTree(self): |
141 def ResetTree(self): |
|
142 """ |
|
143 Reset LibraryPanel values displayed in controls |
|
144 """ |
|
145 # Clear SearchCtrl, TreeCtrl and TextCtrl |
96 self.SearchCtrl.SetValue("") |
146 self.SearchCtrl.SetValue("") |
97 self.Tree.DeleteAllItems() |
147 self.Tree.DeleteAllItems() |
98 self.Comment.SetValue("") |
148 self.Comment.SetValue("") |
99 |
149 |
100 def RefreshTree(self): |
150 def RefreshTree(self): |
101 if self.Controller is not None: |
151 """ |
102 to_delete = [] |
152 Refresh LibraryPanel values displayed in controls |
103 selected_name = None |
153 """ |
104 selected = self.Tree.GetSelection() |
154 # Get function and function blocks library |
105 if selected.IsOk(): |
155 blocktypes = self.BlockList |
106 selected_pydata = self.Tree.GetPyData(selected) |
156 if blocktypes is None and self.Controller is not None: |
107 if selected_pydata is not None and selected_pydata["type"] != CATEGORY: |
157 # Get library from project controller if not defined |
108 selected_name = self.Tree.GetItemText(selected) |
158 blocktypes = self.Controller.GetBlockTypes() |
109 if self.BlockList is not None: |
159 |
110 blocktypes = self.BlockList |
160 # Refresh TreeCtrl values if a library is defined |
111 else: |
161 if blocktypes is not None: |
112 blocktypes = self.Controller.GetBlockTypes() |
162 # List that will contain tree items to be deleted when TreeCtrl |
|
163 # will be refreshed |
|
164 items_to_delete = [] |
|
165 |
|
166 # Get current selected item for selected it when values refreshed |
|
167 selected_item = self.Tree.GetSelection() |
|
168 selected_pydata = (self.Tree.GetPyData(selected_item) |
|
169 if selected_item.IsOk() and |
|
170 selected_item != self.Tree.GetRootItem() |
|
171 else None) |
|
172 # Don't save selected item if it is a category |
|
173 selected_infos = ((self.Tree.GetItemText(selected_item), |
|
174 selected_pydata["inputs"]) |
|
175 if selected_pydata is not None and |
|
176 selected_pydata["type"] == BLOCK |
|
177 else (None, None)) |
|
178 |
|
179 # Get TreeCtrl root item (hidden) |
113 root = self.Tree.GetRootItem() |
180 root = self.Tree.GetRootItem() |
114 if not root.IsOk(): |
181 if not root.IsOk(): |
|
182 # Create root if not present |
115 root = self.Tree.AddRoot("") |
183 root = self.Tree.AddRoot("") |
|
184 |
|
185 # Iterate over functions and function blocks library categories and |
|
186 # add a tree item to root item for each of them |
|
187 |
|
188 # Get first child under root item |
116 category_item, root_cookie = self.Tree.GetFirstChild(root) |
189 category_item, root_cookie = self.Tree.GetFirstChild(root) |
117 for category in blocktypes: |
190 for category in blocktypes: |
|
191 # Store category name in a local variable to prevent script |
|
192 # extracting translated strings for gettext to consider "name" |
|
193 # to be translated |
118 category_name = category["name"] |
194 category_name = category["name"] |
119 if not category_item.IsOk(): |
195 |
|
196 # Tree item already exists, set item label |
|
197 if category_item.IsOk(): |
|
198 self.Tree.SetItemText(category_item, _(category_name)) |
|
199 |
|
200 # Tree item doesn't exist, add new one to root |
|
201 else: |
120 category_item = self.Tree.AppendItem(root, _(category_name)) |
202 category_item = self.Tree.AppendItem(root, _(category_name)) |
|
203 # On Windows, needs to get next child of root to have a |
|
204 # reference to the newly added tree item |
121 if wx.Platform != '__WXMSW__': |
205 if wx.Platform != '__WXMSW__': |
122 category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie) |
206 category_item, root_cookie = \ |
123 else: |
207 self.Tree.GetNextChild(root, root_cookie) |
124 self.Tree.SetItemText(category_item, _(category_name)) |
208 |
|
209 # Set data associated to tree item (only save that item is a |
|
210 # category) |
125 self.Tree.SetPyData(category_item, {"type" : CATEGORY}) |
211 self.Tree.SetPyData(category_item, {"type" : CATEGORY}) |
126 blocktype_item, category_cookie = self.Tree.GetFirstChild(category_item) |
212 |
|
213 # Iterate over functions and function blocks defined in library |
|
214 # category add a tree item to category tree item for each of |
|
215 # them |
|
216 |
|
217 # Get first child under category tree item |
|
218 blocktype_item, category_cookie = \ |
|
219 self.Tree.GetFirstChild(category_item) |
127 for blocktype in category["list"]: |
220 for blocktype in category["list"]: |
128 if not blocktype_item.IsOk(): |
221 |
129 blocktype_item = self.Tree.AppendItem(category_item, blocktype["name"]) |
222 # Tree item already exists, set item label |
|
223 if blocktype_item.IsOk(): |
|
224 self.Tree.SetItemText(blocktype_item, blocktype["name"]) |
|
225 |
|
226 # Tree item doesn't exist, add new one to category item |
|
227 else: |
|
228 blocktype_item = self.Tree.AppendItem( |
|
229 category_item, blocktype["name"]) |
|
230 # See comment when adding category |
130 if wx.Platform != '__WXMSW__': |
231 if wx.Platform != '__WXMSW__': |
131 blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie) |
232 blocktype_item, category_cookie = \ |
132 else: |
233 self.Tree.GetNextChild(category_item, |
133 self.Tree.SetItemText(blocktype_item, blocktype["name"]) |
234 category_cookie) |
|
235 |
|
236 # Define data to associate to block tree item |
|
237 comment = blocktype["comment"] |
134 block_data = {"type" : BLOCK, |
238 block_data = {"type" : BLOCK, |
135 "block_type" : blocktype["type"], |
239 "block_type" : blocktype["type"], |
136 "inputs" : tuple([type for name, type, modifier in blocktype["inputs"]]), |
240 "inputs" : tuple([type |
137 "extension" : None} |
241 for name, type, modifier |
138 if blocktype["extensible"]: |
242 in blocktype["inputs"]]), |
139 block_data["extension"] = len(blocktype["inputs"]) |
243 "extension" : (len(blocktype["inputs"]) |
|
244 if blocktype["extensible"] |
|
245 else None), |
|
246 "comment": _(comment) + |
|
247 blocktype.get("usage", "")} |
140 self.Tree.SetPyData(blocktype_item, block_data) |
248 self.Tree.SetPyData(blocktype_item, block_data) |
141 if selected_name == blocktype["name"]: |
249 |
|
250 # Select block tree item in tree if it corresponds to |
|
251 # previously selected one |
|
252 if selected_infos == (blocktype["name"], |
|
253 blocktype["inputs"]): |
142 self.Tree.SelectItem(blocktype_item) |
254 self.Tree.SelectItem(blocktype_item) |
143 comment = blocktype["comment"] |
255 |
144 self.Comment.SetValue(_(comment) + blocktype.get("usage", "")) |
256 # Update TextCtrl value |
145 blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie) |
257 self.Comment.SetValue(block_data["comment"]) |
|
258 |
|
259 # Get next block tree item under category tree item |
|
260 blocktype_item, category_cookie = \ |
|
261 self.Tree.GetNextChild(category_item, category_cookie) |
|
262 |
|
263 # Add every remaining tree item under category tree item after |
|
264 # updating all block items to the list of items to delete |
146 while blocktype_item.IsOk(): |
265 while blocktype_item.IsOk(): |
147 to_delete.append(blocktype_item) |
266 items_to_delete.append(blocktype_item) |
148 blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie) |
267 blocktype_item, category_cookie = \ |
149 category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie) |
268 self.Tree.GetNextChild(category_item, category_cookie) |
|
269 |
|
270 # Get next category tree item under root item |
|
271 category_item, root_cookie = \ |
|
272 self.Tree.GetNextChild(root, root_cookie) |
|
273 |
|
274 # Add every remaining tree item under root item after updating all |
|
275 # category items to the list of items to delete |
150 while category_item.IsOk(): |
276 while category_item.IsOk(): |
151 to_delete.append(category_item) |
277 items_to_delete.append(category_item) |
152 category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie) |
278 category_item, root_cookie = \ |
153 for item in to_delete: |
279 self.Tree.GetNextChild(root, root_cookie) |
|
280 |
|
281 # Remove all items in list of items to delete from TreeCtrl |
|
282 for item in items_to_delete: |
154 self.Tree.Delete(item) |
283 self.Tree.Delete(item) |
155 |
284 |
156 def GetSelectedBlock(self): |
285 def GetSelectedBlock(self): |
157 selected = self.Tree.GetSelection() |
286 """ |
158 if (selected.IsOk() and |
287 Get selected block informations |
159 self.Tree.GetItemParent(selected) != self.Tree.GetRootItem() and |
288 @return: {"type": block_type_name, "inputs": [input_type,...]} or None |
160 selected != self.Tree.GetRootItem()): |
289 if no block selected |
161 selected_data = self.Tree.GetPyData(selected) |
290 """ |
162 return {"type": self.Tree.GetItemText(selected), |
291 # Get selected item associated data in tree |
163 "inputs": selected_data["inputs"]} |
292 selected_item = self.Tree.GetSelection() |
164 return None |
293 selected_pydata = (self.Tree.GetPyData(selected_item) |
|
294 if selected_item.IsOk() and |
|
295 selected_item != self.Tree.GetRootItem() |
|
296 else None) |
|
297 |
|
298 # Return value is None if selected tree item is root or a category |
|
299 return ({"type": self.Tree.GetItemText(selected_item), |
|
300 "inputs": selected_pydata["inputs"]} |
|
301 if selected_pydata is not None and |
|
302 selected_pydata["type"] == BLOCK |
|
303 else None) |
165 |
304 |
166 def SelectTreeItem(self, name, inputs): |
305 def SelectTreeItem(self, name, inputs): |
|
306 """ |
|
307 Select Tree item corresponding to block informations given |
|
308 @param name: Block type name |
|
309 @param inputs: List of block inputs type [input_type,...] |
|
310 """ |
|
311 # Find tree item corresponding to block informations |
167 item = self.FindTreeItem(self.Tree.GetRootItem(), name, inputs) |
312 item = self.FindTreeItem(self.Tree.GetRootItem(), name, inputs) |
168 if item is not None and item.IsOk(): |
313 if item is not None and item.IsOk(): |
|
314 # Select tree item found |
169 self.Tree.SelectItem(item) |
315 self.Tree.SelectItem(item) |
170 self.Tree.EnsureVisible(item) |
316 self.Tree.EnsureVisible(item) |
171 |
317 |
172 def FindTreeItem(self, root, name, inputs = None): |
318 def FindTreeItem(self, item, name, inputs = None): |
173 if root.IsOk(): |
319 """ |
174 pydata = self.Tree.GetPyData(root) |
320 Find Tree item corresponding to block informations given |
175 if pydata is not None: |
321 Function is recursive |
176 type_inputs = pydata.get("inputs", None) |
322 @param item: Item to test |
177 type_extension = pydata.get("extension", None) |
323 @param name: Block type name |
178 if inputs is not None and type_inputs is not None: |
324 @param inputs: List of block inputs type [input_type,...] |
179 if type_extension is not None: |
325 """ |
180 same_inputs = type_inputs == inputs[:type_extension] |
326 # Return immediately if item isn't valid |
181 else: |
327 if not item.IsOk(): |
182 same_inputs = type_inputs == inputs |
328 return None |
183 else: |
329 |
184 same_inputs = True |
330 # Get data associated to item to test |
185 if pydata is not None and self.Tree.GetItemText(root) == name and same_inputs: |
331 item_pydata = self.Tree.GetPyData(item) |
186 return root |
332 if item_pydata is not None and item_pydata["type"] == BLOCK: |
|
333 # Only test item corresponding to block |
|
334 |
|
335 # Test if block inputs type are the same than those given |
|
336 type_inputs = item_pydata.get("inputs", None) |
|
337 type_extension = item_pydata.get("extension", None) |
|
338 if inputs is not None and type_inputs is not None: |
|
339 same_inputs = reduce( |
|
340 lambda x, y: x and y, |
|
341 map( |
|
342 lambda x: x[0]==x[1] or x[0]=='ANY' or x[1]=='ANY', |
|
343 zip(type_inputs, |
|
344 (inputs[:type_extension] |
|
345 if type_extension is not None |
|
346 else inputs))), |
|
347 True) |
187 else: |
348 else: |
188 item, root_cookie = self.Tree.GetFirstChild(root) |
349 same_inputs = True |
189 while item.IsOk(): |
350 |
190 result = self.FindTreeItem(item, name, inputs) |
351 # Return item if block data corresponds to informations given |
191 if result: |
352 if self.Tree.GetItemText(item) == name and same_inputs: |
192 return result |
353 return item |
193 item, root_cookie = self.Tree.GetNextChild(root, root_cookie) |
354 |
|
355 # Test item children if item doesn't correspond |
|
356 child, child_cookie = self.Tree.GetFirstChild(item) |
|
357 while child.IsOk(): |
|
358 result = self.FindTreeItem(child, name, inputs) |
|
359 if result: |
|
360 return result |
|
361 child, child_cookie = self.Tree.GetNextChild(item, child_cookie) |
|
362 |
194 return None |
363 return None |
195 |
364 |
196 def SearchInTree(self, value, mode="first"): |
365 def SearchInTree(self, value, mode="first"): |
|
366 """ |
|
367 Search in Tree and select item that name contains string given |
|
368 @param value: String contained in block name to find |
|
369 @param mode: Search mode ('first', 'previous' or 'next') |
|
370 (default: 'first') |
|
371 @return: True if an item was found |
|
372 """ |
|
373 # Return immediately if root isn't valid |
197 root = self.Tree.GetRootItem() |
374 root = self.Tree.GetRootItem() |
198 if not root.IsOk(): |
375 if not root.IsOk(): |
199 return False |
376 return False |
200 |
377 |
201 if mode == "first": |
378 # Set function to navigate in Tree item sibling according to search |
|
379 # mode defined |
|
380 sibling_function = (self.Tree.GetPrevSibling |
|
381 if mode == "previous" |
|
382 else self.Tree.GetNextSibling) |
|
383 |
|
384 # Get current selected item (for next and previous mode) |
|
385 item = self.Tree.GetSelection() |
|
386 if not item.IsOk() or mode == "first": |
202 item, item_cookie = self.Tree.GetFirstChild(root) |
387 item, item_cookie = self.Tree.GetFirstChild(root) |
203 selected = None |
388 selected = None |
204 else: |
389 else: |
205 item = self.Tree.GetSelection() |
|
206 selected = item |
390 selected = item |
207 if not item.IsOk(): |
391 |
208 item, item_cookie = self.Tree.GetFirstChild(root) |
392 # Navigate through tree items until one matching found or reach tree |
|
393 # starting or ending |
209 while item.IsOk(): |
394 while item.IsOk(): |
|
395 |
|
396 # Get item data to get item type |
210 item_pydata = self.Tree.GetPyData(item) |
397 item_pydata = self.Tree.GetPyData(item) |
|
398 |
|
399 # Item is a block category |
211 if item_pydata["type"] == CATEGORY: |
400 if item_pydata["type"] == CATEGORY: |
212 if mode == "previous": |
401 |
213 child = self.Tree.GetLastChild(item) |
402 # Get category first or last child according to search mode |
214 else: |
403 # defined |
215 child, child_cookie = self.Tree.GetFirstChild(item) |
404 child = (self.Tree.GetLastChild(item) |
216 if child.IsOk(): |
405 if mode == "previous" |
217 item = child |
406 else self.Tree.GetFirstChild(item)[0]) |
218 elif mode == "previous": |
407 |
219 item = self.Tree.GetPrevSibling(item) |
408 # If category has no child, go to sibling category |
220 else: |
409 item = (child if child.IsOk() else sibling_function(item)) |
221 item = self.Tree.GetNextSibling(item) |
410 |
|
411 # Item is a block |
222 else: |
412 else: |
|
413 |
|
414 # Extract item block name |
223 name = self.Tree.GetItemText(item) |
415 name = self.Tree.GetItemText(item) |
|
416 # Test if block name contains string given |
224 if name.upper().find(value.upper()) != -1 and item != selected: |
417 if name.upper().find(value.upper()) != -1 and item != selected: |
225 child, child_cookie = self.Tree.GetFirstChild(root) |
418 # Select block and collapse all categories other than block |
226 while child.IsOk(): |
419 # category |
227 self.Tree.CollapseAllChildren(child) |
420 self.Tree.CollapseAllChildren(root) |
228 child, child_cookie = self.Tree.GetNextChild(root, child_cookie) |
|
229 self.Tree.SelectItem(item) |
421 self.Tree.SelectItem(item) |
230 self.Tree.EnsureVisible(item) |
422 self.Tree.EnsureVisible(item) |
231 return True |
423 return True |
232 |
424 |
233 elif mode == "previous": |
425 # Go to next item sibling if block not found |
234 previous = self.Tree.GetPrevSibling(item) |
426 next = sibling_function(item) |
235 if previous.IsOk(): |
427 |
236 item = previous |
428 # If category has no other child, go to next category sibling |
237 else: |
429 item = (next |
238 parent = self.Tree.GetItemParent(item) |
430 if next.IsOk() |
239 item = self.Tree.GetPrevSibling(parent) |
431 else sibling_function(self.Tree.GetItemParent(item))) |
240 |
432 |
241 else: |
|
242 next = self.Tree.GetNextSibling(item) |
|
243 if next.IsOk(): |
|
244 item = next |
|
245 else: |
|
246 parent = self.Tree.GetItemParent(item) |
|
247 item = self.Tree.GetNextSibling(parent) |
|
248 return False |
433 return False |
249 |
434 |
250 def OnSearchCtrlChanged(self, event): |
435 def OnSearchCtrlChanged(self, event): |
|
436 """ |
|
437 Called when SearchCtrl text control value changed |
|
438 @param event: TextCtrl change event |
|
439 """ |
|
440 # Search for block containing SearchCtrl value in 'first' mode |
251 self.SearchInTree(self.SearchCtrl.GetValue()) |
441 self.SearchInTree(self.SearchCtrl.GetValue()) |
252 event.Skip() |
442 event.Skip() |
253 |
443 |
254 def OnSearchButtonClick(self, event): |
444 def OnSearchButtonClick(self, event): |
|
445 """ |
|
446 Called when SearchCtrl search button was clicked |
|
447 @param event: Button clicked event |
|
448 """ |
|
449 # Search for block containing SearchCtrl value in 'next' mode |
255 self.SearchInTree(self.SearchCtrl.GetValue(), "next") |
450 self.SearchInTree(self.SearchCtrl.GetValue(), "next") |
256 event.Skip() |
451 event.Skip() |
257 |
452 |
258 def OnTreeItemSelected(self, event): |
453 def OnTreeItemSelected(self, event): |
259 selected = event.GetItem() |
454 """ |
260 pydata = self.Tree.GetPyData(selected) |
455 Called when tree item is selected |
261 if pydata is not None and pydata["type"] != CATEGORY: |
456 @param event: wx.TreeEvent |
262 blocktype = self.Controller.GetBlockType(self.Tree.GetItemText(selected), pydata["inputs"]) |
457 """ |
263 if blocktype: |
458 # Update TextCtrl value with block selected usage |
264 comment = blocktype["comment"] |
459 item_pydata = self.Tree.GetPyData(event.GetItem()) |
265 self.Comment.SetValue(_(comment) + blocktype.get("usage", "")) |
460 self.Comment.SetValue( |
266 else: |
461 item_pydata["comment"] |
267 self.Comment.SetValue("") |
462 if item_pydata is not None and item_pydata["type"] == BLOCK |
268 else: |
463 else "") |
269 self.Comment.SetValue("") |
464 |
|
465 # Call extra function defined when tree item is selected |
270 if getattr(self, "_OnTreeItemSelected", None) is not None: |
466 if getattr(self, "_OnTreeItemSelected", None) is not None: |
271 self._OnTreeItemSelected(event) |
467 self._OnTreeItemSelected(event) |
|
468 |
272 event.Skip() |
469 event.Skip() |
273 |
470 |
274 def OnTreeBeginDrag(self, event): |
471 def OnTreeBeginDrag(self, event): |
275 selected = event.GetItem() |
472 """ |
276 pydata = self.Tree.GetPyData(selected) |
473 Called when a drag is started in tree |
277 if pydata is not None and pydata["type"] == BLOCK: |
474 @param event: wx.TreeEvent |
278 data = wx.TextDataObject(str((self.Tree.GetItemText(selected), |
475 """ |
279 pydata["block_type"], "", pydata["inputs"]))) |
476 selected_item = event.GetItem() |
|
477 item_pydata = self.Tree.GetPyData(selected_item) |
|
478 |
|
479 # Item dragged is a block |
|
480 if item_pydata is not None and item_pydata["type"] == BLOCK: |
|
481 # Start a drag'n drop |
|
482 data = wx.TextDataObject(str( |
|
483 (self.Tree.GetItemText(selected_item), |
|
484 item_pydata["block_type"], |
|
485 "", |
|
486 item_pydata["inputs"]))) |
280 dragSource = wx.DropSource(self.Tree) |
487 dragSource = wx.DropSource(self.Tree) |
281 dragSource.SetData(data) |
488 dragSource.SetData(data) |
282 dragSource.DoDragDrop() |
489 dragSource.DoDragDrop() |
283 |
490 |
284 def OnKeyDown(self, event): |
491 def OnKeyDown(self, event): |
|
492 """ |
|
493 Called when key is pressed in SearchCtrl text control |
|
494 @param event: wx.KeyEvent |
|
495 """ |
|
496 # Get event keycode and value in SearchCtrl |
285 keycode = event.GetKeyCode() |
497 keycode = event.GetKeyCode() |
286 search_value = self.SearchCtrl.GetValue() |
498 search_value = self.SearchCtrl.GetValue() |
|
499 |
|
500 # Up key was pressed and SearchCtrl isn't empty, search for block in |
|
501 # 'previous' mode |
287 if keycode == wx.WXK_UP and search_value != "": |
502 if keycode == wx.WXK_UP and search_value != "": |
288 self.SearchInTree(search_value, "previous") |
503 self.SearchInTree(search_value, "previous") |
|
504 |
|
505 # Down key was pressed and SearchCtrl isn't empty, search for block in |
|
506 # 'next' mode |
289 elif keycode == wx.WXK_DOWN and search_value != "": |
507 elif keycode == wx.WXK_DOWN and search_value != "": |
290 self.SearchInTree(search_value, "next") |
508 self.SearchInTree(search_value, "next") |
|
509 |
|
510 # Handle key normally |
291 else: |
511 else: |
292 event.Skip() |
512 event.Skip() |