/
container.py
393 lines (323 loc) · 13.3 KB
/
container.py
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# -*- coding: utf-8 -*-
#
# Copyright © Spyder Project Contributors
# Licensed under the terms of the MIT License
# (see spyder/__init__.py for details)
"""
Toolbar Container.
"""
# Standard library imports
from collections import OrderedDict
from spyder.utils.qthelpers import SpyderAction
from typing import Optional, Union, Tuple, Dict, List
# Third party imports
from qtpy.QtCore import QSize, Slot
from qtpy.QtWidgets import QAction, QWidget
from qtpy import PYSIDE2
# Local imports
from spyder.api.exceptions import SpyderAPIError
from spyder.api.translations import _
from spyder.api.widgets.main_container import PluginMainContainer
from spyder.api.utils import get_class_values
from spyder.api.widgets.toolbars import ApplicationToolbar
from spyder.plugins.toolbar.api import ApplicationToolbars
from spyder.utils.registries import TOOLBAR_REGISTRY
# Type annotations
ToolbarItem = Union[SpyderAction, QWidget]
ItemInfo = Tuple[ToolbarItem, Optional[str], Optional[str], Optional[str]]
class ToolbarMenus:
ToolbarsMenu = "toolbars_menu"
class ToolbarsMenuSections:
Main = "main_section"
Secondary = "secondary_section"
class ToolbarActions:
ShowToolbars = "show toolbars"
class QActionID(QAction):
"""Wrapper class around QAction that allows to set/get an identifier."""
@property
def action_id(self):
return self._action_id
@action_id.setter
def action_id(self, act):
self._action_id = act
class ToolbarContainer(PluginMainContainer):
def __init__(self, name, plugin, parent=None):
super().__init__(name, plugin, parent=parent)
self._APPLICATION_TOOLBARS = OrderedDict()
self._ADDED_TOOLBARS = OrderedDict()
self._toolbarslist = []
self._visible_toolbars = []
self._ITEMS_QUEUE = {} # type: Dict[str, List[ItemInfo]]
# ---- Private Methods
# ------------------------------------------------------------------------
def _save_visible_toolbars(self):
"""Save the name of the visible toolbars in the options."""
toolbars = []
for toolbar in self._visible_toolbars:
toolbars.append(toolbar.objectName())
self.set_conf('last_visible_toolbars', toolbars)
def _get_visible_toolbars(self):
"""Collect the visible toolbars."""
toolbars = []
for toolbar in self._toolbarslist:
if (toolbar.toggleViewAction().isChecked()
and toolbar not in toolbars):
toolbars.append(toolbar)
self._visible_toolbars = toolbars
@Slot()
def _show_toolbars(self):
"""Show/Hide toolbars."""
value = not self.get_conf("toolbars_visible")
self.set_conf("toolbars_visible", value)
if value:
self._save_visible_toolbars()
else:
self._get_visible_toolbars()
for toolbar in self._visible_toolbars:
toolbar.setVisible(value)
self.update_actions()
def _add_missing_toolbar_elements(self, toolbar, toolbar_id):
if toolbar_id in self._ITEMS_QUEUE:
pending_items = self._ITEMS_QUEUE.pop(toolbar_id)
for item, section, before, before_section in pending_items:
toolbar.add_item(item, section=section, before=before,
before_section=before_section)
# ---- PluginMainContainer API
# ------------------------------------------------------------------------
def setup(self):
self.show_toolbars_action = self.create_action(
ToolbarActions.ShowToolbars,
text=_("Show toolbars"),
triggered=self._show_toolbars
)
self.toolbars_menu = self.create_menu(
ToolbarMenus.ToolbarsMenu,
_("Toolbars"),
)
self.toolbars_menu.setObjectName('checkbox-padding')
def update_actions(self):
visible_toolbars = self.get_conf("toolbars_visible")
if visible_toolbars:
text = _("Hide toolbars")
tip = _("Hide toolbars")
else:
text = _("Show toolbars")
tip = _("Show toolbars")
self.show_toolbars_action.setText(text)
self.show_toolbars_action.setToolTip(tip)
self.toolbars_menu.setEnabled(visible_toolbars)
# ---- Public API
# ------------------------------------------------------------------------
def create_application_toolbar(
self, toolbar_id: str, title: str) -> ApplicationToolbar:
"""
Create an application toolbar and add it to the main window.
Parameters
----------
toolbar_id: str
The toolbar unique identifier string.
title: str
The localized toolbar title to be displayed.
Returns
-------
spyder.api.widgets.toolbar.ApplicationToolbar
The created application toolbar.
"""
if toolbar_id in self._APPLICATION_TOOLBARS:
raise SpyderAPIError(
'Toolbar with ID "{}" already added!'.format(toolbar_id))
toolbar = ApplicationToolbar(self, title)
toolbar.ID = toolbar_id
toolbar.setObjectName(toolbar_id)
TOOLBAR_REGISTRY.register_reference(
toolbar, toolbar_id, self.PLUGIN_NAME, self.CONTEXT_NAME)
self._APPLICATION_TOOLBARS[toolbar_id] = toolbar
self._add_missing_toolbar_elements(toolbar, toolbar_id)
return toolbar
def add_application_toolbar(self, toolbar, mainwindow=None):
"""
Add toolbar to application toolbars.
Parameters
----------
toolbar: spyder.api.widgets.toolbars.ApplicationToolbar
The application toolbar to add to the `mainwindow`.
mainwindow: QMainWindow
The main application window.
"""
# Check toolbar class
if not isinstance(toolbar, ApplicationToolbar):
raise SpyderAPIError(
'Any toolbar must subclass ApplicationToolbar!'
)
# Check ID
toolbar_id = toolbar.ID
if toolbar_id is None:
raise SpyderAPIError(
f"Toolbar `{repr(toolbar)}` doesn't have an identifier!"
)
if toolbar_id in self._ADDED_TOOLBARS:
raise SpyderAPIError(
'Toolbar with ID "{}" already added!'.format(toolbar_id))
# TODO: Make the icon size adjustable in Preferences later on.
iconsize = 24
toolbar.setIconSize(QSize(iconsize, iconsize))
toolbar.setObjectName(toolbar_id)
self._ADDED_TOOLBARS[toolbar_id] = toolbar
self._toolbarslist.append(toolbar)
if mainwindow:
mainwindow.addToolBar(toolbar)
self._add_missing_toolbar_elements(toolbar, toolbar_id)
def remove_application_toolbar(self, toolbar_id: str, mainwindow=None):
"""
Remove toolbar from application toolbars.
Parameters
----------
toolbar: str
The application toolbar to remove from the `mainwindow`.
mainwindow: QMainWindow
The main application window.
"""
if toolbar_id not in self._ADDED_TOOLBARS:
raise SpyderAPIError(
'Toolbar with ID "{}" is not in the main window'.format(
toolbar_id))
toolbar = self._ADDED_TOOLBARS.pop(toolbar_id)
self._toolbarslist.remove(toolbar)
if mainwindow:
mainwindow.removeToolBar(toolbar)
def add_item_to_application_toolbar(self,
item: ToolbarItem,
toolbar_id: Optional[str] = None,
section: Optional[str] = None,
before: Optional[str] = None,
before_section: Optional[str] = None,
omit_id: bool = False):
"""
Add action or widget `item` to given application toolbar `section`.
Parameters
----------
item: SpyderAction or QWidget
The item to add to the `toolbar`.
toolbar_id: str or None
The application toolbar unique string identifier.
section: str or None
The section id in which to insert the `item` on the `toolbar`.
before: str or None
Make the item appear before another given item.
before_section: str or None
Make the item defined section appear before another given section
(the section must be already defined).
omit_id: bool
If True, then the toolbar will check if the item to add declares an
id, False otherwise. This flag exists only for items added on
Spyder 4 plugins. Default: False
"""
if toolbar_id not in self._APPLICATION_TOOLBARS:
pending_items = self._ITEMS_QUEUE.get(toolbar_id, [])
pending_items.append((item, section, before, before_section))
self._ITEMS_QUEUE[toolbar_id] = pending_items
else:
toolbar = self.get_application_toolbar(toolbar_id)
toolbar.add_item(item, section=section, before=before,
before_section=before_section, omit_id=omit_id)
def remove_item_from_application_toolbar(self, item_id: str,
toolbar_id: Optional[str] = None):
"""
Remove action or widget from given application toolbar by id.
Parameters
----------
item: str
The item to remove from the `toolbar`.
toolbar_id: str or None
The application toolbar unique string identifier.
"""
if toolbar_id not in self._APPLICATION_TOOLBARS:
raise SpyderAPIError(
'{} is not a valid toolbar_id'.format(toolbar_id))
toolbar = self.get_application_toolbar(toolbar_id)
toolbar.remove_item(item_id)
def get_application_toolbar(self, toolbar_id: str) -> ApplicationToolbar:
"""
Return an application toolbar by toolbar_id.
Parameters
----------
toolbar_id: str
The toolbar unique string identifier.
Returns
-------
spyder.api.widgets.toolbars.ApplicationToolbar
The application toolbar.
"""
if toolbar_id not in self._APPLICATION_TOOLBARS:
raise SpyderAPIError(
'Application toolbar "{0}" not found! '
'Available toolbars are: {1}'.format(
toolbar_id,
list(self._APPLICATION_TOOLBARS.keys())
)
)
return self._APPLICATION_TOOLBARS[toolbar_id]
def get_application_toolbars(self):
"""
Return all created application toolbars.
Returns
-------
list
The list of all the added application toolbars.
"""
return self._toolbarslist
def save_last_visible_toolbars(self):
"""Save the last visible toolbars state in our preferences."""
if self.get_conf("toolbars_visible"):
self._get_visible_toolbars()
self._save_visible_toolbars()
def load_last_visible_toolbars(self):
"""Load the last visible toolbars from our preferences."""
toolbars_names = self.get_conf('last_visible_toolbars')
toolbars_visible = self.get_conf("toolbars_visible")
if toolbars_names:
toolbars_dict = {}
for toolbar in self._toolbarslist:
toolbars_dict[toolbar.objectName()] = toolbar
toolbars = []
for name in toolbars_names:
if name in toolbars_dict:
toolbars.append(toolbars_dict[name])
self._visible_toolbars = toolbars
else:
self._get_visible_toolbars()
for toolbar in self._visible_toolbars:
toolbar.setVisible(toolbars_visible)
self.update_actions()
def create_toolbars_menu(self):
"""
Populate the toolbars menu inside the view application menu.
"""
main_section = ToolbarsMenuSections.Main
secondary_section = ToolbarsMenuSections.Secondary
default_toolbars = get_class_values(ApplicationToolbars)
for toolbar_id, toolbar in self._ADDED_TOOLBARS.items():
if toolbar:
action = toolbar.toggleViewAction()
if not PYSIDE2:
# Modifying __class__ of a QObject created by C++ [1] seems
# to invalidate the corresponding Python object when PySide
# is used (changing __class__ of a QObject created in
# Python seems to work).
#
# [1] There are Qt functions such as
# QToolBar.toggleViewAction(), QToolBar.addAction(QString)
# and QMainWindow.addToolbar(QString), which return a
# pointer to an already existing QObject.
action.__class__ = QActionID
action.action_id = f'toolbar_{toolbar_id}'
section = (
main_section
if toolbar_id in default_toolbars
else secondary_section
)
self.add_item_to_menu(
action,
menu=self.toolbars_menu,
section=section,
)