- class QDesignerPropertyEditorInterface¶
The
QDesignerPropertyEditorInterface
class allows you to query and manipulate the current state of Qt Designer’s property editor. More…Synopsis¶
Methods¶
def
__init__()
Virtual methods¶
def
core()
def
isReadOnly()
def
object()
def
setObject()
def
setReadOnly()
Signals¶
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.
QDesignerPropertyEditorInterface
contains a collection of functions that is typically used to query the property editor for its current state, and several slots manipulating it’s state. The interface also provide a signal,propertyChanged()
, which is emitted whenever a property changes in the property editor. The signal’s arguments are the property that changed and its new value.For example, when implementing a custom widget plugin, you can connect the signal to a custom slot:
propertyEditor = formEditor.propertyEditor() propertyEditor.propertyChanged.connect( self.checkProperty)
Then the custom slot can check if the new value is within the range we want when a specified property, belonging to a particular widget, changes:
def checkProperty(property, value): propertyEditor = formEditor.propertyEditor() object = propertyeditor.object() widget = MyCustomWidget(object) if widget and property == aProperty and value != expectedValue: {...}
The
QDesignerPropertyEditorInterface
class is not intended to be instantiated directly. You can retrieve an interface to Qt Designer's property editor using thepropertyEditor()
function. A pointer to Qt Designer's currentQDesignerFormEditorInterface
object (formEditor
in the examples above) is provided by theinitialize()
function’s parameter. When implementing a custom widget plugin, you must subclass theQDesignerCustomWidgetInterface
to expose your plugin to Qt Designer.The functions accessing the property editor are the
core()
function that you can use to retrieve an interface to the form editor, thecurrentPropertyName()
function that returns the name of the currently selected property in the property editor, theobject()
function that returns the currently selected object in Qt Designer's workspace, and theisReadOnly()
function that returns true if the property editor is write proteced (otherwise false).The slots manipulating the property editor’s state are the
setObject()
slot that you can use to change the currently selected object in Qt Designer's workspace, thesetPropertyValue()
slot that changes the value of a given property and thesetReadOnly()
slot that control the write protection of the property editor.See also
- __init__(parent[, flags={}])¶
- Parameters:
parent –
QWidget
flags – Combination of
WindowType
Constructs a property editor interface with the given
parent
and the specified windowflags
.- core()¶
- Return type:
Returns a pointer to Qt Designer's current
QDesignerFormEditorInterface
object.- abstract currentPropertyName()¶
- Return type:
str
Returns the name of the currently selected property in the property editor.
See also
- abstract isReadOnly()¶
- Return type:
bool
Returns true if the property editor is write protected; otherwise false.
See also
Returns the currently selected object in Qt Designer's workspace.
See also
- propertyChanged(name, value)¶
- Parameters:
name – str
value – object
This signal is emitted whenever a property changes in the property editor. The property that changed and its new value are specified by
name
andvalue
respectively.See also
Changes the currently selected object in Qt Designer's workspace, to
object
.See also
- abstract setPropertyValue(name, value[, changed=true])¶
- Parameters:
name – str
value – object
changed – bool
Sets the value of the property specified by
name
tovalue
.In addition, the property is marked as
changed
in the property editor, i.e. its value is different from the default value.See also
- abstract setReadOnly(readOnly)¶
- Parameters:
readOnly – bool
If
readOnly
is true, the property editor is made write protected; otherwise the write protection is removed.See also