|  | Home · All Classes · Main Classes · Annotated · Grouped Classes · Functions |

# QDesignerFormWindowInterface Class Reference

The QDesignerFormWindowInterface class provides an interface that is used to control form windows provided by Qt Designer's form editing component. More...

    #include <QDesignerFormWindowInterface>

Part of the QtDesigner module.

Inherits QWidget.

- List of all members, including inherited members

### Public Types

- flags Feature
- enum FeatureFlag { EditFeature, GridFeature, TabOrderFeature, DefaultFeature }

### Public Functions

- QDesignerFormWindowInterface ( QWidget * parent = 0, Qt::WindowFlags flags = 0 )
- virtual ~QDesignerFormWindowInterface ()
- virtual QDir absoluteDir () const = 0
- virtual void addResourceFile ( const QString & path ) = 0
- virtual QString author () const = 0
- virtual void beginCommand ( const QString & description ) = 0
- virtual QtUndoStack * commandHistory () const = 0
- virtual QString comment () const = 0
- virtual QString contents () const = 0
- virtual QDesignerFormEditorInterface * core () const
- virtual int currentTool () const = 0
- virtual QDesignerFormWindowCursorInterface * cursor () const = 0
- virtual void endCommand () = 0
- virtual void ensureUniqueObjectName ( QObject * object ) = 0
- virtual QString exportMacro () const = 0
- virtual Feature features () const = 0
- virtual QString fileName () const = 0
- virtual QPoint grid () const = 0
- virtual bool hasFeature ( Feature feature ) const = 0
- virtual QStringList includeHints () const = 0
- virtual bool isDirty () const = 0
- virtual bool isManaged ( QWidget * widget ) const = 0
- virtual void layoutDefault ( int * margin, int * spacing ) = 0
- virtual void layoutFunction ( QString * margin, QString * spacing ) = 0
- virtual QWidget * mainContainer () const = 0
- virtual QString pixmapFunction () const = 0
- virtual void registerTool ( QDesignerFormWindowToolInterface * tool ) = 0
- virtual void removeResourceFile ( const QString & path ) = 0
- virtual QStringList resourceFiles () const = 0
- virtual void setAuthor ( const QString & author ) = 0
- virtual void setComment ( const QString & comment ) = 0
- virtual void setContents ( QIODevice * device ) = 0
- virtual void setCurrentTool ( int index ) = 0
- virtual void setExportMacro ( const QString & exportMacro ) = 0
- virtual void setIncludeHints ( const QStringList & includeHints ) = 0
- virtual void setLayoutDefault ( int margin, int spacing ) = 0
- virtual void setLayoutFunction ( const QString & margin, const QString & spacing ) = 0
- virtual void setMainContainer ( QWidget * mainContainer ) = 0
- virtual void setPixmapFunction ( const QString & pixmapFunction ) = 0
- virtual void simplifySelection ( QList<QWidget *> * widgets ) const = 0
- virtual QDesignerFormWindowToolInterface * tool ( int index ) const = 0
- virtual int toolCount () const = 0

- 183 public functions inherited from QWidget
- 28 public functions inherited from QObject
- 10 public functions inherited from QPaintDevice

### Public Slots

- virtual void clearSelection ( bool changePropertyDisplay = true ) = 0
- virtual void editWidgets () = 0
- virtual void manageWidget ( QWidget * widget ) = 0
- virtual void selectWidget ( QWidget * widget, bool select = true ) = 0
- virtual void setContents ( const QString & contents ) = 0
- virtual void setDirty ( bool dirty ) = 0
- virtual void setFeatures ( Feature features ) = 0
- virtual void setFileName ( const QString & fileName ) = 0
- virtual void setGrid ( const QPoint & grid ) = 0
- virtual void unmanageWidget ( QWidget * widget ) = 0

- 17 public slots inherited from QWidget
- 1 public slot inherited from QObject

### Signals

- void aboutToUnmanageWidget ( QWidget * widget )
- void activated ( QWidget * widget )
- void changed ()
- void featureChanged ( Feature feature )
- void fileNameChanged ( const QString & fileName )
- void geometryChanged ()
- void mainContainerChanged ( QWidget * mainContainer )
- void resourceFilesChanged ()
- void selectionChanged ()
- void toolChanged ( int toolIndex )
- void widgetManaged ( QWidget * widget )
- void widgetRemoved ( QWidget * widget )
- void widgetUnmanaged ( QWidget * widget )

