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

Types

Link copied to clipboard
object Companion

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
open fun resetToDefaultShortcuts()

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)

Properties

Link copied to clipboard
abstract var codePaneFontSize: Float

The desired font size for a CodePane.

Link copied to clipboard
abstract val editorGuideLines: MutableList<Int>

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

Link copied to clipboard
abstract var favorite: String?

The KnownAvailProject.id of the project marked to be opened automatically at launch bypassing the AvailProjectManager or null if only the AvailProjectManager should be opened.

Link copied to clipboard
open val favoriteKnownProject: KnownAvailProject?

The favorite or null if favorite is null.

Link copied to clipboard
open val fileContent: String

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
open val jsonFormattedString: String
Link copied to clipboard
open val jsonPrettyPrintedFormattedString: String
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
abstract val knownProjects: MutableSet<KnownAvailProject>

The set of KnownAvailProjects.

Link copied to clipboard
open val knownProjectsByAlphaAscending: List<KnownAvailProject>

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

Link copied to clipboard
open val knownProjectsByAlphaDescending: List<KnownAvailProject>

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

Link copied to clipboard
open val knownProjectsByLastOpenedAscending: List<KnownAvailProject>

The knownProjects sorted by KnownAvailProject.lastOpened in ascending order.

Link copied to clipboard
open val knownProjectsByLastOpenedDescending: List<KnownAvailProject>

The knownProjects sorted by KnownAvailProject.lastOpened in descending order.

Link copied to clipboard
abstract var palette: String

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

Link copied to clipboard
abstract val serializationVersion: Int

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

Link copied to clipboard
abstract val shortcutSettings: ShortcutSettings
Link copied to clipboard
open val stylingSelection: StylingSelection

The StylingSelection from the globalStylingGroup.

Inheritors

Link copied to clipboard