LibreOffice Module sfx2 (master) 1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
SfxViewShell Class Reference

One SfxViewShell more or less represents one edit window for a document, there can be multiple ones for a single opened document (SfxObjectShell). More...

#include <viewsh.hxx>

Inheritance diagram for SfxViewShell:
[legend]
Collaboration diagram for SfxViewShell:
[legend]

Public Member Functions

 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)
 Initialize is called after the frame has been loaded and the controller has been set. More...
 
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
 retrieves the document which shall be considered the "current document" when the frame is active More...
 
void SetCurrentDocument () const
 forwards the current document, as returned by ->GetCurrentDocument, to SfxObjectShell::SetWorkingDocument More...
 
virtual css::uno::Reference< css::view::XRenderable > GetRenderable ()
 get an XRenderable instance that can render this document More...
 
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)
 Internal method for setting the differences between 'pNewPrinter' to the current printer. More...
 
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)
 Set up a more efficient internal callback instead of LibreOfficeKitCallback. More...
 
SfxLokCallbackInterfacegetLibreOfficeKitViewCallback () const
 
void dumpLibreOfficeKitViewState (rtl::OStringBuffer &rState)
 dump view state for diagnostics More...
 
virtual void libreOfficeKitViewCallback (int nType, const OString &pPayload) const override
 Invokes the registered callback, if there are any. More...
 
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)
 Set if we are doing tiled searching. More...
 
virtual int getPart () const
 See lok::Document::getPart(). More...
 
virtual int getEditMode () const
 See lok::Document::getMode(). More...
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
ViewShellId GetViewShellId () const override
 See OutlinerViewShell::GetViewShellId(). More...
 
ViewShellDocId GetDocId () const override
 Get the DocId used by Mobile LOKit to load multiple documents. More...
 
virtual void notifyInvalidation (tools::Rectangle const *) const override
 ILibreOfficeKitNotifier. Emits a LOK_CALLBACK_INVALIDATE_TILES. More...
 
void NotifyOtherViews (int nType, const OString &rKey, const OString &rPayload) override
 See OutlinerViewShell::NotifyOtherViews(). More...
 
void NotifyOtherView (OutlinerViewShell *pOtherShell, int nType, const OString &rKey, const OString &rPayload) override
 See OutlinerViewShell::NotifyOtherView(). More...
 
virtual void NotifyCursor (SfxViewShell *) const
 Ask this view to send its cursor position to pViewShell. More...
 
virtual void afterCallbackRegistered ()
 Where a new view can perform some update/initialization soon after the callback has been registered. More...
 
virtual vcl::WindowGetEditWindowForActiveOLEObj () const override
 See OutlinerViewShell::GetEditWindowForActiveOLEObj(). More...
 
virtual ::Color GetColorConfigColor (svtools::ColorConfigEntry nColorType) const
 Get a color config color from this view. More...
 
virtual OUString GetColorConfigName () const
 Get the color scheme name of this view. More...
 
void SetLOKLanguageTag (const OUString &rBcp47LanguageTag)
 Set the LibreOfficeKit language of this view. More...
 
const LanguageTagGetLOKLanguageTag () const
 Get the LibreOfficeKit language of this view. More...
 
void SetLOKAccessibilityState (bool bEnabled)
 Enable/Disable LibreOfficeKit AT support for this view. More...
 
std::pair< bool, OUString > GetLOKTimezone () const
 Get the LibreOfficeKit timezone of this view. See @SetLOKTimezone. More...
 
void SetLOKTimezone (bool isSet, const OUString &rTimezone)
 Set the LibreOfficeKit timezone of this view. More...
 
void SetLOKLocale (const OUString &rBcp47LanguageTag)
 Set the LibreOfficeKit locale of this view. More...
 
const LanguageTagGetLOKLocale () const
 Get the LibreOfficeKit locale of this view. More...
 
LOKDeviceFormFactor GetLOKDeviceFormFactor () const
 Get the form factor of the device where the lok client is running. More...
 
bool isLOKDesktop () const
 Check if the lok client is running on a desktop machine. More...
 
bool isLOKTablet () const
 Check if the lok client is running on a tablet. More...
 
bool isLOKMobilePhone () const
 Check if the lok client is running on a mobile device. More...
 
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
 The connection to a possible corresponding SbxObject is dissolved. More...
 
virtual SfxInterfaceGetInterface () const
 With this virtual method, which is automatically overridden by each subclass with its own slots through the macro <SFX_DECL_INTERFACE>, one can access each of the <SfxInterface> instance belonging to the subclass. More...
 
void SetName (const OUString &rName)
 Sets the name of the Shell object. More...
 
const OUString & GetName () const
 Returns the name of the Shell object. More...
 
SfxViewShellGetViewShell () const
 Returns the SfxViewShell in which they are located in the subshells. More...
 
const SfxPoolItemGetSlotState (sal_uInt16 nSlotId, const SfxInterface *pIF=nullptr, SfxItemSet *pStateSet=nullptr)
 This method returns the status of the slot with the specified slot ID on the specified interface. More...
 
const SfxPoolItemExecuteSlot (SfxRequest &rReq, const SfxInterface *pIF=nullptr)
 This method allows you to forward a <SfxRequest> to the specified base <SfxShell>. More...
 
void ExecuteSlot (SfxRequest &rReq, bool bAsync)
 Asynchronous ExecuteSlot for the RELOAD. More...
 
SfxItemPoolGetPool () const
 Each Subclass of SfxShell must reference a pool. More...
 
void SetPool (SfxItemPool *pNewPool)
 With this method, the subclasses register their special <SfxItemPool> in the SfxShell. More...
 
virtual SfxUndoManagerGetUndoManager ()
 Each Subclass of SfxShell can have a <SfxUndoManager>. More...
 
void SetUndoManager (SfxUndoManager *pNewUndoMgr)
 Sets a <SfxUndoManager> for this <SfxShell> Instance. More...
 
SfxRepeatTarget * GetRepeatTarget () const
 Returns a pointer to the <SfxRepeatTarget> instance that is used in SID_REPEAT as repeat target when it is addressed from the <SfxUndoManager> supplied by this SfxShell. More...
 
