LibreOffice Module sd (master) 1
Public Member Functions | Private Attributes | List of all members
sd::framework::ChildWindowPane Class Reference

The ChildWindowPane listens to the child window and disposes itself when the child window becomes inaccessible. More...

#include <ChildWindowPane.hxx>

Inheritance diagram for sd::framework::ChildWindowPane:
[legend]
Collaboration diagram for sd::framework::ChildWindowPane:
[legend]

Public Member Functions

 ChildWindowPane (const css::uno::Reference< css::drawing::framework::XResourceId > &rxPaneId, sal_uInt16 nChildWindowId, ViewShellBase &rViewShellBase, ::std::unique_ptr< SfxShell > &&pShell)
 
virtual ~ChildWindowPane () override
 
void Hide ()
 Hide the pane. More...
 
virtual void SAL_CALL disposing () override
 
virtual vcl::WindowGetWindow () override
 This returns the content window when the child window is already visible. More...
 
virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getWindow () override
 The local getWindow() first calls GetWindow() to provide a valid window pointer before forwarding the call to the base class. More...
 
virtual void SAL_CALL disposing (const css::lang::EventObject &rEvent) override
 

Private Attributes

sal_uInt16 mnChildWindowId
 
ViewShellBasemrViewShellBase
 
::std::unique_ptr< SfxShellmpShell
 
bool mbHasBeenActivated
 This flag is set when the pane shell has been activated at least once. More...
 

Detailed Description

The ChildWindowPane listens to the child window and disposes itself when the child window becomes inaccessible.

This happens for instance when a document is made read-only and the task pane is turned off.

Definition at line 46 of file ChildWindowPane.hxx.

Constructor & Destructor Documentation

◆ ChildWindowPane()

sd::framework::ChildWindowPane::ChildWindowPane ( const css::uno::Reference< css::drawing::framework::XResourceId > &  rxPaneId,
sal_uInt16  nChildWindowId,
ViewShellBase rViewShellBase,
::std::unique_ptr< SfxShell > &&  pShell 
)

◆ ~ChildWindowPane()

sd::framework::ChildWindowPane::~ChildWindowPane ( )
overridevirtual

Definition at line 87 of file ChildWindowPane.cxx.

Member Function Documentation

◆ disposing() [1/2]

void SAL_CALL sd::framework::ChildWindowPane::disposing ( )
overridevirtual

◆ disposing() [2/2]

virtual void SAL_CALL sd::framework::ChildWindowPane::disposing ( const css::lang::EventObject &  rEvent)
overridevirtual

◆ GetWindow()

vcl::Window * sd::framework::ChildWindowPane::GetWindow ( )
overridevirtual

This returns the content window when the child window is already visible.

Otherwise <NULL> is returned. In that case a later call may return the requested window (making a child window visible is an asynchronous process.) Note that GetWindow() may return different Window pointers when Hide() is called in between.

Definition at line 118 of file ChildWindowPane.cxx.

References SfxViewFrame::GetChildWindow(), sd::TitledDockingWindow::GetContentWindow(), VCLUnoHelper::GetInterface(), SfxViewShell::GetViewFrame(), SfxChildWindow::GetWindow(), SfxViewFrame::HasChildWindow(), SfxViewFrame::KnowsChildWindow(), mbHasBeenActivated, mnChildWindowId, mpShell, mpWindow, mrViewShellBase, SfxViewFrame::SetChildWindow(), and SfxViewFrame::ShowChildWindow().

Referenced by getWindow().

◆ getWindow()

Reference< awt::XWindow > SAL_CALL sd::framework::ChildWindowPane::getWindow ( )
overridevirtual

The local getWindow() first calls GetWindow() to provide a valid window pointer before forwarding the call to the base class.

Definition at line 181 of file ChildWindowPane.cxx.

References GetWindow(), sd::framework::Pane::getWindow(), and mpWindow.

◆ Hide()

void sd::framework::ChildWindowPane::Hide ( )

Member Data Documentation

◆ mbHasBeenActivated

bool sd::framework::ChildWindowPane::mbHasBeenActivated
private

This flag is set when the pane shell has been activated at least once.

It is used to optimize the start-up performance (by not showing the window too early) and by not delaying its creation at later times.

Definition at line 96 of file ChildWindowPane.hxx.

Referenced by GetWindow().

◆ mnChildWindowId

sal_uInt16 sd::framework::ChildWindowPane::mnChildWindowId
private

Definition at line 87 of file ChildWindowPane.hxx.

Referenced by ChildWindowPane(), GetWindow(), and Hide().

◆ mpShell

::std::unique_ptr<SfxShell> sd::framework::ChildWindowPane::mpShell
private

Definition at line 89 of file ChildWindowPane.hxx.

Referenced by ChildWindowPane(), disposing(), and GetWindow().

◆ mrViewShellBase

ViewShellBase& sd::framework::ChildWindowPane::mrViewShellBase
private

Definition at line 88 of file ChildWindowPane.hxx.

Referenced by ChildWindowPane(), disposing(), GetWindow(), and Hide().


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