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

#include <qdockarealayout_p.h>

Collaboration diagram for QDockAreaLayout:

Public Types

enum  { EmptyDropAreaSize = 80 }
enum  { DockWidgetStateMarker = 0xfd , FloatingDockWidgetTabMarker = 0xf9 }

Public Member Functions

 QDockAreaLayout (QMainWindow *win)
bool isValid () const
void saveState (QDataStream &stream) const
bool restoreState (QDataStream &stream, const QList< QDockWidget * > &widgets, bool testing=false)
QList< int > indexOfPlaceHolder (const QString &objectName) const
QList< int > indexOf (const QWidget *dockWidget) const
QList< int > gapIndex (const QPoint &pos, bool disallowTabs) const
QList< int > findSeparator (const QPoint &pos) const
QDockAreaLayoutItemitem (const QList< int > &path)
QDockAreaLayoutInfoinfo (const QList< int > &path)
const QDockAreaLayoutInfoinfo (const QList< int > &path) const
QDockAreaLayoutInfoinfo (QWidget *widget)
QRect itemRect (const QList< int > &path) const
QRect separatorRect (int index) const
QRect separatorRect (const QList< int > &path) const
bool insertGap (const QList< int > &path, QLayoutItem *dockWidgetItem)
QLayoutItemplug (const QList< int > &path)
QLayoutItemunplug (const QList< int > &path)
void remove (const QList< int > &path)
void removePlaceHolder (const QString &name)
void fitLayout ()
void clear ()
QSize sizeHint () const
QSize minimumSize () const
QSize minimumStableSize () const
template<typename SizePMF, typename CenterPMF>
QSize size_helper (SizePMF sizeFn, CenterPMF centerFn) const
void addDockWidget (QInternal::DockPosition pos, QDockWidget *dockWidget, Qt::Orientation orientation)
bool restoreDockWidget (QDockWidget *dockWidget)
void splitDockWidget (QDockWidget *after, QDockWidget *dockWidget, Qt::Orientation orientation)
void resizeDocks (const QList< QDockWidget * > &docks, const QList< int > &sizes, Qt::Orientation o)
void apply (bool animate)
void paintSeparators (QPainter *p, QWidget *widget, const QRegion &clip, const QPoint &mouse) const
QRegion separatorRegion () const
int separatorMove (const QList< int > &separator, const QPoint &origin, const QPoint &dest)
QLayoutItemitemAt (int *x, int index) const
QLayoutItemtakeAt (int *x, int index)
void deleteAllLayoutItems ()
void getGrid (QList< QLayoutStruct > *ver_struct_list, QList< QLayoutStruct > *hor_struct_list)
void setGrid (QList< QLayoutStruct > *ver_struct_list, QList< QLayoutStruct > *hor_struct_list)
QRect gapRect (const QList< int > &path) const
QRect gapRect (QInternal::DockPosition dockPos) const
void keepSize (QDockWidget *w)
void styleChangedEvent ()

Static Public Member Functions

static QRect constrainedRect (QRect rect, QWidget *widget)

Public Attributes

Qt::DockWidgetArea corners [4]
QRect rect
QLayoutItemcentralWidgetItem
QMainWindowmainWindow
QRect centralWidgetRect
QDockAreaLayoutInfo docks [4]
int sep
bool fallbackToSizeHints
QList< QWidget * > separatorWidgets

Detailed Description

Definition at line 198 of file qdockarealayout_p.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
EmptyDropAreaSize 

Definition at line 201 of file qdockarealayout_p.h.

◆ anonymous enum

anonymous enum
Enumerator
DockWidgetStateMarker 
FloatingDockWidgetTabMarker 

Definition at line 216 of file qdockarealayout_p.h.

Constructor & Destructor Documentation

◆ QDockAreaLayout()

QDockAreaLayout::QDockAreaLayout ( QMainWindow * win)

Definition at line 2369 of file qdockarealayout.cpp.

Member Function Documentation

◆ addDockWidget()

void QDockAreaLayout::addDockWidget ( QInternal::DockPosition pos,
QDockWidget * dockWidget,
Qt::Orientation orientation )

Definition at line 3166 of file qdockarealayout.cpp.

◆ apply()

void QDockAreaLayout::apply ( bool animate)

