#include <Group.h>

Inheritance diagram for KDDockWidgets::QtQuick::Group:

[legend]

Collaboration diagram for KDDockWidgets::QtQuick::Group:

[legend]

Public Slots
void	updateConstraints ()

Signals
void	actualTitleBarChanged ()

void	currentDockWidgetChanged ()

void	isMDIChanged ()

Signals inherited from KDDockWidgets::QtQuick::View
void	geometryUpdated ()

void	itemGeometryChanged ()

Public Member Functions
	Group (Core::Group controller, QQuickItem parent=nullptr)

	~Group () override

KDDockWidgets::QtQuick::TitleBar *	actualTitleBar () const

int	currentIndex () const

QSize	maxSizeHint () const override
	Reimplemented for internal purposes. .

QSize	minSize () const override
	Reimplemented for internal purposes. .

Q_INVOKABLE void	setMDISize (QSize)
	Sets the size of this group in the MDI layout.

QObject *	tabBarObj () const

KDDockWidgets::QtQuick::TitleBar *	titleBar () const

int	userType () const

QQuickItem *	visualItem () const override
	Returns the QQuickItem which represents this group on the screen.

Public Member Functions inherited from KDDockWidgets::QtQuick::View
	View (Core::Controller controller, Core::ViewType type, QQuickItem parent=nullptr, Qt::WindowFlags windowFlags={})

	~View () override=default

void	activateWindow () override

std::shared_ptr< Core::View >	asWrapper () override
	Returns this view, but as a wrapper.

std::shared_ptr< Core::View >	childViewAt (QPoint p) const override

QVector< std::shared_ptr< Core::View > >	childViews () const override
	@Returns a list of child views

bool	close () override

void	enableAttribute (Qt::WidgetAttribute attr, bool enable=true) override

Qt::WindowFlags	flags () const override

Qt::FocusPolicy	focusPolicy () const override

QRect	geometry () const override

void	grabMouse () override

bool	hasAttribute (Qt::WidgetAttribute attr) const override

bool	hasFocus () const override

void	hide () override

bool	isActiveWindow () const override

bool	isExplicitlyHidden () const override

bool	isFixedHeight () const

bool	isFixedWidth () const

bool	isMaximized () const override

bool	isMinimized () const override

bool	isRootView () const override final

bool	isVisible () const override

QPoint	mapFromGlobal (QPoint globalPt) const override

QPoint	mapTo (Core::View *parent, QPoint pos) const override

QPoint	mapToGlobal (QPoint localPt) const override

QSize	maxSizeHint () const override

QSize	minSize () const override

void	move (int x, int y) override

QRect	normalGeometry () const override

void	onWindowStateChangeEvent (QWindowStateChangeEvent *)

std::shared_ptr< Core::View >	parentView () const override
	Returns the gui element's parent. Like QWidget::parentWidget()

QQuickView *	quickView () const

void	raise () override

void	raiseAndActivate () override

Q_INVOKABLE void	redirectMouseEvents (QQuickItem *from)

void	releaseKeyboard () override

void	releaseMouse () override

void	render (QPainter *) override

std::shared_ptr< Core::View >	rootView () const override
	Returns the top-level gui element which this view is inside It's the root view of the window.

void	setCursor (Qt::CursorShape shape) override

void	setFixedHeight (int h) override

void	setFixedSize (Size)

void	setFixedWidth (int w) override

void	setFlag (Qt::WindowType f, bool on=true) override

void	setFocus (Qt::FocusReason reason) override

void	setFocusPolicy (Qt::FocusPolicy) override

void	setGeometry (QRect) override

void	setHeight (int h) override

void	setMaximumSize (QSize sz) override

void	setMinimumSize (QSize sz) override

void	setMouseTracking (bool enable) override

void	setNormalGeometry (QRect geo)

void	setParent (Core::View *parent) override

void	setParent (QQuickItem *parent)

void	setSize (int w, int h) override final

void	setVisible (bool is) override

void	setWidth (int w) override

