QtBase  v6.3.1
Classes | Public Types | Public Member Functions | List of all members
BorderLayout Class Reference

#include <borderlayout.h>

Inheritance diagram for BorderLayout:
Inheritance graph
[legend]
Collaboration diagram for BorderLayout:
Collaboration graph
[legend]

Public Types

enum  Position {
  West , North , South , East ,
  Center
}
 
- Public Types inherited from QLayout
enum  SizeConstraint {
  SetDefaultConstraint , SetNoConstraint , SetMinimumSize , SetFixedSize ,
  SetMaximumSize , SetMinAndMaxSize
}
 

Public Member Functions

 BorderLayout (QWidget *parent, const QMargins &margins=QMargins(), int spacing=-1)
 
 BorderLayout (int spacing=-1)
 
 ~BorderLayout ()
 
void addItem (QLayoutItem *item) override
 
void addWidget (QWidget *widget, Position position)
 
Qt::Orientations expandingDirections () const override
 
bool hasHeightForWidth () const override
 
int count () const override
 
QLayoutItemitemAt (int index) const override
 
QSize minimumSize () const override
 
void setGeometry (const QRect &rect) override
 
QSize sizeHint () const override
 
QLayoutItemtakeAt (int index) override
 
void add (QLayoutItem *item, Position position)
 
- Public Member Functions inherited from QLayout
 QLayout (QWidget *parent=nullptr)
 
 ~QLayout ()
 
virtual int spacing () const
 
virtual void setSpacing (int)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContentsMargins (const QMargins &margins)
 
void unsetContentsMargins ()
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 
QMargins contentsMargins () const
 
QRect contentsRect () const
 
bool setAlignment (QWidget *w, Qt::Alignment alignment)
 
bool setAlignment (QLayout *l, Qt::Alignment alignment)
 
void setSizeConstraint (SizeConstraint)
 
SizeConstraint sizeConstraint () const
 
void setMenuBar (QWidget *w)
 
QWidgetmenuBar () const
 
QWidgetparentWidget () const
 
void invalidate () override
 
QRect geometry () const override
 
bool activate ()
 
void update ()
 
void addWidget (QWidget *w)
 
void removeWidget (QWidget *w)
 
void removeItem (QLayoutItem *)
 
Qt::Orientations expandingDirections () const override
 
QSize minimumSize () const override
 
QSize maximumSize () const override
 
virtual int indexOf (const QWidget *) const
 
virtual int indexOf (const QLayoutItem *) const
 
bool isEmpty () const override
 
QSizePolicy::ControlTypes controlTypes () const override
 
virtual QLayoutItemreplaceWidget (QWidget *from, QWidget *to, Qt::FindChildOptions options=Qt::FindChildrenRecursively)
 
int totalMinimumHeightForWidth (int w) const
 
int totalHeightForWidth (int w) const
 
QSize totalMinimumSize () const
 
QSize totalMaximumSize () const
 
QSize totalSizeHint () const
 
QLayoutlayout () override
 
void setEnabled (bool)
 
bool isEnabled () const
 
void setAlignment (Qt::Alignment a)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 
virtual ~QObject ()
 
virtual bool event (QEvent *event)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const
 
void setObjectName (const QString &name)
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 
bool isWindowType () const
 
bool signalsBlocked () const noexcept
 
bool blockSignals (bool b) noexcept
 
QThreadthread () const
 
void moveToThread (QThread *thread)
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 
template<typename T >
T findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<typename T >
QList< TfindChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<typename T >
QList< TfindChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
const QObjectListchildren () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 
void dumpObjectInfo () const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 
bool inherits (const char *classname) const
 
- Public Member Functions inherited from QLayoutItem
 QLayoutItem (Qt::Alignment alignment=Qt::Alignment())
 
virtual ~QLayoutItem ()
 
virtual int heightForWidth (int) const
 
virtual int minimumHeightForWidth (int) const
 
virtual QWidgetwidget () const
 
virtual QSpacerItemspacerItem ()
 
Qt::Alignment alignment () const
 
void setAlignment (Qt::Alignment a)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 
- Static Public Member Functions inherited from QLayout
static QSize closestAcceptableSize (const QWidget *w, const QSize &s)
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
 
static QMetaObject::Connection ::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
 
static QMetaObject::Connection ::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
 
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QLayout
void widgetEvent (QEvent *)
 
void childEvent (QChildEvent *e) override
 
void addChildLayout (QLayout *l)
 
void addChildWidget (QWidget *w)
 
bool adoptLayout (QLayout *layout)
 
QRect alignmentRect (const QRect &) const
 
 QLayout (QLayoutPrivate &d, QLayout *, QWidget *)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Attributes inherited from QLayoutItem
Qt::Alignment align
 
