LibreOffice Module sd (master) 1
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
sd::ViewShellBase Class Reference

SfxViewShell descendant that the stacked Draw/Impress shells are based on. More...

#include <ViewShellBase.hxx>

Inheritance diagram for sd::ViewShellBase:
[legend]
Collaboration diagram for sd::ViewShellBase:
[legend]

Classes

class  Implementation
 

Public Member Functions

 ViewShellBase (SfxViewFrame &rFrame, SfxViewShell *pOldShell)
 This constructor is used by the view factory of the SFX macros. More...
 
virtual ~ViewShellBase () override
 In this destructor the order in which some of the members are destroyed (and/or being prepared to being destroyed) is important. More...
 
void LateInit (const OUString &rsDefaultView)
 This method is part of the object construction. More...
 
std::shared_ptr< ViewShellManager > const & GetViewShellManager () const
 
std::shared_ptr< ViewShellGetMainViewShell () const
 Return the main view shell stacked on the called ViewShellBase object. More...
 
DrawDocShellGetDocShell () const
 
SdDrawDocumentGetDocument () const
 
virtual void Execute (SfxRequest &rRequest)
 Callback function for general slot calls. More...
 
void GetState (SfxItemSet &rSet)
 Callback function for retrieving item values related to certain slots. More...
 
virtual OUString GetSelectionText (bool=false, bool bOnlyASample=false) override
 
virtual bool HasSelection (bool=true) const override
 
SvBorder GetBorder (bool bOuterResize)
 
virtual void InnerResizePixel (const Point &rOrigin, const Size &rSize, bool inplaceEditModeChange) override
 
virtual void OuterResizePixel (const Point &rOrigin, const Size &rSize) override
 
virtual ErrCode DoVerb (sal_Int32 nVerb) override
 This call is forwarded to the main sub-shell. More...
 
virtual css::uno::Reference< css::view::XRenderable > GetRenderable () override
 Return a new renderer that can be used for example for printing the document. More...
 
virtual SfxPrinterGetPrinter (bool bCreate=false) override
 Forwarded to the print manager. More...
 
virtual sal_uInt16 SetPrinter (SfxPrinter *pNewPrinter, SfxPrinterChangeFlags nDiffFlags=SFX_PRINTER_ALL) override
 Forwarded to the print manager. More...
 
virtual void WriteUserDataSequence (css::uno::Sequence< css::beans::PropertyValue > &) override
 Forward methods to main sub shell. More...
 
virtual void ReadUserDataSequence (const css::uno::Sequence< css::beans::PropertyValue > &) override
 Pass the given properties to the main view shell. More...
 
virtual void UIActivating (SfxInPlaceClient *) override
 
virtual void UIDeactivated (SfxInPlaceClient *) override
 
virtual void Activate (bool IsMDIActivate) override
 
virtual void SetZoomFactor (const Fraction &rZoomX, const Fraction &rZoomY) override
 
virtual bool PrepareClose (bool bUI=true) override
 
virtual void WriteUserData (OUString &, bool bBrowse=false) override
 
virtual void ReadUserData (const OUString &, bool bBrowse=false) override
 
virtual SdrViewGetDrawView () const override
 
void SetBusyState (bool bBusy)
 When <TRUE> is given, then the mouse shape is set to hour glass (or whatever the busy shape looks like on the system.) More...
 
void Rearrange ()
 Call this method when the controls of this view shell or the embedded sub shell need to be rearranged. More...
 
void UpdateBorder (bool bForce=false)
 Update the border that is set with SfxViewShell::SetBorderPixel(). More...
 
void ShowUIControls (bool bVisible)
 With this method the UI controls can be turned on or off. More...
 
std::shared_ptr< tools::EventMultiplexer > const & GetEventMultiplexer () const
 Return an event multiplexer. More...
 
const ::tools::RectanglegetClientRectangle () const
 returns the complete area of the current view relative to the frame window More...
 
std::shared_ptr< ToolBarManager > const & GetToolBarManager () const
 
std::shared_ptr< FormShellManager > const & GetFormShellManager () const
 
DrawControllerGetDrawController () const
 
void SetViewTabBar (const ::rtl::Reference< ViewTabBar > &rViewTabBar)
 
vcl::WindowGetViewWindow ()
 Return the window that is used by the main view shell to display its view and other UI elements, like scroll bars and rulers. More...
 
OUString RetrieveLabelFromCommand (const OUString &aCmdURL) const
 returns the ui descriptive name for the given uno slot. More...
 
int getPart () const override
 See SfxViewShell::getPart(). More...
 
int getEditMode () const override
 See SfxViewShell::getEditMode(). More...
 
void setEditMode (int nMode)
 See SfxViewShell::setEditMode(). More...
 
void afterCallbackRegistered () override
 See SfxViewShell::afterCallbackRegistered(). More...
 
void NotifyCursor (SfxViewShell *pViewShell) const override
 See SfxViewShell::NotifyCursor(). More...
 
::Color GetColorConfigColor (svtools::ColorConfigEntry nColorType) const override
 See SfxViewShell::GetColorConfigColor(). More...
 
OUString GetColorConfigName () const override
 See SfxViewShell::GetColorConfigName(). More...
 
void setLOKVisibleArea (const ::tools::Rectangle &rArea)
 
virtual ::tools::Rectangle getLOKVisibleArea () const override
 