void	setWindowIcon (const QIcon &icon) override

void	setWindowOpacity (double v) override

void	setWindowTitle (const QString &title) override

void	setZOrder (int) override
	Sets the z order Not supported on all platforms and only relevant for MDI mode.

void	show () override

Q_INVOKABLE void	showMaximized () override

Q_INVOKABLE void	showMinimized () override

Q_INVOKABLE void	showNormal () override

void	update () override

void	updateGeometry ()

QString	viewName () const override

std::shared_ptr< Core::Window >	window () const override
	Returns the window this view is inside For the Qt frontend, this wraps a QWindow. Like QWidget::window()

int	zOrder () const override

Public Member Functions inherited from KDDockWidgets::QtCommon::View_qt
	View_qt (Core::Controller controller, Core::ViewType type, QObject thisObj)

	~View_qt () override

Core::HANDLE	handle () const override
	Returns a handle for the GUI element This value only makes sense to the frontend. For example, for QtQuick it might be a QQuickItem, while for QtWidgets it's a QWidget. Can be whatever the frontend developer wants, as long as it uniquely identifies the GUI element. KDDW backend only uses it for comparison purposes.

void	setViewName (const QString &name) override
	Equivalent to Qt's QObject::objectName()

QObject *	thisObject () const

virtual QVariant	viewProperty (const char *name) const
	Equivalent to Qt's QObject::property()

Public Member Functions inherited from KDDockWidgets::Core::View
	View (Controller *controller, ViewType)

template<typename T >
T *	asController ()
	Returns the View's controller, casted as T.

Core::DockWidget *	asDockWidgetController () const

Core::DropArea *	asDropAreaController () const

Core::FloatingWindow *	asFloatingWindowController () const
	asFooController() are deprecated. Use asController<T>() instead

Core::Group *	asGroupController () const

Core::Layout *	asLayout () const

Core::MainWindow *	asMainWindowController () const

Core::MDILayout *	asMDILayoutController () const

Core::Stack *	asStackController () const

Core::TabBar *	asTabBarController () const

Core::TitleBar *	asTitleBarController () const

virtual std::shared_ptr< View >	childViewAt (Point localPos) const =0

Controller *	controller () const
	Returns this view's controller.

virtual void	createPlatformWindow ()

bool	deliverViewEventToFilters (Event *e)
	Delivers mouse events and such to event filters.

void	dumpDebug ()
	Prints some debug to stderr.

bool	equals (const std::shared_ptr< View > &) const

bool	equals (const View *other) const
	Returns whether this view represents the same GUI element as the other.

int	height () const

bool	inDtor () const
	Returns whether the DTOR is currently running. freed() might be true while inDtor false, as the implementation of free() is free to delay it (with deleteLater() for example)

void	installViewEventFilter (EventFilterInterface *)
	Installs an event filter in this view to intercept the event it receives Analogue to QObject::installEventFilter() in the Qt world.

virtual bool	is (ViewType) const
	Returns whether the view is of the specified type Virtual so it can be overridden by ViewWrapper. When we're wrapping an existing GUI element only the specific frontend can know what's the actual type.

bool	isFixedHeight () const

bool	isFixedWidth () const

virtual bool	isNull () const
	Returns whether the gui item represented by this view was already deleted Usually false, as KDDW internal gui elements inherit View, and nobody will access them after destruction. However, ViewWrapper derived classes, wrap an existing gui element, which might get deleted. Override isNull() in our ViewWrapper subclasses and return true if the wrapped gui element was already deleted.

virtual Point	mapFromGlobal (Point) const =0

virtual Point	mapTo (View *, Point) const =0

virtual Point	mapToGlobal (Point) const =0

int	minimumHeight () const

int	minimumWidth () const

void	move (Point)

virtual bool	onFocusInEvent (FocusEvent *)

virtual bool	onResize (int h, int w)

bool	onResize (Size)

Point	pos () const

Rect	rect () const

void	removeViewEventFilter (EventFilterInterface *)
	Removes the event filter.