void SetRepeatTarget (SfxRepeatTarget *pTarget)
 Sets the <SfxRepeatTarget> instance that is used in SID_REPEAT as RepeatTarget, when the current supplied by this <SfxUndoManager> is addressed. More...
 
virtual void Invalidate (sal_uInt16 nId=0)
 With this method can the slots of the subclasses be invalidated through the slot Id or alternatively through the Which ID. More...
 
virtual bool IsDesignMode () const
 
bool IsActive () const
 
virtual void Activate (bool bMDI)
 Virtual method that is called when enabling the SfxShell instance, in order to give the Subclasses the opportunity to respond to the to the enabling. More...
 
virtual void Deactivate (bool bMDI)
 Virtual method that is called when disabling the SfxShell instance, to give the Subclasses the opportunity to respond to the disabling. More...
 
SfxDispatcherGetDispatcher () const
 This method returns a pointer to the <SfxDispatcher>, when the SfxShell is currently <UI-active> or a NULL-pointer if it is not UI-active. More...
 
SfxViewFrameGetFrame () const
 This method returns a pointer to the <SfxViewFrame> to which this SfxShell instance is associated or in which they currently is <UI-active>. More...
 
virtual bool HasUIFeature (SfxShellFeature nFeature) const
 
void UIFeatureChanged ()
 
const SfxPoolItemGetItem (sal_uInt16 nSlotId) const
 With this method any objects of <SfxPoolItemu> subclasses can be accessed. More...
 
template<class T >
const T * GetItem (TypedWhichId< T > nWhich) const
 
void PutItem (const SfxPoolItem &rItem)
 With this method, any objects of subclasses of <SfxPoolItem> can be made available. More...
 
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)
 Set the name of the sidebar context that is broadcast on calls to Activation(). More...
 
void BroadcastContextForActivation (const bool bIsActivated)
 Broadcast a sidebar context change. More...
 
bool SetContextBroadcasterEnabled (const bool bIsEnabled)
 Enabled or disable the context broadcaster. More...
 
SAL_DLLPRIVATE bool CanExecuteSlot_Impl (const SfxSlot &rSlot)
 This method determines by calling the status function whether 'rSlot' can be executed currently. More...
 
virtual bool IsConditionalFastCall (const SfxRequest &rReq)
 This method determines whether we need to execute without checking the disabled state of the slot. More...
 
SAL_DLLPRIVATE void DoActivate_Impl (SfxViewFrame *pFrame, bool bMDI)
 This method controls the activation of SfxShell instance. More...
 
SAL_DLLPRIVATE void DoDeactivate_Impl (SfxViewFrame const *pFrame, bool bMDI)
 This method controls the deactivation of the SfxShell instance. More...
 
- Public Member Functions inherited from SfxBroadcaster
 SfxBroadcaster ()
 
 SfxBroadcaster (const SfxBroadcaster &rBC)
 
virtual ~SfxBroadcaster () COVERITY_NOEXCEPT_FALSE
 
void Broadcast (const SfxHint &rHint)
 
bool HasListeners () const
 
size_t GetListenerCount () const
 
void ForAllListeners (std::function< bool(SfxListener *)> f) const
 
- Public Member Functions inherited from SfxListener
 SfxListener ()
 
 SfxListener (const SfxListener &rCopy)
 
virtual ~SfxListener () COVERITY_NOEXCEPT_FALSE
 
void StartListening (SfxBroadcaster &rBroadcaster, DuplicateHandling eDuplicateHanding=DuplicateHandling::Unexpected)
 
void EndListening (SfxBroadcaster &rBroadcaster, bool bRemoveAllDuplicates=false)
 
void EndListeningAll ()
 
bool IsListening (SfxBroadcaster &rBroadcaster) const
 
sal_uInt16 GetBroadcasterCount () const
 
SfxBroadcasterGetBroadcasterJOE (sal_uInt16 nNo) const
 
virtual void Notify (SfxBroadcaster &rBC, const SfxHint &rHint)
 
void RemoveBroadcaster_Impl (SfxBroadcaster &rBC)
 
virtual bool IsSdrView () const
 
virtual void libreOfficeKitViewCallback (int nType, const OString &pPayload) const=0
 
virtual void libreOfficeKitViewCallbackWithViewId (int nType, const OString &pPayload, int nViewId) const=0
 
virtual void libreOfficeKitViewInvalidateTilesCallback (const tools::Rectangle *pRect, int nPart, int nMode) const=0
 
virtual void libreOfficeKitViewUpdatedCallback (int nType) const=0
 
virtual void libreOfficeKitViewUpdatedCallbackPerViewId (int nType, int nViewId, int nSourceViewId) const=0
 
virtual void libreOfficeKitViewAddPendingInvalidateTiles ()=0
 
virtual ViewShellId GetViewShellId () const=0
 
virtual ViewShellDocId GetDocId () const=0
 
virtual void NotifyOtherViews (int nType, const OString &rKey, const OString &rPayload)=0
 
virtual void NotifyOtherView (OutlinerViewShell *pOtherShell, int nType, const OString &rKey, const OString &rPayload)=0
 
virtual vcl::WindowGetEditWindowForActiveOLEObj () const=0
 
- Public Member Functions inherited from vcl::ILibreOfficeKitNotifier
virtual ~ILibreOfficeKitNotifier ()
 
virtual void notifyWindow (vcl::LOKWindowId nLOKWindowId, const OUString &rAction, const std::vector< LOKPayloadItem > &rPayload=std::vector< LOKPayloadItem >()) const=0
 
virtual void libreOfficeKitViewCallback (int nType, const OString &pPayload) const=0
 
virtual void notifyInvalidation (tools::Rectangle const *) const=0
 

Static Public Member Functions

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)
 Set the current DocId, which is used by Mobile LOKit to load multiple documents and yet identify the views of each. More...
 
- 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 Activate (bool IsMDIActivate) override
 Virtual method that is called when enabling the SfxShell instance, in order to give the Subclasses the opportunity to respond to the to the enabling. More...
 
virtual void Deactivate (bool IsMDIActivate) override
 Virtual method that is called when disabling the SfxShell instance, to give the Subclasses the opportunity to respond to the disabling. More...
 
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 ()
 The constructor of the SfxShell class initializes only simple types, the corresponding SbxObject is only created on-demand. More...
 
 SfxShell (SfxViewShell *pViewSh)
 The constructor of the SfxShell class initializes only simple types, the corresponding SbxObject is only created on-demand. More...
 
