PR: Remember undocked state of plugins when closed and allow to close Outline when the Editor is maximized or in an Editor window #19784

ccordoba12 · 2022-10-11T04:34:32Z

Description of Changes

If a plugin is closed when it's undocked by going to View > Panes, then it'll be automatically undocked when made visible again.
Add a new Close action to the Options menu of undocked plugins, so that this new functionality can be more easily discovered by users.
If a plugin is closed while undocked, also close it when clicking on the Close button of its window. This means that if users want to dock it again, they'll need to click on the Dock action of the respective plugin.
Allow users to close the Outline when shown next to the maximized editor and in editor windows.
Rename Unlock position in the Options menu of plugins to Move. This is because Unlock and Undock differ by a single letter in English, so it's quite easy to click on one of those actions when you really want to click on the other (I made that mistake constantly while working on this PR).

API changes

Use SpyderMenuMixin to create main window menus. That allows to easily access and use them in other places (e.g. in EditorMainwindow).
Make render method of SpyderToolbar public. This follows a similar change done for SpyderMenu.
Add toolbar_id to the constructor of ApplicationToolbar. That allows to more easily create those toolbars.
Register toolbar toggle view actions in ACTION_REGISTRY to access them easily (e.g. for testing).

Visual changes

New close when undocked functionality

New close action in undocked plugins

Changes in EditorMainWindow

Issue(s) Resolved

Fixes #16265.

Affirmation

By submitting this Pull Request or typing my (user)name below,
I affirm the Developer Certificate of Origin
with respect to all commits and content included in this PR,
and understand I am releasing the same under Spyder's MIT (Expat) license.

I certify the above statement is true and correct: @ccordoba12.

ccordoba12 · 2022-10-18T01:42:31Z

Leaving this for 5.4.1 so I can gather feedback from other devs during our developers meeting.

- This allows users to show plugins directly undocked, i.e. without making them first visible but docked on the main window to then undock them. - Also, improve typing a bit.

- To close it the user can click the Close action in its Options menu or go to the Panes menu. - Hide the Outline's Undock and Lock/unlock actions when shown in the maximized editor because it doesn't make sense to show them in that case.

- This preserves the checked state of new Outline action shown in the View menu. - It also removes the handle which looks like an extra and odd border in the window.

- That way it can be used by other plugins or widgets. - Use it to set the menubar stylesheet of EditorMainWindow.

- Also, fix failing tests for the Working directory.

Also, check for the presence of splitter handler because it can't be available during tests.

This was causing a crash at startup in some cases.

ccordoba12 · 2023-12-29T13:26:31Z

@dalthviz, this is finally ready for review. It ended up being a big PR because I decided to migrate EditorMainWindow to the new API to allow users to close the Outline when working with it. I also expanded our test suite to cover the new functionality added here.

jitseniesen

I think there is one problem that needs to be addressed before this can be merged:

When the Outline pane is undocked, there is still an "Undock" action in its options menu, and clicking that leads to a core dump.

The rest is just feedback for your consideration:

I would change "Move to another position" to "Move", because moving something means moving it to another position. I don't think I have ever seen this spelled out in a menu.
I don't like that "Close" in options menu of undocked panes is different from the "Close" button. The latter sometimes hides and sometimes docks. But this seems a conscious decision on your part, so fair enough.
If I maximize the editor pane and then click on View > Window Layouts > Spyder default layout, the result is strange and kind of halfway between the maximized layout and the default layout. But this is probably not related to the PR.
Minor code comments.

spyder/utils/stylesheet.py

spyder/plugins/editor/widgets/window.py

- Also, remove unnecessary condition in test_undock_plugin_and_close and style from the app stylesheet.

Co-authored-by: Jitse Niesen <[email protected]>

This helps to have a more straightforward UI because "Move" means basically "Move to another position". And "Lock" means "Lock position".

Also, remove a couple of unneeded imports.

- We were not unmaximizing a possibly maximized plugin before the switch, which left the window in an inconsistent state. - We also need to reapply the dock tabbar style after the switch so the window looks as expected.

ccordoba12 · 2024-05-16T16:08:43Z

