# {py:mod}`arelle.Cntlr`

```{py:module} arelle.Cntlr
```

```{autodoc2-docstring} arelle.Cntlr
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Cntlr <arelle.Cntlr.Cntlr>`
  - ```{autodoc2-docstring} arelle.Cntlr.Cntlr
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`resourcesDir <arelle.Cntlr.resourcesDir>`
  - ```{autodoc2-docstring} arelle.Cntlr.resourcesDir
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_ <arelle.Cntlr._>`
  - ```{autodoc2-docstring} arelle.Cntlr._
    :summary:
    ```
* - {py:obj}`osPrcs <arelle.Cntlr.osPrcs>`
  - ```{autodoc2-docstring} arelle.Cntlr.osPrcs
    :summary:
    ```
* - {py:obj}`LOG_TEXT_MAX_LENGTH <arelle.Cntlr.LOG_TEXT_MAX_LENGTH>`
  - ```{autodoc2-docstring} arelle.Cntlr.LOG_TEXT_MAX_LENGTH
    :summary:
    ```
* - {py:obj}`cxFrozen <arelle.Cntlr.cxFrozen>`
  - ```{autodoc2-docstring} arelle.Cntlr.cxFrozen
    :summary:
    ```
````

### API

````{py:data} _
:canonical: arelle.Cntlr._
:type: arelle.typing.TypeGetText
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr._
```

````

````{py:data} osPrcs
:canonical: arelle.Cntlr.osPrcs
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.osPrcs
```

````

````{py:data} LOG_TEXT_MAX_LENGTH
:canonical: arelle.Cntlr.LOG_TEXT_MAX_LENGTH
:value: >
   32767

```{autodoc2-docstring} arelle.Cntlr.LOG_TEXT_MAX_LENGTH
```

````

````{py:data} cxFrozen
:canonical: arelle.Cntlr.cxFrozen
:value: >
   'getattr(...)'

```{autodoc2-docstring} arelle.Cntlr.cxFrozen
```

````

````{py:function} resourcesDir() -> str
:canonical: arelle.Cntlr.resourcesDir

```{autodoc2-docstring} arelle.Cntlr.resourcesDir
```
````

`````{py:class} Cntlr(hasGui: bool = False, logFileName: str | None = None, logFileMode: str | None = None, logFileEncoding: str | None = None, logFormat: str | None = None, uiLang: str | None = None, disable_persistent_config: bool = False, betaFeatures: dict[str, bool] | None = None)
:canonical: arelle.Cntlr.Cntlr

```{autodoc2-docstring} arelle.Cntlr.Cntlr
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.Cntlr.Cntlr.__init__
```

````{py:attribute} __version__
:canonical: arelle.Cntlr.Cntlr.__version__
:value: >
   '1.6.0'

```{autodoc2-docstring} arelle.Cntlr.Cntlr.__version__
```

````

````{py:attribute} betaFeatures
:canonical: arelle.Cntlr.Cntlr.betaFeatures
:type: dict[str, bool]
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.betaFeatures
```

````

````{py:attribute} hasWin32gui
:canonical: arelle.Cntlr.Cntlr.hasWin32gui
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.hasWin32gui
```

````

````{py:attribute} hasGui
:canonical: arelle.Cntlr.Cntlr.hasGui
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.hasGui
```

````

````{py:attribute} hasFileSystem
:canonical: arelle.Cntlr.Cntlr.hasFileSystem
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.hasFileSystem
```

````

````{py:attribute} isGAE
:canonical: arelle.Cntlr.Cntlr.isGAE
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.isGAE
```

````

````{py:attribute} isCGI
:canonical: arelle.Cntlr.Cntlr.isCGI
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.isCGI
```

````

````{py:attribute} systemWordSize
:canonical: arelle.Cntlr.Cntlr.systemWordSize
:type: int
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.systemWordSize
```

````

````{py:attribute} uiLang
:canonical: arelle.Cntlr.Cntlr.uiLang
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.uiLang
```

````

````{py:attribute} configDir
:canonical: arelle.Cntlr.Cntlr.configDir
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.configDir
```

````

````{py:attribute} imagesDir
:canonical: arelle.Cntlr.Cntlr.imagesDir
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.imagesDir
```

