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

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

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

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

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

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", "lowerbound", and "upperbound".

The default 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.

NOTE that the "argLowerBound" and "argUpperBound" arguments are no longer supported. They have been replaced by "upperbound" and "lowerbound".

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 += ('"%s" is a required field.\n\n' % fieldNames[i])
               if errmsg == "":
                       break # no problems found
               fieldValues = multenterbox(errmsg, title, fieldNames, fieldValues)

       writeln("Reply was: %s" % str(fieldValues))
       ----------------------------------------------------------------------

Parameters:

• msg - the msg to be displayed.
• title - the window title
• fields - a list of fieldnames.
• values - a list of field values

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

Example

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.\n\n' % fieldNames[i])
                       if errmsg == "": break # no problems found
               fieldValues = multpasswordbox(errmsg, title, fieldNames, fieldValues)

       writeln("Reply was: %s" % str(fieldValues))

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:
               ...

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.

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

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

Display a box that gives information about an exception that has just been raised.

The caller may optionally pass in a title for the window, or a msg to accompany the error information.

Note that you do not need to (and cannot) pass an exception object as an argument. The latest exception will automatically be used.

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.

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.

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.

A dialog to get a file name.

About the "default" argument

The "default" argument specifies a filepath that (normally) contains one or more wildcards. fileopenbox will display only files that match the default filepath. If omitted, defaults to "*" (all files in the current directory).

WINDOWS EXAMPLE:

       ...default="c:/myjunk/*.py"

will open in directory c:\myjunk\ and show all Python files.

WINDOWS EXAMPLE:

       ...default="c:/myjunk/test*.py"

will open in directory c:\myjunk\ and show all Python files whose names begin with "test".

Note that on Windows, fileopenbox automatically changes the path separator to the Windows path separator (backslash).

About the "filetypes" argument

If specified, it should contain a list of items, where each item is either:

       - a string containing a filemask          # e.g. "*.txt"
       - a list of strings, where all of the strings except the last one
               are filemasks (each beginning with "*.",
               such as "*.txt" for text files, "*.py" for Python files, etc.).
               and the last string contains a filetype description

EXAMPLE:

       filetypes = ["*.css", ["*.htm", "*.html", "HTML files"]  ]

NOTE THAT

If the filetypes list does not contain ("All files","*"), it will be added.

If the filetypes list does not contain a filemask that includes the extension of the "default" argument, it will be added. For example, if default="*abc.py" and no filetypes argument was specified, then "*.py" will automatically be added to the filetypes argument.

Parameters:

• msg - the msg to be displayed.
• title - the window title
• default - filepath with wildcards
• filetypes - filemasks that a user can choose, e.g. "*.txt"

Returns: string or None

the name of a file, or None if user chose to cancel

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

The "default" argument should contain a filename (i.e. the current name of the file to be saved). It may also be empty, or contain a filemask that includes wildcards.

The "filetypes" argument works like the "filetypes" argument to fileopenbox.