Our base class for dockable widgets containing some specialized functionality on top of QDockWidget. More...

#include <dockwidget.h>

Inheritance diagram for swift::gui::CDockWidget:

Signals
void	widgetTopLevelChanged (CDockWidget *, bool topLevel)
	Top level has changed for given widget.

void	fontSizePlus ()
	Font size signals.
void	fontSizeMinus ()
	Font size signals.

Public Member Functions
void	setOriginalTitleBar ()
	Set original title bar.
void	setEmptyTitleBar ()
	Set empty title bar (empty widget as title bar).
void	setNullTitleBarWidget ()
	Set null (nullptr) title bar.
const QString &	windowTitleBackup () const
	Window title backup.
QString	windowTitleOrBackup () const
	If current window title is empty, use backup.
bool	showTitleWhenDocked () const
	Window title when window is docked.
bool	isSelected () const
	Selected when tabbed.
bool	isWidgetVisible () const
	Is widget visible? Not to be confused with.
void	allowStatusBar (bool allow)
	Allow a status bar to be displayed.
void	showTitleWhenDocked (bool show)
	Show the window title when docked.
void	resetWasAlreadyFloating ()
	Reset first time floating, marked as never floated before.
bool	wasAlreadyFloating () const
	Was widget already floating?
void	setPreferredSizeWhenFloating (const QSize &size)
	Size when floating first time.
void	setOffsetWhenFloating (const QPoint &point, bool frameless)
	Position offset when floating first time.
void	setFrameless (bool frameless)
	Framless.
void	toggleFloating ()
	Toggle floating.
void	toggleVisibility ()
	Toggle visibility.
void	toggleFrameless ()
	Toggle frameless mode.
void	windowAlwaysOnTop ()
	Toggle frameless deferred.
void	windowNotAlwaysOnTop ()
	Window not on top.
void	setAlwaysOnTop (bool onTop)
	Set always on top.
bool	restoreFromSettings ()
	Restore from settings.
void	saveCurrentStateToSettings ()
	Remember widget state.
void	resetSettings ()
	Reset margin settings.
void	resetPosition ()
	Reset window position.
void	setWindowTitle (const QString &title)
	Set title and internally keep a backup.
void	displayStatusMessage (const swift::misc::CStatusMessage &statusMessage)
	Display status message.
void	displayStatusMessages (const swift::misc::CStatusMessageList &statusMessages)
	Display status messages.
Public Member Functions inherited from swift::gui::COverlayMessagesDockWidget
	COverlayMessagesDockWidget (QWidget *parent=nullptr)
	Constructor.
Public Member Functions inherited from swift::gui::COverlayMessagesBase< QDockWidget >
	~COverlayMessagesBase ()=default
	Destructor.
void	initOverlayMessages (QSize inner={})
	Init, normally we use lazy init, but by calling init explicitly we can force initalization.
void	activateTextMessages (bool activate)
	Active send/receive of text messages.
void	showStatusMessagesFrame ()
	Show the inner frame.
void	setOverlaySizeFactors (double widthFactor, double heightFactor, double middleFactor=2)
	Set the size factors.
void	setForceSmall (bool force)
	Force small (smaller layout).
void	setReducedInfo (bool reduced)
	Display reduced information.
