KDDockWidgets::Core::DockWidgetViewInterface Class Reference

The interface that DockWidget views should implement. More...

#include <DockWidgetViewInterface.h>

Inheritance diagram for KDDockWidgets::Core::DockWidgetViewInterface:

Collaboration diagram for KDDockWidgets::Core::DockWidgetViewInterface:

Public Member Functions
	DockWidgetViewInterface (DockWidget *)
virtual	~DockWidgetViewInterface ()
TitleBar *	actualTitleBar () const
void	addDockWidgetAsTab (DockWidgetViewInterface *other, KDDockWidgets::InitialOption initialOption={})
void	addDockWidgetToContainingWindow (DockWidgetViewInterface *other, KDDockWidgets::Location location, DockWidgetViewInterface *relativeTo=nullptr, KDDockWidgets::InitialOption initialOption={})
Vector< QString >	affinities () const
DockWidget *	dockWidget () const
virtual std::shared_ptr< Core::View >	focusCandidate () const =0
void	forceClose ()
Group *	group () const
Icon	icon (IconPlace place=IconPlace::TitleBar) const
bool	isFloating () const
bool	isFocused () const
bool	isOpen () const
void	moveToSideBar ()
void	open ()
DockWidgetOptions	options () const
void	raise ()
void	setAffinities (const Vector< QString > &)
void	setAffinityName (const QString &name)
void	setAsCurrentTab ()
void	setFloating (bool)
void	setIcon (const Icon &icon, IconPlaces places=IconPlace::All)
void	setOptions (DockWidgetOptions)
void	setTitle (const QString &)
void	show ()
QString	title () const
QString	uniqueName () const

Protected Member Functions
	DockWidgetViewInterface (const DockWidgetViewInterface &)=delete
DockWidgetViewInterface &	operator= (const DockWidgetViewInterface &)=delete

Protected Attributes
DockWidget *const	m_dockWidget

Detailed Description

The interface that DockWidget views should implement.

Definition at line 26 of file DockWidgetViewInterface.h.

Constructor & Destructor Documentation

DockWidgetViewInterface() [1/2]

KDDockWidgets::Core::DockWidgetViewInterface::DockWidgetViewInterface ( DockWidget *  controller )

explicit

Definition at line 19 of file DockWidgetViewInterface.cpp.

~DockWidgetViewInterface()

KDDockWidgets::Core::DockWidgetViewInterface::~DockWidgetViewInterface ( )

virtualdefault

DockWidgetViewInterface() [2/2]

KDDockWidgets::Core::DockWidgetViewInterface::DockWidgetViewInterface ( const DockWidgetViewInterface &  )

protecteddelete

Member Function Documentation

actualTitleBar()

TitleBar * KDDockWidgets::Core::DockWidgetViewInterface::actualTitleBar

(

)

const

Definition at line 34 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::Group::actualTitleBar(), and group().

addDockWidgetAsTab()

void KDDockWidgets::Core::DockWidgetViewInterface::addDockWidgetAsTab	(	DockWidgetViewInterface *	other,
		KDDockWidgets::InitialOption	initialOption = {}
	)

Definition at line 108 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::addDockWidgetAsTab(), dockWidget(), and m_dockWidget.

addDockWidgetToContainingWindow()

void KDDockWidgets::Core::DockWidgetViewInterface::addDockWidgetToContainingWindow	(	DockWidgetViewInterface *	other,
		KDDockWidgets::Location	location,
		DockWidgetViewInterface *	relativeTo = nullptr,
		KDDockWidgets::InitialOption	initialOption = {}
	)

Definition at line 115 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::addDockWidgetToContainingWindow(), dockWidget(), and m_dockWidget.

affinities()

Vector< QString > KDDockWidgets::Core::DockWidgetViewInterface::affinities

(

)

const

Definition at line 154 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::affinities(), and m_dockWidget.

Referenced by setAffinities().

dockWidget()

