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 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
|
# -*- coding: utf-8 -*-
# Copyright Martin Manns
# Distributed under the terms of the GNU General Public License
# --------------------------------------------------------------------
# pyspread 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.
#
# pyspread 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 pyspread. If not, see <http://www.gnu.org/licenses/>.
# --------------------------------------------------------------------
"""
**Provides**
* :class:`MenuBar`: QMenuBar, the main menubar
* :class:`FileMenu`: File menu for the main menubar
* :class:`EditMenu`: Edit menu for the main menubar
* :class:`ViewMenu`: View menu for the main menubar
* :class:`FormatMenu`: Format menu for the main menubar
* :class:`MacroMenu`: Macro menu for the main menubar
* :class:`HelpMenu`: Help menu for the main menubar
* :class:`FileHistoryMenu`: Menu showing recent files
* :class:`BorderChoiceMenu`: QMenu for choosing cell borders
* :class:`BorderWidthMenu`: QMenu for choosing the cell border width
"""
from functools import partial
from pathlib import Path
from PyQt6.QtCore import Qt
from PyQt6.QtGui import QAction
from PyQt6.QtWidgets import QMenuBar, QMenu, QMainWindow, QWidget, QToolBar
try:
import matplotlib.figure as matplotlib_figure
except ImportError:
matplotlib_figure = None
try:
import dateutil
except ImportError:
dateutil = None
try:
from pyspread.actions import MainWindowActions
from pyspread.icons import Icon
except ImportError:
from actions import MainWindowActions
from icons import Icon
class MenuBar(QMenuBar):
"""The main menubar """
def __init__(self, main_window: QMainWindow):
"""
:param main_window: Application main window
"""
super().__init__()
self.main_window = main_window
actions = main_window.main_window_actions
self.file_menu = FileMenu(self, actions)
self.edit_menu = EditMenu(self, actions)
self.view_menu = ViewMenu(self, actions)
self.format_menu = FormatMenu(self, actions)
self.macro_menu = MacroMenu(self, actions)
self.help_menu = HelpMenu(self, actions)
self.addMenu(self.file_menu)
self.addMenu(self.edit_menu)
self.addMenu(self.view_menu)
self.addMenu(self.format_menu)
self.addMenu(self.macro_menu)
self.addMenu(self.help_menu)
class FileMenu(QMenu):
"""File menu for the main menubar"""
def __init__(self, parent: QWidget, actions: MainWindowActions):
"""
:param parent: Parent widget
:param actions: Main window actions
"""
super().__init__('&File', parent)
self.parent = parent
self.addAction(actions.new)
self.addAction(actions.open)
self.history_submenu = FileHistoryMenu(self, actions)
self.history_action = self.addMenu(self.history_submenu)
self.addSeparator()
self.addAction(actions.save)
self.addAction(actions.save_as)
self.addSeparator()
self.addAction(actions.imprt)
self.addAction(actions.export)
self.addSeparator()
self.addAction(actions.approve)
self.addSeparator()
self.addAction(actions.clear_globals)
self.addSeparator()
self.addAction(actions.print_preview)
self.addAction(actions.print)
self.addSeparator()
self.addAction(actions.preferences)
self.addSeparator()
self.addAction(actions.quit)
class EditMenu(QMenu):
"""Edit menu for the main menubar"""
def __init__(self, parent: QWidget, actions: MainWindowActions):
"""
:param parent: Parent widget
:param actions: Main window actions
"""
super().__init__('&Edit', parent)
self.addAction(actions.undo)
self.addAction(actions.redo)
self.addSeparator()
self.addAction(actions.cut)
self.addAction(actions.copy)
self.addAction(actions.copy_results)
self.addAction(actions.paste)
self.addAction(actions.paste_as)
self.addSeparator()
self.addAction(actions.find)
self.addAction(actions.replace)
self.addSeparator()
self.addAction(actions.sort_ascending)
self.addAction(actions.sort_descending)
self.addSeparator()
self.addAction(actions.toggle_selection_mode)
self.addSeparator()
self.addAction(actions.shift_cells_down)
self.addAction(actions.shift_cells_right)
self.addAction(actions.delete_shift_cells_up)
self.addAction(actions.delete_shift_cells_left)
self.addSeparator()
self.addAction(actions.insert_rows)
self.addAction(actions.insert_columns)
self.addAction(actions.insert_table)
self.addSeparator()
self.addAction(actions.delete_rows)
self.addAction(actions.delete_columns)
self.addAction(actions.delete_table)
self.addSeparator()
self.addAction(actions.resize_grid)
class ViewMenu(QMenu):
"""View menu for the main menubar"""
def __init__(self, parent: QWidget, actions: MainWindowActions):
"""
:param parent: Parent widget
:param actions: Main window actions
"""
super().__init__('&View', parent)
self.addAction(actions.fullscreen)
self.addSeparator()
self.toolbar_submenu = self.addMenu('Toolbars')
self.toolbar_submenu.addAction(actions.toggle_main_toolbar)
self.toolbar_submenu.addAction(actions.toggle_macro_toolbar)
self.toolbar_submenu.addAction(actions.toggle_format_toolbar)
self.toolbar_submenu.addAction(actions.toggle_find_toolbar)
self.addAction(actions.toggle_entry_line_dock)
self.addAction(actions.toggle_macro_dock)
self.addSeparator()
self.addAction(actions.goto_cell)
self.addSeparator()
self.addAction(actions.toggle_spell_checker)
self.addSeparator()
self.addAction(actions.zoom_in)
self.addAction(actions.zoom_out)
self.addAction(actions.zoom_1)
self.addSeparator()
self.addAction(actions.refresh_cells)
self.addAction(actions.toggle_periodic_updates)
self.addSeparator()
self.addAction(actions.show_frozen)
class FormatMenu(QMenu):
"""Format menu for the main menubar"""
def __init__(self, parent: QWidget, actions: MainWindowActions):
"""
:param parent: Parent widget
:param actions: Main window actions
"""
super().__init__('&Format', parent)
self.addAction(actions.copy_format)
self.addAction(actions.paste_format)
self.addSeparator()
self.addAction(actions.default_format)
self.addSeparator()
self.addAction(actions.font)
self.addAction(actions.bold)
self.addAction(actions.italics)
self.addAction(actions.underline)
self.addAction(actions.strikethrough)
self.addSeparator()
self.renderer_submenu = self.addMenu('Cell renderer')
self.renderer_submenu.addAction(actions.text)
self.renderer_submenu.addAction(actions.image)
self.renderer_submenu.addAction(actions.markup)
if matplotlib_figure is not None:
self.renderer_submenu.addAction(actions.matplotlib)
self.addAction(actions.freeze_cell)
self.addAction(actions.lock_cell)
self.addAction(actions.button_cell)
self.addSeparator()
self.addAction(actions.merge_cells)
self.addSeparator()
self.rotation_submenu = self.addMenu('Rotation')
self.rotation_submenu.addAction(actions.rotate_0)
self.rotation_submenu.addAction(actions.rotate_90)
self.rotation_submenu.addAction(actions.rotate_180)
self.rotation_submenu.addAction(actions.rotate_270)
self.justification_submenu = self.addMenu('Justification')
self.justification_submenu.addAction(actions.justify_left)
self.justification_submenu.addAction(actions.justify_center)
self.justification_submenu.addAction(actions.justify_right)
self.justification_submenu.addAction(actions.justify_fill)
self.alignment_submenu = self.addMenu('Alignment')
self.alignment_submenu.addAction(actions.align_top)
self.alignment_submenu.addAction(actions.align_center)
self.alignment_submenu.addAction(actions.align_bottom)
self.addSeparator()
self.border_submenu = BorderChoiceMenu(actions)
self.addMenu(self.border_submenu)
self.line_width_submenu = BorderWidthMenu(actions)
self.addMenu(self.line_width_submenu)
self.addSeparator()
self.addAction(actions.text_color)
self.addAction(actions.line_color)
self.addAction(actions.background_color)
class MacroMenu(QMenu):
"""Macro menu for the main menubar"""
def __init__(self, parent: QWidget, actions: MainWindowActions):
"""
:param parent: Parent widget
:param actions: Main window actions
"""
super().__init__('&Macro', parent)
self.addAction(actions.insert_image)
if matplotlib_figure is not None:
self.addAction(actions.insert_chart)
self.addSeparator()
self.addAction(actions.quote)
self.addAction(actions.money)
if dateutil is not None:
self.addAction(actions.datetime)
self.addAction(actions.date)
self.addAction(actions.time)
self.addSeparator()
self.addAction(actions.insert_sum)
class HelpMenu(QMenu):
"""Help menu for the main menubar"""
def __init__(self, parent: QWidget, actions: MainWindowActions):
"""
:param parent: Parent widget
:param actions: Main window actions
"""
super().__init__('&Help', parent)
self.addAction(actions.manual)
self.addAction(actions.tutorial)
self.addSeparator()
self.addAction(actions.dependencies)
self.addSeparator()
self.addAction(actions.about)
class FileHistoryMenu(QMenu):
"""Menu that displays the file history"""
def __init__(self, parent: QWidget, actions: MainWindowActions):
"""
:param parent: Parent widget
:param actions: Main window actions
"""
super().__init__('&Recent files', parent)
self.main_window = parent.parent.main_window
def update_(self):
"""Updates file history menu"""
self.clear()
settings = self.main_window.settings
for posixpath in settings.file_history[:settings.max_file_history]:
filepath = Path(posixpath)
if filepath.is_file():
action = QAction(filepath.name, self)
action.setStatusTip(posixpath)
self.addAction(action)
action.triggered.connect(self.on_recent)
def on_recent(self):
"""Event handler for file history menu"""
posixpath = self.sender().statusTip()
self.main_window.workflows.file_open_recent(posixpath)
class BorderChoiceMenu(QMenu):
"""QMenu for choosing cell borders that shall be manipulated"""
def __init__(self, actions: MainWindowActions):
"""
:param actions: Main window actions
"""
self.actions = actions
super().__init__()
self.setTitle("Formatted borders")
self.setIcon(Icon.border_menu)
self.addAction(actions.format_borders_all)
self.addAction(actions.format_borders_top)
self.addAction(actions.format_borders_bottom)
self.addAction(actions.format_borders_left)
self.addAction(actions.format_borders_right)
self.addAction(actions.format_borders_outer)
self.addAction(actions.format_borders_inner)
self.addAction(actions.format_borders_top_bottom)
self.triggered.connect(self.on_selection)
def on_selection(self, event):
"""Event handler"""
self.actions.parent.format_toolbar.border_menu_button.setAttribute(
Qt.WA_UnderMouse, False)
class BorderWidthMenu(QMenu):
"""QMenu for choosing the cell border width"""
def __init__(self, actions: MainWindowActions):
"""
:param actions: Main window actions
"""
self.actions = actions
super().__init__()
self.setTitle("Border width")
self.setIcon(Icon.format_borders)
self.addAction(actions.format_borders_0)
self.addAction(actions.format_borders_1)
self.addAction(actions.format_borders_2)
self.addAction(actions.format_borders_4)
self.addAction(actions.format_borders_8)
self.addAction(actions.format_borders_16)
self.addAction(actions.format_borders_32)
self.addAction(actions.format_borders_64)
self.triggered.connect(self.on_selection)
def on_selection(self, event):
"""Event handler"""
self.actions.parent.format_toolbar.border_menu_button.setAttribute(
Qt.WidgetAttribute.WA_UnderMouse, False)
class GridContextMenu(QMenu):
"""Context menu for grid"""
def __init__(self, actions: MainWindowActions):
"""
:param actions: Main window actions
"""
super().__init__()
self.addAction(actions.cut)
self.addAction(actions.copy)
self.addAction(actions.copy_results)
self.addAction(actions.copy_format)
self.addAction(actions.paste)
self.addAction(actions.paste_as)
self.addAction(actions.paste_format)
self.addSeparator()
self.addAction(actions.toggle_selection_mode)
self.addSeparator()
self.addAction(actions.copy_format)
self.addAction(actions.paste_format)
self.addSeparator()
self.addAction(actions.toggle_selection_mode)
self.addSeparator()
self.addAction(actions.quote)
self.addSeparator()
self.addAction(actions.shift_cells_down)
self.addAction(actions.shift_cells_right)
self.addAction(actions.delete_shift_cells_up)
self.addAction(actions.delete_shift_cells_left)
self.addSeparator()
self.addAction(actions.insert_rows)
self.addAction(actions.insert_columns)
self.addSeparator()
self.addAction(actions.delete_rows)
self.addAction(actions.delete_columns)
class HorizontalHeaderContextMenu(QMenu):
"""Context menu for horizontal grid header"""
def __init__(self, actions: MainWindowActions):
"""
:param actions: Main window actions
"""
super().__init__()
self.addAction(actions.insert_columns)
self.addAction(actions.delete_columns)
class VerticalHeaderContextMenu(QMenu):
"""Context menu for vertical grid header"""
def __init__(self, actions: MainWindowActions):
"""
:param actions: Main window actions
"""
super().__init__()
self.addAction(actions.insert_rows)
self.addAction(actions.delete_rows)
class TableChoiceContextMenu(QMenu):
"""Context menu for table choice"""
def __init__(self, actions: MainWindowActions):
"""
:param actions: Main window actions
"""
super().__init__()
self.addAction(actions.insert_table)
self.addAction(actions.delete_table)
class ToolbarManagerMenu(QMenu):
"""Menu with all actions of a toolbar that allows toggling visibility"""
def __init__(self, toolbar: QToolBar):
"""
:param toolbar: Toolbar that the menu is managing
"""
super().__init__()
self.toolbar = toolbar
for action in toolbar.actions():
if action.isSeparator():
self.addSeparator()
else:
self.addAction(self._get_toggle_action(action))
self.update_checked_states()
def _get_toggle_action(self, action: QAction) -> QAction:
"""Returns a toggle action for a toolbar action
:param action: Toolbar action for which the toggle state is returned
"""
taction = QAction(action.icon(), action.text(), action, checkable=True)
taction.triggered.connect(partial(self.on_toggled, action))
return taction
def update_checked_states(self):
"""Updates checked states"""
for tool_action, action in zip(self.toolbar.actions(), self.actions()):
action.setChecked(tool_action.isVisible())
def on_toggled(self, action: QAction, toggled: bool):
"""Action toggle event handler
:param action: Toolbar action for which visibility is toggled
:param toggled: If False then action is set invisible and vice versa
"""
action.setVisible(toggled)
|