````

````{py:attribute} localeDir
:canonical: arelle.Cntlr.Cntlr.localeDir
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.localeDir
```

````

````{py:attribute} pluginDir
:canonical: arelle.Cntlr.Cntlr.pluginDir
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.pluginDir
```

````

````{py:attribute} userAppDir
:canonical: arelle.Cntlr.Cntlr.userAppDir
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.userAppDir
```

````

````{py:attribute} isMac
:canonical: arelle.Cntlr.Cntlr.isMac
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.isMac
```

````

````{py:attribute} isMSW
:canonical: arelle.Cntlr.Cntlr.isMSW
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.isMSW
```

````

````{py:attribute} hasClipboard
:canonical: arelle.Cntlr.Cntlr.hasClipboard
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.hasClipboard
```

````

````{py:attribute} contextMenuClick
:canonical: arelle.Cntlr.Cntlr.contextMenuClick
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.contextMenuClick
```

````

````{py:attribute} hasWebServer
:canonical: arelle.Cntlr.Cntlr.hasWebServer
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.hasWebServer
```

````

````{py:attribute} config
:canonical: arelle.Cntlr.Cntlr.config
:type: dict[str, typing.Any] | None
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.config
```

````

````{py:attribute} configJsonFile
:canonical: arelle.Cntlr.Cntlr.configJsonFile
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.configJsonFile
```

````

````{py:attribute} webCache
:canonical: arelle.Cntlr.Cntlr.webCache
:type: arelle.WebCache.WebCache
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.webCache
```

````

````{py:attribute} modelManager
:canonical: arelle.Cntlr.Cntlr.modelManager
:type: arelle.ModelManager.ModelManager
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.modelManager
```

````

````{py:attribute} logger
:canonical: arelle.Cntlr.Cntlr.logger
:type: logging.Logger | None
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.logger
```

````

````{py:attribute} logHandler
:canonical: arelle.Cntlr.Cntlr.logHandler
:type: logging.Handler
:value: >
   None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.logHandler
```

````

````{py:property} uiLangDir
:canonical: arelle.Cntlr.Cntlr.uiLangDir
:type: str

```{autodoc2-docstring} arelle.Cntlr.Cntlr.uiLangDir
```

````

````{py:property} uiLocale
:canonical: arelle.Cntlr.Cntlr.uiLocale
:type: str | None

```{autodoc2-docstring} arelle.Cntlr.Cntlr.uiLocale
```

````

````{py:method} postLoggingInit(localeSetupMessage: str | None = None) -> None
:canonical: arelle.Cntlr.Cntlr.postLoggingInit

```{autodoc2-docstring} arelle.Cntlr.Cntlr.postLoggingInit
```

````

````{py:method} setUiLanguage(locale: str | None, fallbackToDefault: bool = False) -> None
:canonical: arelle.Cntlr.Cntlr.setUiLanguage

```{autodoc2-docstring} arelle.Cntlr.Cntlr.setUiLanguage
```

````

````{py:method} startLogging(logFileName: str | None = None, logFileMode: str | None = None, logFileEncoding: str | None = None, logFormat: str | None = None, logLevel: str | None = None, logFilters: list[logging.Filter] | None = None, logHandler: logging.Handler | None = None, logToBuffer: bool = False, logTextMaxLength: int | None = None, logRefObjectProperties: bool = True, logXmlMaxAttributeLength: int | None = None, logPropagate: bool | None = None) -> None
:canonical: arelle.Cntlr.Cntlr.startLogging

```{autodoc2-docstring} arelle.Cntlr.Cntlr.startLogging
```

````

````{py:method} setLogLevelFilter(logLevelFilter: str) -> None
:canonical: arelle.Cntlr.Cntlr.setLogLevelFilter

```{autodoc2-docstring} arelle.Cntlr.Cntlr.setLogLevelFilter
```

````

````{py:method} setLogCodeFilter(logCodeFilter: str) -> None
:canonical: arelle.Cntlr.Cntlr.setLogCodeFilter

```{autodoc2-docstring} arelle.Cntlr.Cntlr.setLogCodeFilter
```

