from functools import partial from qtpy import QtGui from qtpy.QtCore import Qt from qtpy import QtWidgets from ..i18n import N_ from .. import icons from .. import qtutils from . import defs from . import standard from .toolbarcmds import COMMANDS TREE_LAYOUT = { 'Others': ['Others::LaunchEditor', 'Others::RevertUnstagedEdits'], 'File': [ 'File::QuickOpen', 'File::NewRepo', 'File::OpenRepo', 'File::OpenRepoNewWindow', 'File::Refresh', 'File::EditRemotes', 'File::RecentModified', 'File::SaveAsTarZip', 'File::ApplyPatches', 'File::ExportPatches', ], 'Actions': [ 'Actions::Fetch', 'Actions::Pull', 'Actions::Push', 'Actions::Stash', 'Actions::CreateTag', 'Actions::CherryPick', 'Actions::Merge', 'Actions::AbortMerge', 'Actions::UpdateSubmodules', 'Actions::Grep', 'Actions::Search', ], 'Commit@@verb': [ 'Commit::Stage', 'Commit::AmendLast', 'Commit::UndoLastCommit', 'Commit::StageModified', 'Commit::StageUntracked', 'Commit::UnstageAll', 'Commit::Unstage', 'Commit::LoadCommitMessage', 'Commit::GetCommitMessageTemplate', ], 'Diff': ['Diff::Difftool', 'Diff::Expression', 'Diff::Branches', 'Diff::Diffstat'], 'Branch': [ 'Branch::Review', 'Branch::Create', 'Branch::Checkout', 'Branch::Delete', 'Branch::DeleteRemote', 'Branch::Rename', 'Branch::BrowseCurrent', 'Branch::BrowseOther', 'Branch::VisualizeCurrent', 'Branch::VisualizeAll', ], 'Reset': [ 'Commit::UndoLastCommit', 'Commit::UnstageAll', 'Actions::ResetSoft', 'Actions::ResetMixed', 'Actions::RestoreWorktree', 'Actions::ResetKeep', 'Actions::ResetHard', ], 'View': ['View::DAG', 'View::FileBrowser'], } # Backwards-compatibility: Commit::StageUntracked was previously # exposed as Commit::StageUntracked. RENAMED = { 'Commit::StageAll': 'Commit::StageUntracked', } def configure(toolbar, parent=None): """Launches the Toolbar configure dialog""" if not parent: parent = qtutils.active_window() view = ToolbarView(toolbar, parent) view.show() return view def get_toolbars(widget): return widget.findChildren(ToolBar) def add_toolbar(context, widget): toolbars = get_toolbars(widget) name = 'ToolBar%d' % (len(toolbars) + 1) toolbar = ToolBar.create(context, name) widget.addToolBar(toolbar) configure(toolbar) class ToolBarState: """export_state() and apply_state() providers for toolbars""" def __init__(self, context, widget): """widget must be a QMainWindow for toolBarArea(), etc.""" self.context = context self.widget = widget def apply_state(self, toolbars): context = self.context widget = self.widget for data in toolbars: toolbar = ToolBar.create(context, data['name']) toolbar.load_items(data['items']) try: toolbar.set_toolbar_style(data['toolbar_style']) except KeyError: # Maintain compatibility for toolbars created in git-cola <= 3.11.0 if data['show_icons']: data['toolbar_style'] = ToolBar.STYLE_FOLLOW_SYSTEM toolbar.set_toolbar_style(ToolBar.STYLE_FOLLOW_SYSTEM) else: data['toolbar_style'] = ToolBar.STYLE_TEXT_ONLY toolbar.set_toolbar_style(ToolBar.STYLE_TEXT_ONLY) toolbar.setVisible(data['visible']) toolbar_area = decode_toolbar_area(data['area']) if data['break']: widget.addToolBarBreak(toolbar_area) widget.addToolBar(toolbar_area, toolbar) # floating toolbars must be set after added if data['float']: toolbar.setWindowFlags(Qt.Tool | Qt.FramelessWindowHint) toolbar.move(data['x'], data['y']) def export_state(self): result = [] widget = self.widget toolbars = widget.findChildren(ToolBar) for toolbar in toolbars: toolbar_area = widget.toolBarArea(toolbar) if toolbar_area == Qt.NoToolBarArea: continue # filter out removed toolbars items = [x.data() for x in toolbar.actions()] # show_icons is for backwards compatibility with git-cola <= 3.11.0 show_icons = toolbar.toolbar_style() != ToolBar.STYLE_TEXT_ONLY result.append({ 'name': toolbar.windowTitle(), 'area': encode_toolbar_area(toolbar_area), 'break': widget.toolBarBreak(toolbar), 'float': toolbar.isFloating(), 'x': toolbar.pos().x(), 'y': toolbar.pos().y(), 'width': toolbar.width(), 'height': toolbar.height(), 'show_icons': show_icons, 'toolbar_style': toolbar.toolbar_style(), 'visible': toolbar.isVisible(), 'items': items, }) return result class ToolBar(QtWidgets.QToolBar): SEPARATOR = 'Separator' STYLE_FOLLOW_SYSTEM = 'follow-system' STYLE_ICON_ONLY = 'icon' STYLE_TEXT_ONLY = 'text' STYLE_TEXT_BESIDE_ICON = 'text-beside-icon' STYLE_TEXT_UNDER_ICON = 'text-under-icon' STYLE_NAMES = [ N_('Follow System Style'), N_('Icon Only'), N_('Text Only'), N_('Text Beside Icon'), N_('Text Under Icon'), ] STYLE_SYMBOLS = [ STYLE_FOLLOW_SYSTEM, STYLE_ICON_ONLY, STYLE_TEXT_ONLY, STYLE_TEXT_BESIDE_ICON, STYLE_TEXT_UNDER_ICON, ] @staticmethod def create(context, name): return ToolBar(context, name, TREE_LAYOUT, COMMANDS) def __init__(self, context, title, tree_layout, toolbar_commands): QtWidgets.QToolBar.__init__(self) self.setWindowTitle(title) self.setObjectName(title) self.setToolButtonStyle(Qt.ToolButtonFollowStyle) self.context = context self.tree_layout = tree_layout self.commands = toolbar_commands def set_toolbar_style(self, style_id): style_to_qt = { self.STYLE_FOLLOW_SYSTEM: Qt.ToolButtonFollowStyle, self.STYLE_ICON_ONLY: Qt.ToolButtonIconOnly, self.STYLE_TEXT_ONLY: Qt.ToolButtonTextOnly, self.STYLE_TEXT_BESIDE_ICON: Qt.ToolButtonTextBesideIcon, self.STYLE_TEXT_UNDER_ICON: Qt.ToolButtonTextUnderIcon, } default = Qt.ToolButtonFollowStyle return self.setToolButtonStyle(style_to_qt.get(style_id, default)) def toolbar_style(self): qt_to_style = { Qt.ToolButtonFollowStyle: self.STYLE_FOLLOW_SYSTEM, Qt.ToolButtonIconOnly: self.STYLE_ICON_ONLY, Qt.ToolButtonTextOnly: self.STYLE_TEXT_ONLY, Qt.ToolButtonTextBesideIcon: self.STYLE_TEXT_BESIDE_ICON, Qt.ToolButtonTextUnderIcon: self.STYLE_TEXT_UNDER_ICON, } default = self.STYLE_FOLLOW_SYSTEM return qt_to_style.get(self.toolButtonStyle(), default) def load_items(self, items): for data in items: self.add_action_from_data(data) def add_action_from_data(self, data): parent = data['parent'] child = data['child'] child = RENAMED.get(child, child) if child == self.SEPARATOR: toolbar_action = self.addSeparator() toolbar_action.setData(data) return tree_items = self.tree_layout.get(parent, []) if child in tree_items and child in self.commands: command = self.commands[child] title = N_(command['title']) callback = partial(command['action'], self.context) tooltip = command.get('tooltip', None) icon = None command_icon = command.get('icon', None) if command_icon: icon = getattr(icons, command_icon, None) if callable(icon): icon = icon() if icon: toolbar_action = self.addAction(icon, title, callback) else: toolbar_action = self.addAction(title, callback) toolbar_action.setData(data) tooltip = command.get('tooltip', None) if tooltip: toolbar_action.setToolTip(f'{title}\n{tooltip}') def delete_toolbar(self): self.parent().removeToolBar(self) def contextMenuEvent(self, event): menu = QtWidgets.QMenu() tool_config = menu.addAction(N_('Configure Toolbar'), partial(configure, self)) tool_config.setIcon(icons.configure()) tool_delete = menu.addAction(N_('Delete Toolbar'), self.delete_toolbar) tool_delete.setIcon(icons.remove()) menu.exec_(event.globalPos()) def encode_toolbar_area(toolbar_area): """Encode a Qt::ToolBarArea as a string""" default = 'bottom' return { Qt.LeftToolBarArea: 'left', Qt.RightToolBarArea: 'right', Qt.TopToolBarArea: 'top', Qt.BottomToolBarArea: 'bottom', }.get(toolbar_area, default) def decode_toolbar_area(string): """Decode an encoded toolbar area string into a Qt::ToolBarArea""" default = Qt.BottomToolBarArea return { 'left': Qt.LeftToolBarArea, 'right': Qt.RightToolBarArea, 'top': Qt.TopToolBarArea, 'bottom': Qt.BottomToolBarArea, }.get(string, default) class ToolbarView(standard.Dialog): """Provides the git-cola 'ToolBar' configure dialog""" SEPARATOR_TEXT = '----------------------------' def __init__(self, toolbar, parent=None): standard.Dialog.__init__(self, parent) self.setWindowTitle(N_('Configure Toolbar')) self.toolbar = toolbar self.left_list = ToolbarTreeWidget(self) self.right_list = DraggableListWidget(self) self.text_toolbar_name = QtWidgets.QLabel() self.text_toolbar_name.setText(N_('Name')) self.toolbar_name = QtWidgets.QLineEdit() self.toolbar_name.setText(toolbar.windowTitle()) self.add_separator = qtutils.create_button(N_('Add Separator')) self.remove_item = qtutils.create_button(N_('Remove Element')) self.toolbar_style_label = QtWidgets.QLabel(N_('Toolbar Style:')) self.toolbar_style = QtWidgets.QComboBox() for style_name in ToolBar.STYLE_NAMES: self.toolbar_style.addItem(style_name) style_idx = get_index_from_style(toolbar.toolbar_style()) self.toolbar_style.setCurrentIndex(style_idx) self.apply_button = qtutils.ok_button(N_('Apply')) self.close_button = qtutils.close_button() self.close_button.setDefault(True) self.right_actions = qtutils.hbox( defs.no_margin, defs.spacing, self.add_separator, self.remove_item ) self.name_layout = qtutils.hbox( defs.no_margin, defs.spacing, self.text_toolbar_name, self.toolbar_name ) self.left_layout = qtutils.vbox(defs.no_margin, defs.spacing, self.left_list) self.right_layout = qtutils.vbox( defs.no_margin, defs.spacing, self.right_list, self.right_actions ) self.top_layout = qtutils.hbox( defs.no_margin, defs.spacing, self.left_layout, self.right_layout ) self.actions_layout = qtutils.hbox( defs.no_margin, defs.spacing, self.toolbar_style_label, self.toolbar_style, qtutils.STRETCH, self.close_button, self.apply_button, ) self.main_layout = qtutils.vbox( defs.margin, defs.spacing, self.name_layout, self.top_layout, self.actions_layout, ) self.setLayout(self.main_layout) qtutils.connect_button(self.add_separator, self.add_separator_action) qtutils.connect_button(self.remove_item, self.remove_item_action) qtutils.connect_button(self.apply_button, self.apply_action) qtutils.connect_button(self.close_button, self.accept) self.load_right_items() self.load_left_items() self.init_size(parent=parent) def load_right_items(self): commands = self.toolbar.commands for action in self.toolbar.actions(): data = action.data() try: command_name = data['child'] except KeyError: continue command_name = RENAMED.get(command_name, command_name) if command_name == self.toolbar.SEPARATOR: self.add_separator_action() continue try: command = commands[command_name] except KeyError: continue title = command['title'] icon = command.get('icon', None) tooltip = command.get('tooltip', None) self.right_list.add_item(title, tooltip, data, icon) def load_left_items(self): commands = self.toolbar.commands for parent in self.toolbar.tree_layout: top = self.left_list.insert_top(parent) for item in self.toolbar.tree_layout[parent]: item = RENAMED.get(item, item) try: command = commands[item] except KeyError: continue icon = command.get('icon', None) tooltip = command.get('tooltip', None) child = create_child(parent, item, command['title'], tooltip, icon) top.appendRow(child) top.sortChildren(0, Qt.AscendingOrder) def add_separator_action(self): data = {'parent': None, 'child': self.toolbar.SEPARATOR} self.right_list.add_separator(self.SEPARATOR_TEXT, data) def remove_item_action(self): items = self.right_list.selectedItems() for item in items: self.right_list.takeItem(self.right_list.row(item)) def apply_action(self): self.toolbar.clear() style = get_style_from_index(self.toolbar_style.currentIndex()) self.toolbar.set_toolbar_style(style) self.toolbar.setWindowTitle(self.toolbar_name.text()) for item in self.right_list.get_items(): data = item.data(Qt.UserRole) self.toolbar.add_action_from_data(data) def get_style_from_index(index): """Return the symbolic toolbar style name for the given (combobox) index""" return ToolBar.STYLE_SYMBOLS[index] def get_index_from_style(style): """Return the toolbar style (combobox) index for the symbolic name""" return ToolBar.STYLE_SYMBOLS.index(style) class DraggableListMixin: items = [] def __init__(self, widget, Base): self.widget = widget self.Base = Base widget.setAcceptDrops(True) widget.setSelectionMode(widget.SingleSelection) widget.setDragEnabled(True) widget.setDropIndicatorShown(True) def dragEnterEvent(self, event): widget = self.widget self.Base.dragEnterEvent(widget, event) def dragMoveEvent(self, event): widget = self.widget self.Base.dragMoveEvent(widget, event) def dragLeaveEvent(self, event): widget = self.widget self.Base.dragLeaveEvent(widget, event) def dropEvent(self, event): widget = self.widget event.setDropAction(Qt.MoveAction) self.Base.dropEvent(widget, event) def get_items(self): widget = self.widget base = self.Base items = [base.item(widget, i) for i in range(base.count(widget))] return items class DraggableListWidget(QtWidgets.QListWidget): Mixin = DraggableListMixin def __init__(self, parent=None): QtWidgets.QListWidget.__init__(self, parent) self.setAcceptDrops(True) self.setSelectionMode(self.SingleSelection) self.setDragEnabled(True) self.setDropIndicatorShown(True) self._mixin = self.Mixin(self, QtWidgets.QListWidget) def dragEnterEvent(self, event): return self._mixin.dragEnterEvent(event) def dragMoveEvent(self, event): return self._mixin.dragMoveEvent(event) def dropEvent(self, event): return self._mixin.dropEvent(event) def add_separator(self, title, data): item = QtWidgets.QListWidgetItem() item.setText(title) item.setData(Qt.UserRole, data) self.addItem(item) def add_item(self, title, tooltip, data, icon): item = QtWidgets.QListWidgetItem() item.setText(N_(title)) item.setData(Qt.UserRole, data) if tooltip: item.setToolTip(tooltip) if icon: icon_func = getattr(icons, icon) item.setIcon(icon_func()) self.addItem(item) def get_items(self): return self._mixin.get_items() class ToolbarTreeWidget(standard.TreeView): def __init__(self, parent): standard.TreeView.__init__(self, parent) self.setDragEnabled(True) self.setDragDropMode(QtWidgets.QAbstractItemView.DragOnly) self.setSelectionMode(QtWidgets.QAbstractItemView.SingleSelection) self.setDropIndicatorShown(True) self.setRootIsDecorated(True) self.setHeaderHidden(True) self.setAlternatingRowColors(False) self.setSortingEnabled(False) self.setModel(QtGui.QStandardItemModel()) def insert_top(self, title): item = create_item(title, title) item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled) self.model().insertRow(0, item) self.model().sort(0) return item def create_child(parent, child, title, tooltip, icon): data = {'parent': parent, 'child': child} item = create_item(title, data) if tooltip: item.setToolTip(tooltip) if icon: icon_func = getattr(icons, icon, None) item.setIcon(icon_func()) return item def create_item(name, data): item = QtGui.QStandardItem() item.setEditable(False) item.setDragEnabled(True) item.setText(N_(name)) item.setData(data, Qt.UserRole) return item