void SetViewShell_Impl (SfxViewShell *pView)
 
SAL_DLLPRIVATE void Invalidate_Impl (SfxBindings &rBindings, sal_uInt16 nId)
 
- Protected Member Functions inherited from SfxBroadcaster
void Forward (SfxBroadcaster &rBC, const SfxHint &rHint)
 
- Protected Member Functions inherited from OutlinerViewShell
 ~OutlinerViewShell () noexcept
 

Private Member Functions

LOKDocumentFocusListenerGetLOKDocumentFocusListener ()
 
const LOKDocumentFocusListenerGetLOKDocumentFocusListener () const
 

Static Private Member Functions

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

Private Attributes

std::unique_ptr< struct SfxViewShell_ImplpImpl
 
SfxViewFramerFrame
 
VclPtr< vcl::WindowpWindow
 
bool bNoNewWindow
 
bool mbPrinterSettingsModified
 
LanguageTag maLOKLanguageTag
 
LanguageTag maLOKLocale
 
LOKDeviceFormFactor maLOKDeviceFormFactor
 
bool mbLOKAccessibilityEnabled
 
rtl::Reference< LOKDocumentFocusListenermpLOKDocumentFocusListener
 
std::unordered_set< OUString > mvLOKBlockedCommandList
 
OUString maLOKTimezone
 
bool maLOKIsTimezoneSet
 
std::shared_ptr< SfxStoringHelperm_xHelper
 Used for async export. More...
 
StylesHighlighterColorMap ParaStylesColorMap
 
StylesHighlighterColorMap CharStylesColorMap
 

Static Private Attributes

static ViewShellDocId mnCurrentDocId
 Used to set the DocId at construction time. See SetCurrentDocId. More...
 

Friends

class SfxViewFrame
 
class SfxBaseController
 
class SfxPrinterController
 

Additional Inherited Members

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

Detailed Description

One SfxViewShell more or less represents one edit window for a document, there can be multiple ones for a single opened document (SfxObjectShell).

Definition at line 164 of file viewsh.hxx.

Constructor & Destructor Documentation

◆ SfxViewShell()

SfxViewShell::SfxViewShell ( SfxViewFrame rFrame,
SfxViewShellFlags  nFlags 
)

◆ ~SfxViewShell()

SfxViewShell::~SfxViewShell ( )
overridevirtual

Member Function Documentation

◆ Activate()

void SfxViewShell::Activate ( bool  bMDI)
overrideprotectedvirtual

Virtual method that is called when enabling the SfxShell instance, in order to give the Subclasses the opportunity to respond to the to the enabling.

[Cross-reference]

StarView SystemWindow::Activate(bool)

Reimplemented from SfxShell.

Definition at line 1534 of file viewsh.cxx.

References GetController(), SfxObjectShell::GetModel(), SfxViewFrame::GetObjectShell(), GetViewFrame(), SetCurrentDocument(), and xModel.

◆ AddContextMenuInterceptor_Impl()

void SfxViewShell::AddContextMenuInterceptor_Impl ( const css::uno::Reference< css::ui::XContextMenuInterceptor > &  xInterceptor)

Definition at line 2672 of file viewsh.cxx.

References pImpl.

◆ AddRemoveClipboardListener()

void SfxViewShell::AddRemoveClipboardListener ( const css::uno::Reference< css::datatransfer::clipboard::XClipboardListener > &  ,
bool   
)

Definition at line 2869 of file viewsh.cxx.

References GetViewFrame(), and GetWindow().

◆ AddSubShell()

void SfxViewShell::AddSubShell ( SfxShell rShell)

◆ afterCallbackRegistered()

void SfxViewShell::afterCallbackRegistered ( )
virtual

Where a new view can perform some update/initialization soon after the callback has been registered.

Definition at line 2293 of file viewsh.cxx.

Referenced by setLibreOfficeKitViewCallback().

◆ CheckIPClient_Impl()

void SfxViewShell::CheckIPClient_Impl ( SfxInPlaceClient const *  pIPClient,
const tools::Rectangle rVisArea 
)

◆ CreatePrintOptionsPage()

std::unique_ptr< SfxTabPage > SfxViewShell::CreatePrintOptionsPage ( weld::Container pPage,
weld::DialogController pController,
const SfxItemSet rOptions 
)
virtual

Definition at line 914 of file viewprn.cxx.

◆ Current()

SfxViewShell * SfxViewShell::Current ( )
static

◆ Deactivate()

void SfxViewShell::Deactivate ( bool  bMDI)
overrideprotectedvirtual

Virtual method that is called when disabling the SfxShell instance, to give the Subclasses the opportunity to respond to the disabling.

[Cross-reference]

StarView SystemWindow::Deactivate(bool)

Reimplemented from SfxShell.

Definition at line 1547 of file viewsh.cxx.

◆ DisconnectAllClients()

void SfxViewShell::DisconnectAllClients ( )

Definition at line 2528 of file viewsh.cxx.

References n, and pImpl.

Referenced by SfxViewFrame::Close(), SfxViewFrame::ReleaseObjectShell_Impl(), and SetWindow().

◆ DoVerb()

ErrCode SfxViewShell::DoVerb ( sal_Int32  nVerb)
virtual

Definition at line 1433 of file viewsh.cxx.

References ERRCODE_SO_NOVERBS.

Referenced by SfxViewFrame::ExecView_Impl(), and SfxShell::VerbExec().

◆ dumpAsXml()

void SfxViewShell::dumpAsXml ( xmlTextWriterPtr  pWriter) const
virtual

Definition at line 2461 of file viewsh.cxx.

References GetViewShellId().

◆ dumpLibreOfficeKitViewState()

void SfxViewShell::dumpLibreOfficeKitViewState ( rtl::OStringBuffer &  rState)

dump view state for diagnostics

Definition at line 2177 of file viewsh.cxx.

References pImpl.

Referenced by SfxLokHelper::dumpState().

◆ Escape()

bool SfxViewShell::Escape ( )

Definition at line 2839 of file viewsh.cxx.

References SfxBindings::Execute(), SfxViewFrame::GetBindings(), and GetViewFrame().

