KDDockWidgets::Core::MainWindowViewInterface Class Reference

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

#include <MainWindowViewInterface.h>

Inheritance diagram for KDDockWidgets::Core::MainWindowViewInterface:

Collaboration diagram for KDDockWidgets::Core::MainWindowViewInterface:

Public Member Functions
	MainWindowViewInterface (MainWindow *)
virtual	~MainWindowViewInterface ()
void	addDockWidget (const QString &dockId, KDDockWidgets::Location, const QString &relativeToDockId={}, const KDDockWidgets::InitialOption &={})
void	addDockWidget (DockWidgetViewInterface *dockWidget, KDDockWidgets::Location location, DockWidgetViewInterface *relativeTo=nullptr, const KDDockWidgets::InitialOption &initialOption={})
void	addDockWidgetAsTab (const QString &dockId)
void	addDockWidgetAsTab (DockWidgetViewInterface *dockwidget)
Vector< QString >	affinities () const
bool	anySideBarIsVisible () const
virtual Margins	centerWidgetMargins () const =0
virtual Rect	centralAreaGeometry () const =0
void	clearSideBarOverlay (bool deleteFrame=true)
bool	closeDockWidgets (bool force=false)
bool	isMDI () const
void	layoutEqually ()
void	layoutParentContainerEqually (const QString &dockId)
void	layoutParentContainerEqually (DockWidgetViewInterface *)
MainWindow *	mainWindow () const
	Returns the main window controller.
void	moveToSideBar (const QString &dockId)
void	moveToSideBar (const QString &dockId, KDDockWidgets::SideBarLocation)
void	moveToSideBar (DockWidgetViewInterface *)
void	moveToSideBar (DockWidgetViewInterface *, KDDockWidgets::SideBarLocation)
MainWindowOptions	options () const
void	overlayOnSideBar (const QString &dockId)
void	overlayOnSideBar (DockWidgetViewInterface *)
void	restoreFromSideBar (const QString &dockId)
void	restoreFromSideBar (DockWidgetViewInterface *)
void	setAffinities (const Vector< QString > &names)
virtual void	setContentsMargins (int left, int top, int right, int bottom)=0
void	setPersistentCentralView (std::shared_ptr< Core::View >)
bool	sideBarIsVisible (KDDockWidgets::SideBarLocation) const
void	toggleOverlayOnSideBar (const QString &dockId)
void	toggleOverlayOnSideBar (DockWidgetViewInterface *)
QString	uniqueName () const

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

Protected Attributes
MainWindow *const	m_mainWindow

Detailed Description

The interface that MainWindow views should implement.

Definition at line 27 of file MainWindowViewInterface.h.

Constructor & Destructor Documentation

MainWindowViewInterface() [1/2]

KDDockWidgets::Core::MainWindowViewInterface::MainWindowViewInterface ( Core::MainWindow *  controller )

explicit

Definition at line 20 of file MainWindowViewInterface.cpp.

~MainWindowViewInterface()

KDDockWidgets::Core::MainWindowViewInterface::~MainWindowViewInterface ( )

virtualdefault

MainWindowViewInterface() [2/2]

KDDockWidgets::Core::MainWindowViewInterface::MainWindowViewInterface ( const MainWindowViewInterface &  )

protecteddelete

Member Function Documentation

addDockWidget() [1/2]

void KDDockWidgets::Core::MainWindowViewInterface::addDockWidget	(	const QString &	dockId,
		KDDockWidgets::Location	location,
		const QString &	relativeToDockId = {},
		const KDDockWidgets::InitialOption &	initialOption = {}
	)

Definition at line 200 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::addDockWidget(), KDDockWidgets::DockRegistry::dockByName(), QString::isEmpty(), m_mainWindow, and KDDockWidgets::DockRegistry::self().

addDockWidget() [2/2]

void KDDockWidgets::Core::MainWindowViewInterface::addDockWidget	(	DockWidgetViewInterface *	dockWidget,
		KDDockWidgets::Location	location,
		DockWidgetViewInterface *	relativeTo = nullptr,
		const KDDockWidgets::InitialOption &	initialOption = {}
	)

Definition at line 83 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::addDockWidget(), KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), and m_mainWindow.

addDockWidgetAsTab() [1/2]

void KDDockWidgets::Core::MainWindowViewInterface::addDockWidgetAsTab

(

const QString &

dockId

)

Definition at line 191 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::addDockWidgetAsTab(), m_mainWindow, and KDDockWidgets::DockRegistry::self().

addDockWidgetAsTab() [2/2]

