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

#include <qdesigner_workbench.h>

+ Inheritance diagram for QDesignerWorkbench:
+ Collaboration diagram for QDesignerWorkbench:

Public Slots

void addFormWindow (QDesignerFormWindow *formWindow)
 
void removeFormWindow (QDesignerFormWindow *formWindow)
 
void bringAllToFront ()
 
void toggleFormMinimizationState ()
 
void showNewForm ()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void modeChanged (UIMode mode)
 
void initialized ()
 
- 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.
 

Public Member Functions

 QDesignerWorkbench (const QStringList &pluginPaths)
 
 ~QDesignerWorkbench () override
 
UIMode mode () const
 
QDesignerFormEditorInterfacecore () const
 
QDesignerFormWindowfindFormWindow (QWidget *widget) const
 
QDesignerFormWindowopenForm (const QString &fileName, QString *errorMessage)
 
QDesignerFormWindowopenTemplate (const QString &templateFileName, const QString &editorFileName, QString *errorMessage)
 
int toolWindowCount () const
 
QDesignerToolWindowtoolWindow (int index) const
 
int formWindowCount () const
 
QDesignerFormWindowformWindow (int index) const
 
QDesignerActionsactionManager () const
 
QActionGroupmodeActionGroup () const
 
bool readInForm (const QString &fileName) const
 
bool writeOutForm (QDesignerFormWindowInterface *formWindow, const QString &fileName) const
 
bool saveForm (QDesignerFormWindowInterface *fw)
 
bool handleClose ()
 
bool readInBackup ()
 
void updateBackup (QDesignerFormWindowInterface *fwi)
 
void applyUiSettings ()
 
bool suppressNewFormShow () const
 
void setSuppressNewFormShow (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.
 

Additional Inherited Members

- 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 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)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 40 of file qdesigner_workbench.h.

Constructor & Destructor Documentation

◆ QDesignerWorkbench()

QDesignerWorkbench::QDesignerWorkbench ( const QStringList & pluginPaths)
explicit

◆ ~QDesignerWorkbench()

QDesignerWorkbench::~QDesignerWorkbench ( )
override

Definition at line 227 of file qdesigner_workbench.cpp.

References TopLevelMode.

Member Function Documentation

◆ actionManager()

QDesignerActions * QDesignerWorkbench::actionManager ( ) const

Definition at line 735 of file qdesigner_workbench.cpp.

Referenced by DockedMainWindow::DockedMainWindow().

+ Here is the caller graph for this function:

◆ addFormWindow

void QDesignerWorkbench::addFormWindow ( QDesignerFormWindow * formWindow)
slot

Definition at line 271 of file qdesigner_workbench.cpp.

References QDesignerFormWindow::action(), QDesignerActions::editWidgets(), QDesignerActions::minimizeAction(), and QDesignerActions::setWindowListSeparatorVisible().

+ Here is the call graph for this function:

◆ applyUiSettings()

void QDesignerWorkbench::applyUiSettings ( )

Definition at line 1043 of file qdesigner_workbench.cpp.

◆ bringAllToFront

void QDesignerWorkbench::bringAllToFront ( )
slot

Definition at line 833 of file qdesigner_workbench.cpp.

References TopLevelMode.

◆ core()

QDesignerFormEditorInterface * QDesignerWorkbench::core ( ) const

Definition at line 536 of file qdesigner_workbench.cpp.

Referenced by NewForm::NewForm(), QDesignerActions::QDesignerActions(), QDesignerFormWindow::QDesignerFormWindow(), NewForm::~NewForm(), QDesigner::parseCommandLineArguments(), and toggleFormMinimizationState().

+ Here is the caller graph for this function:

◆ findFormWindow()

QDesignerFormWindow * QDesignerWorkbench::findFormWindow ( QWidget * widget) const

Definition at line 670 of file qdesigner_workbench.cpp.

◆ formWindow()

QDesignerFormWindow * QDesignerWorkbench::formWindow ( int index) const

Definition at line 556 of file qdesigner_workbench.cpp.

◆ formWindowCount()

int QDesignerWorkbench::formWindowCount ( ) const

Definition at line 551 of file qdesigner_workbench.cpp.

Referenced by QDesigner::parseCommandLineArguments().

+ Here is the caller graph for this function:

◆ handleClose()