Definition at line 3278 of file qdockarealayout.cpp.

◆ clear()

void QDockAreaLayout::clear ( )

Definition at line 3019 of file qdockarealayout.cpp.

◆ constrainedRect()

QRect QDockAreaLayout::constrainedRect ( QRect rect,
QWidget * widget )
static

Try to fit the given rectangle rect on the screen which contains the window widget. Used to compute the geometry of a dragged a dock widget that should be shown with rect, but needs to be visible on the screen

Definition at line 3106 of file qdockarealayout.cpp.

◆ deleteAllLayoutItems()

void QDockAreaLayout::deleteAllLayoutItems ( )

Definition at line 3470 of file qdockarealayout.cpp.

◆ findSeparator()

QList< int > QDockAreaLayout::findSeparator ( const QPoint & pos) const

Definition at line 2575 of file qdockarealayout.cpp.

◆ fitLayout()

void QDockAreaLayout::fitLayout ( )

Definition at line 3007 of file qdockarealayout.cpp.

◆ gapIndex()

QList< int > QDockAreaLayout::gapIndex ( const QPoint & pos,
bool disallowTabs ) const

Definition at line 2488 of file qdockarealayout.cpp.

◆ gapRect() [1/2]

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

Definition at line 3503 of file qdockarealayout.cpp.

◆ gapRect() [2/2]

QRect QDockAreaLayout::gapRect ( QInternal::DockPosition dockPos) const

Definition at line 2538 of file qdockarealayout.cpp.

◆ getGrid()

void QDockAreaLayout::getGrid ( QList< QLayoutStruct > * ver_struct_list,
QList< QLayoutStruct > * hor_struct_list )

Definition at line 2733 of file qdockarealayout.cpp.

◆ indexOf()

QList< int > QDockAreaLayout::indexOf ( const QWidget * dockWidget) const

Definition at line 2476 of file qdockarealayout.cpp.

◆ indexOfPlaceHolder()

QList< int > QDockAreaLayout::indexOfPlaceHolder ( const QString & objectName) const

Definition at line 2464 of file qdockarealayout.cpp.

◆ info() [1/3]

QDockAreaLayoutInfo * QDockAreaLayout::info ( const QList< int > & path)

Definition at line 2610 of file qdockarealayout.cpp.

◆ info() [2/3]

const QDockAreaLayoutInfo * QDockAreaLayout::info ( const QList< int > & path) const

Definition at line 2622 of file qdockarealayout.cpp.

◆ info() [3/3]

QDockAreaLayoutInfo * QDockAreaLayout::info ( QWidget * widget)

Definition at line 2600 of file qdockarealayout.cpp.

◆ insertGap()

bool QDockAreaLayout::insertGap ( const QList< int > & path,
QLayoutItem * dockWidgetItem )

Definition at line 2677 of file qdockarealayout.cpp.

◆ isValid()

bool QDockAreaLayout::isValid ( ) const

Definition at line 2395 of file qdockarealayout.cpp.

◆ item()

QDockAreaLayoutItem & QDockAreaLayout::item ( const QList< int > & path)

Definition at line 2627 of file qdockarealayout.cpp.

◆ itemAt()

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

Definition at line 3435 of file qdockarealayout.cpp.

◆ itemRect()

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

Definition at line 2635 of file qdockarealayout.cpp.

◆ keepSize()

void QDockAreaLayout::keepSize ( QDockWidget * w)

Definition at line 3514 of file qdockarealayout.cpp.

◆ minimumSize()

QSize QDockAreaLayout::minimumSize ( ) const

Definition at line 3085 of file qdockarealayout.cpp.

◆ minimumStableSize()

QSize QDockAreaLayout::minimumStableSize ( ) const

Returns the smallest size that doesn't change the size of any of the dock areas.

Definition at line 3095 of file qdockarealayout.cpp.

◆ paintSeparators()

void QDockAreaLayout::paintSeparators ( QPainter * p,
QWidget * widget,
const QRegion & clip,
const QPoint & mouse ) const

Definition at line 3294 of file qdockarealayout.cpp.

◆ plug()

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

Definition at line 2685 of file qdockarealayout.cpp.

◆ remove()

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

Definition at line 2707 of file qdockarealayout.cpp.