virtual void Deactivate (bool IsMDIActivate) override
 
- Public Member Functions inherited from SfxViewShell
 SfxViewShell (SfxViewFrame &rFrame, SfxViewShellFlags nFlags)
 
virtual ~SfxViewShell () override
 
SfxInPlaceClientGetIPClient () const
 
SfxInPlaceClientGetUIActiveClient () const
 
SfxInPlaceClientFindIPClient (const css::uno::Reference< css::embed::XEmbeddedObject > &xObj, vcl::Window *pObjParentWin) const
 
virtual ErrCode DoVerb (sal_Int32 nVerb)
 
void OutplaceActivated (bool bActive)
 
virtual void UIActivating (SfxInPlaceClient *pClient)
 
virtual void UIDeactivated (SfxInPlaceClient *pClient)
 
void JumpToMark (const OUString &rMark)
 
void VisAreaChanged ()
 
virtual bool PrepareClose (bool bUI=true)
 
virtual OUString GetSelectionText (bool bCompleteWords=false, bool bOnlyASample=false)
 
virtual bool HasSelection (bool bText=true) const
 
virtual SdrViewGetDrawView () const
 
void AddSubShell (SfxShell &rShell)
 
void RemoveSubShell (SfxShell *pShell=nullptr)
 
SfxShellGetSubShell (sal_uInt16)
 
virtual SfxShellGetFormShell ()
 
virtual const SfxShellGetFormShell () const
 
virtual void notifyWindow (vcl::LOKWindowId nLOKWindowId, const OUString &rAction, const std::vector< vcl::LOKPayloadItem > &rPayload=std::vector< vcl::LOKPayloadItem >()) const override
 
virtual void ShowCursor (bool bOn=true)
 
virtual bool KeyInput (const KeyEvent &rKeyEvent)
 
bool Escape ()
 
vcl::WindowGetWindow () const
 
weld::WindowGetFrameWeld () const
 
void SetWindow (vcl::Window *pViewPort)
 
const SvBorderGetBorderPixel () const
 
void SetBorderPixel (const SvBorder &rBorder)
 
void InvalidateBorder ()
 
SfxViewFrameGetViewFrame () const
 
virtual SfxPrinterGetPrinter (bool bCreate=false)
 
virtual sal_uInt16 SetPrinter (SfxPrinter *pNewPrinter, SfxPrinterChangeFlags nDiffFlags=SFX_PRINTER_ALL)
 
virtual bool HasPrintOptionsPage () const
 
virtual std::unique_ptr< SfxTabPageCreatePrintOptionsPage (weld::Container *pPage, weld::DialogController *pController, const SfxItemSet &rOptions)
 
PrinterGetActivePrinter () const
 
virtual void WriteUserData (OUString &, bool bBrowse=false)
 
virtual void ReadUserData (const OUString &, bool bBrowse=false)
 
virtual void WriteUserDataSequence (css::uno::Sequence< css::beans::PropertyValue > &)
 
virtual void ReadUserDataSequence (const css::uno::Sequence< css::beans::PropertyValue > &)
 
virtual void QueryObjAreaPixel (tools::Rectangle &rRect) const
 
virtual SfxObjectShellGetObjectShell () override
 
virtual css::uno::Reference< css::frame::XModel > GetCurrentDocument () const
 
void SetCurrentDocument () const
 
virtual css::uno::Reference< css::view::XRenderable > GetRenderable ()
 
virtual void MarginChanged ()
 
const SizeGetMargin () const
 
void SetMargin (const Size &)
 
void DisconnectAllClients ()
 
bool NewWindowAllowed () const
 
void SetNewWindowAllowed (bool bSet)
 
void SetController (SfxBaseController *pController)
 
css::uno::Reference< css::frame::XController > GetController () const
 
bool TryContextMenuInterception (const rtl::Reference< VCLXPopupMenu > &rIn, const OUString &rMenuIdentifier, rtl::Reference< VCLXPopupMenu > &rOut, css::ui::ContextMenuExecuteEvent aEvent)
 
bool TryContextMenuInterception (const rtl::Reference< VCLXPopupMenu > &, const OUString &rMenuIdentifier, css::ui::ContextMenuExecuteEvent aEvent)
 
void ExecPrint (const css::uno::Sequence< css::beans::PropertyValue > &, bool, bool)
 
void StartPrint (const css::uno::Sequence< css::beans::PropertyValue > &, bool, bool)
 
const std::shared_ptr< vcl::PrinterController > & GetPrinterController () const
 
void AddRemoveClipboardListener (const css::uno::Reference< css::datatransfer::clipboard::XClipboardListener > &, bool)
 
css::uno::Reference< css::datatransfer::clipboard::XClipboardNotifier > GetClipboardNotifier () const
 
SAL_DLLPRIVATE SfxInPlaceClientGetUIActiveIPClient_Impl () const
 
SAL_DLLPRIVATE void AddContextMenuInterceptor_Impl (const css::uno::Reference< css::ui::XContextMenuInterceptor > &xInterceptor)
 
SAL_DLLPRIVATE void RemoveContextMenuInterceptor_Impl (const css::uno::Reference< css::ui::XContextMenuInterceptor > &xInterceptor)
 
SAL_DLLPRIVATE bool GlobalKeyInput_Impl (const KeyEvent &rKeyEvent)
 
SAL_DLLPRIVATE void NewIPClient_Impl (SfxInPlaceClient *pIPClient)
 