void	resize (int w, int h)

void	resize (Size)

Size	screenSize () const
	Returns the size of the screen that this view belongs to.

virtual void	setGeometry (Rect)=0

virtual void	setMaximumSize (Size sz)=0

virtual void	setMinimumSize (Size)=0

void	setSize (Size)

virtual void	setWindowIcon (const Icon &)=0

Size	size () const

int	width () const

int	x () const

int	y () const

Public Member Functions inherited from KDDockWidgets::Core::GroupViewInterface
	GroupViewInterface (Group *)

virtual	~GroupViewInterface ()

virtual Rect	dragRect () const
	the rect that should start a drag. Only relevant if the title bar isn't visible. For normal KDDW usage this method doesn't need to be reimplemented.

Group *	group () const

bool	isMDI () const

Protected Member Functions
void	insertDockWidget (Core::DockWidget *dw, int index) override

int	nonContentsHeight () const override
	Returns the height of the "non-dockwidget" part. i.e.: the height of the titlebar (if any), + height of tabbar (if any) + any margins. Should be implemented by frontend developers, as KDDW doesn't know the layout of the group. This is used to honour minimum-sizes of dock widgets.

void	removeDockWidget (Core::DockWidget *dw) override

Q_INVOKABLE void	setStackLayout (QQuickItem *)

Q_INVOKABLE void	startMDIResize ()

Protected Member Functions inherited from KDDockWidgets::QtQuick::View
bool	event (QEvent *) override

bool	eventFilter (QObject watched, QEvent ev) override

void	itemChange (QQuickItem::ItemChange, const QQuickItem::ItemChangeData &) override

virtual void	onHoverEvent (QHoverEvent *, QPoint)
	Override in case you want to have different styling on hover.

void	QQUICKITEMgeometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry) override

Protected Member Functions inherited from KDDockWidgets::Core::View
	View (const View &)=delete

View &	operator= (const View &)=delete

Protected Member Functions inherited from KDDockWidgets::Core::GroupViewInterface
	GroupViewInterface (const GroupViewInterface &)=delete

GroupViewInterface &	operator= (const GroupViewInterface &)=delete

Properties
KDDockWidgets::QtQuick::TitleBar *	actualTitleBar

int	currentIndex

bool	isMDI

QObject *	tabBar

KDDockWidgets::QtQuick::TitleBar *	titleBar

int	userType

Properties inherited from KDDockWidgets::QtQuick::View
bool	isFixedHeight

bool	isFixedWidth

Additional Inherited Members
Static Public Member Functions inherited from KDDockWidgets::QtQuick::View
static std::shared_ptr< Core::View >	asQQuickWrapper (QQuickItem *item)

static bool	close (QQuickItem *)

static QQuickItem *	createItem (const QString &filename, QQuickItem parent, QQmlContext ctx=nullptr)
	Convenience to create a QQuickItem parented to `parent`. Uses the engine from the parent.

static QQuickItem *	createItem (QQmlEngine engine, const QString &filename, QQmlContext context=nullptr)
	Convenience to create a QQuickItem.

static bool	isRootView (const QQuickItem *)

static void	makeItemFillParent (QQuickItem *item)
	This is equivalent to "anchors.fill: parent but in C++.

static std::shared_ptr< Core::View >	parentViewFor (const QQuickItem *)

static void	raiseAndActivate (QQuickItem *)

Static Public Member Functions inherited from KDDockWidgets::QtCommon::View_qt
static QObject *	asQObject (View *)

Static Public Member Functions inherited from KDDockWidgets::Core::View
static bool	equals (const View one, const View two)

static Controller *	firstParentOfType (View *view, ViewType)
	Returns the controller of the first parent view of the specified type Goes up the view hierarchy chain until it finds it. Returns nullptr otherwise.

static Size	hardcodedMinimumSize ()
	The minimum minimum size a dock widget can have.

Public Attributes inherited from KDDockWidgets::Core::View
Private *const	d

