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
qdesigner_internal::Layout Class Referenceabstract

Baseclass for layouting widgets in the Designer (Helper for Layout commands) More...

#include <layout_p.h>

+ Inheritance diagram for qdesigner_internal::Layout:
+ Collaboration diagram for qdesigner_internal::Layout:

Public Member Functions

 ~Layout () override
 
virtual void sort ()=0
 
virtual void doLayout ()=0
 
virtual void setup ()
 The widget list we got in the constructor might contain too much widgets (like widgets with different parents, already laid out widgets, etc.).
 
virtual void undoLayout ()
 
virtual void breakLayout ()
 
const QWidgetListwidgets () const
 
QWidgetparentWidget () const
 
QWidgetlayoutBaseWidget () const
 
bool reparentLayoutWidget () const
 
void setReparentLayoutWidget (bool v)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
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
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Static Public Member Functions

static LayoutcreateLayout (const QWidgetList &widgets, QWidget *parentWidget, QDesignerFormWindowInterface *fw, QWidget *layoutBase, LayoutInfo::Type layoutType)
 
- 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)
 \threadsafe
 
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::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a 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

 Layout (const QWidgetList &wl, QWidget *p, QDesignerFormWindowInterface *fw, QWidget *lb, LayoutInfo::Type layoutType)
 p specifies the parent of the layoutBase lb.
 
virtual void finishLayout (bool needMove, QLayout *layout=nullptr)
 
virtual bool prepareLayout (bool &needMove, bool &needReparent)
 
void setWidgets (const QWidgetList &widgets)
 
QLayoutcreateLayout (int type)
 
void reparentToLayoutBase (QWidget *w)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Baseclass for layouting widgets in the Designer (Helper for Layout commands)

Classes derived from this abstract base class are used for layouting operations in the Designer (creating/breaking layouts).

Instances live in the Layout/BreakLayout commands.

Constructor & Destructor Documentation

◆ Layout()

qdesigner_internal::Layout::Layout ( const QWidgetList & wl,
QWidget * p,
QDesignerFormWindowInterface * fw,
QWidget * lb,
LayoutInfo::Type layoutType )
protected

p specifies the parent of the layoutBase lb.

The parent might be changed in setup(). If the layoutBase is a container, the parent and the layoutBase are the same. Also they always have to be a widget known to the designer (e.g. in the case of the tabwidget parent and layoutBase are the tabwidget and not the page which actually gets laid out. For actual usage the correct widget is found later by Layout.)

Definition at line 86 of file layout.cpp.

◆ ~Layout()

qdesigner_internal::Layout::~Layout ( )
overridedefault

Member Function Documentation

◆ breakLayout()

void qdesigner_internal::Layout::breakLayout ( )
virtual

Definition at line 342 of file layout.cpp.

◆ createLayout() [1/2]

Layout * qdesigner_internal::Layout::createLayout ( const QWidgetList & widgets,
QWidget * parentWidget,
QDesignerFormWindowInterface * fw,
QWidget * layoutBase,
LayoutInfo::Type layoutType )
static

Definition at line 1191 of file layout.cpp.

◆ createLayout() [2/2]

QLayout * qdesigner_internal::Layout::createLayout ( int type)
protected

Definition at line 413 of file layout.cpp.

◆ doLayout()

virtual void qdesigner_internal::Layout::doLayout ( )
pure virtual

◆ finishLayout()

void qdesigner_internal::Layout::finishLayout ( bool needMove,
QLayout * layout = nullptr )
protectedvirtual

Definition at line 235 of file layout.cpp.

◆ layoutBaseWidget()

QWidget * qdesigner_internal::Layout::layoutBaseWidget ( ) const
inline

Definition at line 58 of file layout_p.h.

◆ parentWidget()

QWidget * qdesigner_internal::Layout::parentWidget ( ) const
inline

Definition at line 57 of file layout_p.h.

◆ prepareLayout()

bool qdesigner_internal::Layout::prepareLayout ( bool & needMove,
bool & needReparent )
protectedvirtual

Definition at line 186 of file layout.cpp.

◆ reparentLayoutWidget()

bool qdesigner_internal::Layout::reparentLayoutWidget ( ) const
inline

Definition at line 63 of file layout_p.h.

◆ reparentToLayoutBase()

void qdesigner_internal::Layout::reparentToLayoutBase ( QWidget * w)
protected

Definition at line 431 of file layout.cpp.

◆ setReparentLayoutWidget()

void qdesigner_internal::Layout::setReparentLayoutWidget ( bool v)
inline

Definition at line 64 of file layout_p.h.

◆ setup()

void qdesigner_internal::Layout::setup ( )
virtual

The widget list we got in the constructor might contain too much widgets (like widgets with different parents, already laid out widgets, etc.).

Here we set up the list and so the only the "best" widgets get laid out.

Definition at line 107 of file layout.cpp.

◆ setWidgets()

void qdesigner_internal::Layout::setWidgets ( const QWidgetList & widgets)
inlineprotected

Definition at line 70 of file layout_p.h.

◆ sort()

virtual void qdesigner_internal::Layout::sort ( )
pure virtual

◆ undoLayout()

void qdesigner_internal::Layout::undoLayout ( )
virtual

Definition at line 296 of file layout.cpp.

◆ widgets()

const QWidgetList & qdesigner_internal::Layout::widgets ( ) const
inline

Definition at line 56 of file layout_p.h.


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