◆ ExecKey_Impl()

bool SfxViewShell::ExecKey_Impl ( const KeyEvent aKey)

◆ ExecMisc_Impl()

void SfxViewShell::ExecMisc_Impl ( SfxRequest rReq)

◆ ExecPrint()

void SfxViewShell::ExecPrint ( const css::uno::Sequence< css::beans::PropertyValue > &  ,
bool  ,
bool   
)

◆ ExecPrint_Impl()

void SfxViewShell::ExecPrint_Impl ( SfxRequest rReq)

◆ FindIPClient()

SfxInPlaceClient * SfxViewShell::FindIPClient ( const css::uno::Reference< css::embed::XEmbeddedObject > &  xObj,
vcl::Window pObjParentWin 
) const

Definition at line 1472 of file viewsh.cxx.

References GetWindow(), and pImpl.

Referenced by SfxInPlaceClient::GetClient().

◆ flushPendingLOKInvalidateTiles()

void SfxViewShell::flushPendingLOKInvalidateTiles ( )
virtual

Definition at line 2297 of file viewsh.cxx.

◆ Get()

SfxViewShell * SfxViewShell::Get ( const css::uno::Reference< css::frame::XController > &  i_rController)
static

◆ getA11yCaretPosition()

int SfxViewShell::getA11yCaretPosition ( ) const

◆ getA11yFocusedParagraph()

OUString SfxViewShell::getA11yFocusedParagraph ( ) const

◆ GetActivePrinter()

Printer * SfxViewShell::GetActivePrinter ( ) const

Definition at line 634 of file viewprn.cxx.

References pImpl.

Referenced by SfxPrintHelper::getPrinter().

◆ GetBaseController_Impl()

SfxBaseController * SfxViewShell::GetBaseController_Impl ( ) const

Definition at line 2667 of file viewsh.cxx.

References pImpl.

Referenced by SfxBaseModel::createViewController().

◆ GetBorderPixel()

const SvBorder & SfxViewShell::GetBorderPixel ( ) const

Definition at line 1691 of file viewsh.cxx.

References SfxViewFrame::GetBorderPixelImpl(), and GetViewFrame().

◆ GetClipboardNotifier()

uno::Reference< datatransfer::clipboard::XClipboardNotifier > SfxViewShell::GetClipboardNotifier ( ) const

Definition at line 2862 of file viewsh.cxx.

References GetViewFrame(), and GetWindow().

Referenced by SetController().

◆ GetColorConfigColor()

Color SfxViewShell::GetColorConfigColor ( svtools::ColorConfigEntry  nColorType) const

Get a color config color from this view.

Definition at line 2320 of file viewsh.cxx.

References SAL_WARN.

◆ GetColorConfigName()

OUString SfxViewShell::GetColorConfigName ( ) const
virtual

Get the color scheme name of this view.

Definition at line 2326 of file viewsh.cxx.

References SAL_WARN.

Referenced by SfxApplication::MiscExec_Impl().

◆ GetController()

Reference< XController > SfxViewShell::GetController ( ) const

◆ GetCurrentDocument()

Reference< XModel > SfxViewShell::GetCurrentDocument ( ) const
virtual

retrieves the document which shall be considered the "current document" when the frame is active

The default implementation simply returns the XModel of the associated SfxObjectShell. You will rarely need to overwrite this behavior.

Definition at line 2596 of file viewsh.cxx.

References SfxObjectShell::GetModel(), and GetObjectShell().

Referenced by SetCurrentDocument().

◆ GetDocId()

ViewShellDocId SfxViewShell::GetDocId ( ) const
overridevirtual

◆ GetDrawView()

SdrView * SfxViewShell::GetDrawView ( ) const
virtual

Definition at line 1872 of file viewsh.cxx.

◆ getEditMode()

int SfxViewShell::getEditMode ( ) const
virtual

See lok::Document::getMode().

Definition at line 2421 of file viewsh.cxx.

Referenced by lcl_generateJSON(), SfxLokHelper::notifyDocumentSizeChanged(), and SfxLokHelper::notifyInvalidation().

◆ GetEditWindowForActiveOLEObj()

vcl::Window * SfxViewShell::GetEditWindowForActiveOLEObj ( ) const
overridevirtual

◆ GetFirst()

SfxViewShell * SfxViewShell::GetFirst ( bool  bOnlyVisible = true,
const std::function< bool(const SfxViewShell *)> &  isViewShell = nullptr 
)
static

◆ GetFormShell() [1/2]

virtual SfxShell * SfxViewShell::GetFormShell ( )
inlinevirtual

Definition at line 260 of file viewsh.hxx.

Referenced by SfxViewFrame::Notify(), and SfxViewFrame::StateReload_Impl().

◆ GetFormShell() [2/2]

virtual const SfxShell * SfxViewShell::GetFormShell ( ) const
inlinevirtual

Definition at line 261 of file viewsh.hxx.

◆ GetFrameWeld()

weld::Window * SfxViewShell::GetFrameWeld ( ) const

◆ GetIPClient()

SfxInPlaceClient * SfxViewShell::GetIPClient ( ) const

◆ getLibreOfficeKitViewCallback()

SfxLokCallbackInterface * SfxViewShell::getLibreOfficeKitViewCallback ( ) const

Definition at line 2172 of file viewsh.cxx.

References pImpl.

◆ GetLOKDeviceFormFactor()

LOKDeviceFormFactor SfxViewShell::GetLOKDeviceFormFactor ( ) const
inline

Get the form factor of the device where the lok client is running.

Definition at line 464 of file viewsh.hxx.

◆ GetLOKDocumentFocusListener() [1/2]

LOKDocumentFocusListener & SfxViewShell::GetLOKDocumentFocusListener ( )
private

◆ GetLOKDocumentFocusListener() [2/2]

const LOKDocumentFocusListener & SfxViewShell::GetLOKDocumentFocusListener ( ) const
private

Definition at line 2356 of file viewsh.cxx.

References GetLOKDocumentFocusListener().

◆ GetLOKLanguageTag()

const LanguageTag & SfxViewShell::GetLOKLanguageTag ( ) const
inline

Get the LibreOfficeKit language of this view.

Definition at line 440 of file viewsh.hxx.