void	showOverlayMessagesWithConfirmation (const swift::misc::CStatusMessageList &messages, bool appendOldMessages, const QString &confirmationMessage, std::function< void()> okLambda, QMessageBox::StandardButton defaultButton=QMessageBox::Cancel, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Show multiple messages with confirmation bar.
void	clearOverlayMessages ()
	Clear the overlay messages.
void	closeOverlay ()
	Close button clicked.
void	showOverlayMessages (const swift::misc::CStatusMessageList &messages, bool appendOldMessages=false, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Show multiple messages.
void	showOverlayMessagesOrSingleMessage (const swift::misc::CStatusMessageList &messages, bool appendOldMessages=false, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Show multiple messages or a single message.
void	showOverlayMessagesOrHTMLMessage (const swift::misc::CStatusMessageList &messages, bool appendOldMessages=false, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Show multiple messages or a single message (HTML).
void	sortOverlayMessages (const swift::misc::CPropertyIndex &property, Qt::SortOrder order)
	Sort of overlay messages.
void	setOverlayMessagesSorting (const swift::misc::CPropertyIndex &property, Qt::SortOrder order)
	Set sorting of overlay messages.
bool	showOverlayMessage (const swift::misc::CStatusMessage &message, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Show single message.
bool	showOverlayTextMessage (const swift::misc::network::CTextMessage &textMessage, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Info message, based on text message.
void	showOverlayVariant (const swift::misc::CVariant &variant, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Display one of the supported types.
void	showOverlayImage (const swift::misc::CPixmap &pixmap, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Image.
bool	showOverlayHTMLMessage (const QString &htmlMessage, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	HTML message.
void	showDownloadProgress (int progress, qint64 current, qint64 max, const QUrl &url, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
	Download progress.
void	showOverlayInlineTextMessage (components::TextMessageTab tab)
	Image.
Public Member Functions inherited from QDockWidget
	QDockWidget (QWidget *parent, Qt::WindowFlags flags)
	QDockWidget (const QString &title, QWidget *parent, Qt::WindowFlags flags)
void	allowedAreasChanged (Qt::DockWidgetAreas allowedAreas)
void	dockLocationChanged (Qt::DockWidgetArea area)
void	featuresChanged (QDockWidget::DockWidgetFeatures features)
void	setAllowedAreas (Qt::DockWidgetAreas areas)
void	setDockLocation (Qt::DockWidgetArea area)
void	setFeatures (QDockWidget::DockWidgetFeatures features)
void	setFloating (bool floating)
void	setTitleBarWidget (QWidget *widget)
void	setWidget (QWidget *widget)
void	topLevelChanged (bool topLevel)
void	visibilityChanged (bool visible)
QAction *	toggleViewAction () const const
QDockWidget::DockWidgetFeatures	features () const const
QWidget *	titleBarWidget () const const
QWidget *	widget () const const
Qt::DockWidgetArea	dockLocation () const const
Qt::DockWidgetAreas	allowedAreas () const const
bool	isAreaAllowed (Qt::DockWidgetArea area) const const
bool	isFloating () const const
Public Member Functions inherited from QWidget
QAction *	addAction (const QIcon &icon, const QString &text)
QAction *	addAction (const QIcon &icon, const QString &text, Args &&... args)
QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)
QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)
QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)
QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)
QAction *	addAction (const QString &text)
QAction *	addAction (const QString &text, Args &&... args)
QAction *	addAction (const QString &text, const QKeySequence &shortcut)
QAction *	addAction (const QString &text, const QKeySequence &shortcut, Args &&... args)
QAction *	addAction (const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)
QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)
QPixmap	grab (const QRect &rectangle)
	QWIDGETSIZE_MAX QWIDGETSIZE_MAX
	QWidget (QWidget *parent, Qt::WindowFlags f)
bool	close ()
bool	restoreGeometry (const QByteArray &geometry)
int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
void	activateWindow ()
void	addAction (QAction *action)
void	addActions (const QList< QAction * > &actions)
void	adjustSize ()
void	clearFocus ()
void	clearMask ()
void	customContextMenuRequested (const QPoint &pos)
void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
void	grabKeyboard ()
void	grabMouse ()
void	grabMouse (const QCursor &cursor)
void	hide ()
void	insertAction (QAction before, QAction action)
void	insertActions (QAction before, const QList< QAction > &actions)
void	lower ()
void	move (const QPoint &)
void	move (int x, int y)
void	overrideWindowFlags (Qt::WindowFlags flags)
void	raise ()
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)
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	setAccessibleIdentifier (const QString &identifier)
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	setScreen (QScreen *screen)
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)
virtual void	setVisible (bool visible)
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	setupUi (QWidget *widget)
void	show ()
void	showFullScreen ()
void	showMaximized ()
void	showMinimized ()
void	showNormal ()
void	stackUnder (QWidget *w)
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 ()
void	windowIconChanged (const QIcon &icon)
void	windowIconTextChanged (const QString &iconText)
void	windowTitleChanged (const QString &title)
QBackingStore *	backingStore () const const
QByteArray	saveGeometry () const const
QCursor	cursor () const const
QFontInfo	fontInfo () const const
QFontMetrics	fontMetrics () const const
QGraphicsEffect *	graphicsEffect () const const
QGraphicsProxyWidget *	graphicsProxyWidget () const const
QIcon	windowIcon () const const
QLayout *	layout () const const
QList< QAction * >	actions () const const
QLocale	locale () const const
QMargins	contentsMargins () const const
virtual QPaintEngine *	paintEngine () const const override
QPalette::ColorRole	backgroundRole () const const
QPalette::ColorRole	foregroundRole () const const
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
QPoint	pos () const const
QPointF	mapFrom (const QWidget *parent, const QPointF &pos) const const
QPointF	mapFromGlobal (const QPointF &pos) const const
QPointF	mapFromParent (const QPointF &pos) const const
QPointF	mapTo (const QWidget *parent, const QPointF &pos) const const
QPointF	mapToGlobal (const QPointF &pos) const const
QPointF	mapToParent (const QPointF &pos) const const
QRect	childrenRect () const const
QRect	contentsRect () const const
QRect	frameGeometry () const const
QRect	normalGeometry () const const
QRect	rect () const const
QRegion	childrenRegion () const const
QRegion	mask () const const
QRegion	visibleRegion () const const
QScreen *	screen () const const
QSize	baseSize () const const
QSize	frameSize () const const
QSize	maximumSize () const const
QSize	minimumSize () const const
virtual QSize	minimumSizeHint () const const
QSize	size () const const
virtual QSize	sizeHint () const const
QSize	sizeIncrement () const const
QSizePolicy	sizePolicy () const const
QString	accessibleDescription () const const
QString	accessibleIdentifier () const const
QString	accessibleName () const const
QString	statusTip () const const
QString	styleSheet () const const
QString	toolTip () const const
QString	whatsThis () const const
QString	windowFilePath () const const
QString	windowIconText () const const
QString	windowRole () const const
QString	windowTitle () const const
QStyle *	style () const const
virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const
QWidget *	childAt (const QPoint &p) const const
QWidget *	childAt (const QPointF &p) const const
QWidget *	childAt (int x, int y) const const
QWidget *	focusProxy () const const
QWidget *	focusWidget () const const
QWidget *	nativeParentWidget () const const
QWidget *	nextInFocusChain () const const
QWidget *	parentWidget () const const
QWidget *	previousInFocusChain () const const
QWidget *	topLevelWidget () const const
QWidget *	window () const const
QWindow *	windowHandle () const const
Qt::ContextMenuPolicy	contextMenuPolicy () const const
Qt::FocusPolicy	focusPolicy () const const
Qt::InputMethodHints	inputMethodHints () const const
Qt::LayoutDirection	layoutDirection () const const
Qt::WindowFlags	windowFlags () const const
Qt::WindowModality	windowModality () const const
Qt::WindowStates	windowState () const const
Qt::WindowType	windowType () const const
WId	effectiveWinId () const const
WId	winId () const const
bool	acceptDrops () const const
bool	autoFillBackground () const const
bool	hasEditFocus () const const
bool	hasFocus () const const
virtual bool	hasHeightForWidth () const const
bool	hasMouseTracking () const const
bool	hasTabletTracking () const const
bool	isActiveWindow () const const
bool	isAncestorOf (const QWidget *child) const const
bool	isEnabled () const const
bool	isEnabledTo (const QWidget *ancestor) 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
bool	testAttribute (Qt::WidgetAttribute attribute) const const
bool	underMouse () const const
bool	updatesEnabled () const const
const QFont &	font () const const
const QPalette &	palette () const const
const QRect &	geometry () const const
int	height () const const
virtual int	heightForWidth (int w) const const
int	maximumHeight () const const
int	maximumWidth () const const
int	minimumHeight () const const
int	minimumWidth () const const
int	toolTipDuration () const const
int	width () const const
int	x () const const
int	y () const const
qreal	windowOpacity () const const
void	ensurePolished () const const
Public Member Functions inherited from QObject
QBindable< QString >	bindableObjectName ()
	QObject (QObject *parent)
	QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUMS (...)
	Q_ENUM_NS (...)
	Q_FLAG (...)
	Q_FLAGS (...)
	Q_FLAG_NS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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	qobject_cast (QObject *object)
T	qobject_cast (const QObject *object)
bool	blockSignals (bool block)
virtual bool	eventFilter (QObject watched, QEvent event)
bool	moveToThread (QThread *targetThread)
bool	setProperty (const char *name, QVariant &&value)
bool	setProperty (const char *name, const QVariant &value)
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::nanoseconds interval, Qt::TimerType timerType)
void	deleteLater ()
void	destroyed (QObject *obj)
void	installEventFilter (QObject *filterObj)
void	killTimer (Qt::TimerId id)
void	killTimer (int id)
void	objectNameChanged (const QString &objectName)
void	removeEventFilter (QObject *obj)
void	setObjectName (QAnyStringView name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
QList< QByteArray >	dynamicPropertyNames () const const
QList< T >	findChildren (QAnyStringView name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const
QObject *	parent () const const
QString	objectName () const const
QThread *	thread () const const
QVariant	property (const char *name) const const
T	findChild (QAnyStringView name, Qt::FindChildOptions options) const const
T	findChild (Qt::FindChildOptions options) const const
bool	disconnect (const QObject receiver, const char method) const const
bool	disconnect (const char signal, const QObject receiver, const char *method) const const
bool	inherits (const char *className) const const
bool	isQmlExposed () const const
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
bool	signalsBlocked () const const
virtual const QMetaObject *	metaObject () const const
const QObjectList &	children () const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
Public Member Functions inherited from QPaintDevice
bool	paintingActive () const const
int	colorCount () const const
int	depth () const const
int	height () const const
int	heightMM () const const
int	logicalDpiX () const const
int	logicalDpiY () const const
int	physicalDpiX () const const
int	physicalDpiY () const const
int	width () const const
int	widthMM () const const
qreal	devicePixelRatio () const const
qreal	devicePixelRatioF () const const
Public Member Functions inherited from swift::gui::CEnableForFramelessWindow
	CEnableForFramelessWindow (WindowMode mode, bool isMainApplicationWindow, const char framelessPropertyname, QWidget correspondingWidget)
	Constructor.
virtual	~CEnableForFramelessWindow ()=default
	Destructor.
	CEnableForFramelessWindow (const CEnableForFramelessWindow &)=delete
	Copy constructor.
CEnableForFramelessWindow &	operator= (const CEnableForFramelessWindow &)=delete
	Copy assignment operator.
void	setMode (WindowMode mode)
	Window mode.
bool	isFrameless () const
	Frameless?
bool	isMainApplicationWindow () const
	Is main application, explicitly set.
void	alwaysOnTop (bool onTop)
	Always on top?
void	activate ()
	Activates the window.
QWidget *	getWidget () const
	Corresponding QMainWindow.

Static Public Member Functions
static const QString &	propertyOuterWidget ()
	Value for dynamic property "dockwidget".
static const QString &	propertyInnerWidget ()
	Value for dynamic property "dockwidget".
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)
void	setTabOrder (std::initializer_list< QWidget * > widgets)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)
QString	tr (const char sourceText, const char disambiguation, int n)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)
bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)
bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)
Static Public Member Functions inherited from QPaintDevice
int	encodeMetricF (QPaintDevice::PaintDeviceMetric metric, double value)
Static Public Member Functions inherited from swift::gui::CEnableForFramelessWindow
static WindowMode	stringToWindowMode (const QString &s)
	String to window mode.