DockWidget * KDDockWidgets::Core::DockWidgetViewInterface::dockWidget

(

)

const

Definition at line 29 of file DockWidgetViewInterface.cpp.

References m_dockWidget.

Referenced by KDDockWidgets::QtQuick::DockWidget::DockWidget(), KDDockWidgets::QtWidgets::MDIArea::addDockWidget(), KDDockWidgets::Core::MainWindowViewInterface::addDockWidget(), KDDockWidgets::Core::MainWindowMDIViewInterface::addDockWidget(), KDDockWidgets::Core::MainWindowViewInterface::addDockWidgetAsTab(), addDockWidgetAsTab(), KDDockWidgets::QtQuick::TabBar::addDockWidgetAsTab(), addDockWidgetToContainingWindow(), KDDockWidgets::QtQuick::DockWidget::event(), KDDockWidgets::Core::MainWindowViewInterface::layoutParentContainerEqually(), KDDockWidgets::QtQuick::DockWidget::maxSizeHint(), KDDockWidgets::QtQuick::DockWidget::minSize(), KDDockWidgets::QtWidgets::MDIArea::moveDockWidget(), KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar(), KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar(), KDDockWidgets::Core::MainWindowViewInterface::overlayOnSideBar(), KDDockWidgets::QtWidgets::MDIArea::resizeDockWidget(), KDDockWidgets::Core::MainWindowViewInterface::restoreFromSideBar(), KDDockWidgets::QtQuick::DockWidget::setGuestItem(), and KDDockWidgets::Core::MainWindowViewInterface::toggleOverlayOnSideBar().

focusCandidate()

virtual std::shared_ptr< Core::View > KDDockWidgets::Core::DockWidgetViewInterface::focusCandidate ( ) const

pure virtual

Implemented in KDDockWidgets::flutter::DockWidget, KDDockWidgets::QtQuick::DockWidget, and KDDockWidgets::QtWidgets::DockWidget.

forceClose()

void KDDockWidgets::Core::DockWidgetViewInterface::forceClose

(

)

Definition at line 83 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::forceClose(), and m_dockWidget.

group()

Group * KDDockWidgets::Core::DockWidgetViewInterface::group

(

)

const

Definition at line 24 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::dptr(), and m_dockWidget.

Referenced by actualTitleBar(), KDDockWidgets::QtQuick::DockWidget::groupVisualItem(), and KDDockWidgets::QtQuick::DockWidget::onGeometryUpdated().

icon()

Icon KDDockWidgets::Core::DockWidgetViewInterface::icon

(

IconPlace

place = IconPlace::TitleBar

)

const

Definition at line 139 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::icon(), and m_dockWidget.

Referenced by setIcon().

isFloating()

bool KDDockWidgets::Core::DockWidgetViewInterface::isFloating

(

)

const

Definition at line 48 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::isFloating(), and m_dockWidget.

isFocused()

bool KDDockWidgets::Core::DockWidgetViewInterface::isFocused

(

)

const

Definition at line 43 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::isFocused(), and m_dockWidget.

isOpen()

bool KDDockWidgets::Core::DockWidgetViewInterface::isOpen

(

)

const

Definition at line 78 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::isOpen(), and m_dockWidget.

moveToSideBar()

void KDDockWidgets::Core::DockWidgetViewInterface::moveToSideBar

(

)

Definition at line 103 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::moveToSideBar().

open()

void KDDockWidgets::Core::DockWidgetViewInterface::open

(

)

Definition at line 88 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::open().

Referenced by KDDockWidgets::QtWidgets::DockWidget::DockWidget(), and show().

operator=()

DockWidgetViewInterface & KDDockWidgets::Core::DockWidgetViewInterface::operator= ( const DockWidgetViewInterface &  )

protecteddelete

options()

DockWidgetOptions KDDockWidgets::Core::DockWidgetViewInterface::options

(

)

const

Definition at line 124 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::options().

raise()

void KDDockWidgets::Core::DockWidgetViewInterface::raise

