KDDockWidgets::Core::SideBar Class Reference

#include <SideBar.h>

Inheritance diagram for KDDockWidgets::Core::SideBar:

Collaboration diagram for KDDockWidgets::Core::SideBar:

Public Member Functions
	SideBar (SideBarLocation, MainWindow *parent=nullptr)
	~SideBar () override
void	addDockWidget (DockWidget *dw)
void	clear ()
	clears the sidebar (removes all dock widgets from it)
bool	containsDockWidget (DockWidget *) const
Vector< DockWidget * >	dockWidgets () const
	returns the list of dock widgets in this sidebar
bool	isEmpty () const
	returns whether there's no dock widgets
bool	isVertical () const
	returns if this side bar has vertical orientation
SideBarLocation	location () const
	returns the sidebar's location in the main window
MainWindow *	mainWindow () const
	Returns the main window this side bar belongs to.
void	onButtonClicked (DockWidget *dw)
Qt::Orientation	orientation () const
	Returns this side bar's orientation.
void	removeDockWidget (DockWidget *dw)
Vector< QString >	serialize () const
	returns a serialization of this sidebar's state Currently it's just a list of dock widget ids
void	toggleOverlay (DockWidget *)
	Toggles the dock widget overlay. Equivalent to the user clicking on the button.
Public Member Functions inherited from KDDockWidgets::Core::Controller
	Controller (ViewType type, View *)
virtual	~Controller ()
bool	close ()
void	destroyLater ()
Controller::Private *	dptr () const
Rect	geometry () const
int	height () const
bool	inDtor () const
bool	is (ViewType) const
	Returns whether this controller is of the specified type.
bool	isVisible () const
Point	mapToGlobal (Point) const
Point	pos () const
Rect	rect () const
void	setParentView (View *parent)
void	setVisible (bool)
void	show () const
Size	size () const
ViewType	type () const
	Returns the type of this controller.
View *	view () const
	Returns the view associated with this controller, if any.
int	width () const
std::shared_ptr< View >	window () const
int	x () const
int	y () const

Additional Inherited Members
Protected Member Functions inherited from KDDockWidgets::Core::Controller
virtual void	setParentView_impl (View *parent)
Protected Attributes inherited from KDDockWidgets::Core::Controller
bool	m_inDtor = false

Detailed Description

Definition at line 29 of file core/SideBar.h.

Constructor & Destructor Documentation

SideBar()

SideBar::SideBar ( SideBarLocation  location, MainWindow *  parent = nullptr  )

explicit

Definition at line 41 of file core/SideBar.cpp.

References KDDockWidgets::Core::View::init(), and KDDockWidgets::Core::Controller::view().

~SideBar()

SideBar::~SideBar ( )

override

Definition at line 54 of file core/SideBar.cpp.

Member Function Documentation

addDockWidget()

void SideBar::addDockWidget

(

DockWidget *

dw

)

Definition at line 59 of file core/SideBar.cpp.

References KDDockWidgets::Core::DockWidget::d, removeDockWidget(), KDDockWidgets::Core::DockWidget::title(), and KDDockWidgets::Core::Controller::view().

Referenced by KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::SideBar_wrapper::addDockWidget(), and c_KDDockWidgets__Core__SideBar__addDockWidget_DockWidget().

clear()

void SideBar::clear

(

)

clears the sidebar (removes all dock widgets from it)

Definition at line 146 of file core/SideBar.cpp.

References removeDockWidget().

Referenced by c_KDDockWidgets__Core__SideBar__clear(), and KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::SideBar_wrapper::clear().

containsDockWidget()

bool SideBar::containsDockWidget

(

DockWidget *

dw

)

const

Definition at line 91 of file core/SideBar.cpp.

Referenced by c_KDDockWidgets__Core__SideBar__containsDockWidget_DockWidget().

dockWidgets()

Vector< DockWidget * > SideBar::dockWidgets

(

)

const

returns the list of dock widgets in this sidebar

Definition at line 152 of file core/SideBar.cpp.

isEmpty()

bool SideBar::isEmpty

(

)

const

returns whether there's no dock widgets

Definition at line 116 of file core/SideBar.cpp.

Referenced by c_KDDockWidgets__Core__SideBar__isEmpty().

isVertical()

bool SideBar::isVertical ( ) const

inline

returns if this side bar has vertical orientation

Definition at line 44 of file core/SideBar.h.

References Qt::Vertical.

Referenced by c_KDDockWidgets__Core__SideBar__isVertical().

location()

SideBarLocation SideBar::location

(

)

const

returns the sidebar's location in the main window

Definition at line 121 of file core/SideBar.cpp.

mainWindow()

MainWindow * SideBar::mainWindow

(

)

const

Returns the main window this side bar belongs to.

Definition at line 126 of file core/SideBar.cpp.

Referenced by c_KDDockWidgets__Core__SideBar__mainWindow().

onButtonClicked()

void SideBar::onButtonClicked

(

DockWidget *

dw

)

Definition at line 96 of file core/SideBar.cpp.

References toggleOverlay().

Referenced by c_KDDockWidgets__Core__SideBar__onButtonClicked_DockWidget(), and KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::SideBar_wrapper::onButtonClicked().

orientation()

Qt::Orientation SideBar::orientation

(

)

const

Returns this side bar's orientation.

Definition at line 111 of file core/SideBar.cpp.

removeDockWidget()

void SideBar::removeDockWidget

(

DockWidget *

dw

)

Definition at line 77 of file core/SideBar.cpp.

References KDDockWidgets::Core::DockWidget::d, KDDockWidgets::Core::DockWidget::title(), and KDDockWidgets::Core::Controller::view().

Referenced by addDockWidget(), c_KDDockWidgets__Core__SideBar__removeDockWidget_DockWidget(), clear(), and KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::SideBar_wrapper::removeDockWidget().

serialize()

Vector< QString > SideBar::serialize

(

)

const

returns a serialization of this sidebar's state Currently it's just a list of dock widget ids

Definition at line 136 of file core/SideBar.cpp.

References KDToolBox::StlContainerAdaptor::StdVectorAdaptor< T, Args >::reserve(), and KDDockWidgets::Core::DockWidget::uniqueName().

toggleOverlay()

void SideBar::toggleOverlay

(

DockWidget *

dw

)

Toggles the dock widget overlay. Equivalent to the user clicking on the button.

Definition at line 131 of file core/SideBar.cpp.

References KDDockWidgets::Core::MainWindow::toggleOverlayOnSideBar().

Referenced by c_KDDockWidgets__Core__SideBar__toggleOverlay_DockWidget(), onButtonClicked(), and KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::SideBar_wrapper::toggleOverlay().

---

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

• core/SideBar.h
• core/SideBar.cpp
• qtquick/views/SideBar.cpp