PySide6.QtDesigner.QDesignerFormWindowCursorInterface

class QDesignerFormWindowCursorInterface

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…

Synopsis

Methods

Virtual methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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 Widgets 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 findFormWindow() functions. For example:

formWindow = QDesignerFormWindowInterface.findFormWindow(myWidget)
formWindow.cursor().setProperty(myWidget, myProperty, newValue)

You can retrieve any of Qt Widgets Designer’s current form windows through Qt Widgets 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.

class MoveOperation

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

Constant

Description

QDesignerFormWindowCursorInterface.NoMove

The cursor does not move.

QDesignerFormWindowCursorInterface.Start

Moves the cursor to the start of the focus chain.

QDesignerFormWindowCursorInterface.End

Moves the cursor to the end of the focus chain.

QDesignerFormWindowCursorInterface.Next

Moves the cursor to the next widget in the focus chain.

QDesignerFormWindowCursorInterface.Prev

Moves the cursor to the previous widget in the focus chain.

QDesignerFormWindowCursorInterface.Left

The cursor moves to the left.

QDesignerFormWindowCursorInterface.Right

The cursor moves to the right.

QDesignerFormWindowCursorInterface.Up

The cursor moves upwards.

QDesignerFormWindowCursorInterface.Down

The cursor moves downwards.
class MoveMode

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

Constant

Description

QDesignerFormWindowCursorInterface.MoveAnchor

The anchor moves with the cursor to its new location.

QDesignerFormWindowCursorInterface.KeepAnchor

The anchor remains at the cursor’s old location.
__init__()
abstract current()
Return type:

QWidget

Returns the currently selected widget in the form window.

See also

selectedWidget()

abstract formWindow()
Return type:

QDesignerFormWindowInterface

Returns the form window interface associated with this cursor interface.

abstract hasSelection()
Return type:

bool

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

isWidgetSelected(widget)
Parameters:

widget – QWidget

Return type:

bool

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

abstract movePosition(op[, mode=QDesignerFormWindowCursorInterface.MoveMode.MoveAnchor])
Parameters:
Return type:

bool

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

abstract position()
Return type:

int

Returns the cursor position.

abstract resetWidgetProperty(widget, name)
Parameters:

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

abstract selectedWidget(index)
Parameters:

index – int

Return type:

QWidget

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

See also

current() widget()

abstract selectedWidgetCount()
Return type:

int

Returns the number of selected widgets in the form window.

See also

widgetCount()

abstract setPosition(pos[, mode=QDesignerFormWindowCursorInterface.MoveMode.MoveAnchor])
Parameters:

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

abstract setProperty(name, value)
Parameters:

  • name – str

  • value – object

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

abstract setWidgetProperty(widget, name, value)
Parameters:

  • widget – QWidget

  • name – str

  • value – object

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

abstract widget(index)
Parameters:

index – int

Return type:

QWidget

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

See also

selectedWidget()

abstract widgetCount()
Return type:

int

Returns the number of widgets in the form window.