static const QString &	windowModeToString (WindowMode m)
	String to window mode.

Protected Member Functions
	CDockWidget (QWidget *parent=nullptr)
	Constructor.
	CDockWidget (bool allowStatusBar, QWidget *parent=nullptr)
	Constructor.
void	setMargins ()
	Set margins from settings.
void	setMarginsWhenFloating (const QMargins &margins)
	Margins when window is floating.
void	setMarginsWhenFloating (int left, int top, int right, int bottom)
	Margins when window is floating.
QMargins	getMarginsWhenFloating () const
	Margins when floating.
void	setMarginsWhenFramelessFloating (const QMargins &margins)
	Margins when window is floating (frameless).
void	setMarginsWhenFramelessFloating (int left, int top, int right, int bottom)
	Margins when window is floating (frameless).
QMargins	getMarginsWhenFramelessFloating () const
	Margins when floating and frameless.
void	setMarginsWhenDocked (const QMargins &margins)
	Margins when widget is floating.
void	setMarginsWhenDocked (int left, int top, int right, int bottom)
	Margins when widget is floating.
QMargins	getMarginsWhenDocked () const
	Margins when docked.
void	setAlwaysOnTopFlag (bool onTop)
	Set the on top flag.
void	closeEvent (QCloseEvent *event)
void	paintEvent (QPaintEvent *event)
void	mouseMoveEvent (QMouseEvent *event)
void	keyPressEvent (QKeyEvent *event)
void	mousePressEvent (QMouseEvent *event)
virtual void	addToContextMenu (QMenu *contextMenu) const
	Contribute to menu.
