#include <titledockwin.hxx>

Inheritance diagram for sd::TitledDockingWindow:

Collaboration diagram for sd::TitledDockingWindow:

Public Types
enum	Orientation { HorizontalOrientation , VerticalOrientation , UnknownOrientation }

Public Member Functions
	TitledDockingWindow (SfxBindings i_pBindings, SfxChildWindow i_pChildWindow, vcl::Window *i_pParent, const OUString &rsTitle)
	Create a new docking window. More...

virtual	~TitledDockingWindow () override

virtual void	dispose () override

vcl::Window &	GetContentWindow ()
	returns the content window, which is to be used as parent window for any content to be displayed in the docking window. More...

const vcl::Window &	GetContentWindow () const

const SvBorder &	GetDecorationBorder () const
	Return the border that is painted around the inner window as decoration. More...

void	SetValidSizeRange (const Range &rValidSizeRange)
	When docked the given range is passed to the parent SplitWindow. More...

Orientation	GetOrientation () const
	When the TitledDockingWindow is docked and managed by a split window it can derive its orientation from the orientation of the split window and return either HorizontalOrientation or VerticalOrientation. More...

Public Member Functions inherited from SfxDockingWindow
	SfxDockingWindow (SfxBindings pBindings, SfxChildWindow pCW, vcl::Window *pParent, WinBits nWinBits)

	SfxDockingWindow (SfxBindings pBindings, SfxChildWindow pCW, vcl::Window *pParent, const OUString &rID, const OUString &rUIXMLDescription)

virtual	~SfxDockingWindow () override

virtual void	dispose () override

void	Initialize (SfxChildWinInfo *pInfo)

virtual void	FillInfo (SfxChildWinInfo &) const

virtual void	StateChanged (StateChangedType nStateChange) override

void	SetDockingRects (const tools::Rectangle &rOuter, const tools::Rectangle &rInner)

const tools::Rectangle &	GetInnerRect () const

const tools::Rectangle &	GetOuterRect () const

SfxBindings &	GetBindings () const

sal_uInt16	GetType () const

SfxChildAlignment	GetAlignment () const

void	SetAlignment (SfxChildAlignment eAlign)

const Size &	GetFloatingSize () const

void	SetFloatingSize (const Size &rSize)

void	SetMinOutputSizePixel (const Size &rSize)

const Size &	GetMinOutputSizePixel () const

virtual bool	EventNotify (NotifyEvent &rNEvt) override

	DECL_DLLPRIVATE_LINK (TimerHdl, Timer *, void)

SAL_DLLPRIVATE void	Initialize_Impl ()

SAL_DLLPRIVATE void	SetItemSize_Impl (const Size &rSize)

SAL_DLLPRIVATE void	Disappear_Impl ()

SAL_DLLPRIVATE void	Reappear_Impl ()

SAL_DLLPRIVATE bool	IsAutoHide_Impl () const

SAL_DLLPRIVATE void	AutoShow_Impl ()

SAL_DLLPRIVATE void	ReleaseChildWindow_Impl ()

Private Member Functions
virtual void	Paint (vcl::RenderContext &rRenderContext, const ::tools::Rectangle &i_rArea) override

virtual void	Resize () override

virtual void	StateChanged (StateChangedType i_nType) override

virtual void	DataChanged (const DataChangedEvent &i_rDataChangedEvent) override

virtual void	SetText (const OUString &i_rText) override

virtual void	MouseButtonDown (const MouseEvent &rEvent) override

virtual void	ApplySettings (vcl::RenderContext &rRenderContext) override

void	impl_resetToolBox ()
	internal version of ResetToolBox More...

	DECL_LINK (OnToolboxItemSelected, ToolBox *, void)

void	impl_layout ()

Private Attributes
OUString	m_sTitle

VclPtr< ToolBox >	m_aToolbox

VclPtr< Window >	m_aContentWindow

SvBorder	m_aBorder
	The border that is painted around the inner window. More...

int	m_nTitleBarHeight
	Height of the title bar. More...

Additional Inherited Members
Protected Member Functions inherited from SfxDockingWindow
SfxChildAlignment	CalcAlignment (const Point &rPos, tools::Rectangle &rRect)

virtual Size	CalcDockingSize (SfxChildAlignment)

virtual SfxChildAlignment	CheckAlignment (SfxChildAlignment, SfxChildAlignment)

virtual void	Resize () override

virtual bool	PrepareToggleFloatingMode () override

virtual void	ToggleFloatingMode () override

virtual void	StartDocking () override

virtual bool	Docking (const Point &rPos, tools::Rectangle &rRect) override

virtual void	EndDocking (const tools::Rectangle &rRect, bool bFloatMode) override

virtual void	Resizing (Size &rSize) override

virtual void	Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect) override

virtual bool	Close () override

virtual void	Move () override