SAL_DLLPRIVATE void IPClientGone_Impl (SfxInPlaceClient const *pIPClient)
 
SAL_DLLPRIVATE void ResetAllClients_Impl (SfxInPlaceClient const *pIP)
 
SAL_DLLPRIVATE void SetPrinter_Impl (VclPtr< SfxPrinter > &pNewPrinter)
 
SAL_DLLPRIVATE bool HandleNotifyEvent_Impl (NotifyEvent const &rEvent)
 
SAL_DLLPRIVATE bool HasKeyListeners_Impl () const
 
SAL_DLLPRIVATE bool HasMouseClickListeners_Impl () const
 
SAL_DLLPRIVATE SfxBaseControllerGetBaseController_Impl () const
 
SAL_DLLPRIVATE void ExecPrint_Impl (SfxRequest &)
 
SAL_DLLPRIVATE void ExecMisc_Impl (SfxRequest &)
 
SAL_DLLPRIVATE void GetState_Impl (SfxItemSet &)
 
SAL_DLLPRIVATE void CheckIPClient_Impl (SfxInPlaceClient const *, const tools::Rectangle &)
 
SAL_DLLPRIVATE void PushSubShells_Impl (bool bPush=true)
 
SAL_DLLPRIVATE void PopSubShells_Impl ()
 
SAL_DLLPRIVATE bool ExecKey_Impl (const KeyEvent &aKey)
 
void setLibreOfficeKitViewCallback (SfxLokCallbackInterface *pCallback)
 
SfxLokCallbackInterfacegetLibreOfficeKitViewCallback () const
 
void dumpLibreOfficeKitViewState (rtl::OStringBuffer &rState)
 
virtual void libreOfficeKitViewCallback (int nType, const OString &pPayload) const override
 
virtual void libreOfficeKitViewCallbackWithViewId (int nType, const OString &pPayload, int nViewId) const override
 
virtual void libreOfficeKitViewInvalidateTilesCallback (const tools::Rectangle *pRect, int nPart, int nMode) const override
 
virtual void libreOfficeKitViewUpdatedCallback (int nType) const override
 
virtual void libreOfficeKitViewUpdatedCallbackPerViewId (int nType, int nViewId, int nSourceViewId) const override
 
virtual void flushPendingLOKInvalidateTiles ()
 
virtual void libreOfficeKitViewAddPendingInvalidateTiles () override
 
virtual std::optional< OString > getLOKPayload (int nType, int nViewId) const
 
void setTiledSearching (bool bTiledSearching)
 
virtual int getPart () const
 
virtual int getEditMode () const
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
ViewShellId GetViewShellId () const override
 
ViewShellDocId GetDocId () const override
 
virtual void notifyInvalidation (tools::Rectangle const *) const override
 
void NotifyOtherViews (int nType, const OString &rKey, const OString &rPayload) override
 
void NotifyOtherView (OutlinerViewShell *pOtherShell, int nType, const OString &rKey, const OString &rPayload) override
 
virtual void NotifyCursor (SfxViewShell *) const
 
virtual void afterCallbackRegistered ()
 
virtual vcl::WindowGetEditWindowForActiveOLEObj () const override
 
virtual ::Color GetColorConfigColor (svtools::ColorConfigEntry nColorType) const
 
virtual OUString GetColorConfigName () const
 
void SetLOKLanguageTag (const OUString &rBcp47LanguageTag)
 
const LanguageTagGetLOKLanguageTag () const
 
void SetLOKAccessibilityState (bool bEnabled)
 
std::pair< bool, OUString > GetLOKTimezone () const
 
void SetLOKTimezone (bool isSet, const OUString &rTimezone)
 
void SetLOKLocale (const OUString &rBcp47LanguageTag)
 
const LanguageTagGetLOKLocale () const
 
LOKDeviceFormFactor GetLOKDeviceFormFactor () const
 
bool isLOKDesktop () const
 
bool isLOKTablet () const
 
bool isLOKMobilePhone () const
 
virtual tools::Rectangle getLOKVisibleArea () const
 
void setBlockedCommandList (const char *blockedCommandList)
 
bool isBlockedCommand (OUString command)
 
void SetStoringHelper (std::shared_ptr< SfxStoringHelper > xHelper)
 
StylesHighlighterColorMapGetStylesHighlighterParaColorMap ()
 
StylesHighlighterColorMapGetStylesHighlighterCharColorMap ()
 
OUString getA11yFocusedParagraph () const
 
int getA11yCaretPosition () const
 
- Public Member Functions inherited from SfxShell
virtual ~SfxShell () override
 
virtual SfxInterfaceGetInterface () const
 
void SetName (const OUString &rName)
 
const OUString & GetName () const
 
SfxViewShellGetViewShell () const
 
const SfxPoolItemGetSlotState (sal_uInt16 nSlotId, const SfxInterface *pIF=nullptr, SfxItemSet *pStateSet=nullptr)
 
const SfxPoolItemExecuteSlot (SfxRequest &rReq, const SfxInterface *pIF=nullptr)
 
void ExecuteSlot (SfxRequest &rReq, bool bAsync)
 
SfxItemPoolGetPool () const
 
void SetPool (SfxItemPool *pNewPool)
 
virtual SfxUndoManagerGetUndoManager ()
 
void SetUndoManager (SfxUndoManager *pNewUndoMgr)
 
