Skip to content

Latest commit

 

History

History
99 lines (68 loc) · 2.55 KB

PreferencesManager.md

File metadata and controls

99 lines (68 loc) · 2.55 KB

Import :

const PreferencesManager = brackets.getModule("preferences/PreferencesManager")

AppInit

PreferencesManager

Kind: global variable

CURRENT_PROJECT : Object

Context to look up preferences in the current project.

Kind: global variable

scopeOrderWithProject

Cached copy of the scopeOrder with the project Scope

Kind: global variable

scopeOrderWithoutProject

Cached copy of the scopeOrder without the project Scope

Kind: global variable

STATE_PROJECT_CONTEXT : string

State project context

Kind: global variable

STATE_GLOBAL_CONTEXT : string

State global context

Kind: global variable

STATE_PROJECT_THEN_GLOBAL_CONTEXT : string

Project then global context

Kind: global variable

PROJECT_SCOPE : Object

Project scope

Kind: global variable

getUserPrefFile() ⇒ string

Get the full path to the user-level preferences file.

Kind: global function
Returns: string - Path to the preferences file

getExtensionPrefs(prefix)

Creates an extension-specific preferences manager using the prefix given. A . character will be appended to the prefix. So, a preference named foo with a prefix of myExtension will be stored as myExtension.foo in the preferences files.

Kind: global function

Param Type Description
prefix string Prefix to be applied

getViewState(id, [context])

Convenience function that gets a view state

Kind: global function

Param Type Description
id string preference to get
[context] Object Optional additional information about the request

setViewState(id, value, [context])

Convenience function that sets a view state and then saves the file

Kind: global function

Param Type Description
id string preference to set
value * new value for the preference
[context] Object Optional additional information about the request