Dialog windows

Dialog windows are modal - this means that only the specified window is active while it is open This is particularly useful for alert boxes and also pop-up menus

class Dialog(xy=None, size=None, align="center", style=None, buttons=None, message="", cancellable=True, callback=None, transition="popup")

Base: Container

Dialog is a base class you can use to create your own dialogs. Call close to make the dialog disappear. Place widgets with self.panel as the parent, not self

Parameters:
  • xy – position that the dialog will be drawn
  • size – size of the dialog
  • align – one of topleft, left, bottomleft, top, center, bottom, topright, right, bottomright
  • style (Style) – style for this dialog. If None, the dialog will have the default style
  • cancellable (bool) – If true, then the dialog can be closed by clicking outside its area. Any callback specified will be passed None as it’s argument
  • callback (callable) – A callback that will be called when the dialog is closed, one argument is passed, which is whatever the close method is called with.
  • transition –
    • “popup” – the dialog appears on screen as specified by xy, size and align.
    • “slide_left” – the dialog slides in to the left, width as per size, xy and align ignored
    • “slide_right” – the dialog slides in to the right, width as per size, xy and align ignored
    • “slide_left” – the dialog slides in downwards, height as per size, xy and align ignored
    • “slide_left” – the dialog slides in upwards, height as per size, xy and align ignored
Attributes:
  • cancellable – If true, then the dialog can be closed by clicking outside its area. Any callback specified will be passed None as it’s argument
  • callback – A callback that will be called when the dialog is closed, one argument is passed, which is whatever the close method is called with. See Callbacks for more
  • panel – A panel to place widgets on - this allows the dialog to implement the sliding operation
Style Attributes:
 
  • scrollbar_width – width of the scrollbars
  • slider_line_color – color of the line
  • slider_handle_color – color of the handle
close(self, ret_value=None)
Parameters:ret_value – value to be returned to the callback function

Close this modal window and return ret_value to the callback function

run(self)

Runs the dialog in blocking mode - i.e. execution of other code will stop until the dialog has been closed. Scheduled events via once and every will continue to run.

Returns:whatever self.close was called with
class MessageBox(xy=None, size=None, align="center", style=None, buttons=None, message="", cancellable=True, callback=None)

Base: Dialog

A MessageBox allows you to alert the user to simple events, and also ask simple Yes/No type questions

Parameters:
  • xy – position that the dialog will be drawn (in the centre if None)
  • size – size of the dialog, (280x200 if None)
  • align – one of topleft, left, bottomleft, top, center, bottom, topright, right, bottomright
  • style (Style) – style for this MessageBox. If None, the MessageBox will have the default style
  • buttons – A list of labels for buttons to be shown. Three can be displayed with the default window size and button size. Defaults to [“OK”] if None
  • message (string) – Text to display in the MessageBox
  • cancellable (bool) – If true, then the MessageBox can be closed by clicking outside its area. Any callback specified will be passed None as it’s argument
  • callback (callable) – A callback that will be called when the MessageBox is closed, one argument is passed, which is the label of the button that was pressed (or None if cancelled)
Attributes:
  • cancellable – If true, then the MessageBox can be closed by clicking outside its area. Any callback specified will be passed None as it’s argument
  • callback – A callback that will be called when the MessageBox is closed, one argument is passed, which is the label of the button that was pressed (or None if cancelled) See Callbacks for more
Style Attribute:
 
  • bg_color – background color
  • button_color – color of buttons when not pressed
  • button_pressed_color – color to use when button pressed
  • button_rounding – rounding in pixels of button corners. use 0 for square corners
  • button_text_color – color to use for button text
  • button_text_font – font to use (default font if None)
  • button_text_font_size – font size to use
  • messagebox_button_size – size to use for buttons
  • statictext_color – color to use for message text
  • statictext_font – font to use (default font if None)
  • statictext_font_size – font size to use
Example:
Find out if the user likes cheese
    def cb(name,value=None):
        print name, value

    gui.MessageBox(message="Do you like cheese?",
                   buttons=["Yes","No","Maybe"],
                   cancellable=False,
                   callback = lambda x:cb("Cheese?",x))
message_box(xy=None, size=None, align="center", style=None, buttons=None, message="", cancellable=True)

Utility function. Call this to create a message_box, wait until a button is pressed, and return the value of that button (or None if cancellable is true and the user clicks outside the box)

Parameters:
  • xy – position that the dialog will be drawn (in the centre if None)
  • size – size of the dialog, (280x200 if None)
  • align – one of topleft, left, bottomleft, top, center, bottom, topright, right, bottomright
  • style (Style) – style for this MessageBox. If None, the MessageBox will have the default style
  • buttons – A list of labels for buttons to be shown. Three can be displayed with the default window size and button size. Defaults to [“OK”] if None
  • message (string) – Text to display in the MessageBox
  • cancellable (bool) – If true, then the MessageBox can be closed by clicking outside its area. Any callback specified will be passed None as it’s argument
Example:
Find out if the user likes cheese
    cheese_preference = gui.message_box(message="Do you like cheese?",
                                        buttons=["Yes","No","Maybe"])
class PopupMenu(xy, style=None, cancellable=True, menu_items=None, button_size=None)

Base: Dialog

A PopupMenu (also known as a context menu) allows you to present the user with a menu

Parameters:
  • xy – position for the topleft of the menu. However, the menu may be adjusted so that it fits on the screen. If the menu is so long that it cannot fit on the screen, a scrollbar will be provided
  • style (Style) – style for this PopupMenu. If None, the PopupMenu will have the default style
  • cancellable (bool) – If true, then the PopupMenu can be closed by clicking outside its area.
  • menu_items – is a list of the form [(label,callback)...], one for each entry in the menu. callback takes no arguments and will be called if that menu item selected.
  • button_size – a size parameter for each button in the popupmenu. If none, button_size will be taken from the style.
Attributes:

None
Style Attributes:
 
  • bg_color – background color
  • button_pressed_color – color to use when menu item pressed
  • button_text_color – color to use for text
  • button_text_font – font to use (default)
  • button_text_font_size – font size to use
  • popup_bg_color – color for the background of the popup
  • popupmenu_button_size – default size for the menu items
  • popupmenu_button_class – set this to define a custom button class (for example if you want to add icons etc to it). This class must have the same __init__ parameters as Button.
Example:
Bring up a Popup prompting to Open or Save
    def open_fn():
        print "open"

    def save_fn():
        print "save"

    gui.PopupMenu((160,100), menu_items = [("Open",open_fn), ("Save",save_fn)])