KDDockWidgets API Documentation 1.7
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
KDDockWidgets::MainWindow Class Reference

The QMainwindow sub-class that the application should use to be able to dock KDDockWidget::DockWidget instances. More...

#include <MainWindow.h>

Inheritance diagram for KDDockWidgets::MainWindow:
Inheritance graph
[legend]
Collaboration diagram for KDDockWidgets::MainWindow:
Collaboration graph
[legend]

Public Types

typedef QVector< MainWindow * > List
 
- Public Types inherited from KDDockWidgets::MainWindowBase
typedef QVector< MainWindowBase * > List
 
- Public Types inherited from QMainWindow
enum  DockOption
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 

Public Member Functions

 MainWindow (const QString &uniqueName, MainWindowOptions options=MainWindowOption_None, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Constructor. Use it as you would use QMainWindow.
 
 ~MainWindow () override
 Destructor.
 
QMargins centerWidgetMargins () const override
 
QHBoxLayoutinternalLayout () const
 returns the internal layout this is rarely needed unless you want to layout other widgets next to the main dock widget layout
 
void setCenterWidgetMargins (QMargins)
 
SideBarsideBar (SideBarLocation) const override
 returns the sidebar for the specified location
 
- Public Member Functions inherited from KDDockWidgets::MainWindowBase
 MainWindowBase (const QString &uniqueName, MainWindowOptions options=MainWindowOption_HasCentralFrame, WidgetType *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 
 ~MainWindowBase () override
 
Q_INVOKABLE void addDockWidget (KDDockWidgets::DockWidgetBase *dockWidget, KDDockWidgets::Location location, KDDockWidgets::DockWidgetBase *relativeTo=nullptr, KDDockWidgets::InitialOption initialOption={})
 Docks a DockWidget into this main window.
 
Q_INVOKABLE void addDockWidgetAsTab (KDDockWidgets::DockWidgetBase *dockwidget)
 Docks a DockWidget into the central frame, tabbed.
 
QStringList affinities () const
 Returns the list of affinity names. Empty by default.
 
bool anySideBarIsVisible () const
 Returns whether any side bar is visible.
 
Q_INVOKABLE void clearSideBarOverlay (bool deleteFrame=true)
 closes any overlayed dock widget. The sidebar still displays them as button.
 
Q_INVOKABLE bool closeDockWidgets (bool force=false)
 Closes all dock widgets which are docked into this main window This is convenience to calling DockWidget::close() individually If force is true, then the individual dock widgets can't stop the process Returns false if there's at least one dock widget which rejected closing. Returns true if all dock widgets were closed (0 or more)
 
DropAreaWithCentralFramedropArea () const
 
bool isMDI () const
 Returns whether this main window is using an MDI layout. In other words, returns true if MainWindowOption_MDI was passed in the ctor.
 
Q_INVOKABLE void layoutEqually ()
 layouts all the widgets so they have an equal size within their parent container
 
Q_INVOKABLE void layoutParentContainerEqually (KDDockWidgets::DockWidgetBase *dockWidget)
 like layoutEqually() but starts with the container that has dockWidget. While layoutEqually() starts from the root of the layout tree this function starts on a sub-tree.
 
LayoutWidget * layoutWidget () const
 
MDILayoutWidget * mdiLayoutWidget () const
 
Q_INVOKABLE void moveToSideBar (KDDockWidgets::DockWidgetBase *)
 Moves the dock widget into one of the MainWindow's sidebar. Means the dock widget is removed from the layout, and the sidebar shows a button that if pressed will toggle the dock widget's visibility as an overlay over the layout. This is the auto-hide functionality.
 
Q_INVOKABLE void moveToSideBar (KDDockWidgets::DockWidgetBase *, KDDockWidgets::SideBarLocation)
 overload that allows to specify which sidebar to use, instead of using heuristics.
 
MultiSplitter * multiSplitter () const
 
MainWindowOptions options () const
 Returns the main window options that were passed via constructor.
 
DockWidgetBaseoverlayedDockWidget () const
 returns the dock widget which is currently overlayed. nullptr if none. This is only relevant when using the auto-hide and side-bar feature.
 
int overlayMargin () const
 Returns the margin used by overlay docks. Default: 1.
 
Q_INVOKABLE void overlayOnSideBar (KDDockWidgets::DockWidgetBase *)
 Shows the dock widget overlayed on top of the main window, placed next to the sidebar.
 
QWidgetOrQuickpersistentCentralWidget () const
 
Q_INVOKABLE void restoreFromSideBar (KDDockWidgets::DockWidgetBase *)
 Removes the dock widget from the sidebar and docks it into the main window again.
 
void setAffinities (const QStringList &names)
 Sets the affinities names. Dock widgets can only dock into main windows of the same affinity.
 
void setOverlayMargin (int margin)
 Sets the margin used by overlay docks. Does not modify currently overlayed docks.
 
Q_INVOKABLE void setPersistentCentralWidget (KDDockWidgets::QWidgetOrQuick *widget)
 Sets a persistent central widget. It can't be detached.
 
Q_INVOKABLE KDDockWidgets::SideBar * sideBarForDockWidget (const KDDockWidgets::DockWidgetBase *) const
 Returns the sidebar this dockwidget is in. nullptr if not in any.
 
Q_INVOKABLE bool sideBarIsVisible (KDDockWidgets::SideBarLocation) const
 Returns whether the specified sidebar is visible.
 
Q_INVOKABLE void toggleOverlayOnSideBar (KDDockWidgets::DockWidgetBase *)
 Shows or hides an overlay. It's assumed the dock widget is already in a side-bar.
 
QString uniqueName () const
 Returns the unique name that was passed via constructor. Used internally by the save/restore mechanism.
 
QRect windowGeometry () const
 Returns the window geometry This is usually the same as MainWindowBase::geometry() But fixes the following special cases:
 
- Public Member Functions inherited from QMainWindow
 QMainWindow (QWidget *parent, Qt::WindowFlags flags)
 
virtual ~QMainWindow ()
 
void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget)
 
void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget, Qt::Orientation orientation)
 
