QDesignerFormWindowCursorInterface¶

PyQt5.QtDesigner.QDesignerFormWindowCursorInterface

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

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.

Enums¶

MoveMode

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

Member	Value	Description
KeepAnchor	1	The anchor remains at the cursor’s old location.
MoveAnchor	0	The anchor moves with the cursor to its new location.

MoveOperation

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

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

Methods¶

__init__(): TODO

__init__(QDesignerFormWindowCursorInterface): TODO

current() → QWidget: TODO

formWindow() → QDesignerFormWindowInterface: TODO

hasSelection() → bool: TODO

isWidgetSelected(QWidget) → bool: Returns true if the specified widget is selected; otherwise returns false.

movePosition(MoveOperation, mode: MoveMode = MoveAnchor) → bool: TODO

position() → int: TODO

resetWidgetProperty(QWidget, str): TODO

selectedWidget(int) → QWidget: TODO

selectedWidgetCount() → int: TODO

setPosition(int, mode: MoveMode = MoveAnchor): TODO

setProperty(str, Any): TODO

setWidgetProperty(QWidget, str, Any): TODO

widget(int) → QWidget: TODO

widgetCount() → int: TODO