virtual void	initialFloating ()
	Widget is initialized by being a floating window for a shot period.
virtual void	onStyleSheetsChanged ()
	Style sheet has changed.
Protected Member Functions inherited from swift::gui::COverlayMessagesBase< QDockWidget >
	COverlayMessagesBase (QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags())
	Constructor.
void	initInnerFrame (double widthFactor=-1, double heightFactor=-1)
	Init the inner frame (if not yet initialized).
void	initMinimalFrame (int lines=4)
	Init a minimal frame (smaller as the normal one).
bool	hasMinimumSize (int w, int h) const
	Check minimum height/width.
void	keyPressEvent (QKeyEvent *event)
void	resizeEvent (QResizeEvent *event)
Protected Member Functions inherited from QDockWidget
virtual bool	event (QEvent *event) override
virtual void	changeEvent (QEvent *event) override
virtual void	initStyleOption (QStyleOptionDockWidget *option) const const
Protected Member Functions inherited from QWidget
bool	focusNextChild ()
virtual bool	focusNextPrevChild (bool next)
bool	focusPreviousChild ()
virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)
virtual void	actionEvent (QActionEvent *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 (QEnterEvent *event)
virtual void	focusInEvent (QFocusEvent *event)
virtual void	focusOutEvent (QFocusEvent *event)
virtual void	hideEvent (QHideEvent *event)
virtual void	inputMethodEvent (QInputMethodEvent *event)
virtual void	keyReleaseEvent (QKeyEvent *event)
virtual void	leaveEvent (QEvent *event)
virtual void	mouseDoubleClickEvent (QMouseEvent *event)
virtual void	mouseReleaseEvent (QMouseEvent *event)
virtual void	moveEvent (QMoveEvent *event)
virtual void	showEvent (QShowEvent *event)
virtual void	tabletEvent (QTabletEvent *event)
void	updateMicroFocus (Qt::InputMethodQuery query)
virtual void	wheelEvent (QWheelEvent *event)
virtual int	metric (QPaintDevice::PaintDeviceMetric m) const const override
virtual void	initPainter (QPainter *painter) const const override
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)
virtual void	timerEvent (QTimerEvent *event)
QObject *	sender () const const
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
int	senderSignalIndex () const const
Protected Member Functions inherited from swift::gui::CEnableForFramelessWindow
virtual void	windowFlagsChanged ()
	Can be used as notification if window mode changes.
