Control Properties

Class full path: ControlProperties.ControlProperties

Implementation of the control properties class

Attributes

as_slider: bool property writable

Get the control as slider state

Returns:

Type	Description
bool	control as slider state

background_color: str property writable

Get the background color of the control

Returns:

Type	Description
str	background color of the control

constraint: List[str] property writable

Get the constraint name of the control

Returns:

Type	Description
List[str]	constraint

control_type: ControlType property writable

Get the control type of the control

Returns:

Type	Description
ControlType	control type

enable: bool property writable

Get the enable state of the control

Returns:

Type	Description
bool	enable state

enable_condition: str property writable

Get the enable condition of the control

Returns:

Type	Description
str	enable condition

enable_function: Optional[Callable[..., bool]] property writable

Get the enable function of the control

Returns:

Type	Description
Optional[Callable[..., bool]]	enable function

event_id: str property writable

Get the event id of the control

Returns:

Type	Description
str	event ID

expander_name: str property writable

Get the name of the current expander control

Returns:

Type	Description
str	expander name of the control.

expander_state_key: str property writable

Get the expander state key of the control

Returns:

Type	Description
str	expander state key.

font_face_code: int property writable

Get the font face code of the control

Returns:

Type	Description
int	font face code of the control

font_style: int property writable

Get the font style of the control

Returns:

Type	Description
int	font style of the control

group_text: str property writable

Get the group text of the property

Returns:

Type	Description
str	text of the property.

height: int property writable

Get the height of the control

Returns:

Type	Description
int	height of the control

interval_value: str property writable

Get the interval value of the control

Returns:

Type	Description
str	interval value

list_group_name: str property writable

Get the name of the list group

Returns:

Type	Description
str	name of the list group

max_value: Union[int, float] property writable

Get the max value of the control

Returns:

Type	Description
Union[int, float]	maximal value

max_value_condition: str property writable

Get the max value condition of the control

Returns:

Type	Description
str	maximal value condition

member_text: Dict[str, str] property writable

Get the member text of the property members

Returns:

Type	Description
Dict[str, str]	text of the property members

min_value: Union[int, float] property writable

Get the min value of the control

Returns:

Type	Description
Union[int, float]	minimal value

min_value_condition: str property writable

Get the min value condition of the control

Returns:

Type	Description
str	minimal value condition

page: int property writable

Get the page of the control

Returns:

Type	Description
int	page number.

refresh_control: bool property

Get the refresh control state

Returns:

Type	Description
bool	refresh control state

row_name: str property writable

Get the row name of the control

Returns:

Type	Description
str	row name.

row_state_key: str property writable

Get the row state key of the control

Returns:

Type	Description
str	row state key.

text: str property writable

Get the control text

Returns:

Type	Description
str	control text

value_dialog: str property writable

Get the dialog name for the value input dialog

Returns:

Type	Description
str	dialog name for the value input dialog

value_index_name: str property writable

Get the value index name of the control

Returns:

Type	Description
str	value index name

value_list: str property writable

Get the text with the values for the combo box list like 1|2|5|7

Returns:

Type	Description
str	value list

value_list_2: str property writable

Get the second value list

Returns:

Type	Description
str	second value list

value_list_start_row: int property writable

Get the start row of the value list row numbering inside the palette

Returns:

Type	Description
int	value list start row

value_list_textids: str property

Get the second value list

Returns:

Type	Description
str	value list text IDs

value_name: str property writable

Get the name of the assigned value from the building element

Returns:

Type	Description
str	value name

value_str: str property

Get the control value string

Returns:

Type	Description
str	value string

visible: Union[bool, List[bool]] property writable

Get the visible state of the control

Returns:

Type	Description
Union[bool, List[bool]]	visible state

visible_condition: str property writable

Get the visible condition of the control

Returns:

Type	Description
str	visible condition

visible_function: Optional[Callable[..., bool]] property writable

Get the visible function of the control

Returns:

Type	Description
Optional[Callable[..., bool]]	visible function

width: int property writable

Get the width of the control

Returns:

Type	Description
int	width of the control

Classes

ControlType

Bases: IntEnum

Definition of class ControlType

Functions

__init__(text, value_name, enable_condition, visible_condition, page, expander_name, row_name, value_str, value_list, value_list_2, event_id, control_type=CONTROL, value_index_name='', value_list_start_row=0, value_dialog='', value_list_textids='', as_slider=False, height=22, width=DEFAULT_WIDTH, font_style=2, font_face_code=0, background_color='', row_state_key='', expander_state_key='')

Set the properties of the control

Parameters:

Name	Type	Description	Default
text	str	Text of the control	required
value_name	str	Name of the assigned value from the building element	required
enable_condition	str	Condition for enabled state of the control	required
visible_condition	str	Condition for visible state of the control	required
page	int	page index of the modified property	required
expander_name	str	Expander name	required
row_name	str	row_name	required
value_str	str	Control value as string	required
value_list	str	Text with the values for the combo box list like 1|2|5|7 or	required
value_list_2	str	Second string list separated by | example 1|2|5|7 or	required
event_id	str	event id of the clicked button control	required
control_type	ControlType	Type of the control	CONTROL
value_index_name	str	Index name of the value (in case of list with single value by value index)	''
value_list_start_row	int	Start row of the value list row numbering inside the palette	0
value_dialog	str	Dialog name for the value input	''
value_list_textids	str	text ID's of the value list	''
as_slider	bool	Show the control as slider	False
height	int	Control height in pixel, only used in a row	22
width	int	Control width in pixel, only used in a row	DEFAULT_WIDTH
font_style	int	font style	2
font_face_code	int	font face code	0
background_color	str	Background color in the format "(red, green, blue)" with "(-1, -1, -1)" or "" as default	''
row_state_key	str	row state key	''
expander_state_key	str	expander state key	''

__repr__()

create the string from the values

Returns:

Type	Description
str	string from the values

deep_copy()

deep copy of the data

Returns:

Type	Description
ControlProperties	copied control properties

modify_visible_condition(value_name, condition)

Modify the visible condition

Parameters:

Name	Type	Description	Default
value_name	str	Name of the value	required
condition	str	Visible condition	required

reset_refresh_control()

reset the refresh state of the control

set_member_text(member_name, member_text)

Set the member text of the property member

Parameters:

Name	Type	Description	Default
member_name	str	member name	required
member_text	str	member text	required

set_visible_condition(value_name, condition)

Set the visible condition of the property

Parameters:

Name	Type	Description	Default
value_name	str	Name of the value	required
condition	str	Visible condition	required