unicodes_api.screen.BidirectionalIterator

class documentation

class BidirectionalIterator(ABC):

Known subclasses: unicodes_api.screen.BidirectionalNewIterator, unicodes_api.screen.BidirectionalStaticRevolvingIterator, unicodes_api.screen.BidirectionalStaticStopIterator

View In Hierarchy

Base class Terminal keypress class that allows you to navigate collections.

Class Variable NAME subcommand name.
Class Variable PAD_MAX_HEIGHT initial setting of curses window size.
Method __init__ Init class.
Instance Variable popts Parser options.
Instance Variable is_mouse initial setting for enabling/disabling mouse interaction.
Instance Variable args future argparse.Namespace value.
Instance Variable highlight_vals values to hightlight.
Instance Variable height terminal max height.
Instance Variable width terminal max width.
Instance Variable nav Navigation group.
Instance Variable items output lines.
Method mouse_callback setup argparse options.
Method setup_popts setup argparse options.
Method set_args Set argparse args.
Method toggle_mouse toggle mouse switch.
Method setup Run setup before run.
Instance Variable collection collection of values.
Instance Variable index Current collection value.
Instance Variable txt supplemental messages.
Instance Variable kp initial key press value.
Method getch Get next keypress.
Method next menu item next.
Method prev menu item previous.
Property current_value return current value.
Static Method get_input Get user input through the user interface and return it.
Method pad_refresh Refresh screen.
Method mouseclick Scrolling the window when pressing up/down arrow keys
Method scroll Scrolling the window when pressing up/down arrow keys
Instance Variable pad_pos initial pad position.
Instance Variable win Main curses window.
Instance Variable pad pad value.
Method run Run cli command.
Method _print_menu Output text.
Method _trywrite Attempt to write, and pass if failure occurs.
Method _dowrite perform a bunch of operations to ensure the curses screen renders properly.
Static Method _get_mouse_breakout Get character / word / line from where the mouse is clicked.
Method _run run program (for reals).
NAME =
overridden in unicodes_api.cli.HackerMixerInteractive, unicodes_api.cli.InteractAllGroups

subcommand name.

(type: str)
PAD_MAX_HEIGHT =

initial setting of curses window size.

(type: int)
def __init__(self):
overridden in unicodes_api.cli.InteractAllGroups

Init class.

popts =

Parser options.

is_mouse =
overridden in unicodes_api.cli.HackerMixerInteractive

initial setting for enabling/disabling mouse interaction.

(type: bool)
args =

future argparse.Namespace value.

highlight_vals =

values to hightlight.

(type: list)
height =

terminal max height.

width =

terminal max width.

nav =

Navigation group.

items =

output lines.

@abstractmethod
def mouse_callback(self, value):
overridden in unicodes_api.cli.HackerMixerInteractive, unicodes_api.cli.InteractAllGroups

setup argparse options.

@abstractmethod
def setup_popts(self):
overridden in unicodes_api.cli.HackerMixerInteractive, unicodes_api.cli.InteractAllGroups

setup argparse options.

def set_args(self, args):

Set argparse args.

ParametersargsUndocumented (type: argparse.Namespace)
def toggle_mouse(self):

toggle mouse switch.

def setup(self):
overridden in unicodes_api.screen.BidirectionalNewIterator, unicodes_api.screen.BidirectionalStaticRevolvingIterator, unicodes_api.screen.BidirectionalStaticStopIterator

Run setup before run.

collection =
overridden in unicodes_api.screen.BidirectionalStaticRevolvingIterator, unicodes_api.screen.BidirectionalStaticStopIterator

collection of values.

(type: list)
index =
overridden in unicodes_api.screen.BidirectionalStaticRevolvingIterator, unicodes_api.screen.BidirectionalStaticStopIterator

Current collection value.

(type: int)
txt =
overridden in unicodes_api.cli.HackerMixerInteractive, unicodes_api.cli.InteractAllGroups

supplemental messages.

(type: list)
kp =

initial key press value.

(type: str)
def getch(self):

Get next keypress.

@abstractmethod
def next(self):
overridden in unicodes_api.screen.BidirectionalNewIterator, unicodes_api.screen.BidirectionalStaticRevolvingIterator, unicodes_api.screen.BidirectionalStaticStopIterator

menu item next.

@abstractmethod
def prev(self):
overridden in unicodes_api.screen.BidirectionalNewIterator, unicodes_api.screen.BidirectionalStaticRevolvingIterator, unicodes_api.screen.BidirectionalStaticStopIterator

menu item previous.

@property
current_value =

return current value.

def _print_menu(self):
overridden in unicodes_api.cli.HackerMixerInteractive, unicodes_api.cli.InteractAllGroups

Output text.

@staticmethod
def get_input(prompt):

Get user input through the user interface and return it.

def _trywrite(self, *args):

Attempt to write, and pass if failure occurs.

def _dowrite(self):

perform a bunch of operations to ensure the curses screen renders properly.

def pad_refresh(self):

Refresh screen.

@staticmethod
def _get_mouse_breakout(line, y):

Get character / word / line from where the mouse is clicked.

ParameterslineUndocumented (type: bytes)
yUndocumented
def mouseclick(self):

Scrolling the window when pressing up/down arrow keys

def scroll(self, direction):

Scrolling the window when pressing up/down arrow keys

pad_pos =

initial pad position.

(type: int)
def _run(self, win):

run program (for reals).

win =

Main curses window.

(type: curses.window)
pad =

pad value.

def run(self):

Run cli command.

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