GlobalEnvironmentSettings

interface GlobalEnvironmentSettings : JSONFriendly

The interface that defines the state expected of the configuration for the Avail environment on a specific machine. This data is stored in the envSettingsHome directory across multiple files.

Author

Richard Arriaga

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract var codePaneFontSize: Float

The desired font size for a CodePane.

Link copied to clipboard

The list of character positions to draw an editor guide line.

Link copied to clipboard
Link copied to clipboard
abstract val favorites: MutableSet<String>

The list of KnownAvailProject.ids of the projects marked to be opened automatically at launch bypassing the AvailProjectManager or null if only the AvailProjectManager should be opened.

Link copied to clipboard

The String contents of this GlobalEnvironmentSettings that can be written to disk.

Link copied to clipboard
abstract var font: String

The desired font for a CodePane.

Link copied to clipboard
Link copied to clipboard

The map of KeyboardShortcutOverride.actionMapKey to KeyboardShortcut that override the default key combinations for the listed KeyboardShortcuts.

Link copied to clipboard
Link copied to clipboard

The knownProjects sorted by KnownAvailProject.name in ascending alphabetical order.

Link copied to clipboard

The knownProjects sorted by KnownAvailProject.name in descending alphabetical order.

Link copied to clipboard
abstract var palette: String

The name of the Palette from globalStylingGroup to use for styling.

Link copied to clipboard

The serialization version of this GlobalEnvironmentSettings which represents the structure of the JSONFriendly-based configuration file that represents this GlobalEnvironmentSettings.

Link copied to clipboard
Link copied to clipboard
open val stylingSelection: StylingSelection

The StylingSelection from the globalStylingGroup.

Functions

Link copied to clipboard
open fun add(project: AvailProject, path: String)

Add the provided AvailProject to this GlobalEnvironmentSettings as a KnownAvailProject.

Link copied to clipboard
open fun removeProject(id: String)

Remove the KnownAvailProject with the given KnownAvailProject.id.

Link copied to clipboard

Reset the keyboardShortcutOverrides to the defaults. This clears all current keyboardShortcutOverrides.

Link copied to clipboard
open fun saveToDisk()

Write this GlobalEnvironmentSettings to disk.

Link copied to clipboard
abstract fun writeTo(writer: JSONWriter)