SfxRepeatTarget * GetRepeatTarget () const
 
void SetRepeatTarget (SfxRepeatTarget *pTarget)
 
virtual void Invalidate (sal_uInt16 nId=0)
 
virtual bool IsDesignMode () const
 
bool IsActive () const
 
virtual void Activate (bool bMDI)
 
virtual void Deactivate (bool bMDI)
 
SfxDispatcherGetDispatcher () const
 
SfxViewFrameGetFrame () const
 
virtual bool HasUIFeature (SfxShellFeature nFeature) const
 
void UIFeatureChanged ()
 
const SfxPoolItemGetItem (sal_uInt16 nSlotId) const
 
const T * GetItem (TypedWhichId< T > nWhich) const
 
void PutItem (const SfxPoolItem &rItem)
 
void SetVerbs (const css::uno::Sequence< css::embed::VerbDescriptor > &aVerbs)
 
const css::uno::Sequence< css::embed::VerbDescriptor > & GetVerbs () const
 
void VerbExec (SfxRequest &)
 
SAL_DLLPRIVATE const SfxSlotGetVerbSlot_Impl (sal_uInt16 nId) const
 
virtual SfxObjectShellGetObjectShell ()
 
void SetDisableFlags (SfxDisableFlags nFlags)
 
SfxDisableFlags GetDisableFlags () const
 
virtual std::optional< SfxItemSetCreateItemSet (sal_uInt16 nId)
 
virtual void ApplyItemSet (sal_uInt16 nId, const SfxItemSet &rSet)
 
void SetContextName (const OUString &rsContextName)
 
void BroadcastContextForActivation (const bool bIsActivated)
 
bool SetContextBroadcasterEnabled (const bool bIsEnabled)
 
SAL_DLLPRIVATE bool CanExecuteSlot_Impl (const SfxSlot &rSlot)
 
virtual bool IsConditionalFastCall (const SfxRequest &rReq)
 
SAL_DLLPRIVATE void DoActivate_Impl (SfxViewFrame *pFrame, bool bMDI)
 
SAL_DLLPRIVATE void DoDeactivate_Impl (SfxViewFrame const *pFrame, bool bMDI)
 

Static Public Member Functions

static ViewShellBaseGetViewShellBase (SfxViewFrame const *pFrame)
 When given a view frame this static method returns the corresponding sd::ViewShellBase object. More...
 
- Static Public Member Functions inherited from SfxViewShell
static SAL_WARN_UNUSED_RESULT SfxViewShellGetFirst (bool bOnlyVisible=true, const std::function< bool(const SfxViewShell *)> &isViewShell=nullptr)
 
static SAL_WARN_UNUSED_RESULT SfxViewShellGetNext (const SfxViewShell &rPrev, bool bOnlyVisible=true, const std::function< bool(const SfxViewShell *)> &isViewShell=nullptr)
 
static SAL_WARN_UNUSED_RESULT SfxViewShellCurrent ()
 
static SAL_WARN_UNUSED_RESULT SfxViewShellGet (const css::uno::Reference< css::frame::XController > &i_rController)
 
static void SetCurrentDocId (ViewShellDocId nId)
 
- Static Public Member Functions inherited from SfxShell
static SfxInterfaceGetStaticInterface ()
 
static void EmptyExecStub (SfxShell *pShell, SfxRequest &)
 
static void EmptyStateStub (SfxShell *pShell, SfxItemSet &)
 
static void VerbState (SfxItemSet &)
 

Protected Member Functions

virtual void Notify (SfxBroadcaster &rBC, const SfxHint &rHint) override
 
virtual void InitializeFramework ()
 
- Protected Member Functions inherited from SfxViewShell
virtual void Activate (bool IsMDIActivate) override
 
virtual void Deactivate (bool IsMDIActivate) override
 
virtual void InnerResizePixel (const Point &rOfs, const Size &rSize, bool inplaceEditModeChange)
 
virtual void OuterResizePixel (const Point &rOfs, const Size &rSize)
 
virtual void SetZoomFactor (const Fraction &rZoomX, const Fraction &rZoomY)
 
virtual void Move ()
 
virtual void Notify (SfxBroadcaster &rBC, const SfxHint &rHint) override
 
- Protected Member Functions inherited from SfxShell
 SfxShell ()
 
 SfxShell (SfxViewShell *pViewSh)
 
void SetViewShell_Impl (SfxViewShell *pView)
 
SAL_DLLPRIVATE void Invalidate_Impl (SfxBindings &rBindings, sal_uInt16 nId)
 

Private Member Functions

OUString GetInitialViewShellType () const
 Determine from the properties of the document shell the initial type of the view shell in the center pane. More...
 

Static Private Member Functions

static void InitInterface_Impl ()
 SfxInterface initializer. More...
 

Private Attributes

std::unique_ptr< ImplementationmpImpl
 
DrawDocShellmpDocShell
 
SdDrawDocumentmpDocument
 
::tools::Rectangle maLOKVisibleArea
 

Additional Inherited Members

- Static Protected Member Functions inherited from SfxShell
static void HandleOpenXmlFilterSettings (SfxRequest &)
 

Detailed Description

SfxViewShell descendant that the stacked Draw/Impress shells are based on.

The "base" part of the name does not mean that this is a base class of some class hierarchy. It rather is the base of the stacked shells.