QToolBaraddToolBar (const QString &title)
 
void addToolBar (Qt::ToolBarArea area, QToolBar *toolbar)
 
void addToolBar (QToolBar *toolbar)
 
void addToolBarBreak (Qt::ToolBarArea area)
 
QWidgetcentralWidget () const const
 
Qt::DockWidgetArea corner (Qt::Corner corner) const const
 
virtual QMenucreatePopupMenu ()
 
QMainWindow::DockOptions dockOptions () const const
 
Qt::DockWidgetArea dockWidgetArea (QDockWidget *dockwidget) const const
 
bool documentMode () const const
 
QSize iconSize () const const
 
void iconSizeChanged (const QSize &iconSize)
 
void insertToolBar (QToolBar *before, QToolBar *toolbar)
 
void insertToolBarBreak (QToolBar *before)
 
bool isAnimated () const const
 
bool isDockNestingEnabled () const const
 
QMenuBarmenuBar () const const
 
QWidgetmenuWidget () const const
 
void removeDockWidget (QDockWidget *dockwidget)
 
void removeToolBar (QToolBar *toolbar)
 
void removeToolBarBreak (QToolBar *before)
 
void resizeDocks (const QList< QDockWidget * > &docks, const QList< int > &sizes, Qt::Orientation orientation)
 
bool restoreDockWidget (QDockWidget *dockwidget)
 
bool restoreState (const QByteArray &state, int version)
 
QByteArray saveState (int version) const const
 
void setAnimated (bool enabled)
 
void setCentralWidget (QWidget *widget)
 
void setCorner (Qt::Corner corner, Qt::DockWidgetArea area)
 
void setDockNestingEnabled (bool enabled)
 
void setDockOptions (QMainWindow::DockOptions options)
 
void setDocumentMode (bool enabled)
 
void setIconSize (const QSize &iconSize)
 
void setMenuBar (QMenuBar *menuBar)
 
void setMenuWidget (QWidget *menuBar)
 
void setStatusBar (QStatusBar *statusbar)
 
void setTabPosition (Qt::DockWidgetAreas areas, QTabWidget::TabPosition tabPosition)
 
void setTabShape (QTabWidget::TabShape tabShape)
 
void setToolButtonStyle (Qt::ToolButtonStyle toolButtonStyle)
 
void setUnifiedTitleAndToolBarOnMac (bool set)
 
void splitDockWidget (QDockWidget *first, QDockWidget *second, Qt::Orientation orientation)
 
QStatusBarstatusBar () const const
 
void tabifiedDockWidgetActivated (QDockWidget *dockWidget)
 
QList< QDockWidget * > tabifiedDockWidgets (QDockWidget *dockwidget) const const
 
void tabifyDockWidget (QDockWidget *first, QDockWidget *second)
 
QTabWidget::TabPosition tabPosition (Qt::DockWidgetArea area) const const
 
QTabWidget::TabShape tabShape () const const
 
QWidgettakeCentralWidget ()
 
Qt::ToolBarArea toolBarArea (QToolBar *toolbar) const const
 
bool toolBarBreak (QToolBar *toolbar) const const
 
Qt::ToolButtonStyle toolButtonStyle () const const
 
void toolButtonStyleChanged (Qt::ToolButtonStyle toolButtonStyle)
 
bool unifiedTitleAndToolBarOnMac () const const
 
- 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
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (const QPoint &p) const const
 
QWidgetchildAt (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
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () 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)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () 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
 
QLayoutlayout () 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
 
virtual QSize minimumSizeHint () const const
 
int minimumWidth () const const
 
void move (const QPoint &)
 
void move (int x, int y)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () 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
 
