LibreOffice Module sfx2 (master) 1
Static Public Member Functions | List of all members
sfx2::sidebar::Sidebar Class Reference

Accept requests for switching to certain panels or decks. More...

#include <Sidebar.hxx>

Static Public Member Functions

static void ShowDeck (std::u16string_view rsDeckId, SfxViewFrame *pViewFrame, bool bToggle)
 
static void ShowPanel (std::u16string_view rsPanelId, const css::uno::Reference< css::frame::XFrame > &rxFrame, bool bFocus=false)
 Switch to the deck that contains the specified panel and make sure that the panel is visible (expanded and scrolled into the visible area.) Note that most of the work is done asynchronously and that this function probably returns before the requested panel is visible. More...
 
static void TogglePanel (std::u16string_view rsPanelId, const css::uno::Reference< css::frame::XFrame > &rxFrame)
 Switch to the deck that contains the specified panel and toggle the visibility of the panel (expanded and scrolled into the visible area when visible) Note that most of the work is done asynchronously and that this function probably returns before the requested panel is visible. More...
 
static bool IsPanelVisible (std::u16string_view rsPanelId, const css::uno::Reference< css::frame::XFrame > &rxFrame)
 

Detailed Description

Accept requests for switching to certain panels or decks.

Definition at line 35 of file Sidebar.hxx.

Member Function Documentation

◆ IsPanelVisible()

bool sfx2::sidebar::Sidebar::IsPanelVisible ( std::u16string_view  rsPanelId,
const css::uno::Reference< css::frame::XFrame > &  rxFrame 
)
static

◆ ShowDeck()

void sfx2::sidebar::Sidebar::ShowDeck ( std::u16string_view  rsDeckId,
SfxViewFrame pViewFrame,
bool  bToggle 
)
static

◆ ShowPanel()

void sfx2::sidebar::Sidebar::ShowPanel ( std::u16string_view  rsPanelId,
const css::uno::Reference< css::frame::XFrame > &  rxFrame,
bool  bFocus = false 
)
static

Switch to the deck that contains the specified panel and make sure that the panel is visible (expanded and scrolled into the visible area.) Note that most of the work is done asynchronously and that this function probably returns before the requested panel is visible.

Definition at line 64 of file Sidebar.cxx.

References sfx2::sidebar::SidebarController::GetFocusManager(), sfx2::sidebar::ResourceManager::GetPanelDescriptor(), sfx2::sidebar::SidebarController::GetResourceManager(), sfx2::sidebar::SidebarController::GetSidebarControllerForFrame(), sfx2::sidebar::FocusManager::GrabFocusPanel(), and sfx2::sidebar::SidebarController::OpenThenSwitchToDeck().

Referenced by SfxViewFrame::ChildWindowExecute().

◆ TogglePanel()

void sfx2::sidebar::Sidebar::TogglePanel ( std::u16string_view  rsPanelId,
const css::uno::Reference< css::frame::XFrame > &  rxFrame 
)
static

Switch to the deck that contains the specified panel and toggle the visibility of the panel (expanded and scrolled into the visible area when visible) Note that most of the work is done asynchronously and that this function probably returns before the requested panel is visible.

Definition at line 89 of file Sidebar.cxx.

References sfx2::sidebar::ResourceManager::GetPanelDescriptor(), sfx2::sidebar::SidebarController::GetResourceManager(), sfx2::sidebar::SidebarController::GetSidebarControllerForFrame(), and sfx2::sidebar::SidebarController::OpenThenToggleDeck().


The documentation for this class was generated from the following files: