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

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


products:pyrog:api:lastest:types:properties:file_path_property

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

FilePathProperty

Inherits: Property

Class of property that provides input of file or directory absolute path.

Attributes:

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

Constructor:

def FilePathProperty.__init__(default_value: str = '', name: str| LangConstant = tr.UNNAMED, mode: Modes = Modes.Directory, dialog_title: str | LangConstant = '', placeholder: str | LangConstant = '', filter: str | LangConstant = '(*.*)', tooltip: str | LangConstant = '', show_clear_btn: bool = False)

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 path
  • name: str| LangConstant — property name
  • mode: Modes — mode of path input
  • dialog_title: str | LangConstant — text of title of dialog window
  • placeholder: str | LangConstant — placeholder text
  • filter: str | LangConstant — file type filter
  • tooltip: str | LangConstant — tooltip text
  • show_clear_btn: bool — visibility state of clear button

Properties

default_value

Default value of property.

Returns:

  • str — default path

name

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

Returns:

mode

Mode of path input.

Returns:

  • Modes — mode of path input

dialog_title

Text of title of dialog window.

Returns:

filter

File type filter.

Returns:

placeholder

Placeholder text.

Returns:

tooltip

Tooltip of the property's widget.

Returns:

  • str | LangConstant — tooltip text of the property's widget

show_clear_btn

State of clear button. This button clear text area.

Returns:

  • bool — state of clear button

Methods

get_input_widget

def get_input_widget() -> FilePathInput

Returns:

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