Skip to content

Commit

Permalink
Merge pull request #20620 from dalthviz/editor_mainmenus
Browse files Browse the repository at this point in the history 
PR: Initial code changes for old menu actions to use the `Mainmenu` plugin (Editor)
  • Loading branch information
@ccordoba12
ccordoba12 authored Mar 14, 2023
2 parents de0d4c4 + 077e44d commit 9a1ca89
Show file tree
Hide file tree
Showing 9 changed files with 290 additions and 290 deletions.
159 changes: 2 additions & 157 deletions spyder/app/mainwindow.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,14 +241,6 @@ def signal_handler(signum, frame=None):
self.paste_action = None
self.selectall_action = None

# Menu bars
self.edit_menu = None
self.edit_menu_actions = []
self.search_menu = None
self.search_menu_actions = []
self.source_menu = None
self.source_menu_actions = []

# TODO: Move to corresponding Plugins
self.file_toolbar = None
self.file_toolbar_actions = []
Expand Down Expand Up @@ -414,7 +406,6 @@ def register_plugin(self, plugin_name, external=False, omit_conf=False):
self.unmaximize_plugin)

if isinstance(plugin, SpyderDockablePlugin):
plugin.sig_focus_changed.connect(self.plugin_focus_changed)
plugin.sig_switch_to_plugin_requested.connect(
self.switch_to_plugin)
plugin.sig_update_ancestor_requested.connect(
Expand Down Expand Up @@ -820,12 +811,9 @@ def setup(self):
# TODO: Remove when all menus are migrated to use the Main Menu Plugin
logger.info("Creating Menus...")
from spyder.plugins.mainmenu.api import (
ApplicationMenus, FileMenuSections)
ApplicationMenus, FileMenuSections
)
mainmenu = self.mainmenu
self.edit_menu = mainmenu.get_application_menu("edit_menu")
self.search_menu = mainmenu.get_application_menu("search_menu")
self.source_menu = mainmenu.get_application_menu("source_menu")
self.source_menu.aboutToShow.connect(self.update_source_menu)

