The QDesignerFormWindowInterface class allows you to query and manipulate form windows appearing in \QD's workspace. More...

#include <abstractformwindow.h>

Inheritance diagram for QDesignerFormWindowInterface:

Collaboration diagram for QDesignerFormWindowInterface:

Public Types
enum	FeatureFlag { EditFeature = 0x01 , GridFeature = 0x02 , TabOrderFeature = 0x04 , DefaultFeature = EditFeature \| GridFeature }
	This enum describes the features that are available and can be controlled by the form window interface. More...

enum	ResourceFileSaveMode { SaveAllResourceFiles , SaveOnlyUsedResourceFiles , DontSaveResourceFiles }

Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
	This enum describes how to render the widget when calling QWidget::render(). More...

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled , PdmDevicePixelRatioF_EncodedA , PdmDevicePixelRatioF_EncodedB }

Public Slots
virtual void	manageWidget (QWidget *widget)=0
	Instructs the form window to manage the specified widget.

virtual void	unmanageWidget (QWidget *widget)=0
	Instructs the form window not to manage the specified widget.

virtual void	setFeatures (Feature f)=0
	Enables the specified features for the form window.

virtual void	setDirty (bool dirty)=0
	If dirty is true, the form window is marked as dirty, meaning that it is modified but not saved.

virtual void	clearSelection (bool changePropertyDisplay=true)=0
	Clears the current selection in the form window.

virtual void	selectWidget (QWidget *w, bool select=true)=0
	If select is true, the given widget is selected; otherwise the widget is deselected.

virtual void	setGrid (const QPoint &grid)=0
	Sets the grid size for the form window to the point specified by grid.

virtual void	setFileName (const QString &fileName)=0
	Sets the file name for the form to the given fileName.

virtual bool	setContents (const QString &contents)=0
	Sets the contents of the form using data read from the specified contents string and returns whether the operation succeeded.

virtual void	editWidgets ()=0
	Switches the form window into editing mode.

void	activateResourceFilePaths (const QStringList &paths, int errorCount=nullptr, QString errorMessages=nullptr)
	Activates the resource (.qrc) file paths paths, returning the count of errors in errorCount and error message in errorMessages.

Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)
	Disables widget input events if disable is true; otherwise enables input events.

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

void	update ()
	Updates the widget unless updates are disabled or the widget is hidden.

void	repaint ()
	Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)
	Convenience function, equivalent to setVisible(!hidden).

void	show ()
	Shows the widget and its child widgets.

void	hide ()
	Hides the widget.

void	showMinimized ()
	Shows the widget minimized, as an icon.

void	showMaximized ()
	Shows the widget maximized.

void	showFullScreen ()
	Shows the widget in full-screen mode.

void	showNormal ()
	Restores the widget after it has been maximized or minimized.

bool	close ()
	Closes this widget.

void	raise ()
	Raises this widget to the top of the parent widget's stack.

void	lower ()
	Lowers the widget to the bottom of the parent widget's stack.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	mainContainerChanged (QWidget *mainContainer)
	This signal is emitted whenever the main container changes.

void	toolChanged (int toolIndex)
	This signal is emitted whenever the current tool changes.

void	fileNameChanged (const QString &fileName)
	This signal is emitted whenever the file name of the form changes.

void	featureChanged (Feature f)
	This signal is emitted whenever a feature changes in the form.

void	selectionChanged ()
	This signal is emitted whenever the selection in the form changes.

void	geometryChanged ()
	This signal is emitted whenever the form's geometry changes.

void	resourceFilesChanged ()
	This signal is emitted whenever the list of resource files used by the form changes.

void	widgetManaged (QWidget *widget)
	This signal is emitted whenever a widget on the form becomes managed.

void	widgetUnmanaged (QWidget *widget)
	This signal is emitted whenever a widget on the form becomes unmanaged.

void	aboutToUnmanageWidget (QWidget *widget)
	This signal is emitted whenever a widget on the form is about to become unmanaged.

void	activated (QWidget *widget)
	This signal is emitted whenever a widget is activated on the form.

void	changed ()
	This signal is emitted whenever a form is changed.

void	widgetRemoved (QWidget *w)
	This signal is emitted whenever a widget is removed from the form.

void	objectRemoved (QObject *o)
	This signal is emitted whenever an object (such as an action or a QButtonGroup) is removed from the form.

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)
	This signal is emitted when the window's title has changed, with the new title as an argument.

void	windowIconChanged (const QIcon &icon)
	This signal is emitted when the window's icon has changed, with the new icon as an argument.

void	windowIconTextChanged (const QString &iconText)
	This signal is emitted when the window's icon text has changed, with the new iconText as an argument.

void	customContextMenuRequested (const QPoint &pos)
	This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.

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
	QDesignerFormWindowInterface (QWidget *parent=nullptr, Qt::WindowFlags flags={})
	Constructs a form window interface with the given parent and the specified window flags.

virtual	~QDesignerFormWindowInterface ()
	Destroys the form window interface.

virtual QString	fileName () const =0
	Returns the file name of the UI file that describes the form currently being shown.

virtual QDir	absoluteDir () const =0
	Returns the absolute location of the directory containing the form shown in the form window.

virtual QString	contents () const =0
	Returns details of the contents of the form currently being displayed in the window.

virtual QStringList	checkContents () const =0
	Performs checks on the current form and returns a list of richtext warnings about potential issues (for example, top level spacers on unlaid-out forms).

virtual bool	setContents (QIODevice dev, QString errorMessage=nullptr)=0
	Sets the form's contents using data obtained from the given device and returns whether loading succeeded.

virtual Feature	features () const =0
	Returns a combination of the features provided by the form window associated with the interface.

virtual bool	hasFeature (Feature f) const =0
	Returns true if the form window offers the specified feature; otherwise returns false.

virtual QString	author () const =0
	Returns details of the author or creator of the form currently being displayed in the window.

virtual void	setAuthor (const QString &author)=0
	Sets the details for the author or creator of the form to the author specified.

virtual QString	comment () const =0
	Returns comments about the form currently being displayed in the window.

virtual void	setComment (const QString &comment)=0
	Sets the information about the form to the comment specified.