This class starts as a new and relatively small class. Over time as much code as possible should be moved from the stacked shells to this class.

Definition at line 54 of file ViewShellBase.hxx.

Constructor & Destructor Documentation

◆ ViewShellBase()

sd::ViewShellBase::ViewShellBase ( SfxViewFrame rFrame,
SfxViewShell pOldShell 
)

This constructor is used by the view factory of the SFX macros.

Note that LateInit() has to be called after the constructor terminates and before doing anything else.

Definition at line 223 of file ViewShellBase.cxx.

References VclPtr< class reference_type >::Create(), sd::DrawDocShell::GetDoc(), SfxViewShell::GetObjectShell(), Application::GetSettings(), SfxViewShell::GetViewFrame(), SfxViewFrame::GetWindow(), HAS_PRINTOPTIONS, vcl::Window::Hide(), mpDocShell, mpDocument, mpImpl, vcl::Window::SetBackground(), and SfxViewShell::SetWindow().

◆ ~ViewShellBase()

sd::ViewShellBase::~ViewShellBase ( )
overridevirtual

In this destructor the order in which some of the members are destroyed (and/or being prepared to being destroyed) is important.

Change it only when you know what you are doing.

Definition at line 253 of file ViewShellBase.cxx.

References sfx2::SfxNotebookBar::CloseMethod(), sd::ViewShell::GetActiveWindow(), GetBindings(), GetDocShell(), SfxShell::GetFrame(), GetMainViewShell(), vcl::Window::GetParent(), sd::SlideShow::GetSlideShow(), SfxViewShell::GetViewFrame(), vcl::Window::Hide(), mpImpl, SfxLokHelper::notifyOtherViews(), SfxViewShell::SetWindow(), and sd::SlideShow::Stop().

Member Function Documentation

◆ Activate()

void sd::ViewShellBase::Activate ( bool  IsMDIActivate)
overridevirtual

Reimplemented from SfxViewShell.

Definition at line 733 of file ViewShellBase.cxx.

References SfxViewShell::Activate(), SfxViewShell::GetController(), and GetToolBarManager().

◆ afterCallbackRegistered()

void sd::ViewShellBase::afterCallbackRegistered ( )
overridevirtual

See SfxViewShell::afterCallbackRegistered().

Reimplemented from SfxViewShell.

Definition at line 1013 of file ViewShellBase.cxx.

◆ Deactivate()

virtual void SfxViewShell::Deactivate ( bool  IsMDIActivate)
virtual

Reimplemented from SfxViewShell.

◆ DoVerb()

ErrCode sd::ViewShellBase::DoVerb ( sal_Int32  nVerb)
overridevirtual

This call is forwarded to the main sub-shell.

Reimplemented from SfxViewShell.

Definition at line 505 of file ViewShellBase.cxx.

References sd::ViewShell::DoVerb(), ERRCODE_NONE, and GetMainViewShell().

◆ Execute()

void sd::ViewShellBase::Execute ( SfxRequest rRequest)
virtual

◆ GetBorder()

SvBorder sd::ViewShellBase::GetBorder ( bool  bOuterResize)

Definition at line 591 of file ViewShellBase.cxx.

References mpImpl.

Referenced by UpdateBorder().

◆ getClientRectangle()

const ::tools::Rectangle & sd::ViewShellBase::getClientRectangle ( ) const

returns the complete area of the current view relative to the frame window

Definition at line 916 of file ViewShellBase.cxx.

References mpImpl.

◆ GetColorConfigColor()

Color sd::ViewShellBase::GetColorConfigColor ( svtools::ColorConfigEntry  nColorType) const
override

◆ GetColorConfigName()

OUString sd::ViewShellBase::GetColorConfigName ( ) const
overridevirtual

◆ GetDocShell()

DrawDocShell * sd::ViewShellBase::GetDocShell ( ) const
inline

◆ GetDocument()

SdDrawDocument * sd::ViewShellBase::GetDocument ( ) const
inline

◆ GetDrawController()

DrawController * sd::ViewShellBase::GetDrawController ( ) const

◆ GetDrawView()

SdrView * sd::ViewShellBase::GetDrawView ( ) const
overridevirtual

◆ getEditMode()

int sd::ViewShellBase::getEditMode ( ) const
overridevirtual

See SfxViewShell::getEditMode().

Reimplemented from SfxViewShell.

Definition at line 977 of file ViewShellBase.cxx.

References sd::framework::FrameworkHelper::Instance(), MasterPage, and Page.

◆ GetEventMultiplexer()

std::shared_ptr< tools::EventMultiplexer > const & sd::ViewShellBase::GetEventMultiplexer ( ) const

◆ GetFormShellManager()

std::shared_ptr< FormShellManager > const & sd::ViewShellBase::GetFormShellManager ( ) const

◆ GetInitialViewShellType()

OUString sd::ViewShellBase::GetInitialViewShellType ( ) const
private

Determine from the properties of the document shell the initial type of the view shell in the center pane.

We use this method to avoid starting with the wrong type. When ReadUserDataSequence() is called we check that the right type is active and change again if that is not the case because something went wrong.

Definition at line 849 of file ViewShellBase.cxx.

References aProperties, GetDocShell(), Handout, Notes, SAL_WARN, Standard, and sUNO_View_PageKind.

Referenced by LateInit().

◆ getLOKVisibleArea()

virtual ::tools::Rectangle sd::ViewShellBase::getLOKVisibleArea ( ) const
inlineoverridevirtual

