PR: Remember undocked state of plugins when closed and allow to close Outline when the Editor is maximized or in an Editor window #19784
+930
−351
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ccordoba12
force-pushed
the
make-close-and-dock-different
branch
from
47839a3
to
3fac4ac
Compare
|
Leaving this for 5.4.1 so I can gather feedback from other devs during our developers meeting. |
ccordoba12
force-pushed
the
make-close-and-dock-different
branch
from
3fac4ac
to
1fb9d8d
Compare
- 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.
ccordoba12
force-pushed
the
make-close-and-dock-different
branch
from
e8c8146
to
3f8b7bf
Compare
ccordoba12
changed the title
EditorMainWindow to the new API
ccordoba12
changed the title
EditorMainWindow to the new APIEditorMainWindow to the new API
ccordoba12
force-pushed
the
make-close-and-dock-different
branch
from
3f8b7bf
to
846e9e8
Compare
ccordoba12
changed the title
…g system That allows to make persistent that state across Spyder sessions.
That will allow us to use it in other tests.
- Also, check the visibility of the Outline when shown with the maximized editor. - Fix test_no_update_outline because it was failing.
- Reduce their size to make them a bit smaller than the QMainWindow separators. That will help users to navigate our UI more easily. - Also, remove images of QMainWindow separators because they are not visible.
This will present to users the same UI as the one shown when the editor is maximized.
This will allow us to reuse those menus in other places they are needed.
- This will allow us to easily access them in other places. - Also, fix typing and improve code style in its container.
That way it'll be easier to create those kind of toolbars in other widgets.
This provides a very similar UX to the one users see when maximizing the editor in the main window.
- 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
force-pushed
the
make-close-and-dock-different
branch
from
846e9e8
to
73e1022
Compare
|
@dalthviz, this is finally ready for review. It ended up being a big PR because I decided to migrate |
jitseniesen
requested changes
Feb 4, 2024
There was a problem hiding this comment.
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.
| marginBottom='0px', | ||
| # This is summed to the separator padding (2px) | ||
| width="3px", | ||
| # The default iamge is not visiblw at this size |
There was a problem hiding this comment.
This comment has two typos and can also be written clearer.
Suggested change
| # The default iamge is not visiblw at this size | |
| # Hide image because the default image is not visible at this size |
| height='3px' | ||
| # This is summed to the separator padding (2px) | ||
| height='3px', | ||
| # The default iamge is not visiblw at this size |
There was a problem hiding this comment.
As above.
Suggested change
| # The default iamge is not visiblw at this size | |
| # Hide image because the default image is not visible at this size |
|
|
||
| # ---- Widgets | ||
| # ----------------------------------------------------------------------------- | ||
| class OutlineExplorerinEditorWindow(OutlineExplorerWidget): |
There was a problem hiding this comment.
Consistency in CamelCase capitalization.
Suggested change
| class OutlineExplorerinEditorWindow(OutlineExplorerWidget): | |
| class OutlineExplorerInEditorWindow(OutlineExplorerWidget): |
| self.outlineexplorer = None | ||
| if outline_plugin is not None: | ||
| self.outlineexplorer = OutlineExplorerWidget( | ||
| self.outlineexplorer = OutlineExplorerinEditorWindow( |
There was a problem hiding this comment.
As above.
Suggested change
| self.outlineexplorer = OutlineExplorerinEditorWindow( | |
| self.outlineexplorer = OutlineExplorerInEditorWindow( |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Changes
View > Panes, then it'll be automatically undocked when made visible again.Closeaction to the Options menu of undocked plugins, so that this new functionality can be more easily discovered by users.Closebutton of its window. This means that if users want to dock it again, they'll need to click on theDockaction of the respective plugin.EditorMainWindowto the new API.Unlock positionin the Options menu of plugins toMove to another position. This is becauseUnlockandUndockdiffer 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
SpyderMenuMixinto create main window menus. That allows to easily access and use them in other places (e.g. inEditorMainwindow).rendermethod ofSpyderToolbarpublic. This follows a similar change done forSpyderMenu.toolbar_idto the constructor ofApplicationToolbar. That allows to more easily create those toolbars.ACTION_REGISTRYto access them easily (e.g. for testing).Visual changes
New close when undocked functionality
New close action in undocked plugins
Changes in
EditorMainWindowIssue(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.