Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qmdisubwindow.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QMDISUBWINDOW_H
6#define QMDISUBWINDOW_H
7
8#include <QtWidgets/qtwidgetsglobal.h>
9#include <QtWidgets/qwidget.h>
10
11QT_REQUIRE_CONFIG(mdiarea);
12
13QT_BEGIN_NAMESPACE
14
15class QMenu;
16class QMdiArea;
17
18namespace QMdi { class ControlContainer; }
19class QMdiSubWindowPrivate;
20class Q_WIDGETS_EXPORT QMdiSubWindow : public QWidget
21{
22 Q_OBJECT
23 Q_PROPERTY(int keyboardSingleStep READ keyboardSingleStep WRITE setKeyboardSingleStep)
24 Q_PROPERTY(int keyboardPageStep READ keyboardPageStep WRITE setKeyboardPageStep)
25public:
26 enum SubWindowOption {
27 AllowOutsideAreaHorizontally = 0x1, // internal
28 AllowOutsideAreaVertically = 0x2, // internal
29 RubberBandResize = 0x4,
30 RubberBandMove = 0x8
31 };
32 Q_DECLARE_FLAGS(SubWindowOptions, SubWindowOption)
33
34 QMdiSubWindow(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags());
35 ~QMdiSubWindow();
36
37 QSize sizeHint() const override;
38 QSize minimumSizeHint() const override;
39
40 void setWidget(QWidget *widget);
41 QWidget *widget() const;
42
43 QWidget *maximizedButtonsWidget() const; // internal
44 QWidget *maximizedSystemMenuIconWidget() const; // internal
45
46 bool isShaded() const;
47
48 void setOption(SubWindowOption option, bool on = true);
49 bool testOption(SubWindowOption) const;
50
51 void setKeyboardSingleStep(int step);
52 int keyboardSingleStep() const;
53
54 void setKeyboardPageStep(int step);
55 int keyboardPageStep() const;
56
57#if QT_CONFIG(menu)
58 void setSystemMenu(QMenu *systemMenu);
59 QMenu *systemMenu() const;
60#endif
61
62 QMdiArea *mdiArea() const;
63
64Q_SIGNALS:
65 void windowStateChanged(Qt::WindowStates oldState, Qt::WindowStates newState);
66 void aboutToActivate();
67
68public Q_SLOTS:
69#if QT_CONFIG(menu)
70 void showSystemMenu();
71#endif
72 void showShaded();
73
74protected:
75 bool eventFilter(QObject *object, QEvent *event) override;
76 bool event(QEvent *event) override;
77 void showEvent(QShowEvent *showEvent) override;
78 void hideEvent(QHideEvent *hideEvent) override;
79 void changeEvent(QEvent *changeEvent) override;
80 void closeEvent(QCloseEvent *closeEvent) override;
81 void leaveEvent(QEvent *leaveEvent) override;
82 void resizeEvent(QResizeEvent *resizeEvent) override;
83 void timerEvent(QTimerEvent *timerEvent) override;
84 void moveEvent(QMoveEvent *moveEvent) override;
85 void paintEvent(QPaintEvent *paintEvent) override;
86 void mousePressEvent(QMouseEvent *mouseEvent) override;
87 void mouseDoubleClickEvent(QMouseEvent *mouseEvent) override;
88 void mouseReleaseEvent(QMouseEvent *mouseEvent) override;
89 void mouseMoveEvent(QMouseEvent *mouseEvent) override;
90 void keyPressEvent(QKeyEvent *keyEvent) override;
91#ifndef QT_NO_CONTEXTMENU
92 void contextMenuEvent(QContextMenuEvent *contextMenuEvent) override;
93#endif
94 void focusInEvent(QFocusEvent *focusInEvent) override;
95 void focusOutEvent(QFocusEvent *focusOutEvent) override;
96 void childEvent(QChildEvent *childEvent) override;
97
98private:
99 Q_DISABLE_COPY(QMdiSubWindow)
100 Q_DECLARE_PRIVATE(QMdiSubWindow)
101 Q_PRIVATE_SLOT(d_func(), void _q_updateStaysOnTopHint())
102 Q_PRIVATE_SLOT(d_func(), void _q_enterInteractiveMode())
103 Q_PRIVATE_SLOT(d_func(), void _q_processFocusChanged(QWidget *, QWidget *))
104 friend class QMdiAreaPrivate;
105 friend class QMdiArea;
106#if QT_CONFIG(tabbar)
107 friend class QMdiAreaTabBar;
108#endif
109 friend class QMdi::ControlContainer;
110};
111
112Q_DECLARE_OPERATORS_FOR_FLAGS(QMdiSubWindow::SubWindowOptions)
113
114QT_END_NAMESPACE
115
116#endif // QMDISUBWINDOW_H
void internalRaise(QMdiSubWindow *child) const
void place(QMdi::Placer *placer, QMdiSubWindow *child)
Definition qmdiarea.cpp:845
void resetActiveWindow(QMdiSubWindow *child=nullptr)
QMdi::Rearranger * cascader
Definition qmdiarea_p.h:112
QMdi::Placer * placer
Definition qmdiarea_p.h:115
QPointer< QMdiSubWindow > aboutToBecomeActive
Definition qmdiarea_p.h:125
QMdi::Rearranger * regularTiler
Definition qmdiarea_p.h:113
void activateCurrentWindow()
Definition qmdiarea.cpp:979
QList< int > indicesToActivatedChildren
Definition qmdiarea_p.h:123
QBasicTimer tabToPreviousTimer
Definition qmdiarea_p.h:152
bool scrollBarsEnabled() const
void appendChild(QMdiSubWindow *child)
Definition qmdiarea.cpp:792
void activateHighlightedWindow()
Definition qmdiarea.cpp:988
void emitWindowActivated(QMdiSubWindow *child)
QMdi::Rearranger * iconTiler
Definition qmdiarea_p.h:114
QPointer< QMdiSubWindow > active
Definition qmdiarea_p.h:124
QList< QMdiSubWindow * > subWindowList(QMdiArea::WindowOrder, bool reversed=false) const
void updateScrollBars()
QRect resizeToMinimumTileSize(const QSize &minSubWindowSize, int subWindowCount)
QMdiArea::WindowOrder activationOrder
Definition qmdiarea_p.h:127
bool isExplicitlyDeactivated(QMdiSubWindow *subWindow) const
Definition qmdiarea_p.h:213
void arrangeMinimizedSubWindows()
Definition qmdiarea.cpp:940
QMdiAreaTabBar * tabBar
Definition qmdiarea_p.h:119
bool lastWindowAboutToBeDestroyed() const
QBasicTimer resizeTimer
Definition qmdiarea_p.h:151
bool ignoreGeometryChange
Definition qmdiarea_p.h:139
void activateWindow(QMdiSubWindow *child)
Definition qmdiarea.cpp:950
void highlightNextSubWindow(int increaseFactor)
QList< QMdi::Rearranger * > pendingRearrangements
Definition qmdiarea_p.h:120
QMdiArea::AreaOptions options
Definition qmdiarea_p.h:128
bool tileCalledFromResizeEvent
Definition qmdiarea_p.h:144
void disconnectSubWindow(QObject *subWindow)
void startTabToPreviousTimer()
Definition qmdiarea_p.h:198
void _q_moveTab(int from, int to)
Definition qmdiarea.cpp:768
bool windowStaysOnTop(QMdiSubWindow *subWindow) const
Definition qmdiarea_p.h:206
QList< QPointer< QMdiSubWindow > > pendingPlacements
Definition qmdiarea_p.h:121
void setActive(QMdiSubWindow *subWindow, bool active=true, bool changeFocus=true) const
Definition qmdiarea_p.h:220
bool ignoreWindowStateChange
Definition qmdiarea_p.h:140
void _q_currentTabChanged(int index)
Definition qmdiarea.cpp:733
bool updatesDisabledByUs
Definition qmdiarea_p.h:145
QList< QPointer< QMdiSubWindow > > childWindows
Definition qmdiarea_p.h:122
void _q_deactivateAllWindows(QMdiSubWindow *aboutToActivate=nullptr)
Definition qmdiarea.cpp:660
void scrollBarPolicyChanged(Qt::Orientation, Qt::ScrollBarPolicy) override
bool showActiveWindowMaximized
Definition qmdiarea_p.h:143
QMdiArea::ViewMode viewMode
Definition qmdiarea_p.h:129
void startResizeTimer()
Definition qmdiarea_p.h:190
int indexToPreviousWindow
Definition qmdiarea_p.h:148
void setViewMode(QMdiArea::ViewMode mode)
void updateActiveWindow(int removedIndex, bool activeRemoved)
void rearrange(QMdi::Rearranger *rearranger)
Definition qmdiarea.cpp:884
void setChildActivationEnabled(bool enable=true, bool onlyNextActivationEvent=false) const
void _q_closeTab(int index)
Definition qmdiarea.cpp:757
void _q_processWindowStateChanged(Qt::WindowStates oldState, Qt::WindowStates newState)
Definition qmdiarea.cpp:700
QMdiSubWindow * nextVisibleSubWindow(int increaseFactor, QMdiArea::WindowOrder, int removed=-1, int fromIndex=-1) const
The QMdiArea widget provides an area in which MDI windows are displayed.
Definition qmdiarea.h:22
The QMdiSubWindow class provides a subwindow class for QMdiArea.
Type type() const override
Definition qmdiarea_p.h:77
void rearrange(QList< QWidget * > &widgets, const QRect &domain) const override
Definition qmdiarea.cpp:332
QPoint place(const QSize &size, const QList< QRect > &rects, const QRect &domain) const override
Definition qmdiarea.cpp:503
virtual ~Placer()
Definition qmdiarea_p.h:87
virtual QPoint place(const QSize &size, const QList< QRect > &rects, const QRect &domain) const =0
virtual void rearrange(QList< QWidget * > &widgets, const QRect &domain) const =0
virtual Type type() const =0
virtual ~Rearranger()
Definition qmdiarea_p.h:50
void rearrange(QList< QWidget * > &widgets, const QRect &domain) const override
Definition qmdiarea.cpp:245
Type type() const override
Definition qmdiarea_p.h:59
void rearrange(QList< QWidget * > &widgets, const QRect &domain) const override
Definition qmdiarea.cpp:289
Type type() const override
Definition qmdiarea_p.h:68
static bool sanityCheck(const QList< QWidget * > &widgets, const int index, const char *where)
Definition qmdiarea.cpp:158
static QString tabTextFor(QMdiSubWindow *subWindow)
Definition qmdiarea.cpp:226
static bool sanityCheck(const QMdiSubWindow *const child, const char *where)
Definition qmdiarea.cpp:147
static QMdiArea * mdiAreaParent(QWidget *widget)
Definition qmdiarea.cpp:208
static bool useScrollBar(const QRect &childrenRect, const QSize &maxViewportSize, Qt::Orientation orientation)
Definition qmdiarea.cpp:194
static void setIndex(int *index, int candidate, int min, int max, bool isIncreasing)
Definition qmdiarea.cpp:175
QT_REQUIRE_CONFIG(mdiarea)
QString qt_setWindowTitle_helperHelper(const QString &, const QWidget *)
Returns a modified window title with the [*] place holder replaced according to the rules described i...
Definition qwidget.cpp:6051