void	addFramelessSizeGripToStatusBar (QStatusBar *statusBar)
	Resize grip handle.
void	hideFramelessSizeGripInStatusBar ()
	Resize grip handle.
void	setWindowAttributes (WindowMode mode)
	Attributes.
void	setDynamicProperties (bool frameless)
	Set dynamic properties such as frameless.
QHBoxLayout *	addFramelessCloseButton (QMenuBar *menuBar)
	Close button for frameless windows.
void	toolToNormalWindow ()
	Remove tool and add desktop window.
void	normalToToolWindow ()
	Remove desktop and add tool window.
bool	isToolWindow () const
	Tool window.
bool	handleMousePressEvent (QMouseEvent *event)
	Mouse press, required for frameless window.
bool	handleMouseMoveEvent (QMouseEvent *event)
	Mouse moving, required for frameless window.
bool	handleChangeEvent (QEvent *event)
	Mouse window change event.
void	showMinimizedModeChecked ()
	Check mode and then show minimized.
void	showNormalModeChecked ()
	Check mode and then show normal.

Additional Inherited Members
Public Types inherited from QDockWidget
enum	DockWidgetFeature
Public Types inherited from QWidget
enum	RenderFlag
Public Types inherited from QObject
enum	TimerId
Public Types inherited from QPaintDevice
enum	PaintDeviceMetric
Public Types inherited from swift::gui::CEnableForFramelessWindow
enum	WindowMode { WindowNormal , WindowFrameless , WindowTool }
	Window modes. More...
Public Attributes inherited from QDockWidget
typedef	DockWidgetFeatures
	DockWidgetClosable
	DockWidgetMovable
	DockWidgetFloatable
	DockWidgetVerticalTitleBar
	DockWidgetFeatureMask
	NoDockWidgetFeatures
	Reserved
Public Attributes inherited from QWidget
typedef	RenderFlags
	DrawWindowBackground
	DrawChildren
	IgnoreMask
Public Attributes inherited from QObject
typedef	QObjectList
	Invalid
Public Attributes inherited from QPaintDevice
	PdmWidth
	PdmHeight
	PdmWidthMM
	PdmHeightMM
	PdmNumColors
	PdmDepth
	PdmDpiX
	PdmDpiY
	PdmPhysicalDpiX
	PdmPhysicalDpiY
	PdmDevicePixelRatio
	PdmDevicePixelRatioScaled
	PdmDevicePixelRatioF_EncodedA
	PdmDevicePixelRatioF_EncodedB
Static Protected Member Functions inherited from swift::gui::CEnableForFramelessWindow
static Qt::WindowFlags	modeToWindowFlags (WindowMode mode)
	Translate mode.
Protected Attributes inherited from swift::gui::COverlayMessagesBase< QDockWidget >
COverlayMessages *	m_overlayMessages
	embedded QFrame with status messages
Protected Attributes inherited from swift::gui::CEnableForFramelessWindow
QPoint	m_framelessDragPosition
	position, if moving is handled with frameless window
QSize	m_moveSize
	size when moved (in frameless window)
QPushButton *	m_framelessCloseButton = nullptr
	close button
WindowMode	m_windowMode = WindowNormal
	Window mode,.
WindowMode	m_originalWindowMode = WindowNormal
	mode when initialized
bool	m_isMainApplicationWindow = false
	is this the main application window (only 1)?
QWidget *	m_widget = nullptr
	corresponding window or dock widget
QSizeGrip *	m_framelessSizeGrip = nullptr
	size grip object
QByteArray	m_framelessPropertyName
	property name for frameless widgets
int	m_windowFrameSizeW = -1
	window frame width
int	m_windowFrameSizeH = -1
	window frame height
Properties inherited from QDockWidget
	allowedAreas
	dockLocation
	features
	floating
	windowTitle
