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::FormWindowManager Class Reference

#include <formwindowmanager.h>

+ Inheritance diagram for qdesigner_internal::FormWindowManager:
+ Collaboration diagram for qdesigner_internal::FormWindowManager:

Public Slots

void addFormWindow (QDesignerFormWindowInterface *formWindow) override
 
void removeFormWindow (QDesignerFormWindowInterface *formWindow) override
 
void setActiveFormWindow (QDesignerFormWindowInterface *formWindow) override
 
void closeAllPreviews () override
 
void deviceProfilesChanged ()
 
- Public Slots inherited from QDesignerFormWindowManagerInterface
virtual void addFormWindow (QDesignerFormWindowInterface *formWindow)=0
 Adds the given formWindow to the collection of windows that \QD's form window manager maintains.
 
virtual void removeFormWindow (QDesignerFormWindowInterface *formWindow)=0
 Removes the given formWindow from the collection of windows that \QD's form window manager maintains.
 
virtual void setActiveFormWindow (QDesignerFormWindowInterface *formWindow)=0
 Sets the given formWindow to be the currently active form window in \QD's workspace.
 
virtual void showPreview ()=0
 Show a preview of the current form using the default parameters.
 
virtual void closeAllPreviews ()=0
 Close all currently open previews.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Public Member Functions

 FormWindowManager (QDesignerFormEditorInterface *core, QObject *parent=nullptr)
 
 ~FormWindowManager () override
 
QDesignerFormEditorInterfacecore () const override
 Returns a pointer to \QD's current QDesignerFormEditorInterface object.
 
QActionaction (Action action) const override
 Returns the action specified by the enumeration value action.
 
QActionGroupactionGroup (ActionGroup actionGroup) const override
 Returns the action group specified by the enumeration value actionGroup.
 
QDesignerFormWindowInterfaceactiveFormWindow () const override
 Returns the currently active form window in \QD's workspace.
 
int formWindowCount () const override
 Returns the number of form windows maintained by \QD's form window manager.
 
QDesignerFormWindowInterfaceformWindow (int index) const override
 Returns the form window at the given index.
 
QDesignerFormWindowInterfacecreateFormWindow (QWidget *parentWidget=nullptr, Qt::WindowFlags flags={}) override
 Creates a form window with the given parent and the given window flags.
 
QPixmap createPreviewPixmap () const override
 Creates a pixmap representing the preview of the currently active form.
 
bool eventFilter (QObject *o, QEvent *e) override
 Filters events if this object has been installed as an event filter for the watched object.
 
void dragItems (const QList< QDesignerDnDItemInterface * > &item_list) override
 
QUndoGroupundoGroup () const
 
PreviewManagerpreviewManager () const override
 Accesses the previewmanager implementation.
 
- Public Member Functions inherited from qdesigner_internal::QDesignerFormWindowManager
 QDesignerFormWindowManager (QObject *parent=nullptr)
 
 ~QDesignerFormWindowManager () override
 
void showPluginDialog () override
 Opens a dialog showing the plugins loaded by \QD's and its plugin load failures.
 
- Public Member Functions inherited from QDesignerFormWindowManagerInterface
 QDesignerFormWindowManagerInterface (QObject *parent=nullptr)
 Constructs an interface with the given parent for the form window manager.
 
virtual ~QDesignerFormWindowManagerInterface ()
 Destroys the interface for the form window manager.
 
QActionactionDelete () const
 Allows you to intervene and control \QD's "cut" action.
 
QActionactionSelectAll () const
 Allows you to intervene and control \QD's "select all" action.
 
QActionactionLower () const
 Allows you to intervene and control the action of lowering a form window in \QD's workspace.
 
QActionactionRaise () const
 Allows you to intervene and control the action of raising of a form window in \QD's workspace.
 
QActionactionUndo () const
 Allows you to intervene and control \QD's "undo" action.
 
QActionactionRedo () const
 Allows you to intervene and control \QD's "redo" action.
 
QActionactionHorizontalLayout () const
 Allows you to intervene and control a request for horizontal layout for a form window in \QD's workspace.
 
QActionactionVerticalLayout () const
 Allows you to intervene and control a request for vertical layout for a form window in \QD's workspace.
 