void KDDockWidgets::Core::MainWindowViewInterface::addDockWidgetAsTab

(

DockWidgetViewInterface *

dockwidget

)

Definition at line 77 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::addDockWidgetAsTab(), KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), and m_mainWindow.

affinities()

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

(

)

const

Definition at line 37 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::affinities(), and m_mainWindow.

anySideBarIsVisible()

bool KDDockWidgets::Core::MainWindowViewInterface::anySideBarIsVisible

(

)

const

Definition at line 93 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::anySideBarIsVisible(), and m_mainWindow.

centerWidgetMargins()

virtual Margins KDDockWidgets::Core::MainWindowViewInterface::centerWidgetMargins ( ) const

pure virtual

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::MainWindow_wrapper, KDDockWidgets::flutter::MainWindow, KDDockWidgets::QtQuick::MainWindow, and KDDockWidgets::QtWidgets::MainWindow.

centralAreaGeometry()

virtual Rect KDDockWidgets::Core::MainWindowViewInterface::centralAreaGeometry ( ) const

pure virtual

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::MainWindow_wrapper, KDDockWidgets::flutter::MainWindow, KDDockWidgets::QtQuick::MainWindow, and KDDockWidgets::QtWidgets::MainWindow.

clearSideBarOverlay()

void KDDockWidgets::Core::MainWindowViewInterface::clearSideBarOverlay

(

bool

deleteFrame = true

)

Definition at line 67 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::clearSideBarOverlay(), and m_mainWindow.

closeDockWidgets()

bool KDDockWidgets::Core::MainWindowViewInterface::closeDockWidgets

(

bool

force = false

)

Definition at line 57 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::closeDockWidgets(), and m_mainWindow.

isMDI()

bool KDDockWidgets::Core::MainWindowViewInterface::isMDI

(

)

const

Definition at line 52 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::isMDI(), and m_mainWindow.

layoutEqually()

void KDDockWidgets::Core::MainWindowViewInterface::layoutEqually

(

)

Definition at line 72 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::layoutEqually(), and m_mainWindow.

layoutParentContainerEqually() [1/2]

void KDDockWidgets::Core::MainWindowViewInterface::layoutParentContainerEqually

(

const QString &

dockId

)

Definition at line 182 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::MainWindow::layoutParentContainerEqually(), m_mainWindow, and KDDockWidgets::DockRegistry::self().

layoutParentContainerEqually() [2/2]

void KDDockWidgets::Core::MainWindowViewInterface::layoutParentContainerEqually

(

DockWidgetViewInterface *

dockView

)

Definition at line 129 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), KDDockWidgets::Core::MainWindow::layoutParentContainerEqually(), and m_mainWindow.

mainWindow()

Core::MainWindow * KDDockWidgets::Core::MainWindowViewInterface::mainWindow

(

)

const

Returns the main window controller.

Definition at line 27 of file MainWindowViewInterface.cpp.

References m_mainWindow.

moveToSideBar() [1/4]

void KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar

(

const QString &

dockId

)

Definition at line 136 of file MainWindowViewInterface.cpp.

References m_mainWindow, KDDockWidgets::Core::MainWindow::moveToSideBar(), and KDDockWidgets::DockRegistry::self().

moveToSideBar() [2/4]

void KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar	(	const QString &	dockId,
		KDDockWidgets::SideBarLocation	loc
	)

Definition at line 145 of file MainWindowViewInterface.cpp.

References m_mainWindow, KDDockWidgets::Core::MainWindow::moveToSideBar(), and KDDockWidgets::DockRegistry::self().

moveToSideBar() [3/4]

void KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar

(

DockWidgetViewInterface *

dockView

)

Definition at line 98 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), m_mainWindow, and KDDockWidgets::Core::MainWindow::moveToSideBar().

moveToSideBar() [4/4]

void KDDockWidgets::Core::MainWindowViewInterface::moveToSideBar	(	DockWidgetViewInterface *	dockView,
		KDDockWidgets::SideBarLocation	loc
	)

Definition at line 104 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), m_mainWindow, and KDDockWidgets::Core::MainWindow::moveToSideBar().

operator=()

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

protecteddelete

options()

MainWindowOptions KDDockWidgets::Core::MainWindowViewInterface::options

(

)

const

Definition at line 47 of file MainWindowViewInterface.cpp.

References m_mainWindow, and KDDockWidgets::Core::MainWindow::options().

overlayOnSideBar() [1/2]

void KDDockWidgets::Core::MainWindowViewInterface::overlayOnSideBar

(

const QString &

dockId

)