Properties inherited from QWidget
	acceptDrops
	accessibleDescription
	accessibleIdentifier
	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

Detailed Description

Our base class for dockable widgets containing some specialized functionality on top of QDockWidget.

We currently use dockable widgets either as "info area" or "info bar" dockable widget. Info area widgets reside in an info are and represent a larger piece of information (e.g. all ATC stations, all aircrafts in range). An info bar is meant to be a small info window displaying information about status, menu state etc.

See also: CInfoArea; CDockWidgetInfoArea; CDockWidgetInfoBar

Definition at line 51 of file dockwidget.h.

Constructor & Destructor Documentation

◆ CDockWidget() [1/2]

swift::gui::CDockWidget::CDockWidget ( QWidget * parent = nullptr )

explicitprotected

Constructor.

Definition at line 88 of file dockwidget.cpp.

◆ CDockWidget() [2/2]

swift::gui::CDockWidget::CDockWidget	(	bool	allowStatusBar,
		QWidget *	parent = nullptr )

protected

Constructor.

Definition at line 42 of file dockwidget.cpp.

Member Function Documentation

◆ addToContextMenu()

void swift::gui::CDockWidget::addToContextMenu ( QMenu * contextMenu ) const

protectedvirtual

Contribute to menu.

Reimplemented in swift::gui::CDockWidgetInfoArea, and swift::gui::CDockWidgetInfoBar.

Definition at line 449 of file dockwidget.cpp.

◆ allowStatusBar()

void swift::gui::CDockWidget::allowStatusBar ( bool allow )

inline

Allow a status bar to be displayed.

Definition at line 82 of file dockwidget.h.

◆ closeEvent()

void swift::gui::CDockWidget::closeEvent ( QCloseEvent * event )

protectedvirtual

           since update to Qt 5.14.1 this kills the window
           https://discordapp.com/channels/539048679160676382/539846348275449887/691667651285483564
           \todo code can be removed AFTER 8-2020

        QPointer<CDockWidget> myself(this);
        QTimer::singleShot(500, this, [ = ]
        {

if (myself) { myself->close(); } });

Reimplemented from QDockWidget.

Definition at line 391 of file dockwidget.cpp.

◆ displayStatusMessage()

void swift::gui::CDockWidget::displayStatusMessage ( const swift::misc::CStatusMessage & statusMessage )

Display status message.

Definition at line 171 of file dockwidget.cpp.

◆ displayStatusMessages()

void swift::gui::CDockWidget::displayStatusMessages ( const swift::misc::CStatusMessageList & statusMessages )

Display status messages.

Definition at line 180 of file dockwidget.cpp.

◆ getMarginsWhenDocked()

QMargins swift::gui::CDockWidget::getMarginsWhenDocked ( ) const

protected

Margins when docked.

Definition at line 161 of file dockwidget.cpp.

◆ getMarginsWhenFloating()

QMargins swift::gui::CDockWidget::getMarginsWhenFloating ( ) const

protected

Margins when floating.

Definition at line 130 of file dockwidget.cpp.

◆ getMarginsWhenFramelessFloating()

QMargins swift::gui::CDockWidget::getMarginsWhenFramelessFloating ( ) const

protected

Margins when floating and frameless.

Definition at line 144 of file dockwidget.cpp.

◆ initialFloating()

void swift::gui::CDockWidget::initialFloating ( )

protectedvirtual

Widget is initialized by being a floating window for a shot period.

Place where - when overidden - post initializations can take place. The GUI is already initialized, so all widget data are available.

Reimplemented in swift::gui::CDockWidgetInfoArea, and swift::gui::CDockWidgetInfoBar.

Definition at line 485 of file dockwidget.cpp.

◆ isSelected()

bool swift::gui::CDockWidget::isSelected ( ) const

inline

Selected when tabbed.

Definition at line 75 of file dockwidget.h.

◆ isWidgetVisible()

bool swift::gui::CDockWidget::isWidgetVisible ( ) const

Is widget visible? Not to be confused with.

See also: QWidget::isVisbible

Remarks: Logical vsibility as in

See also: QDockWidget::visibilityChanged

Definition at line 163 of file dockwidget.cpp.

◆ keyPressEvent()

void swift::gui::CDockWidget::keyPressEvent ( QKeyEvent * event )

protectedvirtual

Reimplemented from QWidget.

Definition at line 432 of file dockwidget.cpp.

◆ mouseMoveEvent()

void swift::gui::CDockWidget::mouseMoveEvent ( QMouseEvent * event )

protectedvirtual

Reimplemented from QWidget.

Definition at line 424 of file dockwidget.cpp.

◆ mousePressEvent()

void swift::gui::CDockWidget::mousePressEvent ( QMouseEvent * event )

protectedvirtual

Reimplemented from QWidget.