Reimplemented from SfxViewShell.

Definition at line 230 of file ViewShellBase.hxx.

References maLOKVisibleArea.

◆ GetMainViewShell()

std::shared_ptr< ViewShell > sd::ViewShellBase::GetMainViewShell ( ) const

Return the main view shell stacked on the called ViewShellBase object.

This is usually the view shell displayed in the center pane.

Definition at line 375 of file ViewShellBase.cxx.

References SfxShell::GetViewShell(), sd::framework::FrameworkHelper::Instance(), sd::framework::FrameworkHelper::msCenterPaneURL, and sd::framework::FrameworkHelper::msFullScreenPaneURL.

Referenced by sd::SlideShow::activate(), sd::sidebar::LayoutMenu::AssignLayoutToSelectedSlides(), SdOutliner::BeginConversion(), sd::DrawController::BroadcastContextChange(), sd::DrawDocShell::ClearUndoBuffer(), sd::DrawViewShell::ConfigurationChanged(), sd::sidebar::LayoutMenu::CreateRequest(), sd::AnnotationManagerImpl::CreateTags(), sd::ViewOverlayManager::CreateTags(), sd::DrawController::dispose(), DoVerb(), sd::SlideShow::end(), SdOutliner::EndSpelling(), sd::slidesorter::controller::Clipboard::ExecuteDrop(), sd::slidesorter::controller::Clipboard::ExecuteOrAcceptShapeDrop(), sd::AnnotationManagerImpl::ExecuteReplyToAnnotation(), sd::slidesorter::controller::SlotManager::FuSupport(), sd::slidesorter::SlideSorterViewShell::GetActualPage(), sd::getBindings(), sd::slidesorter::controller::SlotManager::GetClipboardState(), GetColorConfigColor(), GetColorConfigName(), sd::DrawController::getControl(), sd::AnnotationManagerImpl::GetCurrentPage(), sd::DocumentRenderer::Implementation::GetCurrentPageIndex(), sd::getDispatcher(), GetDrawView(), sd::DrawController::getFormController(), SdStyleSheet::GetRealStyleSheet(), GetSelectionText(), sd::slidesorter::SlideSorterViewShell::GetStateMovePageFirst(), sd::slidesorter::SlideSorterViewShell::GetStateMovePageLast(), SdPageObjsTLV::GetViewShellForDocShell(), sd::SlideShow::GetWorkWindow(), HasSelection(), sd::ViewShell::ImpGetUndoManager(), IMPL_LINK(), sd::FormShellManager::ImplDestroy(), sd::sidebar::SlideBackground::Initialize(), sd::AnnotationManagerImpl::InsertAnnotation(), sd::sidebar::LayoutMenu::InsertPageWithLayout(), LateInit(), sd::slidesorter::controller::Listener::Listener(), sd::slidesorter::SlideSorterViewShell::MainViewEndEditAndUnmarkAll(), sd::FormShellManager::Notify(), PrepareClose(), sd::slidesorter::controller::SlideSorterController::PrepareEditModeChange(), sd::DocumentRenderer::Implementation::PrepareHandout(), sd::DocumentRenderer::Implementation::PreparePages(), sd::DocumentRenderer::Implementation::PrepareRegularPages(), SdOutliner::PrepareSpelling(), sd::DocumentRenderer::Implementation::PrepareStdOrNotes(), sd::DocumentRenderer::Implementation::PrintPage(), sd::sidebar::CurrentMasterPagesSelector::ProcessPopupMenu(), sd::SpellDialogChildWindow::ProvideOutliner(), sd::slidesorter::SlideSorterViewShell::ReadFrameViewData(), ReadUserData(), ReadUserDataSequence(), sd::FormShellManager::RegisterAtCenterPane(), RetrieveLabelFromCommand(), sd::FuSearch::SearchAndReplace(), sd::AnnotationManagerImpl::SelectAnnotation(), sd::AnnotationManagerImpl::SelectNextAnnotation(), sd::slidesorter::controller::CurrentSlideManager::SetCurrentSlideAtTabControl(), sd::slidesorter::controller::CurrentSlideManager::SetCurrentSlideAtViewShellBase(), sd::FormShellManager::SetFormShell(), SetPrinter(), sd::DocumentRenderer::Implementation::SetupPaperOrientation(), SdPageObjsTLV::SetViewFrame(), SdOutliner::SetViewMode(), SetZoomFactor(), ShowUIControls(), sd::FuHangulHanjaConversion::StartConversion(), sd::SlideShow::StartFullscreenPresentation(), SdOutliner::StartSearchAndReplace(), sd::SlideShow::startWithArguments(), UIActivating(), UIDeactivated(), sd::FormShellManager::UnregisterAtCenterPane(), UpdateBorder(), sd::sidebar::SlideBackground::updateMasterSlideSelection(), sd::CustomAnimationPane::updateMotionPathTags(), sd::sidebar::LayoutMenu::UpdateSelection(), WriteUserData(), sd::ViewShell::WriteUserDataSequence(), WriteUserDataSequence(), and ~ViewShellBase().

◆ getPart()

int sd::ViewShellBase::getPart ( ) const
overridevirtual

See SfxViewShell::getPart().

Reimplemented from SfxViewShell.

Definition at line 965 of file ViewShellBase.cxx.

References sd::framework::FrameworkHelper::Instance().

