IronMesh Wiki

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
~~NOTOC~~
<WRAP center round info 80%>
Текст документации сгенерирован автоматически из [[https://github.com/iron-mesh/Pyrog|исходного кода]].\\
Если обнаружили ошибку, отправьте об этом сообщение на [[feedback@ironmesh.ru|📧почту]].
</WRAP>

====== StringProperty ======



**Inherits:** [[.:property#property|Property]]


Class of property that provides input of string value.

**Attributes:**

  * **value_changed**: //str// — This signal is emitted when value is changed.

**Constructor:**

<code python>def StringProperty.__init__(default_value: str = '', name: str | LangConstant = tr.UNNAMED, maxlen: int = 32767, input_mask: str | LangConstant = '', placeholder: str | LangConstant = '', re_validator: str | LangConstant = '', tooltip: str | LangConstant = '', show_reset_btn: bool = True)</code>

Initializes class of property.

The description of the arguments is identical to the description of the parameters with the same names.

**Parameters:**

  * **default_value**: //str// — default value of property
  * **name**: //str | [[..:lang_constant#langconstant|LangConstant]]// — name of property
  * **maxlen**: //int// — maximum length of string
  * **input_mask**: //str | [[..:lang_constant#langconstant|LangConstant]]// — validation input mask, see detailed info: https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QLineEdit.html#PySide6.QtWidgets.QLineEdit.inputMask
  * **placeholder**: //str | [[..:lang_constant#langconstant|LangConstant]]// — placeholder text
  * **re_validator**: //str | [[..:lang_constant#langconstant|LangConstant]]// — regular expression used for validation, see detailed info: https://doc.qt.io/qtforpython-6/PySide6/QtGui/QRegularExpressionValidator.html#PySide6.QtGui.QRegularExpressionValidator
  * **tooltip**: //str | [[..:lang_constant#langconstant|LangConstant]]// — tooltip text
  * **show_reset_btn**: //bool// — state of reset button displaying


==== Properties ====


=== maxlen ===


Maximum length of string.

**Notes:**
Must be equal or greater than 0.

**Returns:**
  * //int// — maximum length of string


=== input_mask ===


Validation input mask.
See detailed info: https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QLineEdit.html#PySide6.QtWidgets.QLineEdit.inputMask

**Returns:**
  * //str// — validation input mask


=== re_validator ===


Regular expression used for validation.
See detailed info: https://doc.qt.io/qtforpython-6/PySide6/QtGui/QRegularExpressionValidator.html#PySide6.QtGui.QRegularExpressionValidator

**Returns:**
  * //str// — regular expression used for validation


=== name ===


[[.:property#property|Property]] name, this text is displayed in [[.:property_container#propertycontainer|PropertyContainer]] form editing values.

**Returns:**
  * //str | [[..:lang_constant#langconstant|LangConstant]]// — property name


=== tooltip ===


Tooltip of the property's widget

**Returns:**
  * //str | [[..:lang_constant#langconstant|LangConstant]]// — tooltip text of the property's widget


=== show_reset_btn ===


State of reset button displaying.
This button is displayed if value isn't equal to default value.

**Returns:**
  * //bool// — state of reset button displaying


=== placeholder ===


Placeholder text

**Returns:**
  * //str | [[..:lang_constant#langconstant|LangConstant]]// — placeholder text


=== default_value ===


Default value of property

**Returns:**
  * //str// — default value of property


==== Methods ====


=== get_input_widget ===


<code python>def get_input_widget() -> QWidget</code>

**Returns:**
  * //QWidget// — (without description)


=== reset_value ===


<code python>def reset_value() -> None</code>

**Returns:**
  * //None// — (without description)