- 1 signal inherited from QWidget
- 1 signal inherited from QObject

### Static Public Members

- QDesignerFormWindowInterface * findFormWindow ( QWidget * widget )

- 4 static public members inherited from QWidget
- 4 static public members inherited from QObject

### Additional Inherited Members

- 52 properties inherited from QWidget
- 1 property inherited from QObject
- 39 protected functions inherited from QWidget
- 7 protected functions inherited from QObject

## Detailed Description

The QDesignerFormWindowInterface class provides an interface that is used to control form windows provided by Qt Designer's form editing component.

See also QDesignerFormEditorInterface.

## Member Type Documentation

### enum QDesignerFormWindowInterface::FeatureFlag
flags QDesignerFormWindowInterface::Feature

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:

Constant | Value | Description
--- | --- | ---
`QDesignerFormWindowInterface::EditFeature` | `0x01` | Form editing
`QDesignerFormWindowInterface::GridFeature` | `0x02` | Grid display and snap-to-grid facilities for editing
`QDesignerFormWindowInterface::TabOrderFeature` | `0x04` | Tab order management
`QDesignerFormWindowInterface::DefaultFeature` | `EditFeature | GridFeature` | Support for default features (form editing and grid)

The Feature type is a typedef for QFlags<FeatureFlag>. It stores an OR combination of FeatureFlag values.

See also hasFeature().

## Member Function Documentation

### QDesignerFormWindowInterface::QDesignerFormWindowInterface ( QWidget * parent = 0, Qt::WindowFlags flags = 0 )

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

### QDesignerFormWindowInterface::~QDesignerFormWindowInterface () `[virtual]`

Destroys the form window interface.

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

### QDir QDesignerFormWindowInterface::absoluteDir () const `[pure virtual]`

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

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

### void QDesignerFormWindowInterface::addResourceFile ( const QString & path ) `[pure virtual]`

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

### QString QDesignerFormWindowInterface::author () const `[pure virtual]`

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

### void QDesignerFormWindowInterface::beginCommand ( const QString & description ) `[pure virtual]`

Begins execution of a command. Commands are executed between beginCommand() and endCommand() function calls to ensure that the undo stack records them.

See also endCommand().

### void QDesignerFormWindowInterface::changed () `[signal]`

This signal is emitted whenever a form is changed.

### void QDesignerFormWindowInterface::clearSelection ( bool changePropertyDisplay = true ) `[pure virtual slot]`

Clears the current selection in the form window.

### QtUndoStack * 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.

### QString QDesignerFormWindowInterface::comment () const `[pure virtual]`

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

### QString QDesignerFormWindowInterface::contents () const `[pure virtual]`

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

### QDesignerFormEditorInterface * QDesignerFormWindowInterface::core () const `[virtual]`

Returns the core form editor interface associated with this interface.

### int QDesignerFormWindowInterface::currentTool () const `[pure virtual]`

Returns the index of the current tool in use.

See also setCurrentTool().

### QDesignerFormWindowCursorInterface * QDesignerFormWindowInterface::cursor () const `[pure virtual]`

Returns the cursor interface used by the form window.

### void QDesignerFormWindowInterface::editWidgets () `[pure virtual slot]`

Switches the form window into editing mode.

See also Designer's Form Editing Mode.

### void QDesignerFormWindowInterface::endCommand () `[pure virtual]`

Ends execution of the current command.

See also beginCommand().

### void QDesignerFormWindowInterface::ensureUniqueObjectName ( QObject * object ) `[pure virtual]`

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

### 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 Custom Widgets for Qt Designer.

### void QDesignerFormWindowInterface::featureChanged ( Feature feature ) `[signal]`

This signal is emitted whenever a feature changes in the form. The new feature is specified by feature.

### 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 Feature enum values to determine which features are supported by the window.

See also setFeatures().

### QString QDesignerFormWindowInterface::fileName () const `[pure virtual]`

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

See also setFileName().

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

### QDesignerFormWindowInterface * QDesignerFormWindowInterface::findFormWindow ( QWidget * widget ) `[static]`

Returns the form window interface for the given widget.

### void QDesignerFormWindowInterface::geometryChanged () `[signal]`

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

See also selectionChanged().

### QPoint QDesignerFormWindowInterface::grid () const `[pure virtual]`

Returns the grid spacing used by the form window.

See also setGrid().

### bool QDesignerFormWindowInterface::hasFeature ( Feature feature ) const `[pure virtual]`

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

