Инструменты пользователя

Инструменты сайта


products:pyrog:api:latest:types:properties:plain_text_property

Текст документации сгенерирован автоматически из исходного кода.
Если обнаружили ошибку, отправьте об этом сообщение на 📧почту.

PlainTextProperty

Inherits: Property

Class of property that provides input of string as plain text.

Attributes:

  • value_changed — This signal is emitted when value is changed.

Constructor:

def PlainTextProperty.__init__(default_value: str = '', name: str | LangConstant = tr.UNNAMED, placeholder: str | LangConstant = '', tooltip: str | LangConstant = '', show_reset_btn: bool = True)

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 | LangConstant — name of property
  • placeholder: str | LangConstant — placeholder text
  • tooltip: str | LangConstant — tooltip text
  • show_reset_btn: bool — state of reset button displaying

Properties


value

@property
def value() -> str

Current value of the property.

Returns:

  • str — string as plain text.

name

Property name, this text is displayed in PropertyContainer form editing values.

Returns:


tooltip

Tooltip of the property's widget

Returns:

  • str | 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:


default_value

Default value of property

Returns:

  • str — default value of property

Methods


get_input_widget

def get_input_widget() -> QWidget

Returns:

  • QWidget — (without description)

delete_input_widget

def delete_input_widget() -> None

Deletes widget for data input if it exists

Returns:

  • None — (without description)

reset_value

def reset_value() -> None

Returns:

  • None — (without description)

products/pyrog/api/latest/types/properties/plain_text_property.txt · Последнее изменение: 127.0.0.1