iXBRLViewerPlugin.ui

Module Contents

Classes

BaseViewerDialog

Base class for shared dialog configuration between settings and save dialogs

SaveViewerDialog

Dialog for saving a viewer instance. Initializes with (but doesn’t overwrite) default settings configured in the settings dialog.

SettingsDialog

Dialog for saving default viewer settings.

Data

UNSET_SCRIPT_URL

API

iXBRLViewerPlugin.ui.UNSET_SCRIPT_URL = <Multiline-String>
class iXBRLViewerPlugin.ui.BaseViewerDialog(cntlr)

Bases: tkinter.Toplevel

Base class for shared dialog configuration between settings and save dialogs

Initialization

Construct a toplevel widget with the parent MASTER.

Valid resource names: background, bd, bg, borderwidth, class, colormap, container, cursor, height, highlightbackground, highlightcolor, highlightthickness, menu, relief, screen, takefocus, use, visual, width.

addButtons(frame: tkinter.ttk.Frame, x: int, y: int) → int

Adds base buttons (OK, Cancel) to frame starting at column x on row y. Can be extended to add buttons before or after base buttons.

Parameters:

  • frame – Frame to add buttons to

  • x – Grid column to start at

  • y – Grid row to add buttons on

Returns:

Column x that the last button was added on

addFields(frame: tkinter.ttk.Frame, y: int) → int

Adds base fields to frame starting on row y. Can be extended to add fields before or after base fields.

Parameters:

  • frame – Frame to add fields to

  • y – Grid row to add buttons on

Returns:

Row y that the last field was added on

close(event=None)

Closes the dialog.

confirm(event=None)

Closes the dialog after calling onConfirm.

getTitle() → str
Returns:

Title of dialog window

onConfirm()

Actions to confirm when “OK” button or “Enter” key are pressed. Window is closed immediately after.

render()

Performs the arrangement and rendering if dialog fields and buttons. Process control is held here via wait_window until the dialog is closed.

copyScript()
features()
scriptUrl()
class iXBRLViewerPlugin.ui.SaveViewerDialog(cntlr)

Bases: iXBRLViewerPlugin.ui.BaseViewerDialog

Dialog for saving a viewer instance. Initializes with (but doesn’t overwrite) default settings configured in the settings dialog.

Initialization

Construct a toplevel widget with the parent MASTER.

Valid resource names: background, bd, bg, borderwidth, class, colormap, container, cursor, height, highlightbackground, highlightcolor, highlightthickness, menu, relief, screen, takefocus, use, visual, width.

addFields(frame: tkinter.ttk.Frame, y: int) → int

Adds filename and zip output fields before other settings.

browseForFile()
getTitle() → str
onConfirm()

Saves output-specific config values before triggering instance to be saved.

filename()
zipViewerOutput()
class iXBRLViewerPlugin.ui.SettingsDialog(cntlr)

Bases: iXBRLViewerPlugin.ui.BaseViewerDialog

Dialog for saving default viewer settings.

Initialization

Construct a toplevel widget with the parent MASTER.

Valid resource names: background, bd, bg, borderwidth, class, colormap, container, cursor, height, highlightbackground, highlightcolor, highlightthickness, menu, relief, screen, takefocus, use, visual, width.

addButtons(frame: tkinter.ttk.Frame, x: int, y: int) → int

Adds reset button before OK button

addFields(frame: tkinter.ttk.Frame, y: int) → int

Adds launch-on-load checkbox above other settings

getTitle() → str
onConfirm()

Saves configuration values for saving viewers as well as global viewer behavior settings

reset(event=None)

Resets dialog variable values to default values