◆ removePlaceHolder()

void QDockAreaLayout::removePlaceHolder ( const QString & name)

Definition at line 2715 of file qdockarealayout.cpp.

◆ resizeDocks()

void QDockAreaLayout::resizeDocks ( const QList< QDockWidget * > & docks,
const QList< int > & sizes,
Qt::Orientation o )

Definition at line 3214 of file qdockarealayout.cpp.

◆ restoreDockWidget()

bool QDockAreaLayout::restoreDockWidget ( QDockWidget * dockWidget)

Definition at line 3127 of file qdockarealayout.cpp.

◆ restoreState()

bool QDockAreaLayout::restoreState ( QDataStream & stream,
const QList< QDockWidget * > & widgets,
bool testing = false )

Definition at line 2422 of file qdockarealayout.cpp.

◆ saveState()

void QDockAreaLayout::saveState ( QDataStream & stream) const

Definition at line 2400 of file qdockarealayout.cpp.

◆ separatorMove()

int QDockAreaLayout::separatorMove ( const QList< int > & separator,
const QPoint & origin,
const QPoint & dest )

Definition at line 3328 of file qdockarealayout.cpp.

◆ separatorRect() [1/2]

QRect QDockAreaLayout::separatorRect ( const QList< int > & path) const

Definition at line 2664 of file qdockarealayout.cpp.

◆ separatorRect() [2/2]

QRect QDockAreaLayout::separatorRect ( int index) const

Definition at line 2643 of file qdockarealayout.cpp.

◆ separatorRegion()

QRegion QDockAreaLayout::separatorRegion ( ) const

Definition at line 3313 of file qdockarealayout.cpp.

◆ setGrid()

void QDockAreaLayout::setGrid ( QList< QLayoutStruct > * ver_struct_list,
QList< QLayoutStruct > * hor_struct_list )

Definition at line 2911 of file qdockarealayout.cpp.

◆ size_helper()

template<typename SizePMF, typename CenterPMF>
QSize QDockAreaLayout::size_helper ( SizePMF sizeFn,
CenterPMF centerFn ) const

Definition at line 3029 of file qdockarealayout.cpp.

◆ sizeHint()

QSize QDockAreaLayout::sizeHint ( ) const

Definition at line 3080 of file qdockarealayout.cpp.

◆ splitDockWidget()

void QDockAreaLayout::splitDockWidget ( QDockWidget * after,
QDockWidget * dockWidget,
Qt::Orientation orientation )

Definition at line 3263 of file qdockarealayout.cpp.

◆ styleChangedEvent()

void QDockAreaLayout::styleChangedEvent ( )

Definition at line 3524 of file qdockarealayout.cpp.

◆ takeAt()

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

Definition at line 3451 of file qdockarealayout.cpp.

◆ unplug()

QLayoutItem * QDockAreaLayout::unplug ( const QList< int > & path)

Definition at line 2699 of file qdockarealayout.cpp.

Member Data Documentation

◆ centralWidgetItem

QLayoutItem* QDockAreaLayout::centralWidgetItem

Definition at line 205 of file qdockarealayout_p.h.

◆ centralWidgetRect

QRect QDockAreaLayout::centralWidgetRect

Definition at line 207 of file qdockarealayout_p.h.

◆ corners

Qt::DockWidgetArea QDockAreaLayout::corners[4]

Definition at line 203 of file qdockarealayout_p.h.

◆ docks

QDockAreaLayoutInfo QDockAreaLayout::docks[4]

Definition at line 209 of file qdockarealayout_p.h.

◆ fallbackToSizeHints

bool QDockAreaLayout::fallbackToSizeHints

Definition at line 211 of file qdockarealayout_p.h.

◆ mainWindow

QMainWindow* QDockAreaLayout::mainWindow

Definition at line 206 of file qdockarealayout_p.h.

◆ rect

QRect QDockAreaLayout::rect

Definition at line 204 of file qdockarealayout_p.h.

◆ sep

int QDockAreaLayout::sep

Definition at line 210 of file qdockarealayout_p.h.

◆ separatorWidgets

QList<QWidget *> QDockAreaLayout::separatorWidgets
mutable

Definition at line 212 of file qdockarealayout_p.h.


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