Represents a dock widget. More...

#include <DockWidget.h>

Inheritance diagram for KDDockWidgets::QtWidgets::DockWidget:

[legend]

Collaboration diagram for KDDockWidgets::QtWidgets::DockWidget:

[legend]

Signals
void	guestViewChanged ()

void	isCurrentTabChanged (bool)
	Emitted when a dock widget becomes current or not in its tab group.

void	isFloatingChanged (bool)

void	isFocusedChanged (bool)

void	isOpenChanged (bool)

void	optionsChanged (KDDockWidgets::DockWidgetOptions)

void	windowActiveAboutToChange (bool)

Public Member Functions
	DockWidget (const QString &uniqueName, DockWidgetOptions options={}, LayoutSaverOptions layoutSaverOptions={}, Qt::WindowFlags windowFlags=Qt::Tool)
	constructs a new DockWidget

	~DockWidget () override
	destructor

QAction *	floatAction () const

void	raise () override

void	setWidget (QWidget *widget)
	sets the widget which this dock widget hosts.

void	show () override

QSize	size () const const

QAction *	toggleAction () const

QWidget *	widget () const
	Returns the guest widget.

Public Member Functions inherited from KDDockWidgets::QtWidgets::View< QWidget >
	View (Core::Controller controller, Core::ViewType type, QWidget 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 localPos) const override

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

bool	close () override

void	createPlatformWindow () 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	isMaximized () const override

bool	isMinimized () const override

bool	isRootView () const override

bool	isVisible () const override

QPoint	mapFromGlobal (QPoint globalPt) const override

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

QPoint	mapToGlobal (QPoint localPt) const override

QSize	maxSizeHint () const override

QSize	minimumSizeHint () const override

QSize	minSize () const override

void	move (int x, int y) override

QRect	normalGeometry () const override

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

void	raise () override

void	raiseAndActivate () override

void	releaseKeyboard () override

void	releaseMouse () override

void	render (QPainter *p) 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	setFixedWidth (int w) override

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

void	setFocus (Qt::FocusReason reason) override

void	setFocusPolicy (Qt::FocusPolicy policy) override

void	setGeometry (QRect geo) override

void	setHeight (int height) override

void	setMaximumSize (QSize sz) override

void	setMinimumSize (QSize sz) override

void	setMouseTracking (bool enable) override

void	setParent (Core::View *parent) override

void	setSize (int width, int height) override

void	setVisible (bool is) override

void	setWidth (int width) override

void	setWindowIcon (const QIcon &icon) override

void	setWindowOpacity (double v) override

void	setWindowTitle (const QString &title) override

void	show () override

void	showMaximized () override

void	showMinimized () override

void	showNormal () override

void	update () override

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 QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

virtual	~QWidget ()

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

void	getContentsMargins (int left, int top, int right, int bottom) const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isEnabledToTLW () const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

virtual QSize	sizeHint () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual	~QObject ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const const

int	depth () const const

int	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

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.

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)

virtual void	init ()

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

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

Size	size () const

int	width () const

int	x () const

int	y () const

Public Member Functions inherited from KDDockWidgets::Core::DockWidgetViewInterface
	DockWidgetViewInterface (DockWidget *)

virtual	~DockWidgetViewInterface ()

TitleBar *	actualTitleBar () const

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

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

Vector< QString >	affinities () const

DockWidget *	dockWidget () const

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	setMDIPosition (Point pos)
	Sets this dock widgets position to pos within the MDI layout This only applies if the main window is in MDI mode, which it is not by default.

void	setMDISize (Size size)
	like setMDIPosition(), but for the size.

void	setMDIZ (int z)
	like setMDIPosition(), but for the Z only implemented for QtQuick

void	setOptions (DockWidgetOptions)

void	setTitle (const QString &)

void	show ()

QString	title () const

QString	uniqueName () const

Protected Member Functions
bool	event (QEvent *) override

std::shared_ptr< Core::View >	focusCandidate () const override

void	mouseDoubleClickEvent (QMouseEvent *ev) override

void	resizeEvent (QResizeEvent *) override

Protected Member Functions inherited from KDDockWidgets::QtWidgets::View< QWidget >
void	closeEvent (QCloseEvent *ev) override

bool	event (QEvent *e) override

void	resizeEvent (QResizeEvent *ev) override

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (QPaintDevice::PaintDeviceMetric m) const const override

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

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

View &	operator= (const View &)=delete

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

DockWidgetViewInterface &	operator= (const DockWidgetViewInterface &)=delete

Properties
	size

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Additional Inherited Members
Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Static Public Member Functions inherited from KDDockWidgets::QtWidgets::View< QWidget >
static QVector< std::shared_ptr< Core::View > >	childViewsFor (const QWidget *parent)

static void	raiseAndActivate (QWidget *w)

static void	setParentFor (QWidget widget, Core::View parent)

Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

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 QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

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::DockWidgetViewInterface
DockWidget *const	m_dockWidget

Detailed Description