Referenced by ExecKey_Impl().

◆ GetLOKLocale()

const LanguageTag & SfxViewShell::GetLOKLocale ( ) const
inline

Get the LibreOfficeKit locale of this view.

Definition at line 462 of file viewsh.hxx.

◆ getLOKPayload()

std::optional< OString > SfxViewShell::getLOKPayload ( int  nType,
int  nViewId 
) const
virtual

Definition at line 2302 of file viewsh.cxx.

References nType, and SAL_WARN.

◆ GetLOKTimezone()

std::pair< bool, OUString > SfxViewShell::GetLOKTimezone ( ) const
inline

Get the LibreOfficeKit timezone of this view. See @SetLOKTimezone.

Definition at line 445 of file viewsh.hxx.

◆ getLOKVisibleArea()

virtual tools::Rectangle SfxViewShell::getLOKVisibleArea ( ) const
inlinevirtual

Definition at line 472 of file viewsh.hxx.

◆ GetMargin()

const Size & SfxViewShell::GetMargin ( ) const

Definition at line 2616 of file viewsh.cxx.

References pImpl.

◆ GetNext()

SfxViewShell * SfxViewShell::GetNext ( const SfxViewShell rPrev,
bool  bOnlyVisible = true,
const std::function< bool(const SfxViewShell *)> &  isViewShell = nullptr 
)
static

◆ GetObjectShell()

SfxObjectShell * SfxViewShell::GetObjectShell ( )
overridevirtual

◆ getPart()

int SfxViewShell::getPart ( ) const
virtual

◆ GetPrinter()

SfxPrinter * SfxViewShell::GetPrinter ( bool  bCreate = false)
virtual

◆ GetPrinterController()

const std::shared_ptr< vcl::PrinterController > & SfxViewShell::GetPrinterController ( ) const

Definition at line 629 of file viewprn.cxx.

References pImpl.

Referenced by ExecPrint().

◆ GetRenderable()

Reference< view::XRenderable > SfxViewShell::GetRenderable ( )
virtual

get an XRenderable instance that can render this document

Definition at line 2844 of file viewsh.cxx.

References SfxObjectShell::GetModel(), GetObjectShell(), and xModel.

Referenced by StartPrint().

◆ GetSelectionText()

OUString SfxViewShell::GetSelectionText ( bool  bCompleteWords = false,
bool  bOnlyASample = false 
)
virtual

Definition at line 1887 of file viewsh.cxx.

◆ GetState_Impl()

void SfxViewShell::GetState_Impl ( SfxItemSet rSet)

◆ GetStylesHighlighterCharColorMap()

StylesHighlighterColorMap & SfxViewShell::GetStylesHighlighterCharColorMap ( )
inline

◆ GetStylesHighlighterParaColorMap()

StylesHighlighterColorMap & SfxViewShell::GetStylesHighlighterParaColorMap ( )
inline

◆ GetSubShell()

SfxShell * SfxViewShell::GetSubShell ( sal_uInt16  nNo)

Definition at line 1970 of file viewsh.cxx.

References nCount, and pImpl.

◆ GetUIActiveClient()

SfxInPlaceClient * SfxViewShell::GetUIActiveClient ( ) const

◆ GetUIActiveIPClient_Impl()

SfxInPlaceClient * SfxViewShell::GetUIActiveIPClient_Impl ( ) const

Definition at line 1500 of file viewsh.cxx.

References pImpl.

Referenced by SfxFrameWindow_Impl::EventNotify(), and SfxFrame::Resize().

◆ GetViewFrame()

SfxViewFrame & SfxViewShell::GetViewFrame ( ) const
inline

◆ GetViewShellId()

ViewShellId SfxViewShell::GetViewShellId ( ) const
overridevirtual

◆ GetWindow()

vcl::Window * SfxViewShell::GetWindow ( ) const
inline

◆ GlobalKeyInput_Impl()

bool SfxViewShell::GlobalKeyInput_Impl ( const KeyEvent rKeyEvent)

Definition at line 2495 of file viewsh.cxx.

References ExecKey_Impl().

Referenced by SfxDockingWindow::EventNotify().

◆ HandleNotifyEvent_Impl()

bool SfxViewShell::HandleNotifyEvent_Impl ( NotifyEvent const &  rEvent)

Definition at line 2820 of file viewsh.cxx.

References pImpl.

Referenced by SfxFrameWindow_Impl::PreNotify().

◆ HasKeyListeners_Impl()

bool SfxViewShell::HasKeyListeners_Impl ( ) const

Definition at line 2827 of file viewsh.cxx.

References pImpl.

Referenced by SfxFrameWindow_Impl::PreNotify().

◆ HasMouseClickListeners_Impl()

bool SfxViewShell::HasMouseClickListeners_Impl ( ) const

Definition at line 2833 of file viewsh.cxx.

References pImpl.

Referenced by SfxFrameWindow_Impl::PreNotify().

◆ HasPrintOptionsPage()

bool SfxViewShell::HasPrintOptionsPage ( ) const
virtual

Definition at line 919 of file viewprn.cxx.

Referenced by ExecPrint_Impl().

◆ HasSelection()

bool SfxViewShell::HasSelection ( bool  bText = true) const
virtual

Definition at line 1917 of file viewsh.cxx.

◆ InitInterface_Impl()

void SfxViewShell::InitInterface_Impl ( )
staticprivate

SfxInterface initializer.

Definition at line 921 of file viewsh.cxx.

◆ InnerResizePixel()

void SfxViewShell::InnerResizePixel ( const Point rOfs,
const Size rSize,
bool  inplaceEditModeChange 
)
protectedvirtual

Definition at line 1622 of file viewsh.cxx.

References SetBorderPixel().

◆ InvalidateBorder()

void SfxViewShell::InvalidateBorder ( )

Definition at line 1671 of file viewsh.cxx.

References GetViewFrame(), SfxViewFrame::InvalidateBorderImpl(), and pImpl.

◆ IPClientGone_Impl()

void SfxViewShell::IPClientGone_Impl ( SfxInPlaceClient const *  pIPClient)

Definition at line 1039 of file viewsh.cxx.

References pImpl.

Referenced by SfxInPlaceClient::~SfxInPlaceClient().

◆ isBlockedCommand()