SAL_DLLPRIVATE SfxChildWindow *	GetChildWindow_Impl ()

Protected Attributes inherited from SfxDockingWindow
std::unique_ptr< weld::Builder >	m_xBuilder

std::unique_ptr< weld::Box >	m_xContainer

Detailed Description

Definition at line 30 of file titledockwin.hxx.

Member Enumeration Documentation

◆ Orientation

enum sd::TitledDockingWindow::Orientation

Enumerator
HorizontalOrientation
VerticalOrientation
UnknownOrientation

Definition at line 70 of file titledockwin.hxx.

Constructor & Destructor Documentation

◆ TitledDockingWindow()

sd::TitledDockingWindow::TitledDockingWindow	(	SfxBindings *	i_pBindings,
		SfxChildWindow *	i_pChildWindow,
		vcl::Window *	i_pParent,
		const OUString &	rsTitle
	)

Create a new docking window.

Parameters

pBindings	Used, among others, to determine the ViewShellBase and PaneManager that manage the new docking window.
pChildWindow	This child window is the logical container for the new docking window.
pParent	The parent window of the new docking window.
rsTitle	the initial title

Definition at line 38 of file titledockwin.cxx.

References Create(), impl_resetToolBox(), LINK, m_aContentWindow, m_aToolbox, m_sTitle, WB_3DLOOK, WB_CLOSEABLE, WB_DIALOGCONTROL, WB_DOCKABLE, WB_HIDE, and WB_MOVEABLE.

◆ ~TitledDockingWindow()

sd::TitledDockingWindow::~TitledDockingWindow ( )

overridevirtual

Definition at line 59 of file titledockwin.cxx.

Member Function Documentation

◆ ApplySettings()

void sd::TitledDockingWindow::ApplySettings ( vcl::RenderContext & rRenderContext )

overrideprivatevirtual

Definition at line 119 of file titledockwin.cxx.

References StyleSettings::GetAppFont(), StyleSettings::GetButtonTextColor(), OutputDevice::GetSettings(), AllSettings::GetStyleSettings(), and OutputDevice::SetTextFillColor().

◆ DataChanged()

void sd::TitledDockingWindow::DataChanged ( const DataChangedEvent & i_rDataChangedEvent )

overrideprivatevirtual

Definition at line 255 of file titledockwin.cxx.

References DataChangedEvent::GetFlags(), DataChangedEvent::GetType(), and impl_layout().

◆ DECL_LINK()

sd::TitledDockingWindow::DECL_LINK	(	OnToolboxItemSelected	,
		ToolBox *	,
		void
	)

private

◆ dispose()

void sd::TitledDockingWindow::dispose ( void )

overridevirtual

Reimplemented from SfxDockingWindow.

Definition at line 64 of file titledockwin.cxx.

References SfxDockingWindow::dispose(), VclPtr< class reference_type >::disposeAndClear(), m_aContentWindow, and m_aToolbox.

◆ GetContentWindow() [1/2]

vcl::Window & sd::TitledDockingWindow::GetContentWindow ( )

inline

returns the content window, which is to be used as parent window for any content to be displayed in the docking window.

Definition at line 58 of file titledockwin.hxx.

References m_aContentWindow.

Referenced by sd::framework::ChildWindowPane::GetWindow(), MouseButtonDown(), and StateChanged().

◆ GetContentWindow() [2/2]

const vcl::Window & sd::TitledDockingWindow::GetContentWindow ( ) const

inline

Definition at line 59 of file titledockwin.hxx.

References m_aContentWindow.

◆ GetDecorationBorder()

const SvBorder & sd::TitledDockingWindow::GetDecorationBorder ( ) const

inline

Return the border that is painted around the inner window as decoration.

Definition at line 64 of file titledockwin.hxx.

References m_aBorder.

Referenced by SetValidSizeRange().

◆ GetOrientation()

TitledDockingWindow::Orientation sd::TitledDockingWindow::GetOrientation ( ) const

When the TitledDockingWindow is docked and managed by a split window it can derive its orientation from the orientation of the split window and return either HorizontalOrientation or VerticalOrientation.

Otherwise UnknownOrientation is returned.

Definition at line 312 of file titledockwin.cxx.

References HorizontalOrientation, SplitWindow::IsHorizontal(), UnknownOrientation, and VerticalOrientation.

Referenced by sd::slidesorter::view::SlideSorterView::UpdateOrientation().

◆ impl_layout()

void sd::TitledDockingWindow::impl_layout ( )

private

Definition at line 87 of file titledockwin.cxx.

References Size::AdjustHeight(), SvBorder::Bottom(), Size::Height(), SvBorder::Left(), m_aBorder, m_aContentWindow, m_aToolbox, m_nTitleBarHeight, SvBorder::Right(), SvBorder::Top(), and Size::Width().