QActionactionSplitHorizontal () const
 Allows you to intervene and control \QD's "split horizontal" action.
 
QActionactionSplitVertical () const
 Allows you to intervene and control \QD's "split vertical" action.
 
QActionactionGridLayout () const
 Allows you to intervene and control a request for grid layout for a form window in \QD's workspace.
 
QActionactionFormLayout () const
 Allows you to intervene and control \QD's "form layout" action.
 
QActionactionBreakLayout () const
 Allows you to intervene and control \QD's "break layout" action.
 
QActionactionAdjustSize () const
 Allows you to intervene and control \QD's "adjust size" action.
 
QActionactionSimplifyLayout () const
 Allows you to intervene and control \QD's "simplify layout" action.
 
- 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.
 
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.
 

Private Slots

void showPreview () override
 

Additional Inherited Members

- Public Types inherited from QDesignerFormWindowManagerInterface
enum  Action {
  DeleteAction = 103 , SelectAllAction , LowerAction = 200 , RaiseAction ,
  UndoAction = 300 , RedoAction , HorizontalLayoutAction = 400 , VerticalLayoutAction ,
  SplitHorizontalAction , SplitVerticalAction , GridLayoutAction , FormLayoutAction ,
  BreakLayoutAction , AdjustSizeAction , SimplifyLayoutAction , DefaultPreviewAction = 500 ,
  FormWindowSettingsDialogAction = 600
}
 Specifies an action of \QD. More...
 
enum  ActionGroup { StyledPreviewActionGroup = 100 }
 Specifies an action group of \QD. More...
 
- Signals inherited from QDesignerFormWindowManagerInterface
void formWindowAdded (QDesignerFormWindowInterface *formWindow)
 This signal is emitted when a new form window is added to the collection of windows that \QD's form window manager maintains.
 
void formWindowRemoved (QDesignerFormWindowInterface *formWindow)
 This signal is emitted when a form window is removed from the collection of windows that \QD's form window manager maintains.
 
void activeFormWindowChanged (QDesignerFormWindowInterface *formWindow)
 This signal is emitted when the contents of the currently active form window in \QD's workspace changed.
 
void formWindowSettingsChanged (QDesignerFormWindowInterface *fw)
 This signal is emitted when the settings of the form window change.
 
- 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.
 
- 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 31 of file formwindowmanager.h.

Constructor & Destructor Documentation

◆ FormWindowManager()

qdesigner_internal::FormWindowManager::FormWindowManager ( QDesignerFormEditorInterface * core,
QObject * parent = nullptr )
explicit

Definition at line 79 of file formwindowmanager.cpp.

◆ ~FormWindowManager()

qdesigner_internal::FormWindowManager::~FormWindowManager ( )
override

Definition at line 93 of file formwindowmanager.cpp.

Member Function Documentation

◆ action()

QAction * qdesigner_internal::FormWindowManager::action ( Action action) const
overridevirtual

Returns the action specified by the enumeration value action.

Obsoletes the action accessors of Qt 4.X.

Since
5.0

Implements QDesignerFormWindowManagerInterface.

Definition at line 981 of file formwindowmanager.cpp.

◆ actionGroup()

QActionGroup * qdesigner_internal::FormWindowManager::actionGroup ( ActionGroup actionGroup) const
overridevirtual

Returns the action group specified by the enumeration value actionGroup.

Since
5.0

Implements QDesignerFormWindowManagerInterface.

Definition at line 1031 of file formwindowmanager.cpp.

◆ activeFormWindow()

QDesignerFormWindowInterface * qdesigner_internal::FormWindowManager::activeFormWindow ( ) const
overridevirtual

Returns the currently active form window in \QD's workspace.

See also
setActiveFormWindow(), removeFormWindow()

Implements QDesignerFormWindowManagerInterface.

Definition at line 103 of file formwindowmanager.cpp.

◆ addFormWindow

void qdesigner_internal::FormWindowManager::addFormWindow ( QDesignerFormWindowInterface * formWindow)
overrideslot

Definition at line 236 of file formwindowmanager.cpp.

◆ closeAllPreviews

void qdesigner_internal::FormWindowManager::closeAllPreviews ( )
overrideslot

Definition at line 327 of file formwindowmanager.cpp.

◆ core()