virtual void	layoutDefault (int margin, int spacing)=0
	Fills in the default margin and spacing for the form's default layout in the margin and spacing variables specified.

virtual void	setLayoutDefault (int margin, int spacing)=0
	Sets the default margin and spacing for the form's layout.

virtual void	layoutFunction (QString margin, QString spacing)=0
	Fills in the current margin and spacing for the form's layout in the margin and spacing variables specified.

virtual void	setLayoutFunction (const QString &margin, const QString &spacing)=0
	Sets the margin and spacing for the form's layout.

virtual QString	pixmapFunction () const =0
	Returns the name of the function used to load pixmaps into the form window.

virtual void	setPixmapFunction (const QString &pixmapFunction)=0
	Sets the function used to load pixmaps into the form window to the given pixmapFunction.

virtual QString	exportMacro () const =0
	Returns the export macro associated with the form currently being displayed in the window.

virtual void	setExportMacro (const QString &exportMacro)=0
	Sets the form window's export macro to exportMacro.

virtual QStringList	includeHints () const =0
	Returns a list of the header files that will be included in the form window's associated UI file.

virtual void	setIncludeHints (const QStringList &includeHints)=0
	Sets the header files that will be included in the form window's associated UI file to the specified includeHints.

virtual ResourceFileSaveMode	resourceFileSaveMode () const =0
	Returns the resource file save mode behavior.

virtual void	setResourceFileSaveMode (ResourceFileSaveMode behaviour)=0
	Sets the resource file save mode behavior.

virtual QtResourceSet *	resourceSet () const =0
	Returns the resource set used by the form window interface.

virtual void	setResourceSet (QtResourceSet *resourceSet)=0
	Sets the resource set used by the form window interface to resourceSet.

QStringList	activeResourceFilePaths () const
	Returns the active resource (.qrc) file paths currently loaded in \QD.

virtual QDesignerFormEditorInterface *	core () const
	Returns a pointer to \QD's current QDesignerFormEditorInterface object.

virtual QDesignerFormWindowCursorInterface *	cursor () const =0
	Returns the cursor interface used by the form window.

virtual int	toolCount () const =0
	Returns the number of tools available.

virtual int	currentTool () const =0
	Returns the index of the current tool in use.

virtual void	setCurrentTool (int index)=0
	Sets the current tool to be the one with the given index.

virtual QDesignerFormWindowToolInterface *	tool (int index) const =0
	Returns an interface to the tool with the given index.

virtual void	registerTool (QDesignerFormWindowToolInterface *tool)=0
	Registers the given tool with the form window.

virtual QPoint	grid () const =0
	Returns the grid spacing used by the form window.

virtual QWidget *	mainContainer () const =0
	Returns the main container widget for the form window.

virtual void	setMainContainer (QWidget *mainContainer)=0
	Sets the main container widget on the form to the specified mainContainer.

virtual QWidget *	formContainer () const =0
	Returns the form the widget containing the main container widget.

virtual bool	isManaged (QWidget *widget) const =0
	Returns true if the specified widget is managed by the form window; otherwise returns false.

virtual bool	isDirty () const =0
	Returns true if the form window is "dirty" (modified but not saved); otherwise returns false.

virtual QUndoStack *	commandHistory () const =0
	Returns an object that can be used to obtain the commands used so far in the construction of the form.

virtual void	beginCommand (const QString &description)=0
	Begins execution of a command with the given description.

virtual void	endCommand ()=0
	Ends execution of the current command.

virtual void	simplifySelection (QList< QWidget * > *widgets) const =0
	Simplifies the selection of widgets specified by widgets.

virtual void	emitSelectionChanged ()=0
	Emits the selectionChanged() signal.

virtual QStringList	resourceFiles () const =0
	Returns a list of paths to resource files that are currently being used by the form window.

virtual void	addResourceFile (const QString &path)=0
	Adds the resource file at the given path to those used by the form.

virtual void	removeResourceFile (const QString &path)=0
	Removes the resource file at the specified path from the list of those used by the form.

virtual void	ensureUniqueObjectName (QObject *object)=0
	Ensures that the specified object has a unique name amongst the other objects on the form.

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	Constructs a widget which is a child of parent, with widget flags set to f.

	~QWidget ()
	Destroys the widget.

int	devType () const override

WId	winId () const
	Returns the window system identifier of the widget.

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)
	Sets the widget's GUI style to style.

bool	isWindow () const
	Returns `true` if the widget is an independent window, otherwise returns `false`.

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const
	Returns `true` if this widget would become enabled if ancestor is enabled; otherwise returns `false`.

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).

void	setFixedSize (const QSize &)
	Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.

void	setFixedSize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.

void	setFixedWidth (int w)
	Sets both the minimum and maximum width of the widget to w without changing the heights.

void	setFixedHeight (int h)
	Sets both the minimum and maximum heights of the widget to h without changing the widths.

QPointF	mapToGlobal (const QPointF &) const
	Translates the widget coordinate pos to global screen coordinates.

QPoint	mapToGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromGlobal (const QPointF &) const
	Translates the global screen coordinate pos to widget coordinates.

QPoint	mapFromGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapToParent (const QPointF &) const
	Translates the widget coordinate pos to a coordinate in the parent widget.

QPoint	mapToParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromParent (const QPointF &) const
	Translates the parent widget coordinate pos to widget coordinates.