### QStringList QDesignerFormWindowInterface::includeHints () const `[pure virtual]`

Returns a list of hints.

See also setIncludeHints().

### bool QDesignerFormWindowInterface::isDirty () const `[pure virtual]`

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

See also setDirty().

### 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 setManaged().

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

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

### QWidget * QDesignerFormWindowInterface::mainContainer () const `[pure virtual]`

Returns the main container widget for the form window.

See also setMainContainer().

### void QDesignerFormWindowInterface::mainContainerChanged ( QWidget * mainContainer ) `[signal]`

This signal is emitted whenever the main container changes. The new container is specified by mainContainer.

### void QDesignerFormWindowInterface::manageWidget ( QWidget * widget ) `[pure virtual slot]`

Instructs the form window to manage the specified widget.

See also isManaged().

### QString QDesignerFormWindowInterface::pixmapFunction () const `[pure virtual]`

Returns the name of the function used to generate a pixmap for the form window.

See also setPixmapFunction().

### void QDesignerFormWindowInterface::registerTool ( QDesignerFormWindowToolInterface * tool ) `[pure virtual]`

Registers the given tool with the form window.

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

### QStringList QDesignerFormWindowInterface::resourceFiles () const `[pure virtual]`

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

### void QDesignerFormWindowInterface::resourceFilesChanged () `[signal]`

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

### void QDesignerFormWindowInterface::selectWidget ( QWidget * widget, bool select = true ) `[pure virtual slot]`

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

### void QDesignerFormWindowInterface::selectionChanged () `[signal]`

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

See also geometryChanged().

### void QDesignerFormWindowInterface::setAuthor ( const QString & author ) `[pure virtual]`

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

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

### void QDesignerFormWindowInterface::setContents ( QIODevice * device ) `[pure virtual]`

Sets the form's contents using data obtained from the given device.

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

### void QDesignerFormWindowInterface::setContents ( const QString & contents ) `[pure virtual slot]`

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Sets the contents of the form using data read from the specified contents string.

### void QDesignerFormWindowInterface::setCurrentTool ( int index ) `[pure virtual]`

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

See also currentTool().

### void QDesignerFormWindowInterface::setDirty ( bool dirty ) `[pure virtual slot]`

If dirty is true, the form window is marked as dirty, meaning that it has been modified but not saved. If dirty is false, the form window is considered to be unmodified.

See also isDirty().

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

### void QDesignerFormWindowInterface::setFeatures ( Feature features ) `[pure virtual slot]`

Enables the specified features for the form window.

See also features().

### void QDesignerFormWindowInterface::setFileName ( const QString & fileName ) `[pure virtual slot]`

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

See also fileName().

### void QDesignerFormWindowInterface::setGrid ( const QPoint & grid ) `[pure virtual slot]`

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

### void QDesignerFormWindowInterface::setIncludeHints ( const QStringList & includeHints ) `[pure virtual]`

Sets the include hints used by the form to the list specified by includeHints.

See also includeHints().

### void QDesignerFormWindowInterface::setLayoutDefault ( int margin, int spacing ) `[pure virtual]`

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

See also layoutDefault().

### void QDesignerFormWindowInterface::setLayoutFunction ( const QString & margin, const QString & spacing ) `[pure virtual]`

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

See also layoutFunction().

### void QDesignerFormWindowInterface::setMainContainer ( QWidget * mainContainer ) `[pure virtual]`

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

See also mainContainer().

### void QDesignerFormWindowInterface::setPixmapFunction ( const QString & pixmapFunction ) `[pure virtual]`

Sets the function used to generate the pixmap for the form window to the given pixmapFunction.

See also pixmapFunction().

### void QDesignerFormWindowInterface::simplifySelection ( QList<QWidget *> * widgets ) const `[pure virtual]`

Simplifies the selection of widgets specified by widgets.

See also selectionChanged().

### QDesignerFormWindowToolInterface * QDesignerFormWindowInterface::tool ( int index ) const `[pure virtual]`

Returns the tool interface used by the form window.

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

### int QDesignerFormWindowInterface::toolCount () const `[pure virtual]`

Returns the number of tools available.

### void QDesignerFormWindowInterface::unmanageWidget ( QWidget * widget ) `[pure virtual slot]`

Instructs the form window not to manage the specified widget.

See also aboutToUnmanageWidget() and widgetUnmanaged().

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

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

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