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
QMainWindowLayoutState Class Reference

#include <qmainwindowlayout_p.h>

Collaboration diagram for QMainWindowLayoutState:

Public Types

enum class  StateMarkers {
  FloatingDockWidgetTab = 0xf9 , Tab = 0xfa , Widget = 0xfb , Sequence = 0xfc ,
  ToolBarEx = Sequence , DockWidget = 0xfd , ToolBar = 0xfe
}

Public Member Functions

 QMainWindowLayoutState (QMainWindow *win)
void apply (QWidgetAnimator::AnimationRule rule)
void deleteAllLayoutItems ()
void deleteCentralWidgetItem ()
QSize sizeHint () const
QSize minimumSize () const
bool fits () const
void fitLayout ()
QLayoutItemitemAt (int index, int *x) const
QLayoutItemtakeAt (int index, int *x)
QList< int > indexOf (QWidget *widget) const
QLayoutItemitem (const QList< int > &path)
QRect itemRect (const QList< int > &path) const
QRect gapRect (const QList< int > &path) const
bool contains (QWidget *widget) const
void setCentralWidget (QWidget *widget)
QWidgetcentralWidget () const
QList< int > gapIndex (QWidget *widget, const QPoint &pos) const
bool insertGap (const QList< int > &path, QLayoutItem *item)
void remove (const QList< int > &path)
void remove (QLayoutItem *item)
void clear ()
bool isValid () const
QLayoutItemplug (const QList< int > &path)
QLayoutItemunplug (const QList< int > &path, QMainWindowLayoutState *savedState=nullptr)
void saveState (QDataStream &stream) const
bool checkFormat (QDataStream &stream)
bool restoreState (QDataStream &stream, const QMainWindowLayoutState &oldState)

Public Attributes

QRect rect
QMainWindowmainWindow
QLayoutItemcentralWidgetItem
QRect centralWidgetRect

Friends

QDebug operator<< (QDebug debug, StateMarkers marker)
QDataStreamoperator<< (QDataStream &stream, StateMarkers marker)
QDataStreamoperator>> (QDataStream &stream, StateMarkers &marker)

Detailed Description

Definition at line 429 of file qmainwindowlayout_p.h.

Member Enumeration Documentation

◆ StateMarkers

Enumerator
FloatingDockWidgetTab 
Tab 
Widget 
Sequence 
ToolBarEx 
DockWidget 
ToolBar 

Definition at line 432 of file qmainwindowlayout_p.h.

Constructor & Destructor Documentation

◆ QMainWindowLayoutState()

QMainWindowLayoutState::QMainWindowLayoutState ( QMainWindow * win)

QDockWidgetGroupWindow is a floating window, containing several QDockWidgets floating together. This requires QMainWindow::GroupedDragging to be enabled. QDockWidgets floating jointly in a QDockWidgetGroupWindow are considered to be docked. Their isFloating property is false. QDockWidget children of a QDockWidgetGroupWindow are either: \list

  • tabbed (as long as Qt is compiled with the tabbar feature), or
  • arranged next to each other, equivalent to the default on a main window dock. \endlist

QDockWidgetGroupWindow uses QDockWidgetGroupLayout to lay out its QDockWidget children. It stores layout information in a QDockAreaLayoutInfo, including temporary spacer items and rubber bands.

If its QDockWidget children are tabbed, the QDockWidgetGroupWindow shows the active QDockWidget's title as its own window title.

QDockWidgetGroupWindow is designed to hold more than one QDockWidget. A QDockWidgetGroupWindow with only one QDockWidget child may occur only temporarily \list

  • in its construction phase, or
  • during a hover: While QDockWidget A is hovered over B, B is converted into a QDockWidgetGroupWindow. \endlist

A QDockWidgetGroupWindow with only one QDockWidget child must never get focus, be dragged or dropped. To enforce this restriction, QDockWidgetGrouWindow will remove itself after its second QDockWidget child has been removed. It will make its last QDockWidget child a single, floating QDockWidget. Eventually, the empty QDockWidgetGroupWindow will call deleteLater() on itself.

Definition at line 834 of file qmainwindowlayout.cpp.

Member Function Documentation

◆ apply()

void QMainWindowLayoutState::apply ( QWidgetAnimator::AnimationRule rule)

Definition at line 911 of file qmainwindowlayout.cpp.

◆ centralWidget()

QWidget * QMainWindowLayoutState::centralWidget ( ) const

Definition at line 1070 of file qmainwindowlayout.cpp.

◆ checkFormat()

bool QMainWindowLayoutState::checkFormat ( QDataStream & stream)

Definition at line 1309 of file qmainwindowlayout.cpp.

◆ clear()

void QMainWindowLayoutState::clear ( )

Definition at line 1176 of file qmainwindowlayout.cpp.

◆ contains()

bool QMainWindowLayoutState::contains ( QWidget * widget) const

Definition at line 1035 of file qmainwindowlayout.cpp.