◆ GetPrinter()

SfxPrinter * sd::ViewShellBase::GetPrinter ( bool  bCreate = false)
overridevirtual

Forwarded to the print manager.

Reimplemented from SfxViewShell.

Definition at line 523 of file ViewShellBase.cxx.

References GetDocShell(), sd::DrawDocShell::GetPrinter(), and mpImpl.

Referenced by sd::framework::ShellStackGuard::IsPrinting().

◆ GetRenderable()

Reference< view::XRenderable > sd::ViewShellBase::GetRenderable ( )
overridevirtual

Return a new renderer that can be used for example for printing the document.

Reimplemented from SfxViewShell.

Definition at line 516 of file ViewShellBase.cxx.

◆ GetSelectionText()

OUString sd::ViewShellBase::GetSelectionText ( bool  bCompleteWords = false,
bool  bOnlyASample = false 
)
overridevirtual

◆ GetState()

void sd::ViewShellBase::GetState ( SfxItemSet rSet)

Callback function for retrieving item values related to certain slots.

This is the companion of Execute() and handles the slots concerned with showing the pane docking windows.

Definition at line 672 of file ViewShellBase.cxx.

References sd::FuBullet::GetSlotState(), SfxViewShell::GetViewFrame(), mpImpl, and rSet.

◆ GetToolBarManager()

std::shared_ptr< ToolBarManager > const & sd::ViewShellBase::GetToolBarManager ( ) const

◆ GetViewShellBase()

ViewShellBase * sd::ViewShellBase::GetViewShellBase ( SfxViewFrame const *  pFrame)
static

◆ GetViewShellManager()

std::shared_ptr< ViewShellManager > const & sd::ViewShellBase::GetViewShellManager ( ) const

◆ GetViewWindow()

vcl::Window * sd::ViewShellBase::GetViewWindow ( )

Return the window that is used by the main view shell to display its view and other UI elements, like scroll bars and rulers.

Ownership of that window remains with the called ViewShellBase object.

Definition at line 951 of file ViewShellBase.cxx.

References mpImpl.

Referenced by sd::SlideShow::activate(), sd::framework::BasicPaneFactory::CreateFrameWindowPane(), sd::framework::BasicPaneFactory::CreateFullScreenPane(), and sd::SlideShow::StartInPlacePresentation().

◆ HasSelection()

bool sd::ViewShellBase::HasSelection ( bool  bText = true) const
overridevirtual

◆ InitializeFramework()

void sd::ViewShellBase::InitializeFramework ( )
protectedvirtual

Reimplemented in sd::GraphicViewShellBase, sd::ImpressViewShellBase, and sd::PresentationViewShellBase.

Definition at line 439 of file ViewShellBase.cxx.

Referenced by LateInit().

◆ InitInterface_Impl()

void sd::ViewShellBase::InitInterface_Impl ( )
staticprivate

SfxInterface initializer.

Definition at line 219 of file ViewShellBase.cxx.

◆ InnerResizePixel()

void sd::ViewShellBase::InnerResizePixel ( const Point rOrigin,
const Size rSize,
bool  inplaceEditModeChange 
)
overridevirtual

◆ LateInit()

void sd::ViewShellBase::LateInit ( const OUString &  rsDefaultView)

◆ Notify()

void sd::ViewShellBase::Notify ( SfxBroadcaster rBC,
const SfxHint rHint 
)
overrideprotectedvirtual

◆ NotifyCursor()

void sd::ViewShellBase::NotifyCursor ( SfxViewShell pViewShell) const
overridevirtual

◆ OuterResizePixel()

void sd::ViewShellBase::OuterResizePixel ( const Point rOrigin,
const Size rSize 
)
overridevirtual

Reimplemented from SfxViewShell.

Definition at line 481 of file ViewShellBase.cxx.

References mpImpl.

◆ PrepareClose()

bool sd::ViewShellBase::PrepareClose ( bool  bUI = true)
overridevirtual

◆ ReadUserData()

void sd::ViewShellBase::ReadUserData ( const OUString &  rString,
bool  bBrowse = false 
)
overridevirtual

Reimplemented from SfxViewShell.

Definition at line 786 of file ViewShellBase.cxx.

References GetMainViewShell(), sd::ViewShell::ReadUserData(), and SfxViewShell::ReadUserData().

◆ ReadUserDataSequence()

void sd::ViewShellBase::ReadUserDataSequence ( const css::uno::Sequence< css::beans::PropertyValue > &  rSequence)
overridevirtual

◆ Rearrange()

void sd::ViewShellBase::Rearrange ( )

Call this method when the controls of this view shell or the embedded sub shell need to be rearranged.

This is necessary e.g. when the border has been modified (UpdateBorder() calls this method).

This method is like ResizePixel() with no arguments.

Definition at line 486 of file ViewShellBase.cxx.

References SfxViewShell::GetViewFrame(), SfxViewShell::GetWindow(), SfxViewFrame::Resize(), SAL_WARN, SfxViewShell::SetBorderPixel(), and UpdateBorder().

Referenced by ShowUIControls().

◆ RetrieveLabelFromCommand()

OUString sd::ViewShellBase::RetrieveLabelFromCommand ( const OUString &  aCmdURL) const

returns the ui descriptive name for the given uno slot.

The result is taken from the configuration and not cached, so do not use it excessive (f.e. in status updates)

