Module rstk::dialog

Dialogs - various built-in dialogs.

All of the dialogs (apart from the font chooser) are built using a “builder” style. The named function creates a relevant struct value, and then functions on the relevant TkWIDGET struct alter the default values in that struct, until finally calling show will set up and display the dialog.

There is only one font chooser dialog instance, and commands are provided to interact with it directly.

Message boxes

• also see the Tk manual

The message-box is used to set up a simple alert, confirmation or information dialog:

rstk::message_box()
  .OPTION(VALUE) // 0 or more
  .show();

1. message_box is called first, to get the TkMessageBox instance.
2. show must be called last, to set up and display the dialog.
3. zero or more options are added to the message box.

Chooser dialogs

For colours, directories, files and fonts!

Each dialog returns an Option type, with value None if cancelled.

Tk manual pages:

• chooseColor
• chooseDirectory
• getOpenFile (and getSaveFile)
• fontchooser

Structs

• TkColourChooser
  Refers to the settings for TkColourChooser.
• TkDirectoryChooser
  Refers to the settings for TkDirectoryChooser.
• TkMessageBox
  Refers to the settings for TkMessageBox.
• TkOpenFileChooser
  Refers to the settings for TkOpenFileChooser.
• TkSaveFileChooser
  Refers to the settings for TkSaveFileChooser.

Functions

• colour_chooser
  Creates a colour-chooser to complete in builder style.
• directory_chooser
  Creates a directory-chooser to complete in builder style.
• font_chooser_command
  Set the command to be called when a font is chosen.
• font_chooser_font_get
  Get the font for the font-chooser.
• font_chooser_font_set
  Set the font for the font-chooser.
• font_chooser_hide
  Hide the font-chooser, making it not visible.
• font_chooser_parent
  Set the parent widget for the font-chooser.
• font_chooser_show
  Show the font-chooser, making it visible.
• font_chooser_title
  Set the title for the font-chooser.
• font_chooser_visible
  Check if the font-chooser is currently visible.
• message_box
  Creates a message box to complete in builder style.
• open_file_chooser
  Creates an open-file dialog to complete in builder style.
• save_file_chooser
  Creates a save-file dialog to complete in builder style.