Definition at line 441 of file dockwidget.cpp.

◆ onStyleSheetsChanged()

void swift::gui::CDockWidget::onStyleSheetsChanged ( )

protectedvirtual

Style sheet has changed.

Reimplemented in swift::gui::CDockWidgetInfoBar.

Definition at line 706 of file dockwidget.cpp.

◆ paintEvent()

void swift::gui::CDockWidget::paintEvent ( QPaintEvent * event )

protectedvirtual

Reimplemented from QDockWidget.

Definition at line 417 of file dockwidget.cpp.

◆ propertyInnerWidget()

const QString & swift::gui::CDockWidget::propertyInnerWidget ( )

static

Value for dynamic property "dockwidget".

Definition at line 251 of file dockwidget.cpp.

◆ propertyOuterWidget()

const QString & swift::gui::CDockWidget::propertyOuterWidget ( )

static

Value for dynamic property "dockwidget".

Definition at line 245 of file dockwidget.cpp.

◆ resetPosition()

void swift::gui::CDockWidget::resetPosition ( )

Reset window position.

Definition at line 810 of file dockwidget.cpp.

◆ resetSettings()

void swift::gui::CDockWidget::resetSettings ( )

Reset margin settings.

Definition at line 802 of file dockwidget.cpp.

◆ resetWasAlreadyFloating()

void swift::gui::CDockWidget::resetWasAlreadyFloating ( )

Reset first time floating, marked as never floated before.

Definition at line 202 of file dockwidget.cpp.

◆ restoreFromSettings()

bool swift::gui::CDockWidget::restoreFromSettings ( )

Restore from settings.

Definition at line 347 of file dockwidget.cpp.

◆ saveCurrentStateToSettings()

void swift::gui::CDockWidget::saveCurrentStateToSettings ( )

Remember widget state.

Definition at line 790 of file dockwidget.cpp.

◆ setAlwaysOnTop()

void swift::gui::CDockWidget::setAlwaysOnTop ( bool onTop )

inline

Set always on top.

Definition at line 121 of file dockwidget.h.

◆ setAlwaysOnTopFlag()

void swift::gui::CDockWidget::setAlwaysOnTopFlag ( bool onTop )

protected

Set the on top flag.

Definition at line 335 of file dockwidget.cpp.

◆ setEmptyTitleBar()

void swift::gui::CDockWidget::setEmptyTitleBar ( )

Set empty title bar (empty widget as title bar).

Definition at line 103 of file dockwidget.cpp.

◆ setFrameless()

void swift::gui::CDockWidget::setFrameless ( bool frameless )

virtual

Framless.

Reimplemented from swift::gui::CEnableForFramelessWindow.

Definition at line 212 of file dockwidget.cpp.

◆ setMargins()

void swift::gui::CDockWidget::setMargins ( )

protected

Set margins from settings.

Definition at line 75 of file dockwidget.cpp.

◆ setMarginsWhenDocked() [1/2]

void swift::gui::CDockWidget::setMarginsWhenDocked ( const QMargins & margins )

protected

Margins when widget is floating.

Definition at line 149 of file dockwidget.cpp.

◆ setMarginsWhenDocked() [2/2]

void swift::gui::CDockWidget::setMarginsWhenDocked	(	int	left,
		int	top,
		int	right,
		int	bottom )

protected

Margins when widget is floating.

Definition at line 156 of file dockwidget.cpp.

◆ setMarginsWhenFloating() [1/2]

void swift::gui::CDockWidget::setMarginsWhenFloating ( const QMargins & margins )

protected

Margins when window is floating.

Definition at line 118 of file dockwidget.cpp.

◆ setMarginsWhenFloating() [2/2]

void swift::gui::CDockWidget::setMarginsWhenFloating	(	int	left,
		int	top,
		int	right,
		int	bottom )

protected

Margins when window is floating.

Definition at line 125 of file dockwidget.cpp.

◆ setMarginsWhenFramelessFloating() [1/2]

void swift::gui::CDockWidget::setMarginsWhenFramelessFloating ( const QMargins & margins )

protected

Margins when window is floating (frameless).

Definition at line 132 of file dockwidget.cpp.

◆ setMarginsWhenFramelessFloating() [2/2]

void swift::gui::CDockWidget::setMarginsWhenFramelessFloating	(	int	left,
		int	top,
		int	right,
		int	bottom )

protected

Margins when window is floating (frameless).

Definition at line 139 of file dockwidget.cpp.

◆ setNullTitleBarWidget()

void swift::gui::CDockWidget::setNullTitleBarWidget ( )

Set null (nullptr) title bar.

Definition at line 116 of file dockwidget.cpp.

◆ setOffsetWhenFloating()

void swift::gui::CDockWidget::setOffsetWhenFloating	(	const QPoint &	point,
		bool	frameless )

