arelle.CntlrWinMain

This module is Arelle’s controller in windowing interactive UI mode

See COPYRIGHT.md for copyright information.

Module Contents

Classes

CntlrWinMain
WinMainLogHandler
TkinterCallWrapper	Replacement for internal tkinter class. Stores function to call when some user defined Tcl function is called e.g. after an event occurred.

Functions

deferMenuCommands	Make every Tk menu command run after the native menu action that invoked it has returned.
main

Data

restartMain
DOCUMENTATION_URL

API

arelle.CntlrWinMain.restartMain

True

arelle.CntlrWinMain.DOCUMENTATION_URL

‘https://arelle.readthedocs.io/’

class arelle.CntlrWinMain.CntlrWinMain(parent: tkinter.Tk)

Bases: arelle.Cntlr.Cntlr

Initialization

config: dict[str, Any]

None

buildValidateDuplicateFactsMenu(validateMenu: tkinter.Menu) → None

onTabChanged(event: Any, *args: Any) → None

loadFileMenuHistory() → None

onPackageEnablementChanged() → None

fileNew(*ignore: Any) → None

getViewAndModelXbrl() → tuple[Any, Any]

okayToContinue() → bool

fileSave(event: Any = None, view: Any = None, fileType: str | None = None, filenameFromInstance: bool = False, method: Any = None, caption: str | None = None, *ignore: Any) → Any

fileSaveExistingFile(event: Any = None, view: Any = None, fileType: str | None = None, *ignore: Any) → Any

saveDTSpackage() → None

fileOpen(*ignore: Any) → None

importFileOpen(*ignore: Any) → bool | None

updateFileHistory(url: Any, importToDTS: bool) → None

fileOpenFile(filename: Any, importToDTS: bool = False, selectTopView: bool = False) → None

webOpen(*ignore: Any) → None

importWebOpen(*ignore: Any) → bool | None

backgroundLoadXbrl(filesource: Any, entrypointFiles: list[dict[str, Any]], importToDTS: bool, selectTopView: bool) → None

showLoadedXbrl(modelXbrl: Any, attach: bool, selectTopView: bool = False, isSupplementalModelXbrl: bool = False) → None

saveXmlInstance() → None

showFormulaOutputInstance(priorOutputInstance: arelle.ModelXbrl.ModelXbrl, currentOutputInstance: arelle.ModelXbrl.ModelXbrl) → None

showProfileStats() → None

clearProfileStats() → None

fileClose(*ignore: Any) → None

fileReopen(*ignore: Any) → None

validate() → None

backgroundValidate() → None

compareDTSes() → bool | None

backgroundCompareDTSes(versReportFile: str) → None

showComparedDTSes(modelVersReport: arelle.ModelXbrl.ModelXbrl) → None

loadFile(filename: str) → None

quit(event: Any = None, restartAfterQuit: bool = False) → None

restart(event: Any = None) → None

setValidateDuplicateFacts(*args: Any) → None

setWorkOffline(*args: Any) → None

setInternetRecheck(*args: Any) → None

setNoCertificateCheck(*args: Any) → None

internetConnectionTimeout() → None

confirmClearWebCache() → None

manageWebCache() → None

setupProxy() → None

setupUserAgent() → None

setValidateDisclosureSystem(*args: Any) → None

promptForDisclosureSystemIfUnset() → None

selectDisclosureSystem(*args: Any) → None

formulaParametersDialog(*args: Any) → None

rssWatchOptionsDialog(*args: Any) → None

rssWatchControl(start: bool = False, stop: bool = False, close: bool = False) → bool | None

rssWatchUpdateOption(latestPubDate: Any = None) → None

uiRssWatchUpdateOption(latestPubDate: Any) → None

languagesDialog(*args: Any) → None

setValidateTooltipText() → None

setCalcChoiceEnumVar(*args: Any) → None

setBaseTaxonomyValidationModeEnumVar(*args: Any) → None

setValidateUtr(*args: Any) → None

setValidateXmlOim(*args: Any) → None

setValidateTableConstraintsSkipLoading(*args: Any) → None

setValidateAllFilesAsReportPackages(*args: Any) → None

setValidateAllFilesAsTaxonomyPackages(*args: Any) → None

setCollectProfileStats(*args: Any) → None

setShowDebugMessages(*args: Any) → None

find(*args: Any) → None

openOnlineDocumentation(event: Any = None) → None

helpAbout(event: Any = None) → None

addToLog(message: str, messageCode: str = '', messageArgs: dict[str, Any] | None = None, file: str = '', refs: list[dict[str, Any]] | None = None, level: int | str = logging.INFO) → None

uiAddToLog(message: str) → None

logClear(*ignore: Any) → None

logSelect(*ignore: Any) → None

logSaveToFile(*ignore: Any) → bool

viewModelObject(modelXbrl: arelle.ModelXbrl.ModelXbrl, objectId: str) → None

uiViewModelObject(modelXbrl: arelle.ModelXbrl.ModelXbrl, objectId: str) → None

reloadViews(modelXbrl: arelle.ModelXbrl.ModelXbrl) → None

uiReloadViews(modelXbrl: arelle.ModelXbrl.ModelXbrl) → None

showStatus(message: str, clearAfter: int | None = None) → None

uiClearStatusTimerEvent() → None

uiShowStatus(message: str, clearAfter: int | None = None) → None

internet_user_password(host: str, realm: str) → Any

internet_logon(url: str, quotedUrl: str, dialogCaption: str, dialogText: str) → Any

waitForUiThreadQueue() → None

uiThreadChecker(widget: Any, delayMsecs: int = 100) → None

uiFileDialog(action: str, title: str | None = None, initialdir: str | None = None, filetypes: list[tuple[str, str]] = [], defaultextension: str | None = None, owner: tkinter.Tk | None = None, multiple: bool = False, parent: tkinter.Tk | None = None) → Any

class arelle.CntlrWinMain.WinMainLogHandler(cntlr: arelle.CntlrWinMain.CntlrWinMain)

Bases: logging.Handler

startLogBuffering() → None

endLogBuffering() → None

flush() → None

Nothing to flush

emit(logRecord: logging.LogRecord) → None

get_name()

set_name(name)

name

‘property(…)’

createLock()

acquire()

release()

setLevel(level)

format(record)

handle(record)

setFormatter(fmt)

close()

handleError(record)

addFilter(filter)

removeFilter(filter)

filter(record)

class arelle.CntlrWinMain.TkinterCallWrapper(func: Any, subst: Any, widget: Any)

Replacement for internal tkinter class. Stores function to call when some user defined Tcl function is called e.g. after an event occurred.

Initialization

Store FUNC, SUBST and WIDGET as members.

arelle.CntlrWinMain.deferMenuCommands() → None

Make every Tk menu command run after the native menu action that invoked it has returned.

On macOS 27, a Tk modal dialog opened while the menu bar’s action is still on the stack stops receiving events and hangs the app (https://core.tcl-lang.org/tk/tktview/33b3af1cea). Remove once a Tk release with the fix is in use.

arelle.CntlrWinMain.main() → None