````

````{py:method} addToLog(message: str, messageCode: str = '', messageArgs: dict[str, typing.Any] | None = None, file: str = '', refs: list[dict[str, typing.Any]] | None = None, level: int | str = logging.INFO) -> None
:canonical: arelle.Cntlr.Cntlr.addToLog

```{autodoc2-docstring} arelle.Cntlr.Cntlr.addToLog
```

````

````{py:method} showStatus(message: str, clearAfter: int | None = None) -> None
:canonical: arelle.Cntlr.Cntlr.showStatus

```{autodoc2-docstring} arelle.Cntlr.Cntlr.showStatus
```

````

````{py:method} close(saveConfig: bool = False) -> None
:canonical: arelle.Cntlr.Cntlr.close

```{autodoc2-docstring} arelle.Cntlr.Cntlr.close
```

````

````{py:method} saveConfig() -> None
:canonical: arelle.Cntlr.Cntlr.saveConfig

```{autodoc2-docstring} arelle.Cntlr.Cntlr.saveConfig
```

````

````{py:method} viewModelObject(modelXbrl: arelle.ModelXbrl.ModelXbrl, objectId: str) -> None
:canonical: arelle.Cntlr.Cntlr.viewModelObject

```{autodoc2-docstring} arelle.Cntlr.Cntlr.viewModelObject
```

````

````{py:method} reloadViews(modelXbrl: arelle.ModelXbrl.ModelXbrl) -> None
:canonical: arelle.Cntlr.Cntlr.reloadViews

```{autodoc2-docstring} arelle.Cntlr.Cntlr.reloadViews
```

````

````{py:method} rssWatchUpdateOption(**args: typing.Any) -> None
:canonical: arelle.Cntlr.Cntlr.rssWatchUpdateOption

```{autodoc2-docstring} arelle.Cntlr.Cntlr.rssWatchUpdateOption
```

````

````{py:method} onPackageEnablementChanged() -> None
:canonical: arelle.Cntlr.Cntlr.onPackageEnablementChanged

```{autodoc2-docstring} arelle.Cntlr.Cntlr.onPackageEnablementChanged
```

````

````{py:method} internet_user_password(host: str, realm: str) -> tuple[str, str]
:canonical: arelle.Cntlr.Cntlr.internet_user_password

```{autodoc2-docstring} arelle.Cntlr.Cntlr.internet_user_password
```

````

````{py:method} internet_logon(url: str, quotedUrl: str, dialogCaption: str, dialogText: str) -> str
:canonical: arelle.Cntlr.Cntlr.internet_logon

```{autodoc2-docstring} arelle.Cntlr.Cntlr.internet_logon
```

````

````{py:method} clipboardData(text: str | None = None) -> typing.Any
:canonical: arelle.Cntlr.Cntlr.clipboardData

```{autodoc2-docstring} arelle.Cntlr.Cntlr.clipboardData
```

````

````{py:property} memoryUsed
:canonical: arelle.Cntlr.Cntlr.memoryUsed
:type: float | int

```{autodoc2-docstring} arelle.Cntlr.Cntlr.memoryUsed
```

````

````{py:method} workingOnlineOrInCache(url: str) -> bool
:canonical: arelle.Cntlr.Cntlr.workingOnlineOrInCache

```{autodoc2-docstring} arelle.Cntlr.Cntlr.workingOnlineOrInCache
```

````

````{py:method} getPluginData(pluginName: str) -> arelle.utils.PluginData.PluginData | None
:canonical: arelle.Cntlr.Cntlr.getPluginData

```{autodoc2-docstring} arelle.Cntlr.Cntlr.getPluginData
```

````

````{py:method} setPluginData(pluginData: arelle.utils.PluginData.PluginData) -> None
:canonical: arelle.Cntlr.Cntlr.setPluginData

```{autodoc2-docstring} arelle.Cntlr.Cntlr.setPluginData
```

````

````{py:method} _clearPluginData() -> None
:canonical: arelle.Cntlr.Cntlr._clearPluginData

```{autodoc2-docstring} arelle.Cntlr.Cntlr._clearPluginData
```

````

`````