QPoint	mapFromParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapTo (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos to the coordinate system of parent.

QPoint	mapTo (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFrom (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.

QPoint	mapFrom (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QWidget *	window () const
	Returns the window for this widget, i.e.

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)
	Sets the background role of the widget to role.

QPalette::ColorRole	backgroundRole () const
	Returns the background role of the widget.

void	setForegroundRole (QPalette::ColorRole)
	Sets the foreground role of the widget to role.

QPalette::ColorRole	foregroundRole () const
	Returns the foreground role.

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const
	Returns the font metrics for the widget's current font.

QFontInfo	fontInfo () const
	Returns the font info for the widget's current font.

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const
	Returns `true` if the widget is under the mouse cursor; otherwise returns `false`.

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)
	Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.

void	setMask (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.

QRegion	mask () const
	Returns the mask currently set on a widget.

void	clearMask ()
	Removes any mask set by setMask().

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
	Subscribes the widget to a given gesture with specific flags.

void	ungrabGesture (Qt::GestureType type)
	Unsubscribes the widget from a given gesture type.

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &)
	Sets the window's role to role.

QString	windowRole () const
	Returns the window's role, or an empty string.

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

bool	isRightToLeft () const

bool	isLeftToRight () const

bool	isActiveWindow () const

void	activateWindow ()
	Sets the top-level widget containing this widget to be the active window.

void	clearFocus ()
	Takes keyboard input focus from the widget.

void	setFocus (Qt::FocusReason reason)
	Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)
	Sets the widget's focus proxy to widget w.

QWidget *	focusProxy () const
	Returns the focus proxy, or \nullptr if there is no focus proxy.

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()
	Grabs the mouse input.

void	grabMouse (const QCursor &)

void	releaseMouse ()
	Releases the mouse grab.

void	grabKeyboard ()
	Grabs the keyboard input.

void	releaseKeyboard ()
	Releases the keyboard grab.

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
	Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.

void	releaseShortcut (int id)
	Removes the shortcut with the given id from Qt's shortcut system.

void	setShortcutEnabled (int id, bool enable=true)
	If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.

void	update (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.

void	update (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	repaint (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.

void	repaint (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.

void	repaint (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	stackUnder (QWidget *)
	Places the widget under w in the parent widget's stack.

void	move (int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).

void	move (const QPoint &)

void	resize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()
	Adjusts the size of the widget to fit its contents.

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const
	Returns `true` if this widget would become visible if ancestor is shown; otherwise returns `false`.

bool	isHidden () const
	Returns `true` if the widget is hidden, otherwise returns `false`.

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const
	Returns the current window state.

void	setWindowState (Qt::WindowStates state)
	Sets the window state to windowState.

void	overrideWindowState (Qt::WindowStates state)

virtual QSize	sizeHint () const

virtual QSize	minimumSizeHint () const

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.

virtual int	heightForWidth (int) const
	Returns the preferred height for this widget, given the width w.

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const
	Returns the unobscured region where paint events can occur.

void	setContentsMargins (int left, int top, int right, int bottom)
	Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.

void	setContentsMargins (const QMargins &margins)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins.

QRect	contentsRect () const
	Returns the area inside the widget's margins.

QLayout *	layout () const
	Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.

void	setLayout (QLayout *)
	Sets the layout manager for this widget to layout.

void	updateGeometry ()
	Notifies the layout system that this widget has changed and may need to change geometry.

void	setParent (QWidget *parent)
	Sets the parent of the widget to parent, and resets the window flags.

void	setParent (QWidget *parent, Qt::WindowFlags f)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.

void	scroll (int dx, int dy)
	Scrolls the widget including its children dx pixels to the right and dy downward.

void	scroll (int dx, int dy, const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.

QWidget *	focusWidget () const
	Returns the last child of this widget that setFocus had been called on.

QWidget *	nextInFocusChain () const
	Returns the next widget in this widget's focus chain.

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain.

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)
	Appends the action action to this widget's list of actions.

void	addActions (const QList< QAction * > &actions)
	Appends the actions actions to this widget's list of actions.

void	insertActions (QAction before, const QList< QAction > &actions)
	Inserts the actions actions to this widget's list of actions, before the action before.

void	insertAction (QAction before, QAction action)
	Inserts the action action to this widget's list of actions, before the action before.

void	removeAction (QAction *action)
	Removes the action action from this widget's list of actions.

QList< QAction * >	actions () const
	Returns the (possibly empty) list of this widget's actions.

QAction *	addAction (const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QString &text, Args &&...args)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QIcon &icon, const QString &text, Args &&...args)

QWidget *	parentWidget () const
	Returns the parent of this widget, or \nullptr if it does not have any parent widget.

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const
	Window flags are a combination of a type (e.g.

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)
	Sets the window flags for the widget to flags, without telling the window system.

Qt::WindowType	windowType () const
	Returns the window type of this widget.

QWidget *	childAt (int x, int y) const
	Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.

QWidget *	childAt (const QPoint &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.

QWidget *	childAt (const QPointF &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	setAttribute (Qt::WidgetAttribute, bool on=true)
	Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

bool	testAttribute (Qt::WidgetAttribute) const
	Returns `true` if attribute attribute is set on this widget; otherwise returns `false`.

QPaintEngine *	paintEngine () const override
	Returns the widget's paint engine.

void	ensurePolished () const
	Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

bool	isAncestorOf (const QWidget *child) const
	Returns `true` if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns `false`.

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const
	If this is a native widget, return the associated QWindow.

QScreen *	screen () const
	Returns the screen the widget is on.

void	setScreen (QScreen *)
	Sets the screen on which the widget should be shown to screen.

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const
	This method is only relevant for input widgets.

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

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	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< QString >	bindableObjectName ()

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).

QThread *	thread () 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 >
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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () 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`.

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Static Public Member Functions
static QDesignerFormWindowInterface *	findFormWindow (QWidget *w)
	Returns the form window interface for the given widget.

static QDesignerFormWindowInterface *	findFormWindow (QObject *obj)
	Returns the form window interface for the given object.

Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )
	Puts the second widget after the first widget in the focus order.

static void	setTabOrder (std::initializer_list< QWidget * > widgets)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

static QWidget *	mouseGrabber ()
	Returns the widget that is currently grabbing the mouse input.

static QWidget *	keyboardGrabber ()
	Returns the widget that is currently grabbing the keyboard input.

static QWidget *	find (WId)
	Returns a pointer to the widget with window identifier/handle id.

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Creates a QWidget that makes it possible to embed window into a QWidget-based application.

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)

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

static int	encodeMetricF (PaintDeviceMetric metric, double value)

Additional Inherited Members
Protected Slots inherited from QWidget
void	updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
	Updates the widget's micro focus and informs input methods that the state specified by query has changed.

Protected Member Functions inherited from QWidget
bool	event (QEvent *event) override
	This is the main event handler; it handles event event.

virtual void	mousePressEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget.

virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget.

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.

virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.

virtual void	keyPressEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive key press events for the widget.

virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget.

virtual void	focusInEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget.

virtual void	focusOutEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget.

virtual void	enterEvent (QEnterEvent *event)
	This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.

virtual void	leaveEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.

virtual void	paintEvent (QPaintEvent *event)
	This event handler can be reimplemented in a subclass to receive paint events passed in event.

virtual void	moveEvent (QMoveEvent *event)
	This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.

virtual void	resizeEvent (QResizeEvent *event)
	This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter.

virtual void	closeEvent (QCloseEvent *event)
	This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.

virtual void	contextMenuEvent (QContextMenuEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events.

virtual void	actionEvent (QActionEvent *event)
	This event handler is called with the given event whenever the widget's actions are changed.

virtual void	showEvent (QShowEvent *event)
	This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter.

virtual void	hideEvent (QHideEvent *event)
	This event handler can be reimplemented in a subclass to receive widget hide events.

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)
	This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.

virtual void	changeEvent (QEvent *)
	This event handler can be reimplemented to handle state changes.

int	metric (PaintDeviceMetric) const override
	Internal implementation of the virtual QPaintDevice::metric() function.

void	initPainter (QPainter *painter) const override
	Initializes the painter pen, background and font to the same as the given widget's.

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)
	This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
	Creates a new widget window.

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)
	Frees up window system resources.

virtual bool	focusNextPrevChild (bool next)
	Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusNextChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusPreviousChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () 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 Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

double	getDecodedMetricF (PaintDeviceMetric metricA, PaintDeviceMetric metricB) const

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget

bool	enabled
	whether the widget is enabled

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget

int	x
	the x coordinate of the widget relative to its parent including any window frame

int	y
	the y coordinate of the widget relative to its parent and including any window frame

QPoint	pos
	the position of the widget within its parent widget

QSize	frameSize
	the size of the widget including any window frame

QSize	size
	the size of the widget excluding any window frame

int	width
	the width of the widget excluding any window frame

int	height
	the height of the widget excluding any window frame

QRect	rect
	the internal geometry of the widget excluding any window frame

QRect	childrenRect
	the bounding rectangle of the widget's children

QRegion	childrenRegion
	the combined region occupied by the widget's children

QSizePolicy	sizePolicy
	the default layout behavior of the widget

QSize	minimumSize
	the widget's minimum size

QSize	maximumSize
	the widget's maximum size in pixels

int	minimumWidth
	the widget's minimum width in pixels

int	minimumHeight
	the widget's minimum height in pixels

int	maximumWidth
	the widget's maximum width in pixels

int	maximumHeight
	the widget's maximum height in pixels

QSize	sizeIncrement
	the size increment of the widget

QSize	baseSize
	the base size of the widget

QPalette	palette
	the widget's palette

QFont	font
	the font currently set for the widget

QCursor	cursor
	the cursor shape for this widget

bool	mouseTracking
	whether mouse tracking is enabled for the widget

bool	tabletTracking
	whether tablet tracking is enabled for the widget

bool	isActiveWindow
	whether this widget's window is the active window

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu

bool	updatesEnabled
	whether updates are enabled

bool	visible
	whether the widget is visible

bool	minimized
	whether this widget is minimized (iconified)

bool	maximized
	whether this widget is maximized

bool	fullScreen
	whether the widget is shown in full screen mode

QSize	sizeHint
	the recommended size for the widget

QSize	minimumSizeHint
	the recommended minimum size for the widget

bool	acceptDrops
	whether drop events are enabled for this widget

QString	windowTitle
	the window title (caption)

QIcon	windowIcon
	the widget's icon

QString	windowIconText
	the text to be displayed on the icon of a minimized window

double	windowOpacity
	The level of opacity for the window.

bool	windowModified
	whether the document shown in the window has unsaved changes

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget.

bool	autoFillBackground
	whether the widget background is filled automatically

QString	styleSheet
	the widget's style sheet

QLocale	locale
	the widget's locale

QString	windowFilePath
	the file path associated with a widget

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has.

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QWidget
	setupUi (QWidget *widget)
	\macro QWIDGETSIZE_MAX

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QDesignerFormWindowInterface class allows you to query and manipulate form windows appearing in \QD's workspace.

\inmodule QtDesigner

QDesignerFormWindowInterface provides information about the associated form window as well as allowing its properties to be altered. The interface is not intended to be instantiated directly, but to provide access to \QD's current form windows controlled by \QD's \l {QDesignerFormWindowManagerInterface}{form window manager}.

If you are looking for the form window containing a specific widget, you can use the static QDesignerFormWindowInterface::findFormWindow() function:

But in addition, you can access any of the current form windows through \QD's form window manager: Use the QDesignerFormEditorInterface::formWindowManager() function to retrieve an interface to the manager. Once you have this interface, you have access to all of \QD's current form windows through the QDesignerFormWindowManagerInterface::formWindow() function. For example:

The pointer to \QD's current QDesignerFormEditorInterface object (formEditor in the example above) is provided by the QDesignerCustomWidgetInterface::initialize() function's parameter. When implementing a custom widget plugin, you must subclass the QDesignerCustomWidgetInterface class to expose your plugin to \QD.

Once you have the form window, you can query its properties. For example, a plain custom widget plugin is managed by \QD only at its top level, i.e. none of its child widgets can be resized in \QD's workspace. But QDesignerFormWindowInterface provides you with functions that enables you to control whether a widget should be managed by \QD, or not:

The complete list of functions concerning widget management is: isManaged(), manageWidget() and unmanageWidget(). There is also several associated signals: widgetManaged(), widgetRemoved(), aboutToUnmanageWidget() and widgetUnmanaged().

In addition to controlling the management of widgets, you can control the current selection in the form window using the selectWidget(), clearSelection() and emitSelectionChanged() functions, and the selectionChanged() signal.

You can also retrieve information about where the form is stored using absoluteDir(), its include files using includeHints(), and its layout and pixmap functions using layoutDefault(), layoutFunction() and pixmapFunction(). You can find out whether the form window has been modified (but not saved) or not, using the isDirty() function. You can retrieve its author(), its contents(), its fileName(), associated comment() and exportMacro(), its mainContainer(), its features(), its grid() and its resourceFiles().

The interface provides you with functions and slots allowing you to alter most of this information as well. The exception is the directory storing the form window. Finally, there is several signals associated with changes to the information mentioned above and to the form window in general.

See also: QDesignerFormWindowCursorInterface, QDesignerFormEditorInterface, QDesignerFormWindowManagerInterface

Definition at line 20 of file abstractformwindow.h.

Member Enumeration Documentation

◆ FeatureFlag

enum QDesignerFormWindowInterface::FeatureFlag

This enum describes the features that are available and can be controlled by the form window interface.

These values are used when querying the form window to determine which features it supports:

\value EditFeature Form editing \value GridFeature Grid display and snap-to-grid facilities for editing \value TabOrderFeature Tab order management \value DefaultFeature Support for default features (form editing and grid)

See also: hasFeature(), features()

Enumerator
EditFeature
GridFeature
TabOrderFeature
DefaultFeature

Definition at line 24 of file abstractformwindow.h.

◆ ResourceFileSaveMode

enum QDesignerFormWindowInterface::ResourceFileSaveMode

Since: 5.0

This enum describes how resource files are saved.

\value SaveAllResourceFiles Save all resource files. \value SaveOnlyUsedResourceFiles Save resource files used by form. \value DontSaveResourceFiles Do not save resource files.

Enumerator
SaveAllResourceFiles
SaveOnlyUsedResourceFiles
DontSaveResourceFiles

Definition at line 33 of file abstractformwindow.h.

Constructor & Destructor Documentation

◆ QDesignerFormWindowInterface()

QDesignerFormWindowInterface::QDesignerFormWindowInterface	(	QWidget *	parent = nullptr,
		Qt::WindowFlags	flags = {} )

explicit

Constructs a form window interface with the given parent and the specified window flags.

Definition at line 131 of file abstractformwindow.cpp.

◆ ~QDesignerFormWindowInterface()

QDesignerFormWindowInterface::~QDesignerFormWindowInterface ( )

virtualdefault

Destroys the form window interface.

Member Function Documentation

◆ aboutToUnmanageWidget

void QDesignerFormWindowInterface::aboutToUnmanageWidget ( QWidget * widget )

signal

This signal is emitted whenever a widget on the form is about to become unmanaged.

When this signal is emitted, the specified widget is still managed, and a widgetUnmanaged() signal will follow, indicating when it is no longer managed.

See also: unmanageWidget(), isManaged()

◆ absoluteDir()

virtual QDir QDesignerFormWindowInterface::absoluteDir ( ) const

pure virtual

Returns the absolute location of the directory containing the form shown in the form window.

Implemented in qdesigner_internal::FormWindow.

◆ activated

void QDesignerFormWindowInterface::activated ( QWidget * widget )

signal

This signal is emitted whenever a widget is activated on the form.

The activated widget is specified by widget.

◆ activateResourceFilePaths

void QDesignerFormWindowInterface::activateResourceFilePaths	(	const QStringList &	paths,
		int *	errorCount = nullptr,
		QString *	errorMessages = nullptr )

slot

Activates the resource (.qrc) file paths paths, returning the count of errors in errorCount and error message in errorMessages.

\QD loads the resources using the QResource class, making them available for form editing.

In IDE integrations, a list of the project's resource (.qrc) file can be activated, making them available to \QD.

Since: 5.0

See also: activeResourceFilePaths(); QResource

Definition at line 258 of file abstractformwindow.cpp.

◆ activeResourceFilePaths()

QStringList QDesignerFormWindowInterface::activeResourceFilePaths ( ) const

Returns the active resource (.qrc) file paths currently loaded in \QD.

Since: 5.0

See also: activateResourceFilePaths()

Definition at line 240 of file abstractformwindow.cpp.

◆ addResourceFile()

virtual void QDesignerFormWindowInterface::addResourceFile ( const QString & path )

pure virtual

Adds the resource file at the given path to those used by the form.

See also: resourceFiles(), resourceFilesChanged()

Implemented in qdesigner_internal::FormWindow.

◆ author()

virtual QString QDesignerFormWindowInterface::author ( ) const

pure virtual

Returns details of the author or creator of the form currently being displayed in the window.

Implemented in qdesigner_internal::FormWindow.

◆ beginCommand()

virtual void QDesignerFormWindowInterface::beginCommand ( const QString & description )

pure virtual

Begins execution of a command with the given description.

Commands are executed between beginCommand() and endCommand() function calls to ensure that they are recorded on the undo stack.

See also: endCommand()

Implemented in qdesigner_internal::FormWindow.

◆ changed

void QDesignerFormWindowInterface::changed ( )

signal

This signal is emitted whenever a form is changed.

◆ checkContents()

virtual QStringList QDesignerFormWindowInterface::checkContents ( ) const

pure virtual

Performs checks on the current form and returns a list of richtext warnings about potential issues (for example, top level spacers on unlaid-out forms).

IDE integrations can call this before handling starting a save operation.

Since: 5.0

Implemented in qdesigner_internal::FormWindowBase.

◆ clearSelection

virtual void QDesignerFormWindowInterface::clearSelection ( bool update = true )

pure virtualslot

Clears the current selection in the form window.

If update is true, the emitSelectionChanged() function is called, emitting the selectionChanged() signal.

See also: selectWidget()

Implemented in qdesigner_internal::FormWindow.

◆ commandHistory()

virtual QUndoStack * QDesignerFormWindowInterface::commandHistory ( ) const

pure virtual

Returns an object that can be used to obtain the commands used so far in the construction of the form.

Implemented in qdesigner_internal::FormWindow.

◆ comment()

virtual QString QDesignerFormWindowInterface::comment ( ) const

pure virtual

Returns comments about the form currently being displayed in the window.

Implemented in qdesigner_internal::FormWindow.

◆ contents()

virtual QString QDesignerFormWindowInterface::contents ( ) const

pure virtual

Returns details of the contents of the form currently being displayed in the window.

Implemented in qdesigner_internal::FormWindow.

◆ core()

QDesignerFormEditorInterface * QDesignerFormWindowInterface::core ( ) const

virtual

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

Reimplemented in qdesigner_internal::FormWindow.

Definition at line 145 of file abstractformwindow.cpp.

◆ currentTool()

virtual int QDesignerFormWindowInterface::currentTool ( ) const

pure virtual

Returns the index of the current tool in use.

See also: setCurrentTool()

Implemented in qdesigner_internal::FormWindow.

◆ cursor()

virtual QDesignerFormWindowCursorInterface * QDesignerFormWindowInterface::cursor ( ) const

pure virtual

Returns the cursor interface used by the form window.

Implemented in qdesigner_internal::FormWindow.

◆ editWidgets

virtual void QDesignerFormWindowInterface::editWidgets ( )

pure virtualslot

Switches the form window into editing mode.

See also: {Qt Widgets Designer's Form Editing Mode}

Implemented in qdesigner_internal::FormWindow.

◆ emitSelectionChanged()

virtual void QDesignerFormWindowInterface::emitSelectionChanged ( )

pure virtual

Emits the selectionChanged() signal.

See also: selectWidget(), clearSelection()

Implemented in qdesigner_internal::FormWindow.

◆ endCommand()

virtual void QDesignerFormWindowInterface::endCommand ( )

pure virtual

Ends execution of the current command.

See also: beginCommand()

Implemented in qdesigner_internal::FormWindow.

◆ ensureUniqueObjectName()

virtual void QDesignerFormWindowInterface::ensureUniqueObjectName ( QObject * object )

pure virtual

Ensures that the specified object has a unique name amongst the other objects on the form.

Implemented in qdesigner_internal::FormWindow.

◆ exportMacro()

virtual QString QDesignerFormWindowInterface::exportMacro ( ) const

pure virtual

Returns the export macro associated with the form currently being displayed in the window.

The export macro is used when the form is compiled to create a widget plugin.

See also: {Creating Custom Widgets for Qt Widgets Designer}

Implemented in qdesigner_internal::FormWindow.

◆ featureChanged

void QDesignerFormWindowInterface::featureChanged ( Feature feature )

signal

This signal is emitted whenever a feature changes in the form.

The new feature is specified by feature.

See also: setFeatures()

◆ features()

virtual Feature QDesignerFormWindowInterface::features ( ) const

pure virtual

Returns a combination of the features provided by the form window associated with the interface.

The value returned can be tested against the \l Feature enum values to determine which features are supported by the window.

See also: setFeatures(), hasFeature()

Implemented in qdesigner_internal::FormWindowBase.

Referenced by testing.tools.test_runner._PerProcessConfig::InitializeFeatures().

Here is the caller graph for this function:

◆ fileName()

virtual QString QDesignerFormWindowInterface::fileName ( ) const

pure virtual

Returns the file name of the UI file that describes the form currently being shown.

See also: setFileName()

Implemented in qdesigner_internal::FormWindow.

◆ fileNameChanged

void QDesignerFormWindowInterface::fileNameChanged ( const QString & fileName )

signal

This signal is emitted whenever the file name of the form changes.

The new file name is specified by fileName.

See also: setFileName()

◆ findFormWindow() [1/2]

QDesignerFormWindowInterface * QDesignerFormWindowInterface::findFormWindow ( QObject * object )

static

Returns the form window interface for the given object.

Since: 4.4

Definition at line 196 of file abstractformwindow.cpp.

◆ findFormWindow() [2/2]

QDesignerFormWindowInterface * QDesignerFormWindowInterface::findFormWindow ( QWidget * w )

static

Returns the form window interface for the given widget.

Definition at line 174 of file abstractformwindow.cpp.

◆ formContainer()

virtual QWidget * QDesignerFormWindowInterface::formContainer ( ) const

pure virtual

Returns the form the widget containing the main container widget.

Since: 5.0

Implemented in qdesigner_internal::FormWindow.

◆ geometryChanged

void QDesignerFormWindowInterface::geometryChanged ( )

signal

This signal is emitted whenever the form's geometry changes.

◆ grid()

virtual QPoint QDesignerFormWindowInterface::grid ( ) const

pure virtual

Returns the grid spacing used by the form window.

See also: setGrid()

Implemented in qdesigner_internal::FormWindowBase.

◆ hasFeature()

virtual bool QDesignerFormWindowInterface::hasFeature ( Feature feature ) const

pure virtual

Returns true if the form window offers the specified feature; otherwise returns false.

See also: features()

Implemented in qdesigner_internal::FormWindowBase.

◆ includeHints()

virtual QStringList QDesignerFormWindowInterface::includeHints ( ) const

pure virtual

Returns a list of the header files that will be included in the form window's associated UI file.

Header files may be local, i.e. relative to the project's directory, "mywidget.h", or global, i.e. part of Qt or the compilers standard libraries: <QtGui/QWidget>.

See also: setIncludeHints()

Implemented in qdesigner_internal::FormWindow.

◆ isDirty()

virtual bool QDesignerFormWindowInterface::isDirty ( ) const

pure virtual

Returns true if the form window is "dirty" (modified but not saved); otherwise returns false.

See also: setDirty()

Implemented in qdesigner_internal::FormWindow.

◆ isManaged()

virtual bool QDesignerFormWindowInterface::isManaged ( QWidget * widget ) const

pure virtual

Returns true if the specified widget is managed by the form window; otherwise returns false.

See also: manageWidget()

Implemented in qdesigner_internal::FormWindow.

◆ layoutDefault()

virtual void QDesignerFormWindowInterface::layoutDefault	(	int *	margin,
		int *	spacing )

pure virtual

Fills in the default margin and spacing for the form's default layout in the margin and spacing variables specified.

Implemented in qdesigner_internal::FormWindow.

◆ layoutFunction()

virtual void QDesignerFormWindowInterface::layoutFunction	(	QString *	margin,
		QString *	spacing )

pure virtual

Fills in the current margin and spacing for the form's layout in the margin and spacing variables specified.

Implemented in qdesigner_internal::FormWindow.

◆ mainContainer()

virtual QWidget * QDesignerFormWindowInterface::mainContainer ( ) const

pure virtual

Returns the main container widget for the form window.

See also: setMainContainer()

Implemented in qdesigner_internal::FormWindow.

◆ mainContainerChanged

void QDesignerFormWindowInterface::mainContainerChanged ( QWidget * mainContainer )

signal

This signal is emitted whenever the main container changes.

The new container is specified by mainContainer.

See also: setMainContainer()

◆ manageWidget

virtual void QDesignerFormWindowInterface::manageWidget ( QWidget * widget )

pure virtualslot

Instructs the form window to manage the specified widget.

See also: isManaged(), unmanageWidget(), widgetManaged()

Implemented in qdesigner_internal::FormWindow.

◆ objectRemoved

void QDesignerFormWindowInterface::objectRemoved ( QObject * object )

signal

This signal is emitted whenever an object (such as an action or a QButtonGroup) is removed from the form.

The object that was removed is specified by object.

Since: 4.5

◆ pixmapFunction()

virtual QString QDesignerFormWindowInterface::pixmapFunction ( ) const

pure virtual

Returns the name of the function used to load pixmaps into the form window.

See also: setPixmapFunction()

Implemented in qdesigner_internal::FormWindow.

◆ registerTool()

virtual void QDesignerFormWindowInterface::registerTool ( QDesignerFormWindowToolInterface * tool )

pure virtual

Registers the given tool with the form window.

Implemented in qdesigner_internal::FormWindow.

◆ removeResourceFile()

virtual void QDesignerFormWindowInterface::removeResourceFile ( const QString & path )

pure virtual

Removes the resource file at the specified path from the list of those used by the form.

See also: resourceFiles(), resourceFilesChanged()

Implemented in qdesigner_internal::FormWindow.

◆ resourceFiles()

virtual QStringList QDesignerFormWindowInterface::resourceFiles ( ) const

pure virtual

Returns a list of paths to resource files that are currently being used by the form window.

See also: addResourceFile(), removeResourceFile()

Implemented in qdesigner_internal::FormWindow.

◆ resourceFileSaveMode()

virtual ResourceFileSaveMode QDesignerFormWindowInterface::resourceFileSaveMode ( ) const

pure virtual

Returns the resource file save mode behavior.

See also: setResourceFileSaveMode()

Implemented in qdesigner_internal::FormWindowBase.

◆ resourceFilesChanged

void QDesignerFormWindowInterface::resourceFilesChanged ( )

signal

This signal is emitted whenever the list of resource files used by the form changes.

See also: resourceFiles()

◆ resourceSet()

virtual QtResourceSet * QDesignerFormWindowInterface::resourceSet ( ) const

pure virtual

Returns the resource set used by the form window interface.

Since: 5.0

Implemented in qdesigner_internal::FormWindowBase.

◆ selectionChanged

void QDesignerFormWindowInterface::selectionChanged ( )

signal

This signal is emitted whenever the selection in the form changes.

See also: selectWidget(), clearSelection()

◆ selectWidget

virtual void QDesignerFormWindowInterface::selectWidget	(	QWidget *	widget,
		bool	select = true )

pure virtualslot

If select is true, the given widget is selected; otherwise the widget is deselected.

See also: clearSelection(), selectionChanged()

Implemented in qdesigner_internal::FormWindow.

◆ setAuthor()

virtual void QDesignerFormWindowInterface::setAuthor ( const QString & author )

pure virtual

Sets the details for the author or creator of the form to the author specified.

Implemented in qdesigner_internal::FormWindow.

◆ setComment()

virtual void QDesignerFormWindowInterface::setComment ( const QString & comment )

pure virtual

Sets the information about the form to the comment specified.

This information should be a human-readable comment about the form.

Implemented in qdesigner_internal::FormWindow.

◆ setContents [1/2]

virtual bool QDesignerFormWindowInterface::setContents ( const QString & contents )

pure virtualslot

Sets the contents of the form using data read from the specified contents string and returns whether the operation succeeded.

See also: contents()

Implemented in qdesigner_internal::FormWindow.

◆ setContents() [2/2]

virtual bool QDesignerFormWindowInterface::setContents	(	QIODevice *	device,
		QString *	errorMessage = nullptr )

pure virtual

Sets the form's contents using data obtained from the given device and returns whether loading succeeded.

If it fails, the error message is returned in errorMessage.

Data can be read from QFile objects or any other subclass of QIODevice.

Implemented in qdesigner_internal::FormWindow.

◆ setCurrentTool()

virtual void QDesignerFormWindowInterface::setCurrentTool ( int index )

pure virtual

Sets the current tool to be the one with the given index.

See also: currentTool()

Implemented in qdesigner_internal::FormWindow.

◆ setDirty

virtual void QDesignerFormWindowInterface::setDirty ( bool dirty )

pure virtualslot

If dirty is true, the form window is marked as dirty, meaning that it is modified but not saved.

If dirty is false, the form window is considered to be unmodified.

See also: isDirty()

Implemented in qdesigner_internal::FormWindow.

◆ setExportMacro()

virtual void QDesignerFormWindowInterface::setExportMacro ( const QString & exportMacro )

pure virtual

Sets the form window's export macro to exportMacro.

The export macro is used when building a widget plugin to export the form's interface to other components.

Implemented in qdesigner_internal::FormWindow.

◆ setFeatures

virtual void QDesignerFormWindowInterface::setFeatures ( Feature features )

pure virtualslot

Enables the specified features for the form window.

See also: features(), featureChanged()

Implemented in qdesigner_internal::FormWindowBase.

◆ setFileName

virtual void QDesignerFormWindowInterface::setFileName ( const QString & fileName )

pure virtualslot

Sets the file name for the form to the given fileName.

See also: fileName(), fileNameChanged()

Implemented in qdesigner_internal::FormWindow.

◆ setGrid

virtual void QDesignerFormWindowInterface::setGrid ( const QPoint & grid )

pure virtualslot

Sets the grid size for the form window to the point specified by grid.

In this function, the coordinates in the QPoint are used to specify the dimensions of a rectangle in the grid.

See also: grid()

Implemented in qdesigner_internal::FormWindowBase.

◆ setIncludeHints()

virtual void QDesignerFormWindowInterface::setIncludeHints ( const QStringList & includeHints )

pure virtual

Sets the header files that will be included in the form window's associated UI file to the specified includeHints.

Header files may be local, i.e. relative to the project's directory, "mywidget.h", or global, i.e. part of Qt or the compilers standard libraries: <QtGui/QWidget>.

See also: includeHints()

Implemented in qdesigner_internal::FormWindow.

◆ setLayoutDefault()

virtual void QDesignerFormWindowInterface::setLayoutDefault	(	int	margin,
		int	spacing )

pure virtual

Sets the default margin and spacing for the form's layout.

See also: layoutDefault()

Implemented in qdesigner_internal::FormWindow.

◆ setLayoutFunction()

virtual void QDesignerFormWindowInterface::setLayoutFunction	(	const QString &	margin,
		const QString &	spacing )

pure virtual

Sets the margin and spacing for the form's layout.

The default layout properties will be replaced by the corresponding layout functions when uic generates code for the form, that is, if the functions are specified. This is useful when different environments requires different layouts for the same form.

See also: layoutFunction()

Implemented in qdesigner_internal::FormWindow.

◆ setMainContainer()

virtual void QDesignerFormWindowInterface::setMainContainer ( QWidget * mainContainer )

pure virtual

Sets the main container widget on the form to the specified mainContainer.

See also: mainContainerChanged()

Implemented in qdesigner_internal::FormWindow.

◆ setPixmapFunction()

virtual void QDesignerFormWindowInterface::setPixmapFunction ( const QString & pixmapFunction )

pure virtual

Sets the function used to load pixmaps into the form window to the given pixmapFunction.

See also: pixmapFunction()

Implemented in qdesigner_internal::FormWindow.

◆ setResourceFileSaveMode()

virtual void QDesignerFormWindowInterface::setResourceFileSaveMode ( ResourceFileSaveMode behavior )

pure virtual

Sets the resource file save mode behavior.

See also: resourceFileSaveMode()

Implemented in qdesigner_internal::FormWindowBase.

◆ setResourceSet()

virtual void QDesignerFormWindowInterface::setResourceSet ( QtResourceSet * resourceSet )

pure virtual

Sets the resource set used by the form window interface to resourceSet.

Since: 5.0

Implemented in qdesigner_internal::FormWindowBase.

◆ simplifySelection()

virtual void QDesignerFormWindowInterface::simplifySelection ( QList< QWidget * > * widgets ) const

pure virtual

Simplifies the selection of widgets specified by widgets.

See also: selectionChanged()

Implemented in qdesigner_internal::FormWindow.

◆ tool()

virtual QDesignerFormWindowToolInterface * QDesignerFormWindowInterface::tool ( int index ) const

pure virtual

Returns an interface to the tool with the given index.

Implemented in qdesigner_internal::FormWindow.

◆ toolChanged

void QDesignerFormWindowInterface::toolChanged ( int toolIndex )

signal

This signal is emitted whenever the current tool changes.

The specified toolIndex is the index of the new tool in the list of tools in the widget box.

◆ toolCount()

virtual int QDesignerFormWindowInterface::toolCount ( ) const

pure virtual

Returns the number of tools available.

Implemented in qdesigner_internal::FormWindow.

◆ unmanageWidget

virtual void QDesignerFormWindowInterface::unmanageWidget ( QWidget * widget )

pure virtualslot

Instructs the form window not to manage the specified widget.

See also: aboutToUnmanageWidget(), widgetUnmanaged()

Implemented in qdesigner_internal::FormWindow.

◆ widgetManaged

void QDesignerFormWindowInterface::widgetManaged ( QWidget * widget )

signal

This signal is emitted whenever a widget on the form becomes managed.

The newly managed widget is specified by widget.

See also: manageWidget()

◆ widgetRemoved

void QDesignerFormWindowInterface::widgetRemoved ( QWidget * widget )

signal

This signal is emitted whenever a widget is removed from the form.

The widget that was removed is specified by widget.

◆ widgetUnmanaged

void QDesignerFormWindowInterface::widgetUnmanaged ( QWidget * widget )

signal

This signal is emitted whenever a widget on the form becomes unmanaged.

The newly released widget is specified by widget.

See also: unmanageWidget(), aboutToUnmanageWidget()

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

qttools/src/designer/src/lib/sdk/abstractformwindow.h (a5bb88c896170ec0c719c3a73ce932cb8d5205ca)
qttools/src/designer/src/lib/sdk/abstractformwindow.cpp (bd6cfe6a5637f2fac2ffebefe4e693e57817ae1c)

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FeatureFlag

◆ ResourceFileSaveMode

Constructor & Destructor Documentation

◆ QDesignerFormWindowInterface()

◆ ~QDesignerFormWindowInterface()

Member Function Documentation

◆ aboutToUnmanageWidget

◆ absoluteDir()

◆ activated

◆ activateResourceFilePaths

◆ activeResourceFilePaths()

◆ addResourceFile()

◆ author()

◆ beginCommand()

◆ changed

◆ checkContents()

◆ clearSelection

◆ commandHistory()

◆ comment()

◆ contents()

◆ core()

◆ currentTool()

◆ cursor()

◆ editWidgets

◆ emitSelectionChanged()

◆ endCommand()

◆ ensureUniqueObjectName()

◆ exportMacro()

◆ featureChanged

◆ features()

◆ fileName()

◆ fileNameChanged

◆ findFormWindow() [1/2]

◆ findFormWindow() [2/2]

◆ formContainer()

◆ geometryChanged

◆ grid()

◆ hasFeature()

◆ includeHints()

◆ isDirty()

◆ isManaged()

◆ layoutDefault()

◆ layoutFunction()

◆ mainContainer()

◆ mainContainerChanged

◆ manageWidget

◆ objectRemoved

◆ pixmapFunction()

◆ registerTool()

◆ removeResourceFile()

◆ resourceFiles()

◆ resourceFileSaveMode()

◆ resourceFilesChanged

◆ resourceSet()

◆ selectionChanged

◆ selectWidget

◆ setAuthor()

◆ setComment()

◆ setContents [1/2]

◆ setContents() [2/2]

◆ setCurrentTool()

◆ setDirty

◆ setExportMacro()

◆ setFeatures

◆ setFileName

◆ setGrid

◆ setIncludeHints()

◆ setLayoutDefault()

◆ setLayoutFunction()

◆ setMainContainer()

◆ setPixmapFunction()

◆ setResourceFileSaveMode()