QScreenscreen () 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)
 
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 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
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () 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
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () 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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< TfindChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< TfindChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< TfindChildren (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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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< TqFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< TqFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () 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
 

Protected Member Functions

QRect centralAreaGeometry () const override
 
void closeEvent (QCloseEvent *) override
 
void resizeEvent (QResizeEvent *) override
 
- Protected Member Functions inherited from KDDockWidgets::MainWindowBase
void onCloseEvent (QCloseEvent *)
 
void onResized (QResizeEvent *)
 
void setUniqueName (const QString &uniqueName)
 
- Protected Member Functions inherited from QMainWindow
virtual void contextMenuEvent (QContextMenuEvent *event) override
 
virtual bool event (QEvent *event) override
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void changeEvent (QEvent *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 mouseDoubleClickEvent (QMouseEvent *event)
 
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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice ()
 

Additional Inherited Members

- Signals inherited from KDDockWidgets::MainWindowBase
void frameCountChanged (int)
 emitted when the number of docked frames changes Note that we're using the "Frame" nomenculature instead of "DockWidget" here, as DockWidgets can be tabbed together, in which case this signal isn't emitted.
 
void overlayMarginChanged (int)
 
void uniqueNameChanged ()
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
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)
 
- Public Attributes inherited from QMainWindow
 AllowNestedDocks
 
 AllowTabbedDocks
 
 AnimatedDocks
 
typedef DockOptions
 
 ForceTabbedDocks
 
 GroupedDragging
 
 VerticalTabs
 
- 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
 
- Properties inherited from KDDockWidgets::MainWindowBase
QStringList affinities
 
bool isMDI
 
KDDockWidgets::MainWindowOptions options
 
int overlayMargin
 
QString uniqueName
 
- Properties inherited from QMainWindow
 animated
 
 dockNestingEnabled
 
 dockOptions
 
 documentMode
 
 iconSize
 
 tabShape
 
 toolButtonStyle
 
 unifiedTitleAndToolBarOnMac
 
- 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
 

Detailed Description

The QMainwindow sub-class that the application should use to be able to dock KDDockWidget::DockWidget instances.

Definition at line 36 of file MainWindow.h.

Member Typedef Documentation

◆ List

Definition at line 40 of file MainWindow.h.

Constructor & Destructor Documentation

◆ MainWindow()

MainWindow::MainWindow ( const QString uniqueName,
MainWindowOptions  options = MainWindowOption_None,
QWidget parent = nullptr,
Qt::WindowFlags  flags = Qt::WindowFlags() 
)
explicit

Constructor. Use it as you would use QMainWindow.

Parameters
uniqueNameMandatory name that should be unique between all MainWindow instances. This name won't be user visible and just used internally for the save/restore.
optionsoptional MainWindowOptions to use
parentQObject *parent to pass to QMainWindow constructor.
flagsWindow flags to pass to QMainWindow constructor.

Definition at line 90 of file MainWindow.cpp.

References QObject::connect(), QWidget::create(), KDDockWidgets::East, QWidget::isWindow(), KDDockWidgets::MainWindowBase::layoutWidget(), KDDockWidgets::North, QObject::parent(), QObject::Q_EMIT(), QObject::qobject_cast(), QWindow::screenChanged(), sideBar(), KDDockWidgets::South, KDDockWidgets::West, Qt::Window, and QWidget::windowHandle().

◆ ~MainWindow()

MainWindow::~MainWindow ( )
override

Destructor.

Definition at line 130 of file MainWindow.cpp.

Member Function Documentation

◆ centerWidgetMargins()

QMargins MainWindow::centerWidgetMargins ( ) const
overridevirtual

Implements KDDockWidgets::MainWindowBase.

Definition at line 151 of file MainWindow.cpp.

◆ centralAreaGeometry()

QRect MainWindow::centralAreaGeometry ( ) const
overrideprotectedvirtual

Reimplemented from KDDockWidgets::MainWindowBase.

Definition at line 164 of file MainWindow.cpp.

References QMainWindow::centralWidget(), and QWidget::geometry.

◆ closeEvent()

void MainWindow::closeEvent ( QCloseEvent ev)
overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 169 of file MainWindow.cpp.

References KDDockWidgets::MainWindowBase::onCloseEvent(), and QObject::qobject_cast().

◆ internalLayout()

QHBoxLayout * MainWindow::internalLayout ( ) const

returns the internal layout this is rarely needed unless you want to layout other widgets next to the main dock widget layout

Definition at line 174 of file MainWindow.cpp.

◆ resizeEvent()

void MainWindow::resizeEvent ( QResizeEvent ev)
overrideprotectedvirtual

◆ setCenterWidgetMargins()

void MainWindow::setCenterWidgetMargins ( QMargins  margins)

Definition at line 156 of file MainWindow.cpp.

◆ sideBar()

SideBar * MainWindow::sideBar ( SideBarLocation  location) const
overridevirtual

returns the sidebar for the specified location

Implements KDDockWidgets::MainWindowBase.

Definition at line 140 of file MainWindow.cpp.

Referenced by MainWindow().


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

© 2019-2023 Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
KDDockWidgets
Advanced Dock Widget Framework for Qt
https://www.kdab.com/development-resources/qt-tools/kddockwidgets/
Generated on Wed Nov 1 2023 00:02:31 for KDDockWidgets API Documentation by doxygen 1.9.8