@jitseniesen, this is ready for another review. About your comments:

When the Outline pane is undocked, there is still an "Undock" action in its options menu, and clicking that leads to a core dump.

Thanks for noticing it. I was able to easily reproduce it and it should be fixed now.

I would change "Move to another position" to "Move", because moving something means moving it to another position. I don't think I have ever seen this spelled out in a menu.

Great suggestion! I implemented it in one of my last commits.

I don't like that "Close" in options menu of undocked panes is different from the "Close" button. The latter sometimes hides and sometimes docks. But this seems a conscious decision on your part, so fair enough.

We'll see what users think about this UX.

If I maximize the editor pane and then click on View > Window Layouts > Spyder default layout, the result is strange and kind of halfway between the maximized layout and the default layout. But this is probably not related to the PR.

Great catch! Although not related to the changes here (as you suspected), I took the opportunity to fix it as well.

jitseniesen

Looks good now, no further comments. Thanks!

ccordoba12 · 2024-05-25T12:12:58Z

Since the failure in our tests was already fixed by PR #22100, I'm going to merge this one.

ccordoba12 added this to the v5.4.0 milestone Oct 11, 2022

ccordoba12 requested a review from dalthviz October 11, 2022 04:34

ccordoba12 self-assigned this Oct 11, 2022

ccordoba12 added User Experience (UX) component:Main Window labels Oct 11, 2022

ccordoba12 mentioned this pull request Oct 11, 2022

PR: Greatly improve Outline performance and update it correctly when it becomes visible #19448

Merged

ccordoba12 force-pushed the make-close-and-dock-different branch from 47839a3 to 3fac4ac Compare October 12, 2022 16:35

ccordoba12 modified the milestones: v5.4.0, v5.4.1 Oct 18, 2022

ccordoba12 modified the milestones: v5.4.1, v6.0alpha1 Dec 6, 2022

ccordoba12 modified the milestones: v6.0alpha1, v6.0alpha2 Jun 8, 2023

ccordoba12 modified the milestones: v6.0alpha2, v6.0alpha3 Aug 4, 2023

ccordoba12 modified the milestones: v6.0alpha3, v6.0beta1 Nov 17, 2023

API: Restore undocked state when plugin is made visible

ab6b051

ccordoba12 added the type:Enhancement label Dec 23, 2023

ccordoba12 changed the base branch from 5.x to master December 23, 2023 15:10

ccordoba12 force-pushed the make-close-and-dock-different branch from 3fac4ac to 1fb9d8d Compare December 23, 2023 15:11

ccordoba12 added 3 commits December 28, 2023 12:13

API: Add the possibility to close undocked windows

bc4b011

- This allows users to show plugins directly undocked, i.e. without making them first visible but docked on the main window to then undock them. - Also, improve typing a bit.

API: Rename text of unlock action to easily distinguish it from "Undock"

1f643ff

ccordoba12 force-pushed the make-close-and-dock-different branch from e8c8146 to 3f8b7bf Compare December 28, 2023 17:18

ccordoba12 changed the title ~~[WIP] PR: Remember undocked state of plugins when closed~~ PR: Remember undocked state of plugins when closed and migrate EditorMainWindow to the new API Dec 28, 2023

ccordoba12 added the component:Editor label Dec 28, 2023

ccordoba12 changed the title ~~PR: Remember undocked state of plugins when closed and migrate EditorMainWindow to the new API~~ PR: Remember undocked state of plugins when closed, allow to close Outline when the Editor is maximized and migrate EditorMainWindow to the new API Dec 28, 2023

ccordoba12 force-pushed the make-close-and-dock-different branch from 3f8b7bf to 846e9e8 Compare December 28, 2023 18:21

ccordoba12 added 5 commits December 28, 2023 16:02

Editor: Hide splitter handle in EditorMainWindow when collpasing Outline

080ad88

- This preserves the checked state of new Outline action shown in the View menu. - It also removes the handle which looks like an extra and odd border in the window.

Main menu: Add singleton with the menubar stylesheet to its API

61f5fe2

- That way it can be used by other plugins or widgets. - Use it to set the menubar stylesheet of EditorMainWindow.

