Home       Trees       Indices       Help   
Module easygui
[hide private]
[frames] | no frames]

Module easygui

source code

EasyGuiRevisionInfo = "version 0.83 2008-06-12"

EasyGui provides an easy-to-use interface for simple GUI interaction with a user. It does not require the programmer to know anything about tkinter, frames, widgets, callbacks or lambda. All GUI interactions are invoked by simple function calls that return results.

Documentation is in an accompanying file, easygui.txt.

WARNING about using EasyGui with IDLE

You may encounter problems using IDLE to run programs that use EasyGui. Try it and find out. EasyGui is a collection of Tkinter routines that run their own event loops. IDLE is also a Tkinter application, with its own event loop. The two may conflict, with the unpredictable results. If you find that you have problems, try running your program outside of IDLE.

Note that EasyGui requires Tk release 8.0 or greater.

Functions [hide private]
 
dq(s) source code
 
ynbox(msg='Shall I continue?', title=' ', choices=('Yes', 'No'), image=None)
Display a msgbox with choices of Yes and No.		 source code
 
ccbox(msg='Shall I continue?', title=' ', choices=('Continue', 'Cancel'), image=None)
Display a msgbox with choices of Continue and Cancel.		 source code
 
boolbox(msg='Shall I continue?', title=' ', choices=('Yes', 'No'), image=None)
Display a boolean msgbox.		 source code
 
indexbox(msg='Shall I continue?', title=' ', choices=('Yes', 'No'), image=None)
Display a buttonbox with the specified choices.		 source code
 
msgbox(msg='(Your message goes here)', title=' ', buttons='OK', image=None)
Display a messagebox		 source code
 
buttonbox(msg='', title=' ', choices=('Button1', 'Button2', 'Button3'), image=None)
Display a msg, a title, and a set of buttons.		 source code
 
integerbox(msg='', title=' ', default='', argLowerBound=0, argUpperBound=99)
Show a box in which a user can enter an integer.		 source code
 
multenterbox(msg='Fill in values for the fields.', title=' ', fields=(), values=())
Show screen with multiple data entry fields.		 source code
 
multpasswordbox(msg='Fill in values for the fields.', title=' ', fields=(), values=())
Same interface as multenterbox.		 source code
 
__multfillablebox(msg='Fill in values for the fields.', title=' ', fields=(), values=(), argMaskCharacter=None) source code
 
__multenterboxGetText(event) source code
 
__multenterboxCancel(event) source code
 
enterbox(msg='Enter something.', title=' ', default='', strip=True)
Show a box in which a user can enter some text.		 source code
 
passwordbox(msg='Enter your password.', title=' ', default='')
Show a box in which a user can enter a password.		 source code
 
__fillablebox(msg, title='', default='', argMaskCharacter=None)
Show a box in which a user can enter some text.		 source code
 
__enterboxGetText(event) source code
 
__enterboxRestore(event) source code
 
__enterboxCancel(event) source code
 
denyWindowManagerClose()
don't allow WindowManager close		 source code
 
multchoicebox(msg='Pick as many items as you like.', title=' ', choices=(), **kwargs)
Present the user with a list of choices.		 source code
 
choicebox(msg='Pick something.', title=' ', choices=(), buttons=())
Present the user with a list of choices.		 source code
 
__choicebox(msg, title, choices, buttons=())
internal routine to support choicebox() and multchoicebox()		 source code
 
__choiceboxGetChoice(event) source code
 
__choiceboxSelectAll(event) source code
 
__choiceboxClearAll(event) source code
 
__choiceboxCancel(event) source code
 
KeyboardListener(event) source code
 
codebox(msg='', title=' ', text='')
Display some text in a monospaced font, with no line wrapping.		 source code
 
textbox(msg='', title=' ', text='', codebox=0)
Display some text in a proportional font with line wrapping at word breaks.		 source code
 
__textboxOK(event) source code
 
diropenbox(msg=None, title=None, default=None)
A dialog to get a directory name.		 source code
 
fileopenbox(msg=None, title=None, default=None)
A dialog to get a file name.		 source code
 
filesavebox(msg=None, title=None, default=None)
A file to get the name of a file to save.		 source code
 
__buttonEvent(event)
Handle an event that is generated by a person clicking a button.		 source code
 
__put_buttons_in_buttonframe(choices)
Put the buttons in the buttons frame		 source code
 
_test() source code
 
abouteasygui()
shows the easygui revision history		 source code
Variables [hide private]
  EasyGuiRevisionInfo = 'version 0.83 2008-06-12'
  rootWindowPosition = '+300+200'
  DEFAULT_FONT_FAMILY = ('MS', 'Sans', 'Serif')
  MONOSPACE_FONT_FAMILY = 'Courier'
  DEFAULT_FONT_SIZE = 10
  BIG_FONT_SIZE = 12
  SMALL_FONT_SIZE = 9
  CODEBOX_FONT_SIZE = 9
  TEXTBOX_FONT_SIZE = 10
  EASYGUI_ABOUT_INFORMATION = '\n===============================...
Function Details [hide private]

ynbox(msg='Shall I continue?', title=' ', choices=('Yes', 'No'), image=None)

source code 

Display a msgbox with choices of Yes and No.

The default is "Yes".

The returned value is calculated this way: 
       if the first choice ("Yes") is chosen, or if the dialog is cancelled:
               return 1
       else:
               return 0
If invoked without a msg argument, displays a generic request for a confirmation that the user wishes to continue. So it can be used this way: 
       if ynbox(): pass # continue
       else: sys.exit(0)  # exit the program
Parameters:
  • msg - the msg to be displayed.
  • title - the window title
  • choices - a list or tuple of the choices to be displayed

ccbox(msg='Shall I continue?', title=' ', choices=('Continue', 'Cancel'), image=None)

source code 

Display a msgbox with choices of Continue and Cancel.

The default is "Continue".

The returned value is calculated this way: 
       if the first choice ("Continue") is chosen, or if the dialog is cancelled:
               return 1
       else:
               return 0
If invoked without a msg argument, displays a generic request for a confirmation that the user wishes to continue. So it can be used this way: 
       if ccbox():
               pass # continue
       else:
               sys.exit(0)  # exit the program
Parameters:
  • msg - the msg to be displayed.
  • title - the window title
  • choices - a list or tuple of the choices to be displayed

boolbox(msg='Shall I continue?', title=' ', choices=('Yes', 'No'), image=None)

source code 

Display a boolean msgbox.

The default is the first choice.

The returned value is calculated this way: 
       if the first choice is chosen, or if the dialog is cancelled:
               returns 1
       else:
               returns 0

indexbox(msg='Shall I continue?', title=' ', choices=('Yes', 'No'), image=None)

source code 
Display a buttonbox with the specified choices. Return the index of the choice selected.

buttonbox(msg='', title=' ', choices=('Button1', 'Button2', 'Button3'), image=None)

source code 
Display a msg, a title, and a set of buttons. The buttons are defined by the members of the choices list. Return the text of the button that the user selected.
Parameters:
  • msg - the msg to be displayed.
  • title - the window title
  • choices - a list or tuple of the choices to be displayed

integerbox(msg='', title=' ', default='', argLowerBound=0, argUpperBound=99)

source code 

Show a box in which a user can enter an integer.

In addition to arguments for msg and title, this function accepts integer arguments for default_value, lowerbound, and upperbound.

The default_value argument may be None.

When the user enters some text, the text is checked to verify that it can be converted to an integer between the lowerbound and upperbound.

If it can be, the integer (not the text) is returned.

If it cannot, then an error msg is displayed, and the integerbox is redisplayed.

If the user cancels the operation, None is returned.

multenterbox(msg='Fill in values for the fields.', title=' ', fields=(), values=())

source code  

Show screen with multiple data entry fields.

If there are fewer values than names, the list of values is padded with
empty strings until the number of values is the same as the number of names.

If there are more values than names, the list of values
is truncated so that there are as many values as names.

Returns a list of the values of the fields,
or None if the user cancels the operation.

Here is some example code, that shows how values returned from
multenterbox can be checked for validity before they are accepted::
    ----------------------------------------------------------------------
    msg = "Enter your personal information"
    title = "Credit Card Application"
    fieldNames = ["Name","Street Address","City","State","ZipCode"]
    fieldValues = []  # we start with blanks for the values
    fieldValues = multenterbox(msg,title, fieldNames)

    # make sure that none of the fields was left blank
    while 1:
        if fieldValues == None: break
        errmsg = ""
        for i in range(len(fieldNames)):
            if fieldValues[i].strip() == "":
                errmsg = errmsg + ('"%s" is a required field.

' % fieldNames[i])
        if errmsg == "": break # no problems found
        fieldValues = multenterbox(errmsg, title, fieldNames, fieldValues)

    print "Reply was:", fieldValues
    ----------------------------------------------------------------------

@arg msg: the msg to be displayed.
@arg title: the window title
@arg fields: a list of fieldnames.
@arg values:  a list of field values

multpasswordbox(msg='Fill in values for the fields.', title=' ', fields=(), values=())

source code  

Same interface as multenterbox.  But in multpassword box,
the last of the fields is assumed to be a password, and
is masked with asterisks.

Here is some example code, that shows how values returned from
multpasswordbox can be checked for validity before they are accepted::
----------------------------------------------------------------------
msg = "Enter logon information"
title = "Demo of multpasswordbox"
fieldNames = ["Server ID", "User ID", "Password"]
fieldValues = []  # we start with blanks for the values
fieldValues = multpasswordbox(msg,title, fieldNames)

# make sure that none of the fields was left blank
while 1:
    if fieldValues == None: break
    errmsg = ""
    for i in range(len(fieldNames)):
        if fieldValues[i].strip() == "":
            errmsg = errmsg + ('"%s" is a required field.

' % fieldNames[i])
    if errmsg == "": break # no problems found
    fieldValues = multpasswordbox(errmsg, title, fieldNames, fieldValues)

print "Reply was:", fieldValues
----------------------------------------------------------------------

enterbox(msg='Enter something.', title=' ', default='', strip=True)

source code 

Show a box in which a user can enter some text.

You may optionally specify some default text, which will appear in the enterbox when it is displayed.

Returns the text that the user entered, or None if he cancels the operation.

By default, enterbox strips its result (i.e. removes leading and trailing whitespace). (If you want it not to strip, use keyword argument: strip=False.) This makes it easier to test the results of the call: 
       reply = enterbox(....)
       if reply:
               ...
       else:
               ...

passwordbox(msg='Enter your password.', title=' ', default='')

source code 
Show a box in which a user can enter a password. The text is masked with asterisks, so the password is not displayed. Returns the text that the user entered, or None if he cancels the operation.

__fillablebox(msg, title='', default='', argMaskCharacter=None)

source code 
Show a box in which a user can enter some text. You may optionally specify some default text, which will appear in the enterbox when it is displayed. Returns the text that the user entered, or None if he cancels the operation.

multchoicebox(msg='Pick as many items as you like.', title=' ', choices=(), **kwargs)

source code 
Present the user with a list of choices. allow him to select multiple items and return them in a list. if the user doesn't choose anything from the list, return the empty list. return None if he cancelled selection.
Parameters:
  • msg - the msg to be displayed.
  • title - the window title
  • choices - a list or tuple of the choices to be displayed

choicebox(msg='Pick something.', title=' ', choices=(), buttons=())

source code 
Present the user with a list of choices. return the choice that he selects. return None if he cancels the selection selection.
Parameters:
  • msg - the msg to be displayed.
  • title - the window title
  • choices - a list or tuple of the choices to be displayed

codebox(msg='', title=' ', text='')

source code 

Display some text in a monospaced font, with no line wrapping. This function is suitable for displaying code and text that is formatted using spaces.

The text parameter should be a string, or a list or tuple of lines to be displayed in the textbox.

textbox(msg='', title=' ', text='', codebox=0)

source code 

Display some text in a proportional font with line wrapping at word breaks. This function is suitable for displaying general written text.

The text parameter should be a string, or a list or tuple of lines to be displayed in the textbox.

diropenbox(msg=None, title=None, default=None)

source code 

A dialog to get a directory name. Note that the msg argument, if specified, is ignored.

Returns the name of a directory, or None if user chose to cancel.

If the "default" argument specifies a directory name, and that directory exists, then the dialog box will start with that directory.

fileopenbox(msg=None, title=None, default=None)

source code 

A dialog to get a file name. Returns the name of a file, or None if user chose to cancel.

If the "default" argument specifies a file name, then the dialog box will start with that file.

filesavebox(msg=None, title=None, default=None)

source code 

A file to get the name of a file to save. Returns the name of a file, or None if user chose to cancel.

If the "default" argument specifies a file name, then the dialog box will start with that file.

Variables Details [hide private]

EASYGUI_ABOUT_INFORMATION

Value:
'''
======================================================================\
==
version 0.83 2008-06-12
======================================================================\
==

BUG FIXES
...

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0beta1 on Thu Jun 12 22:38:46 2008 http://epydoc.sourceforge.net