Referenced by DataChanged(), Resize(), and StateChanged().

◆ impl_resetToolBox()

void sd::TitledDockingWindow::impl_resetToolBox ( )

private

internal version of ResetToolBox

Definition at line 194 of file titledockwin.cxx.

References m_aToolbox, and SdResId().

Referenced by TitledDockingWindow().

◆ MouseButtonDown()

void sd::TitledDockingWindow::MouseButtonDown ( const MouseEvent & rEvent )

overrideprivatevirtual

Definition at line 276 of file titledockwin.cxx.

References MouseEvent::GetButtons(), GetContentWindow(), vcl::Window::GrabFocus(), MOUSE_LEFT, vcl::Window::SetStyle(), and WB_DIALOGCONTROL.

◆ Paint()

void sd::TitledDockingWindow::Paint	(	vcl::RenderContext &	rRenderContext,
		const ::tools::Rectangle &	i_rArea
	)

overrideprivatevirtual

◆ Resize()

void sd::TitledDockingWindow::Resize ( )

overrideprivatevirtual

Reimplemented from SfxDockingWindow.

Definition at line 80 of file titledockwin.cxx.

References impl_layout(), and SfxDockingWindow::Resize().

Referenced by StateChanged().

◆ SetText()

void sd::TitledDockingWindow::SetText ( const OUString & i_rText )

overrideprivatevirtual

Definition at line 71 of file titledockwin.cxx.

References m_sTitle.

◆ SetValidSizeRange()

void sd::TitledDockingWindow::SetValidSizeRange ( const Range & rValidSizeRange )

When docked the given range is passed to the parent SplitWindow.

Definition at line 291 of file titledockwin.cxx.

References SvBorder::Bottom(), GetDecorationBorder(), SplitWindow::GetItemId(), SplitWindow::GetSet(), SplitWindow::IsHorizontal(), SvBorder::Left(), Range::Max(), Range::Min(), nId, SvBorder::Right(), SplitWindow::SetItemSizeRange(), and SvBorder::Top().

Referenced by sd::slidesorter::view::SlideSorterView::UpdateOrientation().

◆ StateChanged()

void sd::TitledDockingWindow::StateChanged ( StateChangedType i_nType )

overrideprivatevirtual

Reimplemented from SfxDockingWindow.

Definition at line 224 of file titledockwin.cxx.

References SfxDockingWindow::GetBindings(), GetContentWindow(), GetDispatcher(), sd::ViewShellBase::GetViewShellBase(), impl_layout(), sd::framework::FrameworkHelper::Instance(), Resize(), vcl::Window::SetStyle(), SfxDockingWindow::StateChanged(), and WB_DIALOGCONTROL.

Member Data Documentation

◆ m_aBorder

SvBorder sd::TitledDockingWindow::m_aBorder

private

The border that is painted around the inner window.

The bevel shadow lines are part of the border, so where the border is 0 no such line is painted.

Definition at line 104 of file titledockwin.hxx.

Referenced by GetDecorationBorder(), impl_layout(), and Paint().

◆ m_aContentWindow

VclPtr<Window> sd::TitledDockingWindow::m_aContentWindow

private

Definition at line 98 of file titledockwin.hxx.

Referenced by dispose(), GetContentWindow(), impl_layout(), and TitledDockingWindow().

◆ m_aToolbox

VclPtr<ToolBox> sd::TitledDockingWindow::m_aToolbox

private

Definition at line 97 of file titledockwin.hxx.

Referenced by dispose(), impl_layout(), impl_resetToolBox(), and TitledDockingWindow().

◆ m_nTitleBarHeight

int sd::TitledDockingWindow::m_nTitleBarHeight

private

Height of the title bar.

Calculated in impl_layout().

Definition at line 108 of file titledockwin.hxx.

Referenced by impl_layout(), and Paint().

◆ m_sTitle

OUString sd::TitledDockingWindow::m_sTitle

private

Definition at line 96 of file titledockwin.hxx.

Referenced by Paint(), SetText(), and TitledDockingWindow().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Orientation

Constructor & Destructor Documentation

◆ TitledDockingWindow()

◆ ~TitledDockingWindow()

Member Function Documentation

◆ ApplySettings()

◆ DataChanged()

◆ DECL_LINK()

◆ dispose()

◆ GetContentWindow() [1/2]

◆ GetContentWindow() [2/2]

◆ GetDecorationBorder()

◆ GetOrientation()

◆ impl_layout()

◆ impl_resetToolBox()

◆ MouseButtonDown()

◆ Paint()

◆ Resize()

◆ SetText()

◆ SetValidSizeRange()

◆ StateChanged()

Member Data Documentation

◆ m_aBorder

◆ m_aContentWindow

◆ m_aToolbox

◆ m_nTitleBarHeight

◆ m_sTitle