QDesignerFormEditorInterface * qdesigner_internal::FormWindowManager::core ( ) const
overridevirtual

Returns a pointer to \QD's current QDesignerFormEditorInterface object.

Implements QDesignerFormWindowManagerInterface.

Definition at line 98 of file formwindowmanager.cpp.

Referenced by createFormWindow().

+ Here is the caller graph for this function:

◆ createFormWindow()

QDesignerFormWindowInterface * qdesigner_internal::FormWindowManager::createFormWindow ( QWidget * parent = nullptr,
Qt::WindowFlags flags = {} )
overridevirtual

Creates a form window with the given parent and the given window flags.

See also
addFormWindow()

Implements QDesignerFormWindowManagerInterface.

Definition at line 914 of file formwindowmanager.cpp.

References core().

+ Here is the call graph for this function:

◆ createPreviewPixmap()

QPixmap qdesigner_internal::FormWindowManager::createPreviewPixmap ( ) const
overridevirtual

Creates a pixmap representing the preview of the currently active form.

Implements QDesignerFormWindowManagerInterface.

Definition at line 922 of file formwindowmanager.cpp.

◆ deviceProfilesChanged

void qdesigner_internal::FormWindowManager::deviceProfilesChanged ( )
slot

Definition at line 934 of file formwindowmanager.cpp.

◆ dragItems()

void qdesigner_internal::FormWindowManager::dragItems ( const QList< QDesignerDnDItemInterface * > & item_list)
overridevirtual

Implements QDesignerFormWindowManagerInterface.

Definition at line 942 of file formwindowmanager.cpp.

◆ eventFilter()

bool qdesigner_internal::FormWindowManager::eventFilter ( QObject * watched,
QEvent * event )
overridevirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
protected:
bool eventFilter(QObject *obj, QEvent *ev) override;
private:
QTextEdit *textEdit;
};
{
textEdit = new QTextEdit;
setCentralWidget(textEdit);
textEdit->installEventFilter(this);
}
{
if (obj == textEdit) {
if (event->type() == QEvent::KeyPress) {
QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
qDebug() << "Ate key press" << keyEvent->key();
return true;
} else {
return false;
}
} else {
// pass the event on to the parent class
}
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning
If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also
installEventFilter()

Reimplemented from QObject.

Definition at line 118 of file formwindowmanager.cpp.

References qdesigner_internal::FormWindow::findFormWindow(), QPainter::QWidget, and qdesigner_internal::FormWindow::repaintSelection().

+ Here is the call graph for this function:

◆ formWindow()

QDesignerFormWindowInterface * qdesigner_internal::FormWindowManager::formWindow ( int index) const
overridevirtual

Returns the form window at the given index.

See also
setActiveFormWindow(), removeFormWindow()

Implements QDesignerFormWindowManagerInterface.

Definition at line 113 of file formwindowmanager.cpp.

◆ formWindowCount()

int qdesigner_internal::FormWindowManager::formWindowCount ( ) const
overridevirtual

Returns the number of form windows maintained by \QD's form window manager.

Implements QDesignerFormWindowManagerInterface.

Definition at line 108 of file formwindowmanager.cpp.

◆ previewManager()

PreviewManager * qdesigner_internal::FormWindowManager::previewManager ( ) const
inlineoverridevirtual

Accesses the previewmanager implementation.

Since
4.5

Implements qdesigner_internal::QDesignerFormWindowManager.

Definition at line 59 of file formwindowmanager.h.

◆ removeFormWindow

void qdesigner_internal::FormWindowManager::removeFormWindow ( QDesignerFormWindowInterface * formWindow)
overrideslot

Definition at line 261 of file formwindowmanager.cpp.

◆ setActiveFormWindow

void qdesigner_internal::FormWindowManager::setActiveFormWindow ( QDesignerFormWindowInterface * formWindow)
overrideslot

Definition at line 282 of file formwindowmanager.cpp.

References qdesigner_internal::FormWindow::emitSelectionChanged(), QPainter::QWidget, and qdesigner_internal::FormWindow::repaintSelection().

+ Here is the call graph for this function:

◆ undoGroup()

QUndoGroup * qdesigner_internal::FormWindowManager::undoGroup ( ) const

Definition at line 947 of file formwindowmanager.cpp.


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