10 KiB
Classes
- AtomEnvironment
Pulsar global for dealing with packages, themes, menus, and the window.
An instance of this class is always available as the
atom
global.- Clipboard
Constants
Functions
- beforeEach()
- beforeEach()
- conditionPromise()
- destroy()
- destroyChildren()
- releaseChildren()
- subscribeToRepository()
- updateDiffs()
- beforeEach()
- beforeEach()
- beforeEach()
- conditionPromise()
- beforeEach()
AtomEnvironment
Pulsar global for dealing with packages, themes, menus, and the window.
An instance of this class is always available as the atom
global.
Kind: global class
- AtomEnvironment
- instance
- .clipboard :
Clipboard
- .deserializers :
DeserializerManager
- .views :
ViewRegistry
- .notifications :
NotificationManager
- .config :
Config
- .keymaps :
KeymapManager
- .tooltips :
TooltipManager
- .commands :
CommandRegistry
- .grammars :
GrammarRegistry
- .styles :
StyleManager
- .packages :
PackageManager
- .themes :
ThemeManager
- .menu :
MenuManager
- .contextMenu :
ContextMenuManager
- .project :
Project
- .textEditors :
TextEditorRegistry
- .workspace :
Workspace
- .history :
HistoryManager
- Messaging the User
- .clipboard :
- static
- .preloadPackages ℗
- Event Subscription
- .onDidBeep(callback) ⇒
Disposable
- .onDidBeep(callback) ⇒
- instance
atomEnvironment.clipboard : Clipboard
Kind: instance property of AtomEnvironment
atomEnvironment.deserializers : DeserializerManager
Kind: instance property of AtomEnvironment
atomEnvironment.views : ViewRegistry
Kind: instance property of AtomEnvironment
atomEnvironment.notifications : NotificationManager
Kind: instance property of AtomEnvironment
atomEnvironment.config : Config
Kind: instance property of AtomEnvironment
atomEnvironment.keymaps : KeymapManager
Kind: instance property of AtomEnvironment
atomEnvironment.tooltips : TooltipManager
Kind: instance property of AtomEnvironment
atomEnvironment.commands : CommandRegistry
Kind: instance property of AtomEnvironment
atomEnvironment.grammars : GrammarRegistry
Kind: instance property of AtomEnvironment
atomEnvironment.styles : StyleManager
Kind: instance property of AtomEnvironment
atomEnvironment.packages : PackageManager
Kind: instance property of AtomEnvironment
atomEnvironment.themes : ThemeManager
Kind: instance property of AtomEnvironment
atomEnvironment.menu : MenuManager
Kind: instance property of AtomEnvironment
atomEnvironment.contextMenu : ContextMenuManager
Kind: instance property of AtomEnvironment
atomEnvironment.project : Project
Kind: instance property of AtomEnvironment
atomEnvironment.textEditors : TextEditorRegistry
Kind: instance property of AtomEnvironment
atomEnvironment.workspace : Workspace
Kind: instance property of AtomEnvironment
atomEnvironment.history : HistoryManager
Kind: instance property of AtomEnvironment
atomEnvironment.beep()
Visually and audibly trigger a beep.
Kind: instance method of AtomEnvironment
Category: Messaging the User
Emits: event:beep
AtomEnvironment.preloadPackages ℗
Returns output of preloadPackages()
for this Classes Instance of Packages
.
Kind: static property of AtomEnvironment
Access: private
AtomEnvironment.onDidBeep(callback) ⇒ Disposable
Invoke the given callback whenever ::beep is called.
Kind: static method of AtomEnvironment
Returns: Disposable
- on which .dispose()
can be called to unsubscribe.
Category: Event Subscription
Param | Type | Description |
---|---|---|
callback | function |
Function to be called whenever ::beep is called. |
Clipboard
new Clipboard()
Represents the clipboard used for copying and pasting in Pulsar.
An instance of this class is always available as the atom.clipboard
global.
Example
// returns 'hello'
atom.clipboard.write('hello');
console.log(atom.clipboard.read());
etch
Kind: global constant
Jsx: etch.dom
fs
dalek
assert
beforeEach()
beforeEach()
conditionPromise()
destroy()
Kind: global function
Describe: Handles tear down of destructables and subscriptions.
Does not handle release of memory. This method should only be called
just before this object is freed, and should only tear down the main
object components that are guarunteed to exist at all times.
destroyChildren()
Kind: global function
Describe: Destroys this objects children (non-freeing), it's intended
to be an ease-of use function for maintaing this object. This method
should only tear down objects that are selectively allocated upon
repository discovery.
Example: this.diffs only exists when we have a repository.
releaseChildren()
Kind: global function
Describe: The memory releasing complement function of destroyChildren
.
frees the memory allocated at all child object storage locations
when there is no repository.
subscribeToRepository()
Kind: global function
Describe: handles all subscriptions based on the repository in focus
updateDiffs()
Kind: global function
Describe: Uses text markers in the target editor to visualize
git modifications, additions, and deletions. The current algorithm
just redraws the markers each call.
beforeEach()
beforeEach()
beforeEach()
conditionPromise()
beforeEach()
Kind: global function
Babel: