menu Namespace Reference

Classes
class	gb
	The class gb contains global variables and pointers to ease up accessibility in coding the functions of this module. More...

Functions
def	SetTitle
def	Print
	Print a message on the screen. More...
def	Prompt (message)
	Prompt a message, wait for any key to be pressed. More...
def	ShowMenu
	Show menu using entries (1st column) and default (2nd column). More...
def	UpDown (entries, default, inc)
	Allow the cursor to move up and down in the list. More...
def	LeftRight (entries, default, options, inc)
	Allow left/right keys to switch options in the second column and change default values. More...
def	Browse
	Browse a menu with entries (1st column) and default (2nd column, optional) Note: with Python > 2.5 we had some troubles initializing curses more than once. More...
def	Insert (entries, default)
	Similar to Browse, but allow the user to directly input the default values by a reading a string. More...
def	RestoreScreen ()
	Restore screen back to shell functionality. More...
def	CursesIsActive ()
	Return 1 if curses have been activated. More...
def	Print_no_curses (message, sleep, row)
	The next set of functions replicate the previous ones without using curses library. More...
def	Prompt_no_curses (message)
def	Browse_no_curses (entries, default, options)
def	Insert_no_curses (entries, names)

Variables
int	have_curses = 1
tuple	q = raw_input()
tuple	i = entries.index(x)
string	opt_list = ''
tuple	c = raw_input(">> choice ["+default[q]+"] ? ")
tuple	newname = raw_input(">> new name ? ")

Function Documentation

def menu.Browse	(		entries,
			default = [],
			options = []
	)

Browse a menu with entries (1st column) and default (2nd column, optional) Note: with Python > 2.5 we had some troubles initializing curses more than once.

For this reason we prefer to initialize curses only at the beginning.

Definition at line 181 of file menu.py.

def Browse(entries, default=[], options=[]):

  gb.ncol = 1
  if (len(default) > 0): gb.ncol = 2

  for x in sys.argv:  # avoid curses library with the --no-curses option.
    if (x == "--no-curses"):
      return Browse_no_curses(entries, default, options)

#
# window setup will be done just once.
# 
  if (gb.init == 0):
    gb.scrn = curses.initscr()
    curses.noecho()
    curses.cbreak()
    gb.scrn.keypad(1)
    gb.init = 1
  ShowMenu(entries, default)
  while True:
    # get user command
    c  = gb.scrn.getch()
    try:    cc = chr(c)
    except: cc = 0

    if (c == 10): 
#      RestoreScreen()
      return entries[gb.row-gb.rbeg]
    elif (cc == 'q'): 
      RestoreScreen()
#      curses.reset_shell_mode()
      sys.exit()
    elif (cc == 'u' or c == curses.KEY_UP):   UpDown(entries, default, -1)
    elif (cc == 'd' or c == curses.KEY_DOWN): UpDown(entries, default, 1)
    elif (gb.ncol > 1): 
      if (cc == 'r' or c == curses.KEY_RIGHT):
        LeftRight(entries, default, options, 1)
      elif (cc == 'l' or c == curses.KEY_LEFT):  
        LeftRight(entries, default, options, -1)

Here is the call graph for this function:

Here is the caller graph for this function:

def menu.Browse_no_curses	(		entries,
			default,
			options
	)

Definition at line 342 of file menu.py.

def Browse_no_curses(entries,  default, options):
#
#

Here is the caller graph for this function:

def menu.CursesIsActive

(

)

Return 1 if curses have been activated.

Definition at line 312 of file menu.py.

def CursesIsActive():

  return gb.init
  

Here is the caller graph for this function:

def menu.Insert	(		entries,
			default
	)

Similar to Browse, but allow the user to directly input the default values by a reading a string.

Definition at line 227 of file menu.py.

def Insert(entries, default):

  gb.ncol = 2

  for x in sys.argv:  # avoid curses library with the --no-curses option.
    if (x == "--no-curses"):
      return Insert_no_curses(entries, default)

  #
  # window setup will be done just once.
  # 

  if (gb.init == 0):
    gb.scrn = curses.initscr()
    curses.noecho()
    curses.cbreak()
    gb.scrn.keypad(1)
    gb.init = 1

#  entries = []
#  for n in range(num): entries.append(repr(n))

#  RestoreScreen()
#  print default
#  sys.exit()
   
  ShowMenu(entries, default)
  while True:
    c  = gb.scrn.getch()   # get user command
    try:    cc = chr(c)
    except: cc = 0

    if (c == 10): 
      return 
    elif (cc == 'q'): 
      RestoreScreen()
      sys.exit()
    elif (cc == 'u' or c == curses.KEY_UP):   UpDown(entries, default, -1)
    elif (cc == 'd' or c == curses.KEY_DOWN): UpDown(entries, default, 1)
    elif (cc == 'r' or c == curses.KEY_RIGHT):
      curses.echo()
      gb.scrn.addstr(gb.row,gb.cbeg+gb.csep,'                                 ')
      gb.scrn.addstr(gb.row,gb.cbeg+gb.csep,'NAME or VALUE > ',curses.A_UNDERLINE)
      new_name = gb.scrn.getstr()
      i = gb.row-gb.rbeg
      default.pop(i)
      default.insert(i,new_name)
      curses.noecho()
      gb.scrn.clrtoeol()
      ShowMenu(entries,default, gb.row)

   

Here is the call graph for this function:

Here is the caller graph for this function:

def menu.Insert_no_curses	(		entries,
			names
	)

Definition at line 385 of file menu.py.

def Insert_no_curses(entries, names):
#
#

Here is the caller graph for this function:

def menu.LeftRight	(		entries,
			default,
			options,
			inc
	)

Allow left/right keys to switch options in the second column and change default values.

Definition at line 155 of file menu.py.

def LeftRight(entries, default, options, inc):

  i    = gb.row - gb.rbeg 
  idef = options[i].index(default[i])
  nopt = len(options[i])
  if (inc > 0): idef = idef + 1
  if (inc < 0): idef = idef - 1
  if (idef < 0):     idef = nopt-1
  if (idef == nopt): idef = 0

  default[i] = options[i][idef]
  gb.scrn.addstr(gb.row, gb.cbeg          , entries[i], curses.A_REVERSE)
  gb.scrn.addstr(gb.row, gb.cbeg + gb.csep, default[i], curses.A_UNDERLINE)
  gb.scrn.clrtoeol()
  gb.scrn.refresh()

Here is the caller graph for this function:

def menu.Print	(		message,
			sleep = 0.7,
			row = 1
	)

Print a message on the screen.

Definition at line 60 of file menu.py.

def Print (message, sleep=0.7,row=1):

  for x in sys.argv:  # avoid curses library with the --no-curses option.
    if (x == "--no-curses" or gb.init == 0):
      Print_no_curses(message,sleep,row)
      return
  
  if (gb.scrn == None): return   # need this when using test_pluto.py script
  if (row == 1): gb.scrn.erase()
  gb.scrn.addstr(row,1,message, curses.A_BOLD)
  gb.scrn.refresh()
  time.sleep(sleep)

Here is the call graph for this function:

Here is the caller graph for this function:

def menu.Print_no_curses	(		message,
			sleep,
			row
	)

The next set of functions replicate the previous ones without using curses library.

They are intended to provide a simpler way select options through a terminal-based replacement.

Definition at line 324 of file menu.py.

def Print_no_curses(message, sleep, row):

  global xglb
#  if (row == 1): os.system("clear")
  print message
  time.sleep(sleep)

Here is the caller graph for this function:

def menu.Prompt

(

message

)

Prompt a message, wait for any key to be pressed.

Definition at line 78 of file menu.py.

def Prompt (message):

  for x in sys.argv:  # avoid curses library with the --no-curses option.
    if (x == "--no-curses"):
      Prompt_no_curses(message)
      return

  gb.scrn.erase()
  gb.scrn.addstr(1,1,message, curses.A_BOLD)
  gb.scrn.refresh()
  c = gb.scrn.getch()

Here is the call graph for this function:

Here is the caller graph for this function:

def menu.Prompt_no_curses

(

message

)

Definition at line 332 of file menu.py.

def Prompt_no_curses (message):
#
#

Here is the caller graph for this function:

def menu.RestoreScreen

(

)

Restore screen back to shell functionality.

Note that RestoreScreen should be followed by sys.exit() in order to avoid troubleshooting observed with Python > 2.5

Definition at line 287 of file menu.py.

def RestoreScreen():

  for x in sys.argv:  # avoid curses library with the --no-curses option.
    if (x == "--no-curses"):
      return

  curses.reset_shell_mode()
  curses.nocbreak()
  gb.scrn.keypad(0)
  curses.echo()
  curses.endwin()

Here is the caller graph for this function:

def menu.SetTitle	(		title,
			subtitle = ''
	)

Definition at line 50 of file menu.py.

def SetTitle (title, subtitle = ''):
  
  gb.title    = title
  gb.subtitle = subtitle

Here is the caller graph for this function:

def menu.ShowMenu	(		entries,
			default,
			row = 0
	)

Show menu using entries (1st column) and default (2nd column).

row is an optional argument giving the line to be highlighted (default is first line)

Definition at line 98 of file menu.py.

def ShowMenu(entries, default, row=0):
  # display title

  gb.scrn.clear()
  gb.scrn.addstr(0,0,">> "+gb.title+" <<", curses.A_BOLD)
  gb.rbeg = 3
  if (len(gb.subtitle) > 1): 
    gb.scrn.addstr(2,0, gb.subtitle, curses.A_UNDERLINE)
    gb.rbeg = 6

  lastrow = gb.rbeg
  for ln in entries[0:len(entries)]:
    indx = entries.index(ln)
    gb.scrn.addstr(lastrow, gb.cbeg, ln)
    if (gb.ncol == 2): 
      gb.scrn.addstr(lastrow, gb.cbeg + gb.csep, default[indx])
    lastrow += 1

  if (row == 0 or gb.row < gb.rbeg or gb.row > lastrow): 
    gb.row = gb.rbeg  # initial position

  n = gb.row - gb.rbeg
  gb.scrn.addstr(gb.row, gb.cbeg        , entries[n], curses.A_REVERSE)
  if (gb.ncol == 2): gb.scrn.addstr(gb.row, gb.cbeg+gb.csep, default[n], curses.A_UNDERLINE)
  gb.scrn.refresh()

Here is the caller graph for this function:

def menu.UpDown	(		entries,
			default,
			inc
	)

Allow the cursor to move up and down in the list.

Definition at line 130 of file menu.py.

def UpDown(entries, default, inc):
  tmp = gb.row + inc

  # ignore attempts to go off the edge of menu

  if tmp >= gb.rbeg and tmp < (gb.rbeg + len(entries)):
    # unhighlight the current line by rewriting it in default attributes
    gb.scrn.addstr(gb.row, gb.cbeg          , entries[gb.row-gb.rbeg])
    if (gb.ncol == 2): gb.scrn.addstr(gb.row, gb.cbeg + gb.csep, default[gb.row-gb.rbeg])
    # highlight the previous/next line
    gb.row = tmp
    c1 = entries[gb.row-gb.rbeg]
    if (gb.ncol == 2): c2 = default[gb.row-gb.rbeg]
     
    gb.scrn.addstr(gb.row, gb.cbeg          , c1, curses.A_REVERSE)
    if (gb.ncol == 2): gb.scrn.addstr(gb.row, gb.cbeg + gb.csep, c2, curses.A_UNDERLINE)
    gb.scrn.refresh()

Here is the caller graph for this function:

Variable Documentation

tuple menu.c = raw_input(">> choice ["+default[q]+"] ? ")

Definition at line 375 of file menu.py.

int menu.have_curses = 1

Definition at line 16 of file menu.py.

tuple menu.i = entries.index(x)

Definition at line 352 of file menu.py.

tuple menu.newname = raw_input(">> new name ? ")

Definition at line 408 of file menu.py.

string menu.opt_list = ''

Definition at line 369 of file menu.py.

tuple menu.q = raw_input()

Definition at line 339 of file menu.py.