Protected Attributes inherited from KDDockWidgets::QtCommon::View_qt
EventFilter *const	m_eventFilter

QObject *const	m_thisObj

Protected Attributes inherited from KDDockWidgets::Core::View
Controller *const	m_controller

bool	m_inDtor = false

Protected Attributes inherited from KDDockWidgets::Core::GroupViewInterface
Group *const	m_group

Detailed Description

Definition at line 37 of file qtquick/views/Group.h.

Constructor & Destructor Documentation

◆ Group()

Group::Group	(	Core::Group *	controller,
		QQuickItem *	parent = `nullptr`
	)

explicit

Definition at line 59 of file qtquick/views/Group.cpp.

References KDDockWidgets::QtQuick.

◆ ~Group()

Group::~Group ( )

override

Definition at line 66 of file qtquick/views/Group.cpp.

Member Function Documentation

◆ actualTitleBar()

KDDockWidgets::QtQuick::TitleBar * Group::actualTitleBar ( ) const

Definition at line 258 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::Group::actualTitleBar(), and KDDockWidgets::Core::GroupViewInterface::m_group.

◆ actualTitleBarChanged

void KDDockWidgets::QtQuick::Group::actualTitleBarChanged ( )

signal

◆ currentDockWidgetChanged

void KDDockWidgets::QtQuick::Group::currentDockWidgetChanged ( )

signal

◆ currentIndex()

int Group::currentIndex ( ) const

Definition at line 139 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::Group::currentIndex(), and KDDockWidgets::Core::GroupViewInterface::m_group.

◆ insertDockWidget()

void Group::insertDockWidget	(	Core::DockWidget *	dw,
		int	index
	)

overrideprotectedvirtual

Reimplemented from KDDockWidgets::Core::GroupViewInterface.

Definition at line 144 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::DockWidget::d, KDDockWidgets::Core::TabBar::insertDockWidget(), KDDockWidgets::Core::GroupViewInterface::m_group, KDDockWidgets::QtQuick::View::makeItemFillParent(), KDDockWidgets::Core::Group::setCurrentDockWidget(), KDDockWidgets::Core::Controller::setParentView(), KDDockWidgets::Core::Group::tabBar(), and KDDockWidgets::Core::Controller::view().

◆ isMDIChanged

void KDDockWidgets::QtQuick::Group::isMDIChanged ( )

signal

◆ maxSizeHint()

QSize Group::maxSizeHint ( ) const

overridevirtual

Reimplemented for internal purposes.
.

Implements KDDockWidgets::Core::View.

Definition at line 198 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::Group::dockWidgets(), isMDI, KDDockWidgets::Core::GroupViewInterface::m_group, KDDockWidgets::QtQuick::View::maxSizeHint(), and nonContentsHeight().

Referenced by updateConstraints().

◆ minSize()

QSize Group::minSize ( ) const

overridevirtual

Reimplemented for internal purposes.
.

Implements KDDockWidgets::Core::View.

Definition at line 192 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::Group::dockWidgetsMinSize(), KDDockWidgets::Core::GroupViewInterface::m_group, and nonContentsHeight().

Referenced by updateConstraints().

◆ nonContentsHeight()

int Group::nonContentsHeight ( ) const

overrideprotectedvirtual

Returns the height of the "non-dockwidget" part. i.e.: the height of the titlebar (if any), + height of tabbar (if any) + any margins. Should be implemented by frontend developers, as KDDW doesn't know the layout of the group. This is used to honour minimum-sizes of dock widgets.

Implements KDDockWidgets::Core::GroupViewInterface.

Definition at line 228 of file qtquick/views/Group.cpp.

Referenced by maxSizeHint(), and minSize().

◆ removeDockWidget()

void Group::removeDockWidget ( Core::DockWidget * dw )

overrideprotectedvirtual

Reimplemented from KDDockWidgets::Core::GroupViewInterface.

Definition at line 134 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::GroupViewInterface::m_group, KDDockWidgets::Core::TabBar::removeDockWidget(), and KDDockWidgets::Core::Group::tabBar().

