RWESharp.Configurable.PythonTypes.BoolConfigurable¶

class RWESharp.Configurable.PythonTypes.BoolConfigurable(mod, name: str, default: bool = False, description: str = '')[source]¶

Bases: Configurable

Parameters:

name (str)
default (bool)
description (str)

__init__(mod, name: str, default: bool = False, description: str = '')[source]¶

Abstract object for creating custom config parameters and storing them :param mod: mod to link configurable :param name: name of object. should not contain spaces or any special characters :param default: default value of variable :param description: description in config menu

Parameters:

name (str)
default (bool)
description (str)

Methods

`__init__`(mod, name[, default, description])	Abstract object for creating custom config parameters and storing them :param mod: mod to link configurable :param name: name of object.
`blockSignals`(object, /)
`childEvent`(object, /)
`children`()
`connect`
`connectNotify`(object, /)
`customEvent`(object, /)
`deleteLater`()
`disconnect`
`disconnectNotify`(object, /)
`dumpObjectInfo`()
`dumpObjectTree`()
`dynamicPropertyNames`()
`emit`
`event`(object, /)
`eventFilter`
`findChild`
`findChildren`
`flip`()
`inherits`(object, /)
`installEventFilter`(object, /)
`isQuickItemType`()
`isSignalConnected`(object, /)
`isWidgetType`()
`isWindowType`()
`killTimer`(object, /)
`link_action`(action[, key])	Makes link between Action and Configurable, where state is synced :param action: action to link :param key: optional key to link to action :return: None
`link_button`(button[, key])	Makes link between Button and Configurable, where value gets synced :param button: button to link :param key: optional key to link to button :return: None
`link_button_action`(button, action[, key])	Links both Button and Action to a Configurable and syncs the state :param button: Button to link :param action: action to link :param key: optional key to link to action(for it to be used globally) :return: None
`link_mod`(mod)
`load_str_value`(text)
`metaObject`()
`moveToThread`(object, /)
`objectName`()
`parent`()
`property`(object, /)
`receivers`(object, /)
`removeEventFilter`(object, /)
`reset_value`()
`save_str_value`()
`sender`()
`senderSignalIndex`()
`setObjectName`(object, /)
`setParent`(object, /)
`setProperty`
`signalsBlocked`()
`startTimer`
`thread`()
`timerEvent`(object, /)
`tr`
`update_value`([value])
`update_value_default`(value)

Attributes

`destroyed`
`objectNameChanged`
`staticMetaObject`
`valueChanged`	Activated when value is changed

class KeyConfigurable(mod, name, default: QKeySequence | str | StandardKey, description='', shortdesc='')¶

Bases: Configurable

Parameters:: default (QKeySequence | str | StandardKey)

blockSignals(object, /)¶

childEvent(object, /)¶

children()¶

static connect()¶

connectNotify(object, /)¶

customEvent(object, /)¶

deleteLater()¶

destroyed¶

static disconnect()¶

disconnectNotify(object, /)¶

dumpObjectInfo()¶

dumpObjectTree()¶

dynamicPropertyNames()¶

emit()¶

event(object, /)¶

eventFilter()¶

findChild()¶

findChildren()¶

inherits(object, /)¶

installEventFilter(object, /)¶

isQuickItemType()¶

isSignalConnected(object, /)¶

isWidgetType()¶

isWindowType()¶

killTimer(object, /)¶

link_action(action: QAction)¶

Parameters:: action (QAction)

link_button(button: QAbstractButton)¶

Parameters:: button (QAbstractButton)

link_keysequenceedit(edit: QKeySequenceEdit)¶

Parameters:: edit (QKeySequenceEdit)

link_mod(mod)¶

link_shortcut(shortcut: QShortcut)¶

Parameters:: shortcut (QShortcut)

load_str_value(text: str) → None¶

Parameters:: text (str)
Return type:: None

metaObject()¶

moveToThread(object, /)¶

objectName()¶

