Concentrate all focus handling in this class. More...

#include <FocusManager.hxx>

Collaboration diagram for sfx2::sidebar::FocusManager:

Classes
class	FocusLocation

Public Member Functions
	FocusManager (std::function< void(const Panel &)> aShowPanelFunctor)

	~FocusManager ()

void	Clear ()
	Forget all panels and buttons. More...

void	GrabFocus ()
	Transfer the focus into the sidebar tree of windows. More...

void	GrabFocusPanel ()

void	SetDeck (Deck *pDeck)

void	SetPanels (const SharedPanelContainer &rPanels)

void	SetButtons (const std::vector< weld::Widget * > &rButtons)

Private Types
enum	PanelComponent { PC_DeckToolBox , PC_PanelTitle , PC_PanelToolBox , PC_PanelContent , PC_TabBar , PC_None }

Private Member Functions
	DECL_LINK (KeyInputHdl, const KeyEvent &, bool)
	Listen for key events for panels and buttons. More...

void	ClearPanels ()

void	ClearButtons ()

void	RegisterWindow (weld::Widget &rWidget)
	Let the focus manager listen for window events for the given window. More...

void	FocusDeckTitle ()

bool	IsDeckTitleVisible () const

bool	IsPanelTitleVisible (const sal_Int32 nPanelIndex) const

void	FocusPanel (const sal_Int32 nPanelIndex, const bool bFallbackToDeckTitle)
	Set the focus to the title bar of the panel or, if the title bar is not visible, directly to the panel. More...

void	FocusPanelContent (const sal_Int32 nPanelIndex)

void	FocusButton (const sal_Int32 nButtonIndex)

void	MoveFocusInsidePanel (const FocusLocation &rLocation, const sal_Int32 nDirection)

bool	MoveFocusInsideDeckTitle (const FocusLocation &rLocation, const sal_Int32 nDirection)

bool	HandleKeyEvent (const vcl::KeyCode &rKeyCode, const FocusLocation &rLocation)

FocusLocation	GetFocusLocation () const

Static Private Member Functions
static void	UnregisterWindow (weld::Widget &rWidget)

Private Attributes
VclPtr< Deck >	mxDeck

DeckTitleBar *	mpDeckTitleBar

SharedPanelContainer	maPanels

std::vector< weld::Widget * >	maButtons

const std::function< void(const Panel &)>	maShowPanelFunctor

Detailed Description

Concentrate all focus handling in this class.

There is one ring of windows that accept the input focus which are cycled through with the arrow keys:

the closer in the deck title (present only when docked)
the panel title bars
the tab bar items

When the focus is in a panel title then focus travels over

the panel title
the panel closer
the panel content

Once the focus is in the panel content then focus cycles through all controls inside the panel but not back to the title bar of the panel. Escape places the focus back in the panel title.

Definition at line 50 of file FocusManager.hxx.

Member Enumeration Documentation

◆ PanelComponent

enum sfx2::sidebar::FocusManager::PanelComponent

private

Enumerator
PC_DeckToolBox
PC_PanelTitle
PC_PanelToolBox
PC_PanelContent
PC_TabBar
PC_None

Definition at line 78 of file FocusManager.hxx.

Constructor & Destructor Documentation

◆ FocusManager()

sfx2::sidebar::FocusManager::FocusManager ( std::function< void(const Panel &)> aShowPanelFunctor )

Definition at line 39 of file FocusManager.cxx.

◆ ~FocusManager()

sfx2::sidebar::FocusManager::~FocusManager ( )

Definition at line 45 of file FocusManager.cxx.

References Clear().

Member Function Documentation

◆ Clear()

void sfx2::sidebar::FocusManager::Clear ( )

Forget all panels and buttons.

Remove all window listeners.

Definition at line 60 of file FocusManager.cxx.

References ClearButtons(), ClearPanels(), and SetDeck().

Referenced by sfx2::sidebar::SidebarController::disposeDecks(), sfx2::sidebar::SidebarController::disposing(), sfx2::sidebar::SidebarController::SwitchToDeck(), sfx2::sidebar::SidebarController::UpdateConfigurations(), and ~FocusManager().

◆ ClearButtons()

void sfx2::sidebar::FocusManager::ClearButtons ( )

private

Definition at line 84 of file FocusManager.cxx.

References maButtons, and UnregisterWindow().

Referenced by Clear(), and SetButtons().

◆ ClearPanels()

void sfx2::sidebar::FocusManager::ClearPanels ( )

private

Definition at line 67 of file FocusManager.cxx.

References maPanels, and UnregisterWindow().

Referenced by Clear(), and SetPanels().

◆ DECL_LINK()

sfx2::sidebar::FocusManager::DECL_LINK	(	KeyInputHdl	,
		const KeyEvent &	,
		bool
	)

private

Listen for key events for panels and buttons.

◆ FocusButton()

void sfx2::sidebar::FocusManager::FocusButton ( const sal_Int32 nButtonIndex )

private

Definition at line 253 of file FocusManager.cxx.

References maButtons.

Referenced by HandleKeyEvent().

◆ FocusDeckTitle()

void sfx2::sidebar::FocusManager::FocusDeckTitle ( )

private

Definition at line 175 of file FocusManager.cxx.

References FocusPanel(), weld::Toolbar::get_n_items(), sfx2::sidebar::TitleBar::GetToolBox(), weld::Widget::grab_focus(), and mpDeckTitleBar.

Referenced by FocusPanel(), GrabFocus(), and HandleKeyEvent().

◆ FocusPanel()

void sfx2::sidebar::FocusManager::FocusPanel	(	const sal_Int32	nPanelIndex,
		const bool	bFallbackToDeckTitle
	)

private

Set the focus to the title bar of the panel or, if the title bar is not visible, directly to the panel.

Parameters

nPanelIndex	Index of the panel to focus.
bFallbackToDeckTitle	When the panel title bar is not visible then The fallback bias defines whether to focus the deck (true) or the panel content (false) will be focused instead.

Definition at line 207 of file FocusManager.cxx.

References FocusDeckTitle(), FocusPanelContent(), sfx2::sidebar::PanelTitleBar::GetExpander(), sfx2::sidebar::Panel::GetTitleBar(), sfx2::sidebar::TitleBar::GetVisible(), weld::Widget::grab_focus(), IsDeckTitleVisible(), o3tl::make_unsigned(), maPanels, maShowPanelFunctor, and sfx2::sidebar::Panel::SetExpanded().