Testing: Check the behavior of Outline and toolbars in editor windows

fe613bc

- Also, fix failing tests for the Working directory.

Editor: Catch KeyError when getting toolbars/menus in EditorMainWindow

80ced8c

Also, check for the presence of splitter handler because it can't be available during tests.

Layout: Fix error when plugins required for tabification are unavailable

73e1022

This was causing a crash at startup in some cases.

ccordoba12 force-pushed the make-close-and-dock-different branch from 846e9e8 to 73e1022 Compare December 28, 2023 21:21

jitseniesen requested changes Feb 4, 2024

View reviewed changes

spyder/utils/stylesheet.py Outdated Show resolved Hide resolved

spyder/utils/stylesheet.py Outdated Show resolved Hide resolved

spyder/plugins/editor/widgets/window.py Outdated Show resolved Hide resolved

spyder/plugins/editor/widgets/window.py Outdated Show resolved Hide resolved

ccordoba12 removed the request for review from dalthviz February 5, 2024 00:45

ccordoba12 modified the milestones: v6.0alpha4, v6.0beta1 Feb 6, 2024

dalthviz mentioned this pull request Feb 16, 2024

PR: Initial Editor migration to the new API #21353

Merged

ccordoba12 modified the milestones: v6.0alpha5, v6.0beta1 Mar 12, 2024

ccordoba12 modified the milestones: v6.0beta1, v6.0beta2 May 10, 2024

ccordoba12 and others added 8 commits May 15, 2024 23:33

Merge branch 'master' into make-close-and-dock-different

f9de0fe

Editor: Fix creating editor windows after merge with master

da5976d

Testing: Fix test_editor_window_outline_and_toolbars

695c4c3

- Also, remove unnecessary condition in test_undock_plugin_and_close and style from the app stylesheet.

Apply suggestions from code review

11f671a

Co-authored-by: Jitse Niesen <[email protected]>

Variable Explorer: Fix rendering toolbars for its editors

f7653c8

API: Simplify text of lock_unlock_action

c36103a

This helps to have a more straightforward UI because "Move" means basically "Move to another position". And "Lock" means "Lock position".

Outline Explorer: Hide unnecessary actions when the plugin is undocked

369544d

Also, remove a couple of unneeded imports.

Layout: Fix visual glitches when switching layouts

1149dcf

- We were not unmaximizing a possibly maximized plugin before the switch, which left the window in an inconsistent state. - We also need to reapply the dock tabbar style after the switch so the window looks as expected.

jitseniesen approved these changes May 25, 2024

View reviewed changes

ccordoba12 merged commit 543dc35 into spyder-ide:master May 25, 2024
13 of 14 checks passed

ccordoba12 deleted the make-close-and-dock-different branch May 25, 2024 12:13

ccordoba12 added the type:Bug label May 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Remember undocked state of plugins when closed and allow to close Outline when the Editor is maximized or in an Editor window #19784

PR: Remember undocked state of plugins when closed and allow to close Outline when the Editor is maximized or in an Editor window #19784

ccordoba12 commented Oct 11, 2022 •

edited

ccordoba12 commented Oct 18, 2022

ccordoba12 commented Dec 29, 2023

jitseniesen left a comment

ccordoba12 commented May 16, 2024

jitseniesen left a comment

ccordoba12 commented May 25, 2024

PR: Remember undocked state of plugins when closed and allow to close Outline when the Editor is maximized or in an Editor window #19784

PR: Remember undocked state of plugins when closed and allow to close Outline when the Editor is maximized or in an Editor window #19784

Conversation

ccordoba12 commented Oct 11, 2022 • edited

Description of Changes

API changes

Visual changes

Issue(s) Resolved

Affirmation

ccordoba12 commented Oct 18, 2022

ccordoba12 commented Dec 29, 2023

jitseniesen left a comment

Choose a reason for hiding this comment

ccordoba12 commented May 16, 2024

jitseniesen left a comment

Choose a reason for hiding this comment

ccordoba12 commented May 25, 2024

ccordoba12 commented Oct 11, 2022 •

edited