objectNameChanged¶

parent()¶

property(object, /)¶

receivers(object, /)¶

removeEventFilter(object, /)¶

reset_value()¶

save_str_value() → str¶

Return type:: str

sender()¶

senderSignalIndex()¶

setObjectName(object, /)¶

setParent(object, /)¶

setProperty()¶

signalsBlocked()¶

startTimer()¶

staticMetaObject = PySide6.QtCore.QMetaObject("KeyConfigurable" inherits "Configurable": Methods: #4 type=Signal, signature=valueChanged(QKeySequence), parameters=QKeySequence #5 type=Signal, signature=tooltipChanged(QString), parameters=QString )¶

thread()¶

timerEvent(object, /)¶

tooltipChanged¶

classmethod tr()¶

update_value(value: QKeySequence)¶

Parameters:: value (QKeySequence)

update_value_default(value: ...)¶

Parameters:: value (...)

valueChanged: Signal | None¶: Activated when value is changed

buttons: list[QAbstractButton]¶

valueChanged: Signal | None¶: Activated when value is changed

load_str_value(text: str) → None[source]¶

Parameters:: text (str)
Return type:: None

save_str_value() → str[source]¶

Return type:: str

update_value(value: bool | CheckState | None = None) → None[source]¶

Parameters:: value (bool | CheckState | None)
Return type:: None

flip()[source]¶

link_button(button: QAbstractButton, key: KeyConfigurable = None) → None[source]¶

Makes link between Button and Configurable, where value gets synced :param button: button to link :param key: optional key to link to button :return: None

Parameters:

button (QAbstractButton)
key (KeyConfigurable)

Return type:

None

link_action(action: QAction, key: KeyConfigurable = None) → None[source]¶

Makes link between Action and Configurable, where state is synced :param action: action to link :param key: optional key to link to action :return: None

Parameters:

action (QAction)
key (KeyConfigurable)

Return type:

None

link_button_action(button: QAbstractButton, action: QAction, key: KeyConfigurable = None) → None[source]¶

Links both Button and Action to a Configurable and syncs the state :param button: Button to link :param action: action to link :param key: optional key to link to action(for it to be used globally) :return: None

Parameters:

button (QAbstractButton)
action (QAction)
key (KeyConfigurable)

Return type:

None

blockSignals(object, /)¶

childEvent(object, /)¶

children()¶

static connect()¶

connectNotify(object, /)¶

customEvent(object, /)¶

deleteLater()¶

destroyed¶

static disconnect()¶

disconnectNotify(object, /)¶

dumpObjectInfo()¶

dumpObjectTree()¶

dynamicPropertyNames()¶

emit()¶

event(object, /)¶

eventFilter()¶

findChild()¶

findChildren()¶

inherits(object, /)¶

installEventFilter(object, /)¶

isQuickItemType()¶

isSignalConnected(object, /)¶

isWidgetType()¶

isWindowType()¶

killTimer(object, /)¶

link_mod(mod)¶

metaObject()¶

moveToThread(object, /)¶

objectName()¶

objectNameChanged¶

parent()¶

property(object, /)¶

receivers(object, /)¶

removeEventFilter(object, /)¶

reset_value()¶

sender()¶

senderSignalIndex()¶

setObjectName(object, /)¶

setParent(object, /)¶

setProperty()¶

signalsBlocked()¶

startTimer()¶

staticMetaObject = PySide6.QtCore.QMetaObject("BoolConfigurable" inherits "Configurable": Methods: #4 type=Signal, signature=valueChanged(bool), parameters=bool #5 type=Slot, signature=update_value() #6 type=Slot, signature=update_value(Qt::CheckState), parameters=Qt::CheckState #7 type=Slot, signature=update_value(bool), parameters=bool #8 type=Slot, signature=flip() )¶

thread()¶

timerEvent(object, /)¶

classmethod tr()¶

update_value_default(value: ...)¶

Parameters:: value (...)