- Properties inherited from QLayout
int spacing
 the spacing between widgets inside the layout More...
 
QMargins contentsMargins
 
SizeConstraint sizeConstraint
 the resize mode of the layout More...
 
- Properties inherited from QObject
QString objectName
 the name of this object More...
 

Detailed Description

Definition at line 57 of file borderlayout.h.

Member Enumeration Documentation

◆ Position

Enumerator
West 
North 
South 
East 
Center 

Definition at line 60 of file borderlayout.h.

Constructor & Destructor Documentation

◆ BorderLayout() [1/2]

BorderLayout::BorderLayout ( QWidget parent,
const QMargins margins = QMargins(),
int  spacing = -1 
)
explicit

Definition at line 53 of file borderlayout.cpp.

Here is the call graph for this function:

◆ BorderLayout() [2/2]

BorderLayout::BorderLayout ( int  spacing = -1)

Definition at line 60 of file borderlayout.cpp.

Here is the call graph for this function:

◆ ~BorderLayout()

BorderLayout::~BorderLayout ( )

Definition at line 66 of file borderlayout.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ add()

void BorderLayout::add ( QLayoutItem item,
Position  position 
)

Definition at line 192 of file borderlayout.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addItem()

void BorderLayout::addItem ( QLayoutItem item)
overridevirtual

Implemented in subclasses to add an item. How it is added is specific to each subclass.

This function is not usually called in application code. To add a widget to a layout, use the addWidget() function; to add a child layout, use the addLayout() function provided by the relevant QLayout subclass.

{Note:} The ownership of item is transferred to the layout, and it's the layout's responsibility to delete it.

See also
addWidget(), QBoxLayout::addLayout(), QGridLayout::addLayout()

Implements QLayout.

Definition at line 73 of file borderlayout.cpp.

Here is the call graph for this function:

◆ addWidget()

void BorderLayout::addWidget ( QWidget widget,
Position  position 
)

Definition at line 78 of file borderlayout.cpp.

Here is the call graph for this function:

◆ count()

int BorderLayout::count ( ) const
overridevirtual

Must be implemented in subclasses to return the number of items in the layout.

See also
itemAt()

Implements QLayout.

Definition at line 93 of file borderlayout.cpp.

Here is the call graph for this function:

◆ expandingDirections()

Qt::Orientations BorderLayout::expandingDirections ( ) const
overridevirtual

Returns whether this layout item can make use of more space than sizeHint(). A value of Qt::Vertical or Qt::Horizontal means that it wants to grow in only one dimension, whereas Qt::Vertical | Qt::Horizontal means that it wants to grow in both dimensions.

Implements QLayoutItem.

Definition at line 83 of file borderlayout.cpp.

◆ hasHeightForWidth()

bool BorderLayout::hasHeightForWidth ( ) const
overridevirtual

Returns true if this layout's preferred height depends on its width; otherwise returns false. The default implementation returns false.

Reimplement this function in layout managers that support height for width.

See also
heightForWidth(), QWidget::heightForWidth()

Reimplemented from QLayoutItem.

Definition at line 88 of file borderlayout.cpp.

◆ itemAt()

QLayoutItem * BorderLayout::itemAt ( int  index) const
overridevirtual

Must be implemented in subclasses to return the layout item at index. If there is no such item, the function must return \nullptr. Items are numbered consecutively from 0. If an item is deleted, other items will be renumbered.

This function can be used to iterate over a layout. The following code will draw a rectangle for each layout item in the layout structure of the widget.

See also
count(), takeAt()

Implements QLayout.

Definition at line 98 of file borderlayout.cpp.

Here is the call graph for this function:

◆ minimumSize()

QSize BorderLayout::minimumSize ( ) const
overridevirtual

Implemented in subclasses to return the minimum size of this item.

Implements QLayoutItem.

Definition at line 104 of file borderlayout.cpp.

◆ setGeometry()

void BorderLayout::setGeometry ( const QRect r)
overridevirtual

\reimp

Reimplemented from QLayout.

Definition at line 109 of file borderlayout.cpp.

Here is the call graph for this function:

◆ sizeHint()

QSize BorderLayout::sizeHint ( ) const
overridevirtual

Implemented in subclasses to return the preferred size of this item.

Implements QLayoutItem.

Definition at line 178 of file borderlayout.cpp.

◆ takeAt()

QLayoutItem * BorderLayout::takeAt ( int  index)
overridevirtual

Must be implemented in subclasses to remove the layout item at index from the layout, and return the item. If there is no such item, the function must do nothing and return 0. Items are numbered consecutively from 0. If an item is removed, other items will be renumbered.

The following code fragment shows a safe way to remove all items from a layout:

See also
itemAt(), count()

Implements QLayout.

Definition at line 183 of file borderlayout.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

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