Feature request(?): more Keyboard shortcuts to switch focus

[BetterRed]

Originally Posted by KevinH

. . .
I have just now pushed to master the ability to use keyboard shortcuts (that you must assign in Sigil's Keyboard Preferences)

IMO that should be the practice for all newly created keyboard shortcuts… and I'm not just thinking of Sigil.

BR

[BeckyEbook]

Sure. They are simply helpful, although of course the user usually knows what shortcut they have called up

[BeckyEbook]

I have noticed that if sub-windows are merged (e.g. TOC + Book Browser or TOC + Clips) then the focus changes, but the called window is not switched to the foreground.
You can see this clearly in the attached screenshot.
The Book Browser is still visible, despite the change of focus to TOC.

[DiapDealer]

Tabbified qdockwidgets have always behaved with a mind of their own.

[KevinH]

Yes I am seeing the same thing on macOS. Not sure how to detect if QDockWidget is tabbified and not the front tab.

Will try to see if there is any solution.

[BeckyEbook]

I did a trial and raise() seems sufficient.
It doesn't need to be added to the Code View, as no other widgets can be added to this window.

void MainWindow::FocusOnBookBrowser()
{
    FocusOn(m_BookBrowser);
    m_BookBrowser->FocusOnBookBrowser();
    m_BookBrowser->raise();
    ShowMessageOnStatusBar(tr("Focus changed to BookBrowser window."));
}

void MainWindow::FocusOnPreview()
{
    FocusOn(m_PreviewWindow);
    m_PreviewWindow->SetFocusOnPreview();
    m_PreviewWindow->raise();
    ShowMessageOnStatusBar(tr("Focus changed to Preview window."));
}

void MainWindow::FocusOnTOC()
{
    FocusOn(m_TableOfContents);
    m_TableOfContents->SetFocusOnTOC();
    m_TableOfContents->raise();
    ShowMessageOnStatusBar(tr("Focus changed to Table Of Contents window."));
}

void MainWindow::FocusOnClips()
{
    FocusOn(m_Clips);
    m_Clips->SetFocusOnClips();
    m_Clips->raise();
    ShowMessageOnStatusBar(tr("Focus changed to Clips window."));
}

[KevinH]

Sounds good. I am away from my dev machine. Please create a PR and I will merge it, or I will make that change on Monday when I am back home.

[DiapDealer]

There's an .isTabified property I think. But if raise() is not going to trigger anything unnecessary, checking the property before doing so is probably overkill.

[BeckyEbook]

I checked via Debug that the widget can be checked for visibility before raise().
When the widget is in the foreground then raise() will not be called.

So an extra test shouldn't hurt, here an example:

void MainWindow::FocusOnTOC()
{
    FocusOn(m_TableOfContents);
    m_TableOfContents->SetFocusOnTOC();
    DBG qDebug() << "Focus";
    if (m_TableOfContents->visibleRegion().isEmpty()) {
        DBG qDebug() << "Here raise";
        m_TableOfContents->raise();
    }
    ShowMessageOnStatusBar(tr("Focus changed to Table Of Contents window."));
}

[recook]

Hi,

one more niggling detail:
When the Find dialog has found a match and displays it in the Code view, oftentimes i want to focus the match and edit there.

For example, in building an ebook,
i collected a bunch of web pages,
named them s\d+.xhtml (numbered),
and have a list of original URLs as TOC (keeping a copy as Refernce page),
which i then replace (via regex) with s1.xhtml.
Next, i scan for "s1 and want to edit the matches to change the numbers.

It would be nice if a found match would focus there.
But it's no big thing, i can Focus the Code view, and it's just one shortcut more to type.

[BeckyEbook]

I don't know if I'm understanding you correctly, but you want to search for something, and after the search the focus is supposed to remain in the Find box?

If so then your request is the opposite of the approach in Sigil.
Find&Replace should not steal focus. [link]

If you want to edit your search then you'd better get used to that extra Ctrl+F though.

[recook]

Hi,

indeed not, i'm sorry.

Once more, unto the breach:
I type ^F, then (in my example) the three characters "s1 into the find text field, then either click Find or type ^F again to find. When a match is found, i can (with the new Focus shortcuts - thanks @DiapDealer!) type the new shortcut to focus the Codeview to edit the match.
If Find would directly focus Codeview when a match is found, that last focus action wouldn't be necessary.

Actually, i never even got the Idea to

After typing what you want in the find field, instead of clicking enter or hitting the Find button click in the main CodeView window once, then hit Find.

from the link you referenced, much less experienced that focus stealing.

[BeckyEbook]

Wait, wait...
You mean to say that in version 2.0.2, after searching for something, the focus does not jump to Code View and remains in F&R?

Ctrl-F in F&R does not result in a search, Find button should jump to Code View.

[KevinH]

Well it seems with multiple main windows on macOS, the visibleRegion().isEmpty() test failed sometimes and so no raise was done but needed.

I think the safest way to handle this is to use raise() called immediately after FocusOn call and before the specific internal subwidget is given focus. This should not hurt anything and works on macOS as well.

I also added a nullptr check for each to make sure the QDockWidget in question has not been deleted yet for safety in case someone deletes a main Window and shortcut keys or key events are waiting to be flushed out. This is more of a concern on macOS with its multiple main windows but is safer for everyone.

I have pushed this master. If you get a chance please make sure I have not hurt anything on Windows. It should all be okay but just to make sure.

I think with this change, we should consider this new feature as complete.

Glad people find it useful.

KevinH

Originally Posted by BeckyEbook

I checked via Debug that the widget can be checked for visibility before raise().
When the widget is in the foreground then raise() will not be called.

So an extra test shouldn't hurt, here an example:

void MainWindow::FocusOnTOC()
{
    FocusOn(m_TableOfContents);
    m_TableOfContents->SetFocusOnTOC();
    DBG qDebug() << "Focus";
    if (m_TableOfContents->visibleRegion().isEmpty()) {
        DBG qDebug() << "Here raise";
        m_TableOfContents->raise();
    }
    ShowMessageOnStatusBar(tr("Focus changed to Table Of Contents window."));
}

[BeckyEbook]

I have built a new Sigil, I will check the focus switching during normal use of the application.
In short tests on Windows 10 Pro, everything looks good.
Thank you!