Base Interactor

Class full path: BaseInteractor.BaseInteractor

Bases: ABC

base class for a PythonPart interactor

Parameters:

Name	Type	Description	Default
abc		base class	required

Classes

InteractorInputMode

Bases: IntEnum

definition of the interactor modes

Functions

modify_element_property(page, name, value) abstractmethod

Modify property of element

Parameters:

Name	Type	Description	Default
page	int	the page of the property	required
name	str	the name of the property.	required
value	Any	new value for property.	required

on_cancel_function() abstractmethod

Handles the cancel function event (e.g. by ESC, ...)

Returns:

Type	Description
bool	True/False for success.

on_control_event(event_id) abstractmethod

Handles the on control event

Parameters:

Name	Type	Description	Default
event_id	int	event id of button control.	required

on_mouse_leave() abstractmethod

Handles the mouse leave event

on_preview_draw() abstractmethod

Handles the preview draw event

on_value_input_control_enter() abstractmethod

Handles the enter inside the value input control event

Returns:

Type	Description
bool	True/False for success.

process_mouse_msg(mouse_msg, pnt, msg_info) abstractmethod

Handles the process mouse message event

Parameters:

Name	Type	Description	Default
mouse_msg	int	the mouse message.	required
pnt		the input point.	required
msg_info		additional message info.	required

Returns:

Type	Description
bool	True/False for success.