bool SfxViewShell::isBlockedCommand ( OUString  command)

Definition at line 2910 of file viewsh.cxx.

References mvLOKBlockedCommandList.

◆ isLOKDesktop()

bool SfxViewShell::isLOKDesktop ( ) const
inline

Check if the lok client is running on a desktop machine.

Definition at line 466 of file viewsh.hxx.

References DESKTOP.

◆ isLOKMobilePhone()

bool SfxViewShell::isLOKMobilePhone ( ) const
inline

Check if the lok client is running on a mobile device.

Definition at line 470 of file viewsh.hxx.

References MOBILE.

Referenced by InterceptLOKStateChangeEvent(), sfx2::sidebar::SidebarController::RequestCloseDeck(), and sfx2::sidebar::Deck::RequestLayout().

◆ isLOKTablet()

bool SfxViewShell::isLOKTablet ( ) const
inline

Check if the lok client is running on a tablet.

Definition at line 468 of file viewsh.hxx.

References TABLET.

◆ JumpToMark()

void SfxViewShell::JumpToMark ( const OUString &  rMark)

◆ KeyInput()

bool SfxViewShell::KeyInput ( const KeyEvent rKeyEvent)
virtual

Definition at line 2469 of file viewsh.cxx.

References ExecKey_Impl().

Referenced by SfxFrameWindow_Impl::EventNotify().

◆ libreOfficeKitViewAddPendingInvalidateTiles()

void SfxViewShell::libreOfficeKitViewAddPendingInvalidateTiles ( )
overridevirtual

Implements OutlinerViewShell.

Definition at line 2283 of file viewsh.cxx.

References pImpl, and SAL_INFO.

◆ libreOfficeKitViewCallback()

void SfxViewShell::libreOfficeKitViewCallback ( int  nType,
const OString &  pPayload 
) const
overridevirtual

◆ libreOfficeKitViewCallbackWithViewId()

void SfxViewShell::libreOfficeKitViewCallbackWithViewId ( int  nType,
const OString &  pPayload,
int  nViewId 
) const
overridevirtual

◆ libreOfficeKitViewInvalidateTilesCallback()

void SfxViewShell::libreOfficeKitViewInvalidateTilesCallback ( const tools::Rectangle pRect,
int  nPart,
int  nMode 
) const
overridevirtual

◆ libreOfficeKitViewUpdatedCallback()

void SfxViewShell::libreOfficeKitViewUpdatedCallback ( int  nType) const
overridevirtual

Implements OutlinerViewShell.

Definition at line 2257 of file viewsh.cxx.

References ignoreLibreOfficeKitViewCallback(), nType, pImpl, and SAL_INFO.

Referenced by SfxLokHelper::notifyUpdate().

◆ libreOfficeKitViewUpdatedCallbackPerViewId()

void SfxViewShell::libreOfficeKitViewUpdatedCallbackPerViewId ( int  nType,
int  nViewId,
int  nSourceViewId 
) const
overridevirtual

◆ MarginChanged()

void SfxViewShell::MarginChanged ( )
virtual

Definition at line 2638 of file viewsh.cxx.

Referenced by SetMargin().

◆ Move()

void SfxViewShell::Move ( )
protectedvirtual

Definition at line 1552 of file viewsh.cxx.

◆ NewIPClient_Impl()

void SfxViewShell::NewIPClient_Impl ( SfxInPlaceClient pIPClient)

Definition at line 1034 of file viewsh.cxx.

References pImpl.

Referenced by SfxInPlaceClient::SfxInPlaceClient().

◆ NewWindowAllowed()

bool SfxViewShell::NewWindowAllowed ( ) const
inline

Definition at line 332 of file viewsh.hxx.

◆ Notify()

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

◆ NotifyCursor()

void SfxViewShell::NotifyCursor ( SfxViewShell ) const
virtual

Ask this view to send its cursor position to pViewShell.

Definition at line 2407 of file viewsh.cxx.

Referenced by setLibreOfficeKitViewCallback().

◆ notifyInvalidation()

void SfxViewShell::notifyInvalidation ( tools::Rectangle const *  pRect) const
overridevirtual

ILibreOfficeKitNotifier. Emits a LOK_CALLBACK_INVALIDATE_TILES.

Implements vcl::ILibreOfficeKitNotifier.

Definition at line 2442 of file viewsh.cxx.

References SfxLokHelper::notifyInvalidation().

◆ NotifyOtherView()

void SfxViewShell::NotifyOtherView ( OutlinerViewShell pOtherShell,
int  nType,
const OString &  rKey,
const OString &  rPayload 
)
overridevirtual

See OutlinerViewShell::NotifyOtherView().

Implements OutlinerViewShell.

Definition at line 2452 of file viewsh.cxx.

References SfxLokHelper::notifyOtherView(), and nType.

◆ NotifyOtherViews()

void SfxViewShell::NotifyOtherViews ( int  nType,
const OString &  rKey,
const OString &  rPayload 
)
overridevirtual

◆ notifyWindow()

void SfxViewShell::notifyWindow ( vcl::LOKWindowId  nLOKWindowId,
const OUString &  rAction,
const std::vector< vcl::LOKPayloadItem > &  rPayload = std::vector<vcl::LOKPayloadItem>() 
) const
overridevirtual

Definition at line 2857 of file viewsh.cxx.

References SfxLokHelper::notifyWindow().

◆ OuterResizePixel()

void SfxViewShell::OuterResizePixel ( const Point rOfs,
const Size rSize 
)
protectedvirtual

Definition at line 1573 of file viewsh.cxx.

References SetBorderPixel().

◆ OutplaceActivated()

void SfxViewShell::OutplaceActivated ( bool  bActive)

◆ PopSubShells_Impl()

SAL_DLLPRIVATE void SfxViewShell::PopSubShells_Impl ( )
inline

Definition at line 377 of file viewsh.hxx.

Referenced by SfxViewFrame::PopShellAndSubShells_Impl().

◆ PrepareClose()

bool SfxViewShell::PrepareClose ( bool  bUI = true)
virtual

Initialize is called after the frame has been loaded and the controller has been set.

By the time this is called the document has been fully imported.

Parameters
bOnlyASampleused by some dialogs to avoid constructing monster strings e.g. in calc