Position offset when floating first time.

Definition at line 206 of file dockwidget.cpp.

◆ setOriginalTitleBar()

void swift::gui::CDockWidget::setOriginalTitleBar ( )

Set original title bar.

Definition at line 90 of file dockwidget.cpp.

◆ setPreferredSizeWhenFloating()

void swift::gui::CDockWidget::setPreferredSizeWhenFloating ( const QSize & size )

Size when floating first time.

Definition at line 204 of file dockwidget.cpp.

◆ setWindowTitle()

void swift::gui::CDockWidget::setWindowTitle ( const QString & title )

Set title and internally keep a backup.

Definition at line 165 of file dockwidget.cpp.

◆ showTitleWhenDocked() [1/2]

bool swift::gui::CDockWidget::showTitleWhenDocked ( ) const

inline

Window title when window is docked.

Definition at line 72 of file dockwidget.h.

◆ showTitleWhenDocked() [2/2]

void swift::gui::CDockWidget::showTitleWhenDocked ( bool show )

Show the window title when docked.

Definition at line 189 of file dockwidget.cpp.

◆ toggleFloating()

void swift::gui::CDockWidget::toggleFloating ( )

Toggle floating.

Definition at line 257 of file dockwidget.cpp.

◆ toggleFrameless()

void swift::gui::CDockWidget::toggleFrameless ( )

Toggle frameless mode.

Definition at line 300 of file dockwidget.cpp.

◆ toggleVisibility()

void swift::gui::CDockWidget::toggleVisibility ( )

Toggle visibility.

Definition at line 298 of file dockwidget.cpp.

◆ wasAlreadyFloating()

bool swift::gui::CDockWidget::wasAlreadyFloating ( ) const

inline

Was widget already floating?

Definition at line 91 of file dockwidget.h.

◆ windowAlwaysOnTop()

void swift::gui::CDockWidget::windowAlwaysOnTop ( )

Toggle frameless deferred.

void CDockWidget::toggleFramelessDeferred(int delayMs) { QPointer<CDockWidget> myself(this); QTimer::singleShot(delayMs, this, [ = ] { if (myself) { myself->toggleFrameless(); } }); }

Window always on top

Definition at line 317 of file dockwidget.cpp.

◆ windowNotAlwaysOnTop()

void swift::gui::CDockWidget::windowNotAlwaysOnTop ( )

Window not on top.

Definition at line 326 of file dockwidget.cpp.

◆ windowTitleBackup()

const QString & swift::gui::CDockWidget::windowTitleBackup ( ) const

inline

Window title backup.

Definition at line 66 of file dockwidget.h.

◆ windowTitleOrBackup()

QString swift::gui::CDockWidget::windowTitleOrBackup ( ) const

If current window title is empty, use backup.

Definition at line 505 of file dockwidget.cpp.

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

src/gui/dockwidget.h
src/gui/dockwidget.cpp

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CDockWidget() [1/2]

◆ CDockWidget() [2/2]

Member Function Documentation

◆ addToContextMenu()

◆ allowStatusBar()

◆ closeEvent()

◆ displayStatusMessage()

◆ displayStatusMessages()

◆ getMarginsWhenDocked()

◆ getMarginsWhenFloating()

◆ getMarginsWhenFramelessFloating()

◆ initialFloating()

◆ isSelected()

◆ isWidgetVisible()

◆ keyPressEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ onStyleSheetsChanged()

◆ paintEvent()

◆ propertyInnerWidget()

◆ propertyOuterWidget()

◆ resetPosition()

◆ resetSettings()

◆ resetWasAlreadyFloating()

◆ restoreFromSettings()

◆ saveCurrentStateToSettings()

◆ setAlwaysOnTop()

◆ setAlwaysOnTopFlag()

◆ setEmptyTitleBar()

◆ setFrameless()

◆ setMargins()

◆ setMarginsWhenDocked() [1/2]

◆ setMarginsWhenDocked() [2/2]

◆ setMarginsWhenFloating() [1/2]

◆ setMarginsWhenFloating() [2/2]

◆ setMarginsWhenFramelessFloating() [1/2]

◆ setMarginsWhenFramelessFloating() [2/2]

◆ setNullTitleBarWidget()

◆ setOffsetWhenFloating()

◆ setOriginalTitleBar()

◆ setPreferredSizeWhenFloating()

◆ setWindowTitle()

◆ showTitleWhenDocked() [1/2]

◆ showTitleWhenDocked() [2/2]

◆ toggleFloating()

◆ toggleFrameless()

◆ toggleVisibility()

◆ wasAlreadyFloating()

◆ windowAlwaysOnTop()

◆ windowNotAlwaysOnTop()

◆ windowTitleBackup()

◆ windowTitleOrBackup()