bool QDesignerWorkbench::handleClose ( )

Definition at line 680 of file qdesigner_workbench.cpp.

Referenced by QDesigner::event().

+ Here is the caller graph for this function:

◆ initialized

void QDesignerWorkbench::initialized ( )
signal

◆ mode()

UIMode QDesignerWorkbench::mode ( ) const

Definition at line 266 of file qdesigner_workbench.cpp.

◆ modeActionGroup()

QActionGroup * QDesignerWorkbench::modeActionGroup ( ) const

◆ modeChanged

void QDesignerWorkbench::modeChanged ( UIMode mode)
signal

◆ openForm()

QDesignerFormWindow * QDesignerWorkbench::openForm ( const QString & fileName,
QString * errorMessage )

Definition at line 957 of file qdesigner_workbench.cpp.

References QDesignerFormWindow::editor(), and QDesignerFormWindow::firstShow().

+ Here is the call graph for this function:

◆ openTemplate()

QDesignerFormWindow * QDesignerWorkbench::openTemplate ( const QString & templateFileName,
const QString & editorFileName,
QString * errorMessage )

Definition at line 967 of file qdesigner_workbench.cpp.

References QDesignerFormWindow::editor(), and QDesignerFormWindow::firstShow().

+ Here is the call graph for this function:

◆ readInBackup()

bool QDesignerWorkbench::readInBackup ( )

Definition at line 787 of file qdesigner_workbench.cpp.

References QDesignerActions::readInForm().

Referenced by QDesigner::parseCommandLineArguments().

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

◆ readInForm()

bool QDesignerWorkbench::readInForm ( const QString & fileName) const

Definition at line 655 of file qdesigner_workbench.cpp.

References QDesignerActions::readInForm().

+ Here is the call graph for this function:

◆ removeFormWindow

void QDesignerWorkbench::removeFormWindow ( QDesignerFormWindow * formWindow)
slot

Definition at line 582 of file qdesigner_workbench.cpp.

References QDesignerFormWindow::action(), QDesignerFormWindow::editor(), QDesignerActions::setWindowListSeparatorVisible(), showNewForm(), and updateBackup().

Referenced by QDesignerFormWindow::~QDesignerFormWindow().

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

◆ saveForm()

bool QDesignerWorkbench::saveForm ( QDesignerFormWindowInterface * fw)

Definition at line 665 of file qdesigner_workbench.cpp.

References QDesignerActions::saveForm().

+ Here is the call graph for this function:

◆ setSuppressNewFormShow()

void QDesignerWorkbench::setSuppressNewFormShow ( bool v)
inline

Definition at line 77 of file qdesigner_workbench.h.

◆ showNewForm

void QDesignerWorkbench::showNewForm ( )
slot

Definition at line 606 of file qdesigner_workbench.cpp.

Referenced by QDesigner::parseCommandLineArguments(), and removeFormWindow().

+ Here is the caller graph for this function:

◆ suppressNewFormShow()

bool QDesignerWorkbench::suppressNewFormShow ( ) const
inline

Definition at line 76 of file qdesigner_workbench.h.

◆ toggleFormMinimizationState

void QDesignerWorkbench::toggleFormMinimizationState ( )
slot

Definition at line 988 of file qdesigner_workbench.cpp.

References core(), and NeutralMode.

+ Here is the call graph for this function:

◆ toolWindow()

QDesignerToolWindow * QDesignerWorkbench::toolWindow ( int index) const

Definition at line 546 of file qdesigner_workbench.cpp.

◆ toolWindowCount()

int QDesignerWorkbench::toolWindowCount ( ) const

Definition at line 541 of file qdesigner_workbench.cpp.

◆ updateBackup()

void QDesignerWorkbench::updateBackup ( QDesignerFormWindowInterface * fwi)

Definition at line 813 of file qdesigner_workbench.cpp.

References QDesignerSettings::QDesignerSettings().

Referenced by removeFormWindow(), and QDesignerActions::writeOutForm().

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

◆ writeOutForm()

bool QDesignerWorkbench::writeOutForm ( QDesignerFormWindowInterface * formWindow,
const QString & fileName ) const

Definition at line 660 of file qdesigner_workbench.cpp.

References QDesignerActions::writeOutForm().

+ Here is the call graph for this function:

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