Definition at line 1816 of file viewsh.cxx.

References Application::CreateMessageDialog(), SfxShell::GetDispatcher(), GetFrameWeld(), GetPrinter(), GetViewFrame(), SfxViewFrame::GetWindow(), GetWindow(), Printer::IsPrinting(), vcl::Window::ReleaseLOKNotifier(), and SfxResId().

Referenced by SfxViewFrame::ExecReload_Impl(), SfxFrame::PrepareClose_Impl(), and SfxViewFrame::SwitchToViewShell_Impl().

◆ PushSubShells_Impl()

void SfxViewShell::PushSubShells_Impl ( bool  bPush = true)

◆ QueryObjAreaPixel()

void SfxViewShell::QueryObjAreaPixel ( tools::Rectangle rRect) const
virtual

Definition at line 2540 of file viewsh.cxx.

◆ ReadUserData()

void SfxViewShell::ReadUserData ( const OUString &  ,
bool  bBrowse = false 
)
virtual

Definition at line 2002 of file viewsh.cxx.

◆ ReadUserDataSequence()

void SfxViewShell::ReadUserDataSequence ( const css::uno::Sequence< css::beans::PropertyValue > &  )
virtual

Definition at line 2006 of file viewsh.cxx.

◆ RemoveContextMenuInterceptor_Impl()

void SfxViewShell::RemoveContextMenuInterceptor_Impl ( const css::uno::Reference< css::ui::XContextMenuInterceptor > &  xInterceptor)

Definition at line 2678 of file viewsh.cxx.

References pImpl.

◆ RemoveSubShell()

void SfxViewShell::RemoveSubShell ( SfxShell pShell = nullptr)

◆ ResetAllClients_Impl()

void SfxViewShell::ResetAllClients_Impl ( SfxInPlaceClient const *  pIP)

Definition at line 2513 of file viewsh.cxx.

References pImpl.

Referenced by SfxInPlaceClient_Impl::activatingUI().

◆ setBlockedCommandList()

void SfxViewShell::setBlockedCommandList ( const char *  blockedCommandList)

Definition at line 2896 of file viewsh.cxx.

References i, and mvLOKBlockedCommandList.

Referenced by SfxLokHelper::setBlockedCommandList().

◆ SetBorderPixel()

void SfxViewShell::SetBorderPixel ( const SvBorder rBorder)

Definition at line 1680 of file viewsh.cxx.

References GetViewFrame(), pImpl, and SfxViewFrame::SetBorderPixelImpl().

Referenced by InnerResizePixel(), and OuterResizePixel().

◆ SetController()

void SfxViewShell::SetController ( SfxBaseController pController)

Definition at line 2651 of file viewsh.cxx.

References GetClipboardNotifier(), and pImpl.

Referenced by SfxBaseModel::createViewController().

◆ SetCurrentDocId()

void SfxViewShell::SetCurrentDocId ( ViewShellDocId  nId)
static

Set the current DocId, which is used by Mobile LOKit to load multiple documents and yet identify the views of each.

There are events that are fired while creating a new view, and if we don't have a DocId, we can't know which other views within the same document (if any) should get those events. By setting this static value, we are able to set the DocId of each SfxViewShell at construction time.

Definition at line 2431 of file viewsh.cxx.

References mnCurrentDocId, and nId.

Referenced by SfxLokHelper::createView().

◆ SetCurrentDocument()

void SfxViewShell::SetCurrentDocument ( ) const

forwards the current document, as returned by ->GetCurrentDocument, to SfxObjectShell::SetWorkingDocument

Definition at line 2608 of file viewsh.cxx.

References GetCurrentDocument(), and SfxObjectShell::SetCurrentComponent().

Referenced by Activate(), and SfxApplication::SetViewFrame_Impl().

◆ setLibreOfficeKitViewCallback()

void SfxViewShell::setLibreOfficeKitViewCallback ( SfxLokCallbackInterface pCallback)

Set up a more efficient internal callback instead of LibreOfficeKitCallback.

Definition at line 2153 of file viewsh.cxx.

References afterCallbackRegistered(), GetDocId(), GetFirst(), GetNext(), NotifyCursor(), and pImpl.

◆ SetLOKAccessibilityState()

void SfxViewShell::SetLOKAccessibilityState ( bool  bEnabled)

Enable/Disable LibreOfficeKit AT support for this view.

Definition at line 2361 of file viewsh.cxx.

References LOKDocumentFocusListener::attachRecursive(), LOKDocumentFocusListener::detachRecursive(), GetLOKDocumentFocusListener(), mbLOKAccessibilityEnabled, pWindow, and SAL_WARN.

◆ SetLOKLanguageTag()

void SfxViewShell::SetLOKLanguageTag ( const OUString &  rBcp47LanguageTag)

◆ SetLOKLocale()

void SfxViewShell::SetLOKLocale ( const OUString &  rBcp47LanguageTag)

Set the LibreOfficeKit locale of this view.

Definition at line 2402 of file viewsh.cxx.

References LanguageTag::makeFallback(), and maLOKLocale.

◆ SetLOKTimezone()

void SfxViewShell::SetLOKTimezone ( bool  isSet,
const OUString &  rTimezone 
)
inline

Set the LibreOfficeKit timezone of this view.

@isSet true to use @rTimezone, even if it's empty. Otherwise, no timezone. @rTimezone the value to set (which could be empty).

Definition at line 453 of file viewsh.hxx.

◆ SetMargin()

void SfxViewShell::SetMargin ( const Size rSize)

◆ SetNewWindowAllowed()

void SfxViewShell::SetNewWindowAllowed ( bool  bSet)
inline

Definition at line 333 of file viewsh.hxx.

◆ SetPrinter()

sal_uInt16 SfxViewShell::SetPrinter ( SfxPrinter pNewPrinter,
SfxPrinterChangeFlags  nDiffFlags = SFX_PRINTER_ALL 
)
virtual

◆ SetPrinter_Impl()

void SfxViewShell::SetPrinter_Impl ( VclPtr< SfxPrinter > &  pNewPrinter)

◆ SetStoringHelper()

void SfxViewShell::SetStoringHelper ( std::shared_ptr< SfxStoringHelper xHelper)
inline

◆ setTiledSearching()