(

)

Definition at line 98 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::raise().

setAffinities()

void KDDockWidgets::Core::DockWidgetViewInterface::setAffinities

(

const Vector< QString > &

affinities

)

Definition at line 144 of file DockWidgetViewInterface.cpp.

References affinities(), m_dockWidget, and KDDockWidgets::Core::DockWidget::setAffinities().

setAffinityName()

void KDDockWidgets::Core::DockWidgetViewInterface::setAffinityName

(

const QString &

name

)

Definition at line 149 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::setAffinityName().

setAsCurrentTab()

void KDDockWidgets::Core::DockWidgetViewInterface::setAsCurrentTab

(

)

Definition at line 73 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::setAsCurrentTab().

setFloating()

void KDDockWidgets::Core::DockWidgetViewInterface::setFloating

(

bool

is

)

Definition at line 68 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::setFloating().

setIcon()

void KDDockWidgets::Core::DockWidgetViewInterface::setIcon	(	const Icon &	icon,
		IconPlaces	places = IconPlace::All
	)

Definition at line 134 of file DockWidgetViewInterface.cpp.

References icon(), m_dockWidget, and KDDockWidgets::Core::DockWidget::setIcon().

setOptions()

void KDDockWidgets::Core::DockWidgetViewInterface::setOptions

(

DockWidgetOptions

opts

)

Definition at line 129 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::setOptions().

setTitle()

void KDDockWidgets::Core::DockWidgetViewInterface::setTitle

(

const QString &

title

)

Definition at line 63 of file DockWidgetViewInterface.cpp.

References m_dockWidget, KDDockWidgets::Core::DockWidget::setTitle(), and title().

show()

void KDDockWidgets::Core::DockWidgetViewInterface::show

(

)

Deprecated:

. Use open() instead.

Definition at line 93 of file DockWidgetViewInterface.cpp.

References open().

title()

QString KDDockWidgets::Core::DockWidgetViewInterface::title

(

)

const

Definition at line 58 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::title().

Referenced by setTitle(), KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::DockWidget_wrapper::setWindowTitle(), and KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::DockWidget_wrapper::setWindowTitle_nocallback().

uniqueName()

QString KDDockWidgets::Core::DockWidgetViewInterface::uniqueName

(

)

const

Definition at line 53 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::uniqueName().

Member Data Documentation

m_dockWidget

DockWidget* const KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget

protected

Definition at line 72 of file DockWidgetViewInterface.h.

Referenced by KDDockWidgets::flutter::DockWidget::DockWidget(), KDDockWidgets::QtWidgets::DockWidget::DockWidget(), KDDockWidgets::QtQuick::DockWidget::DockWidget(), addDockWidgetAsTab(), addDockWidgetToContainingWindow(), affinities(), dockWidget(), KDDockWidgets::flutter::DockWidget::dockWidget(), KDDockWidgets::QtWidgets::DockWidget::event(), KDDockWidgets::QtQuick::DockWidget::floatAction(), KDDockWidgets::QtWidgets::DockWidget::floatAction(), KDDockWidgets::QtWidgets::DockWidget::focusCandidate(), forceClose(), group(), KDDockWidgets::QtQuick::DockWidget::guestItem(), icon(), isFloating(), isFocused(), isOpen(), moveToSideBar(), open(), options(), raise(), KDDockWidgets::QtWidgets::DockWidget::resizeEvent(), setAffinities(), setAffinityName(), setAsCurrentTab(), setFloating(), setIcon(), setOptions(), setTitle(), KDDockWidgets::QtWidgets::DockWidget::setWidget(), title(), KDDockWidgets::QtQuick::DockWidget::toggleAction(), KDDockWidgets::QtWidgets::DockWidget::toggleAction(), uniqueName(), and KDDockWidgets::QtWidgets::DockWidget::widget().

---

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

• DockWidgetViewInterface.h
• DockWidgetViewInterface.cpp