Represents a dock widget.

Most of the interface lives in Core::DockWidget, to facilitate sharing with QtQuick.

Definition at line 41 of file qtwidgets/views/DockWidget.h.

Constructor & Destructor Documentation

◆ DockWidget()

DockWidget::DockWidget	(	const QString &	uniqueName,
		DockWidgetOptions	options = `{}`,
		LayoutSaverOptions	layoutSaverOptions = `{}`,
		Qt::WindowFlags	windowFlags = `Qt::Tool`
	)

explicit

constructs a new DockWidget

Parameters

uniqueName	Mandatory name that should be unique between all DockWidget instances. This name won't be user visible and just used internally for the save/restore. Use setTitle() for user visible text.
options	optional options controlling behaviour

There's no parent argument. The DockWidget is either parented to FloatingWindow or MainWindow when visible, or stays without a parent when hidden. This allows to support docking to different main windows.

Definition at line 54 of file qtwidgets/views/DockWidget.cpp.

References KDDockWidgets::Core::DockWidget::d, guestViewChanged(), KDDockWidgets::Core::DockWidget::init(), isCurrentTabChanged(), isFloatingChanged(), isFocusedChanged(), isOpenChanged(), KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget, KDDockWidgets::Core::DockWidgetViewInterface::open(), optionsChanged(), QObject::Q_EMIT(), QWidget::setSizePolicy(), widget(), and windowActiveAboutToChange().

◆ ~DockWidget()

DockWidget::~DockWidget ( )

override

destructor

Definition at line 100 of file qtwidgets/views/DockWidget.cpp.

Member Function Documentation

◆ event()

bool DockWidget::event ( QEvent * e )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 110 of file qtwidgets/views/DockWidget.cpp.

References KDDockWidgets::QtWidgets::View< Base >::event(), KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget, KDDockWidgets::Core::DockWidget::open(), QEvent::Show, and QEvent::type().

◆ floatAction()

QAction * DockWidget::floatAction ( ) const

Definition at line 140 of file qtwidgets/views/DockWidget.cpp.

References KDDockWidgets::Core::DockWidget::floatAction(), and KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget.

◆ focusCandidate()

std::shared_ptr< Core::View > DockWidget::focusCandidate ( ) const

overrideprotectedvirtual

Implements KDDockWidgets::Core::DockWidgetViewInterface.

Definition at line 145 of file qtwidgets/views/DockWidget.cpp.

References KDDockWidgets::Core::DockWidget::guestView(), and KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget.

◆ guestViewChanged

void KDDockWidgets::QtWidgets::DockWidget::guestViewChanged ( )

signal

Referenced by DockWidget().

◆ isCurrentTabChanged

void KDDockWidgets::QtWidgets::DockWidget::isCurrentTabChanged ( bool )

signal

Emitted when a dock widget becomes current or not in its tab group.

Parameters

isCurrent true if it became current

Referenced by DockWidget().

◆ isFloatingChanged

void KDDockWidgets::QtWidgets::DockWidget::isFloatingChanged ( bool )

signal

Referenced by DockWidget().

◆ isFocusedChanged

void KDDockWidgets::QtWidgets::DockWidget::isFocusedChanged ( bool )

signal

Referenced by DockWidget().

◆ isOpenChanged

void KDDockWidgets::QtWidgets::DockWidget::isOpenChanged ( bool )

signal

Referenced by DockWidget().

◆ mouseDoubleClickEvent()

void DockWidget::mouseDoubleClickEvent ( QMouseEvent * ev )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 153 of file qtwidgets/views/DockWidget.cpp.

References QEvent::accept().

◆ optionsChanged

void KDDockWidgets::QtWidgets::DockWidget::optionsChanged ( KDDockWidgets::DockWidgetOptions )

signal

Referenced by DockWidget().

◆ raise()

void KDDockWidgets::QtWidgets::DockWidget::raise ( )

inlineoverridevirtual

If this view is a root view, then raises its window, otherwise, raises itself relatively to its siblings and does not raise its window

Implements KDDockWidgets::Core::View.

Definition at line 93 of file qtwidgets/views/DockWidget.h.

◆ resizeEvent()

void DockWidget::resizeEvent ( QResizeEvent * e )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 119 of file qtwidgets/views/DockWidget.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget, KDDockWidgets::Core::DockWidget::onResize(), QWidget::resizeEvent(), and QResizeEvent::size().

◆ setWidget()

void DockWidget::setWidget ( QWidget * widget )

sets the widget which this dock widget hosts.

Parameters

widget the widget to show inside this dock widget. Must not be null.

Ownership for widget is transferred to Core::DockWidget. Ownsership for any previously existing widget is transferred back to the user. Meaning if you call setWidget(A) followed by setWidget(B) then A will have to be deleted by you, while B is owned by the dock widget.

Definition at line 105 of file qtwidgets/views/DockWidget.cpp.

References KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget, KDDockWidgets::Core::DockWidget::setGuestView(), and widget().