unicodes_api.screen.NavItem

class documentation

class NavItem:

View In Hierarchy

Navigation item class.

Method __init__ initialize NavItem class.
Instance Variable description Navigation item description.
Instance Variable key key integer value.
Instance Variable func main Callback function.
Instance Variable callbacks Additional callback functions.
Instance Variable aliases int key code aliases.
Instance Variable hidden set if menu is hidden.
Property key_name Key name.
Method set_hidden Set menu item to hidden.
Method set_func Set menu item function.
Method add_callback Add to menu item callbacks.
Method add_alias Add key alias.
Method run Run attached function and callbacks for menu item.
def __init__(self, main_key, description):

initialize NavItem class.

Parametersmain_keyUndocumented (type: Any)
descriptionUndocumented (type: str)
description =

Navigation item description.

key =

key integer value.

func =

main Callback function.

callbacks =

Additional callback functions.

(type: List[Callable])
aliases =

int key code aliases.

(type: list)
hidden =

set if menu is hidden.

(type: bool)
@property
key_name =

Key name.

def set_hidden(self):

Set menu item to hidden.

def set_func(self, func):

Set menu item function.

def add_callback(self, func):

Add to menu item callbacks.

def add_alias(self, alias):

Add key alias.

ParametersaliasUndocumented (type: int)
def run(self):

Run attached function and callbacks for menu item.

API Documentation for unicodes_api, generated by pydoctor 21.2.2 at 1996-06-17 15:00:00.