KeyCodes Module

class epyk.core.html.KeyCodes.KeyCode(component: Optional[HtmlModel] = None, source_event: Optional[str] = None, page=None)

alt(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

any(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, source_event: Optional[str] = None)

Trigger event for any keycodes.

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• source_event – Optional. The source component for the event

backspace(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

control(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

custom(rule: str, js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, source_event: Optional[str] = None)

Parameters:

• rule – Bespoke keys combination

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• source_event – Optional. The source component for the event

delete(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Keycode 46, the sup key

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

down(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

enter(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

escape(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Keycode 27, the escape key.

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

get_event()

Return the complete definition for the key event.

key(key_code: int, js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• key_code – The key code

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

left(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

right(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

save(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• source_event – Optional. The source component for the event

shift(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

shift_with(key: str, js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, source_event: Optional[str] = None)

Parameters:

• key (str) –

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• source_event – Optional. The source component for the event

space(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Add an event on the space key.

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

tab(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event

up(js_funcs: Union[list, str], profile: Optional[Union[bool, dict]] = None, reset: bool = False, source_event: Optional[str] = None)

Parameters:

• js_funcs – Javascript functions

• profile – Optional. A flag to set the component performance storage

• reset – Optional. Flag to reset the events sequence

• source_event – Optional. The source component for the event