◆ deleteAllLayoutItems()

void QMainWindowLayoutState::deleteAllLayoutItems ( )

Definition at line 947 of file qmainwindowlayout.cpp.

◆ deleteCentralWidgetItem()

void QMainWindowLayoutState::deleteCentralWidgetItem ( )

Definition at line 958 of file qmainwindowlayout.cpp.

◆ fitLayout()

void QMainWindowLayoutState::fitLayout ( )

Definition at line 929 of file qmainwindowlayout.cpp.

◆ fits()

bool QMainWindowLayoutState::fits ( ) const

Returns whether the layout fits into the main window.

Definition at line 891 of file qmainwindowlayout.cpp.

◆ gapIndex()

QList< int > QMainWindowLayoutState::gapIndex ( QWidget * widget,
const QPoint & pos ) const

Definition at line 1085 of file qmainwindowlayout.cpp.

◆ gapRect()

QRect QMainWindowLayoutState::gapRect ( const QList< int > & path) const

Definition at line 1233 of file qmainwindowlayout.cpp.

◆ indexOf()

QList< int > QMainWindowLayoutState::indexOf ( QWidget * widget) const

Definition at line 1008 of file qmainwindowlayout.cpp.

◆ insertGap()

bool QMainWindowLayoutState::insertGap ( const QList< int > & path,
QLayoutItem * item )

Definition at line 1121 of file qmainwindowlayout.cpp.

◆ isValid()

bool QMainWindowLayoutState::isValid ( ) const

Definition at line 1191 of file qmainwindowlayout.cpp.

◆ item()

QLayoutItem * QMainWindowLayoutState::item ( const QList< int > & path)

Definition at line 1196 of file qmainwindowlayout.cpp.

◆ itemAt()

QLayoutItem * QMainWindowLayoutState::itemAt ( int index,
int * x ) const

Definition at line 969 of file qmainwindowlayout.cpp.

◆ itemRect()

QRect QMainWindowLayoutState::itemRect ( const QList< int > & path) const

Definition at line 1216 of file qmainwindowlayout.cpp.

◆ minimumSize()

QSize QMainWindowLayoutState::minimumSize ( ) const

Definition at line 868 of file qmainwindowlayout.cpp.

◆ plug()

QLayoutItem * QMainWindowLayoutState::plug ( const QList< int > & path)

Definition at line 1250 of file qmainwindowlayout.cpp.

◆ remove() [1/2]

void QMainWindowLayoutState::remove ( const QList< int > & path)

Definition at line 1145 of file qmainwindowlayout.cpp.

◆ remove() [2/2]

void QMainWindowLayoutState::remove ( QLayoutItem * item)

Definition at line 1160 of file qmainwindowlayout.cpp.

◆ restoreState()

bool QMainWindowLayoutState::restoreState ( QDataStream & stream,
const QMainWindowLayoutState & oldState )

Definition at line 1358 of file qmainwindowlayout.cpp.

◆ saveState()

void QMainWindowLayoutState::saveState ( QDataStream & stream) const

Definition at line 1286 of file qmainwindowlayout.cpp.

◆ setCentralWidget()

void QMainWindowLayoutState::setCentralWidget ( QWidget * widget)

Definition at line 1054 of file qmainwindowlayout.cpp.

◆ sizeHint()

QSize QMainWindowLayoutState::sizeHint ( ) const

Definition at line 849 of file qmainwindowlayout.cpp.

◆ takeAt()

QLayoutItem * QMainWindowLayoutState::takeAt ( int index,
int * x )

Definition at line 987 of file qmainwindowlayout.cpp.

◆ unplug()

QLayoutItem * QMainWindowLayoutState::unplug ( const QList< int > & path,
QMainWindowLayoutState * savedState = nullptr )

Definition at line 1267 of file qmainwindowlayout.cpp.

◆ operator<< [1/2]

QDataStream & operator<< ( QDataStream & stream,
StateMarkers marker )
friend

Definition at line 199 of file qmainwindowlayout.cpp.

◆ operator<< [2/2]

QDebug operator<< ( QDebug debug,
StateMarkers marker )
friend

Definition at line 180 of file qmainwindowlayout.cpp.

◆ operator>>

QDataStream & operator>> ( QDataStream & stream,
StateMarkers & marker )
friend

Definition at line 206 of file qmainwindowlayout.cpp.

Member Data Documentation

◆ centralWidgetItem

QLayoutItem* QMainWindowLayoutState::centralWidgetItem

Definition at line 454 of file qmainwindowlayout_p.h.

◆ centralWidgetRect

QRect QMainWindowLayoutState::centralWidgetRect

Definition at line 455 of file qmainwindowlayout_p.h.

◆ mainWindow

QMainWindow* QMainWindowLayoutState::mainWindow

Definition at line 443 of file qmainwindowlayout_p.h.

◆ rect

QRect QMainWindowLayoutState::rect

Definition at line 442 of file qmainwindowlayout_p.h.


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