Definition at line 958 of file ViewShellBase.cxx.

References aProperties, vcl::CommandInfoProvider::GetCommandProperties(), SfxShell::GetFrame(), vcl::CommandInfoProvider::GetLabelForCommand(), GetMainViewShell(), vcl::CommandInfoProvider::GetModuleIdentifier(), and SfxViewShell::GetViewFrame().

Referenced by sd::FuFormatPaintBrush::Paste().

◆ SetBusyState()

void sd::ViewShellBase::SetBusyState ( bool  bBusy)

When <TRUE> is given, then the mouse shape is set to hour glass (or whatever the busy shape looks like on the system.)

Definition at line 806 of file ViewShellBase.cxx.

References GetDocShell(), and SfxObjectShell::SetWaitCursor().

Referenced by sd::sidebar::MasterPagesSelector::ExecuteCommand().

◆ setEditMode()

void sd::ViewShellBase::setEditMode ( int  nMode)

See SfxViewShell::setEditMode().

Definition at line 995 of file ViewShellBase.cxx.

References sd::framework::FrameworkHelper::Instance(), MasterPage, and Page.

◆ setLOKVisibleArea()

void sd::ViewShellBase::setLOKVisibleArea ( const ::tools::Rectangle rArea)
inline

Definition at line 229 of file ViewShellBase.hxx.

References maLOKVisibleArea.

◆ SetPrinter()

sal_uInt16 sd::ViewShellBase::SetPrinter ( SfxPrinter pNewPrinter,
SfxPrinterChangeFlags  nDiffFlags = SFX_PRINTER_ALL 
)
overridevirtual

◆ SetViewTabBar()

void sd::ViewShellBase::SetViewTabBar ( const ::rtl::Reference< ViewTabBar > &  rViewTabBar)

Definition at line 944 of file ViewShellBase.cxx.

References mpImpl.

Referenced by sd::ViewTabBar::disposing(), and sd::ViewTabBar::ViewTabBar().

◆ SetZoomFactor()

void sd::ViewShellBase::SetZoomFactor ( const Fraction rZoomX,
const Fraction rZoomY 
)
overridevirtual

Reimplemented from SfxViewShell.

Definition at line 748 of file ViewShellBase.cxx.

References GetMainViewShell(), SfxViewShell::SetZoomFactor(), and sd::ViewShell::SetZoomFactor().

◆ ShowUIControls()

void sd::ViewShellBase::ShowUIControls ( bool  bVisible)

With this method the UI controls can be turned on or off.

It is used by the FuSlideShow to hide the UI controls while showing a non-full-screen or in-window presentation in the center pane.

Definition at line 836 of file ViewShellBase.cxx.

References bVisible, GetMainViewShell(), mpImpl, Rearrange(), sd::ViewShell::ShowUIControls(), and UpdateBorder().

◆ UIActivating()

void sd::ViewShellBase::UIActivating ( SfxInPlaceClient pClient)
overridevirtual

◆ UIDeactivated()

void sd::ViewShellBase::UIDeactivated ( SfxInPlaceClient pClient)
overridevirtual

◆ UpdateBorder()

void sd::ViewShellBase::UpdateBorder ( bool  bForce = false)

Update the border that is set with SfxViewShell::SetBorderPixel().

This is done by adding the border used by the ViewShellBase itself with the border used by the main view shell.

Parameters
bForceif true the borders are also updated if old border and new border are same.

Definition at line 812 of file ViewShellBase.cxx.

References sd::ViewShell::GetBorder(), GetBorder(), SfxViewShell::GetBorderPixel(), GetDocShell(), GetMainViewShell(), SfxViewShell::GetWindow(), SfxViewShell::InvalidateBorder(), and SfxViewShell::SetBorderPixel().

Referenced by SdScaleControl::Command(), LateInit(), Rearrange(), and ShowUIControls().

◆ WriteUserData()

void sd::ViewShellBase::WriteUserData ( OUString &  rString,
bool  bBrowse = false 
)
overridevirtual

Reimplemented from SfxViewShell.

Definition at line 776 of file ViewShellBase.cxx.

References GetMainViewShell(), sd::ViewShell::WriteUserData(), and SfxViewShell::WriteUserData().

◆ WriteUserDataSequence()

void sd::ViewShellBase::WriteUserDataSequence ( css::uno::Sequence< css::beans::PropertyValue > &  rSequence)
overridevirtual

Forward methods to main sub shell.

Reimplemented from SfxViewShell.

Definition at line 679 of file ViewShellBase.cxx.

References GetMainViewShell(), and sd::ViewShell::WriteUserDataSequence().

Member Data Documentation

◆ maLOKVisibleArea

::tools::Rectangle sd::ViewShellBase::maLOKVisibleArea
private

Definition at line 243 of file ViewShellBase.hxx.

Referenced by getLOKVisibleArea(), and setLOKVisibleArea().

◆ mpDocShell

DrawDocShell* sd::ViewShellBase::mpDocShell
private

Definition at line 241 of file ViewShellBase.hxx.

Referenced by GetDocShell(), and ViewShellBase().

◆ mpDocument

SdDrawDocument* sd::ViewShellBase::mpDocument
private

Definition at line 242 of file ViewShellBase.hxx.

Referenced by GetDocument(), and ViewShellBase().

◆ mpImpl

std::unique_ptr<Implementation> sd::ViewShellBase::mpImpl
private

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