Definition at line 164 of file MainWindowViewInterface.cpp.

References m_mainWindow, KDDockWidgets::Core::MainWindow::overlayOnSideBar(), and KDDockWidgets::DockRegistry::self().

overlayOnSideBar() [2/2]

void KDDockWidgets::Core::MainWindowViewInterface::overlayOnSideBar

(

DockWidgetViewInterface *

dockView

)

Definition at line 117 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), m_mainWindow, and KDDockWidgets::Core::MainWindow::overlayOnSideBar().

restoreFromSideBar() [1/2]

void KDDockWidgets::Core::MainWindowViewInterface::restoreFromSideBar

(

const QString &

dockId

)

Definition at line 155 of file MainWindowViewInterface.cpp.

References m_mainWindow, KDDockWidgets::Core::MainWindow::restoreFromSideBar(), and KDDockWidgets::DockRegistry::self().

restoreFromSideBar() [2/2]

void KDDockWidgets::Core::MainWindowViewInterface::restoreFromSideBar

(

DockWidgetViewInterface *

dockView

)

Definition at line 111 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), m_mainWindow, and KDDockWidgets::Core::MainWindow::restoreFromSideBar().

setAffinities()

void KDDockWidgets::Core::MainWindowViewInterface::setAffinities

(

const Vector< QString > &

names

)

Definition at line 42 of file MainWindowViewInterface.cpp.

References m_mainWindow, and KDDockWidgets::Core::MainWindow::setAffinities().

setContentsMargins()

virtual void KDDockWidgets::Core::MainWindowViewInterface::setContentsMargins ( int  left, int  top, int  right, int  bottom  )

pure virtual

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::MainWindow_wrapper, KDDockWidgets::flutter::MainWindow, KDDockWidgets::QtQuick::MainWindow, and KDDockWidgets::QtWidgets::MainWindow.

setPersistentCentralView()

void KDDockWidgets::Core::MainWindowViewInterface::setPersistentCentralView

(

std::shared_ptr< Core::View >

view

)

Definition at line 214 of file MainWindowViewInterface.cpp.

References m_mainWindow, and KDDockWidgets::Core::MainWindow::setPersistentCentralView().

sideBarIsVisible()

bool KDDockWidgets::Core::MainWindowViewInterface::sideBarIsVisible

(

KDDockWidgets::SideBarLocation

loc

)

const

Definition at line 62 of file MainWindowViewInterface.cpp.

References m_mainWindow, and KDDockWidgets::Core::MainWindow::sideBarIsVisible().

toggleOverlayOnSideBar() [1/2]

void KDDockWidgets::Core::MainWindowViewInterface::toggleOverlayOnSideBar

(

const QString &

dockId

)

Definition at line 173 of file MainWindowViewInterface.cpp.

References m_mainWindow, KDDockWidgets::DockRegistry::self(), and KDDockWidgets::Core::MainWindow::toggleOverlayOnSideBar().

toggleOverlayOnSideBar() [2/2]

void KDDockWidgets::Core::MainWindowViewInterface::toggleOverlayOnSideBar

(

DockWidgetViewInterface *

dockView

)

Definition at line 123 of file MainWindowViewInterface.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::dockWidget(), m_mainWindow, and KDDockWidgets::Core::MainWindow::toggleOverlayOnSideBar().

uniqueName()

QString KDDockWidgets::Core::MainWindowViewInterface::uniqueName

(

)

const

Definition at line 32 of file MainWindowViewInterface.cpp.

References m_mainWindow, and KDDockWidgets::Core::MainWindow::uniqueName().

Member Data Documentation

m_mainWindow

MainWindow* const KDDockWidgets::Core::MainWindowViewInterface::m_mainWindow

protected

Definition at line 77 of file MainWindowViewInterface.h.

Referenced by addDockWidget(), addDockWidget(), addDockWidgetAsTab(), addDockWidgetAsTab(), affinities(), anySideBarIsVisible(), clearSideBarOverlay(), closeDockWidgets(), isMDI(), layoutEqually(), layoutParentContainerEqually(), layoutParentContainerEqually(), mainWindow(), moveToSideBar(), moveToSideBar(), moveToSideBar(), moveToSideBar(), options(), overlayOnSideBar(), overlayOnSideBar(), restoreFromSideBar(), restoreFromSideBar(), setAffinities(), setPersistentCentralView(), sideBarIsVisible(), toggleOverlayOnSideBar(), toggleOverlayOnSideBar(), and uniqueName().

---

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

• MainWindowViewInterface.h
• MainWindowViewInterface.cpp