Qt 5.7 | Qt Designer Manual | C++ Classes | QDesignerFormWindowCursorInterface

Qt 5.7.1 Reference Documentation

# QDesignerFormWindowCursorInterface Class

The QDesignerFormWindowCursorInterface class allows you to query and modify a form window's widget selection, and in addition modify the properties of all the form's widgets. More...

Header: | #include <QDesignerFormWindowCursorInterface>
qmake: | QT += designer

- List of all members, including inherited members

## Public Types

enum | MoveMode { MoveAnchor, KeepAnchor }
enum | MoveOperation { NoMove, Start, End, Next, ..., Down }

## Public Functions

virtual | ~QDesignerFormWindowCursorInterface()
virtual QWidget * | current() const = 0
virtual QDesignerFormWindowInterface * | formWindow() const = 0
virtual bool | hasSelection() const = 0
bool | isWidgetSelected(QWidget *widget) const
virtual bool | movePosition(MoveOperation operation, MoveMode mode = MoveAnchor) = 0
virtual int | position() const = 0
virtual void | resetWidgetProperty(QWidget *widget, const QString &name) = 0
virtual QWidget * | selectedWidget(int index) const = 0
virtual int | selectedWidgetCount() const = 0
virtual void | setPosition(int position, MoveMode mode = MoveAnchor) = 0
virtual void | setProperty(const QString &name, const QVariant &value) = 0
virtual void | setWidgetProperty(QWidget *widget, const QString &name, const QVariant &value) = 0
virtual QWidget * | widget(int index) const = 0
virtual int | widgetCount() const = 0

## Detailed Description

The QDesignerFormWindowCursorInterface class allows you to query and modify a form window's widget selection, and in addition modify the properties of all the form's widgets.

QDesignerFormWindowCursorInterface is a convenience class that provides an interface to the associated form window's text cursor; it provides a collection of functions that enables you to query a given form window's selection and change the selection's focus according to defined modes (MoveMode) and movements (MoveOperation). You can also use the interface to query the form's widgets and change their properties.

The interface is not intended to be instantiated directly, but to provide access to the selections and widgets of Qt Designer's current form windows. QDesignerFormWindowInterface always provides an associated cursor interface. The form window for a given widget can be retrieved using the static QDesignerFormWindowInterface::findFormWindow() functions. For example:

          QDesignerFormWindowInterface *formWindow = 0;
          formWindow = QDesignerFormWindowInterface::findFormWindow(myWidget);

          formWindow->cursor()->setProperty(myWidget, myProperty, newValue);

You can retrieve any of Qt Designer's current form windows through Qt Designer's form window manager.

Once you have a form window's cursor interface, you can check if the form window has a selection at all using the hasSelection() function. You can query the form window for its total widgetCount() and selectedWidgetCount(). You can retrieve the currently selected widget (or widgets) using the current() or selectedWidget() functions.

You can retrieve any of the form window's widgets using the widget() function, and check if a widget is selected using the isWidgetSelected() function. You can use the setProperty() function to set the selected widget's properties, and the setWidgetProperty() or resetWidgetProperty() functions to modify the properties of any given widget.

Finally, you can change the selection by changing the text cursor's position() using the setPosition() and movePosition() functions.

See also QDesignerFormWindowInterface and QDesignerFormWindowManagerInterface.

## Member Type Documentation

### enum QDesignerFormWindowCursorInterface::MoveMode

This enum describes the different modes that are used when the text cursor moves.

Constant | Value | Description
--- | --- | ---
`QDesignerFormWindowCursorInterface::MoveAnchor` | `0` | The anchor moves with the cursor to its new location.
`QDesignerFormWindowCursorInterface::KeepAnchor` | `1` | The anchor remains at the cursor's old location.

### enum QDesignerFormWindowCursorInterface::MoveOperation

This enum describes the types of text cursor operation that can occur in a form window.

Constant | Value | Description
--- | --- | ---
`QDesignerFormWindowCursorInterface::NoMove` | `0` | The cursor does not move.
`QDesignerFormWindowCursorInterface::Start` | `1` | Moves the cursor to the start of the focus chain.
`QDesignerFormWindowCursorInterface::End` | `2` | Moves the cursor to the end of the focus chain.
`QDesignerFormWindowCursorInterface::Next` | `3` | Moves the cursor to the next widget in the focus chain.
`QDesignerFormWindowCursorInterface::Prev` | `4` | Moves the cursor to the previous widget in the focus chain.
`QDesignerFormWindowCursorInterface::Left` | `5` | The cursor moves to the left.
`QDesignerFormWindowCursorInterface::Right` | `6` | The cursor moves to the right.
`QDesignerFormWindowCursorInterface::Up` | `7` | The cursor moves upwards.
`QDesignerFormWindowCursorInterface::Down` | `8` | The cursor moves downwards.

## Member Function Documentation

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

Destroys the cursor interface.

### `[pure virtual]` QWidget *QDesignerFormWindowCursorInterface::current() const

Returns the currently selected widget in the form window.

See also selectedWidget().

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

Returns the form window interface associated with this cursor interface.

### `[pure virtual]` bool QDesignerFormWindowCursorInterface::hasSelection() const

Returns true if the form window contains a selection; otherwise returns false.

### bool QDesignerFormWindowCursorInterface::isWidgetSelected(QWidget *widget) const

Returns true if the specified widget is selected; otherwise returns false.

### `[pure virtual]` bool QDesignerFormWindowCursorInterface::movePosition(MoveOperation operation, MoveMode mode = MoveAnchor)

Performs the given operation on the cursor using the specified mode, and returns true if it completed successfully; otherwise returns false.

See also position() and setPosition().

### `[pure virtual]` int QDesignerFormWindowCursorInterface::position() const

Returns the cursor position.

See also setPosition() and movePosition().

### `[pure virtual]` void QDesignerFormWindowCursorInterface::resetWidgetProperty(QWidget *widget, const QString &name)

Resets the property with the given name for the specified widget to its default value.

See also setProperty() and setWidgetProperty().

### `[pure virtual]` QWidget *QDesignerFormWindowCursorInterface::selectedWidget(int index) const

Returns the widget with the given index in the list of selected widgets.

See also current() and widget().

### `[pure virtual]` int QDesignerFormWindowCursorInterface::selectedWidgetCount() const

Returns the number of selected widgets in the form window.

See also widgetCount().

### `[pure virtual]` void QDesignerFormWindowCursorInterface::setPosition(int position, MoveMode mode = MoveAnchor)

Sets the position of the cursor to the given position using the mode to specify how it is moved there.

See also position() and movePosition().

### `[pure virtual]` void QDesignerFormWindowCursorInterface::setProperty(const QString &name, const QVariant &value)

Sets the property with the given name for the currently selected widget to the specified value.

See also setWidgetProperty() and resetWidgetProperty().

### `[pure virtual]` void QDesignerFormWindowCursorInterface::setWidgetProperty(QWidget *widget, const QString &name, const QVariant &value)

Sets the property with the given name for the given widget to the specified value.

See also resetWidgetProperty() and setProperty().

### `[pure virtual]` QWidget *QDesignerFormWindowCursorInterface::widget(int index) const

Returns the widget with the given index in the list of widgets in the form window.

See also selectedWidget().

### `[pure virtual]` int QDesignerFormWindowCursorInterface::widgetCount() const

Returns the number of widgets in the form window.

See also selectedWidgetCount().