# Switcher shortcuts
self.file_switcher_action = create_action(
Expand All @@ -850,38 +838,6 @@ def setup(self):
self.register_shortcut(self.symbol_finder_action, context="_",
name="symbol finder", add_shortcut_to_tip=True)

def create_edit_action(text, tr_text, icon):
textseq = text.split(' ')
method_name = textseq[0].lower() + "".join(textseq[1:])
action = create_action(self, tr_text,
icon=icon,
triggered=self.global_callback,
data=method_name,
context=Qt.WidgetShortcut)
self.register_shortcut(action, "Editor", text)
return action

self.undo_action = create_edit_action('Undo', _('Undo'),
ima.icon('undo'))
self.redo_action = create_edit_action('Redo', _('Redo'),
ima.icon('redo'))
self.copy_action = create_edit_action('Copy', _('Copy'),
ima.icon('editcopy'))
self.cut_action = create_edit_action('Cut', _('Cut'),
ima.icon('editcut'))
self.paste_action = create_edit_action('Paste', _('Paste'),
ima.icon('editpaste'))
self.selectall_action = create_edit_action("Select All",
_("Select All"),
ima.icon('selectall'))

self.edit_menu_actions += [self.undo_action, self.redo_action,
None, self.cut_action, self.copy_action,
self.paste_action, self.selectall_action,
None]
if self.get_plugin(Plugins.Editor, error=False):
self.edit_menu_actions += self.editor.edit_menu_actions

switcher_actions = [
self.file_switcher_action,
self.symbol_finder_action
Expand All @@ -903,12 +859,6 @@ def create_edit_action(text, tr_text, icon):

self.set_splash(_("Setting up main window..."))

# TODO: Migrate to use the MainMenu Plugin instead of list of actions
# Filling out menu/toolbar entries:
add_actions(self.edit_menu, self.edit_menu_actions)
add_actions(self.search_menu, self.search_menu_actions)
add_actions(self.source_menu, self.source_menu_actions)

def __getattr__(self, attr):
"""
Redefinition of __getattr__ to enable access to plugins.
Expand Down Expand Up @@ -946,15 +896,6 @@ def pre_visible_setup(self):
if self.splash is not None:
self.splash.hide()

# Menu about to show
for child in self.menuBar().children():
if isinstance(child, QMenu):
try:
child.aboutToShow.connect(self.update_edit_menu)
child.aboutToShow.connect(self.update_search_menu)
except TypeError:
pass

# Register custom layouts
if self.layouts is not None:
self.layouts.register_custom_layouts()
Expand Down Expand Up @@ -1191,26 +1132,10 @@ def hideEvent(self, event):

# ---- Other
# -------------------------------------------------------------------------
def update_source_menu(self):
"""Update source menu options that vary dynamically."""
# This is necessary to avoid an error at startup.
# Fixes spyder-ide/spyder#14901
try:
editor = self.get_plugin(Plugins.Editor, error=False)
if editor:
editor.refresh_formatter_name()
except AttributeError:
pass

def free_memory(self):
"""Free memory after event."""
gc.collect()

def plugin_focus_changed(self):
"""Focus has changed from one plugin to another"""
self.update_edit_menu()
self.update_search_menu()

def show_shortcuts(self, menu):
"""Show action shortcuts in menu."""
menu_actions = menu.actions()
Expand Down Expand Up @@ -1271,73 +1196,6 @@ def get_focus_widget_properties(self):
textedit_properties = (console, not_readonly, readwrite_editor)
return widget, textedit_properties

def update_edit_menu(self):
"""Update edit menu"""
widget, textedit_properties = self.get_focus_widget_properties()
if textedit_properties is None: # widget is not an editor/console
return
# !!! Below this line, widget is expected to be a QPlainTextEdit
# instance
console, not_readonly, readwrite_editor = textedit_properties

if hasattr(self, 'editor'):
# Editor has focus and there is no file opened in it
if (not console and not_readonly and self.editor
and not self.editor.is_file_opened()):
return

# Disabling all actions to begin with
for child in self.edit_menu.actions():
child.setEnabled(False)

self.selectall_action.setEnabled(True)

# Undo, redo
self.undo_action.setEnabled(readwrite_editor
and widget.document().isUndoAvailable())
self.redo_action.setEnabled(readwrite_editor
and widget.document().isRedoAvailable())

# Copy, cut, paste, delete
has_selection = widget.has_selected_text()
self.copy_action.setEnabled(has_selection)
self.cut_action.setEnabled(has_selection and not_readonly)
self.paste_action.setEnabled(not_readonly)

# Comment, uncomment, indent, unindent...
if not console and not_readonly:
# This is the editor and current file is writable
if self.get_plugin(Plugins.Editor, error=False):
for action in self.editor.edit_menu_actions:
action.setEnabled(True)

def update_search_menu(self):
"""Update search menu"""
# Disabling all actions except the last one
# (which is Find in files) to begin with
for child in self.search_menu.actions()[:-1]:
child.setEnabled(False)

widget, textedit_properties = self.get_focus_widget_properties()
if textedit_properties is None: # widget is not an editor/console
return

# !!! Below this line, widget is expected to be a QPlainTextEdit
# instance
console, not_readonly, readwrite_editor = textedit_properties

# Find actions only trigger an effect in the Editor
if not console:
for action in self.search_menu.actions():
try:
action.setEnabled(True)
except RuntimeError:
pass

# Disable the replace action for read-only files
if len(self.search_menu_actions) > 3:
self.search_menu_actions[3].setEnabled(readwrite_editor)

def set_splash(self, message):
"""Set splash message"""
if self.splash is None:
Expand Down Expand Up @@ -1427,19 +1285,6 @@ def add_dockwidget(self, plugin):
self.addDockWidget(location, dockwidget)
self.widgetlist.append(plugin)

def global_callback(self):
"""Global callback"""
widget = QApplication.focusWidget()
action = self.sender()
callback = from_qvariant(action.data(), to_text_string)
from spyder.plugins.editor.widgets.base import TextEditBaseWidget
from spyder.plugins.ipythonconsole.widgets import ControlWidget

if isinstance(widget, (TextEditBaseWidget, ControlWidget)):
getattr(widget, callback)()
else:
return

def redirect_internalshell_stdio(self, state):
console = self.get_plugin(Plugins.Console, error=False)
if console:
Expand Down
7 changes: 6 additions & 1 deletion spyder/app/tests/test_mainwindow.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
from spyder.plugins.help.tests.test_plugin import check_text
from spyder.plugins.ipythonconsole.utils.kernel_handler import KernelHandler
from spyder.plugins.ipythonconsole.api import IPythonConsolePyConfiguration
from spyder.plugins.mainmenu.api import ApplicationMenus
from spyder.plugins.layout.layouts import DefaultLayouts
from spyder.plugins.toolbar.api import ApplicationToolbars
from spyder.plugins.run.api import (
Expand Down Expand Up @@ -2987,7 +2988,11 @@ def test_preferences_checkboxes_not_checked_regression(main_window, qtbot):

# Check the menus are correctly updated
count = 0
for menu_item in main_window.source_menu_actions:
mainmenu = main_window.get_plugin(Plugins.MainMenu)
source_menu_actions = mainmenu.get_application_menu(
ApplicationMenus.Source
).get_actions()
for menu_item in source_menu_actions:
if menu_item and isinstance(menu_item, QAction):
print(menu_item.text(), menu_item.isChecked())

Expand Down
Loading

0 comments on commit 9a1ca89

Please sign in to comment.