void SfxViewShell::setTiledSearching ( bool  bTiledSearching)

Set if we are doing tiled searching.

Definition at line 2411 of file viewsh.cxx.

References pImpl.

◆ SetWindow()

void SfxViewShell::SetWindow ( vcl::Window pViewPort)

Definition at line 1696 of file viewsh.cxx.

References DisconnectAllClients(), and pWindow.

◆ SetZoomFactor()

void SfxViewShell::SetZoomFactor ( const Fraction rZoomX,
const Fraction rZoomY 
)
protectedvirtual

Definition at line 1423 of file viewsh.cxx.

References aMap, DBG_ASSERT, GetWindow(), and vcl::Window::SetMapMode().

◆ ShowCursor()

void SfxViewShell::ShowCursor ( bool  bOn = true)
virtual

Definition at line 2501 of file viewsh.cxx.

Referenced by SfxViewFrame::Enable().

◆ StartPrint()

void SfxViewShell::StartPrint ( const css::uno::Sequence< css::beans::PropertyValue > &  ,
bool  ,
bool   
)

◆ TryContextMenuInterception() [1/2]

bool SfxViewShell::TryContextMenuInterception ( const rtl::Reference< VCLXPopupMenu > &  rPopupMenu,
const OUString &  rMenuIdentifier,
css::ui::ContextMenuExecuteEvent  aEvent 
)

◆ TryContextMenuInterception() [2/2]

bool SfxViewShell::TryContextMenuInterception ( const rtl::Reference< VCLXPopupMenu > &  rIn,
const OUString &  rMenuIdentifier,
rtl::Reference< VCLXPopupMenu > &  rOut,
css::ui::ContextMenuExecuteEvent  aEvent 
)

◆ UIActivating()

void SfxViewShell::UIActivating ( SfxInPlaceClient pClient)
virtual

◆ UIDeactivated()

void SfxViewShell::UIDeactivated ( SfxInPlaceClient pClient)
virtual

◆ VisAreaChanged()

void SfxViewShell::VisAreaChanged ( )

Definition at line 2545 of file viewsh.cxx.

References pImpl.

◆ WriteUserData()

void SfxViewShell::WriteUserData ( OUString &  ,
bool  bBrowse = false 
)
virtual

Definition at line 1997 of file viewsh.cxx.

◆ WriteUserDataSequence()

void SfxViewShell::WriteUserDataSequence ( css::uno::Sequence< css::beans::PropertyValue > &  )
virtual

Definition at line 2010 of file viewsh.cxx.

Referenced by SfxViewFrame::SaveCurrentViewData_Impl().

Friends And Related Function Documentation

◆ SfxBaseController

friend class SfxBaseController
friend

Definition at line 167 of file viewsh.hxx.

◆ SfxPrinterController

friend class SfxPrinterController
friend

Definition at line 168 of file viewsh.hxx.

◆ SfxViewFrame

friend class SfxViewFrame
friend

Definition at line 166 of file viewsh.hxx.

Member Data Documentation

◆ bNoNewWindow

bool SfxViewShell::bNoNewWindow
private

Definition at line 173 of file viewsh.hxx.

◆ CharStylesColorMap

StylesHighlighterColorMap SfxViewShell::CharStylesColorMap
private

Definition at line 191 of file viewsh.hxx.

◆ m_xHelper

std::shared_ptr<SfxStoringHelper> SfxViewShell::m_xHelper
private

Used for async export.

Definition at line 188 of file viewsh.hxx.

◆ maLOKDeviceFormFactor

LOKDeviceFormFactor SfxViewShell::maLOKDeviceFormFactor
private

Definition at line 177 of file viewsh.hxx.

Referenced by SfxViewShell().

◆ maLOKIsTimezoneSet

bool SfxViewShell::maLOKIsTimezoneSet
private

Definition at line 182 of file viewsh.hxx.

Referenced by SfxViewShell().

◆ maLOKLanguageTag

LanguageTag SfxViewShell::maLOKLanguageTag
private

Definition at line 175 of file viewsh.hxx.

Referenced by SetLOKLanguageTag(), and SfxViewShell().

◆ maLOKLocale

LanguageTag SfxViewShell::maLOKLocale
private

Definition at line 176 of file viewsh.hxx.

Referenced by SetLOKLocale(), and SfxViewShell().

◆ maLOKTimezone

OUString SfxViewShell::maLOKTimezone
private

Definition at line 181 of file viewsh.hxx.

Referenced by SfxViewShell().

◆ mbLOKAccessibilityEnabled

bool SfxViewShell::mbLOKAccessibilityEnabled
private

Definition at line 178 of file viewsh.hxx.

Referenced by SetLOKAccessibilityState().

◆ mbPrinterSettingsModified

bool SfxViewShell::mbPrinterSettingsModified
private

Definition at line 174 of file viewsh.hxx.

Referenced by ExecPrint_Impl(), and StartPrint().

◆ mnCurrentDocId

ViewShellDocId SfxViewShell::mnCurrentDocId
staticprivate

Used to set the DocId at construction time. See SetCurrentDocId.

Definition at line 185 of file viewsh.hxx.

Referenced by SetCurrentDocId().

◆ mpLOKDocumentFocusListener

rtl::Reference<LOKDocumentFocusListener> SfxViewShell::mpLOKDocumentFocusListener
private

Definition at line 179 of file viewsh.hxx.

Referenced by GetLOKDocumentFocusListener().

◆ mvLOKBlockedCommandList

std::unordered_set<OUString> SfxViewShell::mvLOKBlockedCommandList
private

Definition at line 180 of file viewsh.hxx.

Referenced by isBlockedCommand(), and setBlockedCommandList().

◆ ParaStylesColorMap

StylesHighlighterColorMap SfxViewShell::ParaStylesColorMap
private

Definition at line 190 of file viewsh.hxx.

◆ pImpl

std::unique_ptr<struct SfxViewShell_Impl> SfxViewShell::pImpl
private

◆ pWindow

VclPtr<vcl::Window> SfxViewShell::pWindow
private

Definition at line 172 of file viewsh.hxx.

Referenced by GetFrameWeld(), SetLOKAccessibilityState(), and SetWindow().

◆ rFrame

SfxViewFrame& SfxViewShell::rFrame
private

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