◆ setMDISize()

void Group::setMDISize ( QSize sz )

Sets the size of this group in the MDI layout.

Definition at line 272 of file qtquick/views/Group.cpp.

References isMDI, KDDockWidgets::Core::GroupViewInterface::m_group, KDDockWidgets::Core::View::m_inDtor, KDDockWidgets::Core::Group::mdiLayout(), and KDDockWidgets::Core::MDILayout::resizeDockWidget().

◆ setStackLayout()

void Group::setStackLayout ( QQuickItem * stackLayout )

protected

Definition at line 168 of file qtquick/views/Group.cpp.

◆ startMDIResize()

void Group::startMDIResize ( )

protected

Called by QML when user stars resizing a MDI Group So WidgetResizeHandler can start receiving events and resize the item

Definition at line 178 of file qtquick/views/Group.cpp.

References isMDI, KDDockWidgets::Core::GroupViewInterface::m_group, and KDDockWidgets::Core::Group::resizeHandler().

◆ tabBarObj()

QObject * Group::tabBarObj ( ) const

Definition at line 218 of file qtquick/views/Group.cpp.

◆ titleBar()

KDDockWidgets::QtQuick::TitleBar * Group::titleBar ( ) const

Definition at line 249 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::GroupViewInterface::m_group, and KDDockWidgets::Core::Group::titleBar().

◆ updateConstraints

void Group::updateConstraints ( )

slot

Definition at line 122 of file qtquick/views/Group.cpp.

References KDDockWidgets::Core::View::d, KDDockWidgets::Core::GroupViewInterface::m_group, maxSizeHint(), minSize(), and KDDockWidgets::Core::Group::onDockWidgetCountChanged().

Referenced by KDDockWidgets::QtQuick::DockWidget::onGeometryUpdated().

◆ userType()

int Group::userType ( ) const

Definition at line 267 of file qtquick/views/Group.cpp.

◆ visualItem()

QQuickItem * Group::visualItem ( ) const

overridevirtual

Returns the QQuickItem which represents this group on the screen.

Reimplemented from KDDockWidgets::QtQuick::View.

Definition at line 223 of file qtquick/views/Group.cpp.

Property Documentation

◆ actualTitleBar

KDDockWidgets::QtQuick::TitleBar * KDDockWidgets::QtQuick::Group::actualTitleBar

read

Definition at line 43 of file qtquick/views/Group.h.

◆ currentIndex

int KDDockWidgets::QtQuick::Group::currentIndex

read

Definition at line 45 of file qtquick/views/Group.h.

◆ isMDI

bool KDDockWidgets::QtQuick::Group::isMDI

read

Definition at line 46 of file qtquick/views/Group.h.

Referenced by maxSizeHint(), setMDISize(), and startMDIResize().

◆ tabBar

QObject * KDDockWidgets::QtQuick::Group::tabBar

read

Definition at line 40 of file qtquick/views/Group.h.

◆ titleBar

KDDockWidgets::QtQuick::TitleBar * KDDockWidgets::QtQuick::Group::titleBar

read

Definition at line 41 of file qtquick/views/Group.h.

◆ userType

int KDDockWidgets::QtQuick::Group::userType

read

Definition at line 42 of file qtquick/views/Group.h.

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Group()

◆ ~Group()

Member Function Documentation

◆ actualTitleBar()

◆ actualTitleBarChanged

◆ currentDockWidgetChanged

◆ currentIndex()

◆ insertDockWidget()

◆ isMDIChanged

◆ maxSizeHint()

◆ minSize()

◆ nonContentsHeight()

◆ removeDockWidget()

◆ setMDISize()

◆ setStackLayout()

◆ startMDIResize()

◆ tabBarObj()

◆ titleBar()

◆ updateConstraints

◆ userType()

◆ visualItem()

Property Documentation

◆ actualTitleBar

◆ currentIndex

◆ isMDI

◆ tabBar

◆ titleBar

◆ userType