diff --git a/docs/Atom.html b/docs/Atom.html index e779ee047..b54a7e75d 100644 --- a/docs/Atom.html +++ b/docs/Atom.html @@ -1,6 +1,7 @@ --- layout: docs title: Atom +edit_url: "https://github.com/nylas/N1/blob/master/src/atom.coffee" ---

Summary

@@ -29,12 +30,12 @@ title: Atom

onDidBeep(callback)

- +

Invoke the given callback whenever beep is called.

- + Parameters @@ -46,13 +47,13 @@ title: Atom callback
- +

Function to be called whenever beep is called.

- +
- + Returns @@ -64,13 +65,13 @@ title: Atom

onWillThrowError(callback)

- +

Invoke the given callback when there is an unhandled error, but before the devtools pop open

- + Parameters
@@ -82,13 +83,13 @@ title: Atom callback
- +

Function to be called whenever there is an unhandled error

- +
- + Returns @@ -100,12 +101,12 @@ title: Atom

onDidThrowError(callback)

- +

Invoke the given callback whenever there is an unhandled error.

- + Parameters
@@ -117,13 +118,13 @@ title: Atom callback
- +

Function to be called whenever there is an unhandled error

- +
- + Returns @@ -135,7 +136,7 @@ title: Atom

trace()

- +

Run the Chromium content-tracing module for five seconds, and save the output to a file which is printed to the command-line output of the app. @@ -144,48 +145,48 @@ title: Atom Tools Profiler, but for all processes and threads.

- - + +

inDevMode()

- +

Is the current window in development mode?

- - + +

inSafeMode()

- +

Is the current window in safe mode?

- - + +

inSpecMode()

- +

Is the current window running specs?

- - + +

getVersion()

- +

Get the version of the Atom application.

- - + + Returns
@@ -197,25 +198,25 @@ title: Atom

isReleasedVersion()

- +

Determine whether the current version is an official release.

- - + +

getWindowLoadTime()

- +

Get the time taken to completely load the current window.

This time include things like loading and activating packages, creating DOM elements for the editor, and reading the config.

- - + + Returns
@@ -228,23 +229,23 @@ title: Atom

close()

- +

Close the current window.

- - + +

getSize()

- +

Get the size of current window.

- - + + Returns
@@ -256,12 +257,12 @@ title: Atom

setSize(widthheight)

- +

Set the size of current window.

- + Parameters
@@ -273,9 +274,9 @@ title: Atom width @@ -283,22 +284,22 @@ title: Atom height
- +

The Number of pixels.

- +
- +

The Number of pixels.

- +
- +

setSizeAnimated(widthheightduration)

- +

Transition and set the size of the current window.

- + Parameters @@ -310,9 +311,9 @@ title: Atom width @@ -320,9 +321,9 @@ title: Atom height @@ -330,23 +331,23 @@ title: Atom duration
- +

The Number of pixels.

- +
- +

The Number of pixels.

- +
- +

The Number of pixels.

- +
- +

getPosition()

- +

Get the position of current window.

- - + + Returns @@ -358,12 +359,12 @@ title: Atom

setPosition(xy)

- +

Set the position of current window.

- + Parameters
@@ -375,9 +376,9 @@ title: Atom x @@ -385,77 +386,77 @@ title: Atom y
- +

The Number of pixels.

- +
- +

The Number of pixels.

- +
- +

center()

- +

Move current window to the center of the screen.

- - + +

focus()

- +

Focus the current window.

- - + +

show()

- +

Show the current window.

- - + +

hide()

- +

Hide the current window.

- - + +

reload()

- +

Reload the current window.

- - + +

getWindowProps()

- +

The windowProps passed when creating the window via newWindow.

- - + +

onWindowPropsReceived()

- +

If your package declares hot-loaded window types, onWindowPropsReceived fires when your hot-loaded window is about to be shown so you can update @@ -466,67 +467,67 @@ title: Atom

- - + +

isMaximixed()

- +

Is the current window maximized?

- - + +

isFullScreen()

- +

Is the current window in full screen mode?

- - + +

setFullScreen()

- +

Set the full screen state of the current window.

- - + +

toggleFullScreen()

- +

Toggle the full screen state of the current window.

- - + +

beep()

- +

Visually and audibly trigger a beep.

- - + +

confirm(options)

- +

A flexible way to open a dialog akin to an alert dialog.

- + Parameters @@ -538,13 +539,13 @@ title: Atom options
- +

An Object with the following keys:

- +
- + Returns @@ -556,31 +557,28 @@ title: Atom

openDevTools()

- +

Open the dev tools for the current window.

- - + +

toggleDevTools()

- +

Toggle the visibility of the dev tools for the current window.

- - + +

executeJavaScriptInDevTools()

- +

Execute code in dev tools.

- - - diff --git a/docs/BufferedNodeProcess.html b/docs/BufferedNodeProcess.html index e99df5c6a..b851bf180 100644 --- a/docs/BufferedNodeProcess.html +++ b/docs/BufferedNodeProcess.html @@ -1,6 +1,7 @@ --- layout: docs title: BufferedNodeProcess +edit_url: "https://github.com/nylas/N1/blob/master/src/buffered-node-process.coffee" ---

Summary

@@ -24,12 +25,12 @@ to run.

constructor(options)

- +

Runs the given Node script by spawning a new child process.

- + Parameters
@@ -41,11 +42,9 @@ to run.

options
- +

An Object with the following keys:

- +
- - diff --git a/docs/BufferedProcess.html b/docs/BufferedProcess.html index eda0ce7cc..146a65494 100644 --- a/docs/BufferedProcess.html +++ b/docs/BufferedProcess.html @@ -1,6 +1,7 @@ --- layout: docs title: BufferedProcess +edit_url: "https://github.com/nylas/N1/blob/master/src/buffered-process.coffee" ---

Summary

@@ -26,12 +27,12 @@ Node's ChildProcess.

constructor(options)

- +

Runs the given command by spawning a new child process.

- + Parameters @@ -43,17 +44,17 @@ Node's ChildProcess.

options
- +

An Object with the following keys:

- +
- +

onWillThrowError(callback)

- +

Will call your callback when an error will be raised by the process. Usually this is due to the command not being available or not on the PATH. @@ -61,7 +62,7 @@ Node's ChildProcess.

that you have handled this error.

- + Parameters @@ -73,13 +74,13 @@ Node's ChildProcess.

callback
- +

Function callback

- +
- + Returns @@ -91,11 +92,8 @@ Node's ChildProcess.

kill()

- +

Terminate the process.

- - - diff --git a/docs/Clipboard.html b/docs/Clipboard.html index f90d4d5a6..ed4e7b903 100644 --- a/docs/Clipboard.html +++ b/docs/Clipboard.html @@ -1,6 +1,7 @@ --- layout: docs title: Clipboard +edit_url: "https://github.com/nylas/N1/blob/master/src/clipboard.coffee" ---

Summary

@@ -23,14 +24,14 @@ title: Clipboard

write(textmetadata)

- +

Write the given text to the clipboard.

The metadata associated with the text is available by calling readWithMetadata.

- + Parameters
@@ -42,9 +43,9 @@ title: Clipboard text @@ -52,23 +53,23 @@ title: Clipboard metadata
- +

The String to store.

- +
- +

The additional info to associate with the text.

- +
- +

read()

- +

Read the text from the clipboard.

- - + + Returns @@ -80,14 +81,14 @@ title: Clipboard

readWithMetadata()

- +

Read the text from the clipboard and return both the text and the associated metadata.

- - + + Returns
@@ -100,4 +101,3 @@ title: Clipboard
- diff --git a/docs/Color.html b/docs/Color.html index 22bc68737..8c2854f9c 100644 --- a/docs/Color.html +++ b/docs/Color.html @@ -1,6 +1,7 @@ --- layout: docs title: Color +edit_url: "https://github.com/nylas/N1/blob/master/src/color.coffee" ---

Summary

@@ -21,12 +22,12 @@ at the key path is of type 'color'.

parse(value)

- +

Parse a String or Object into a Color.

- + Parameters @@ -38,13 +39,13 @@ at the key path is of type 'color'.

value
- +

A String such as 'white', #ff00ff, or 'rgba(255, 15, 60, .75)' or an Object with red, green, blue, and alpha properties.

- +
- + Returns @@ -61,12 +62,12 @@ at the key path is of type 'color'.

toHexString()

- +

- - + + Returns
@@ -78,12 +79,12 @@ at the key path is of type 'color'.

toRGBAString()

- +

- - + + Returns
@@ -92,4 +93,3 @@ at the key path is of type 'color'.

Returns a String in the form 'rgba(25, 50, 75, .9)'.

- diff --git a/docs/CommandRegistry.html b/docs/CommandRegistry.html index f4b7cbc84..687dce553 100644 --- a/docs/CommandRegistry.html +++ b/docs/CommandRegistry.html @@ -1,6 +1,7 @@ --- layout: docs title: CommandRegistry +edit_url: "https://github.com/nylas/N1/blob/master/src/command-registry.coffee" ---

Summary

@@ -47,13 +48,13 @@ bubbling process and prevent invocation of additional listeners.

add()

- +

Add one or more command listeners associated with a selector.

- - + + Returns @@ -66,12 +67,12 @@ bubbling process and prevent invocation of additional listeners.

findCommands(params)

- +

Find all registered commands matching a query.

- + Parameters
@@ -83,13 +84,13 @@ bubbling process and prevent invocation of additional listeners.

params
- +

An Object containing one or more of the following keys:

- +
- + Returns @@ -108,7 +109,7 @@ bubbling process and prevent invocation of additional listeners.

dispatch(targetcommandName)

- +

Simulate the dispatch of a command on a DOM node.

This can be useful for testing when you want to simulate the invocation of a @@ -117,7 +118,7 @@ bubbling process and prevent invocation of additional listeners.

processed.

- + Parameters
@@ -129,9 +130,9 @@ bubbling process and prevent invocation of additional listeners.

target @@ -139,11 +140,9 @@ bubbling process and prevent invocation of additional listeners.

commandName
- +

The DOM node at which to start bubbling the command event.

- +
- +

String indicating the name of the command to dispatch.

- +
- - diff --git a/docs/ComponentRegistry.html b/docs/ComponentRegistry.html index 0dc72f533..23ce0ec1f 100644 --- a/docs/ComponentRegistry.html +++ b/docs/ComponentRegistry.html @@ -1,6 +1,7 @@ --- layout: docs title: ComponentRegistry +edit_url: "https://github.com/nylas/N1/blob/master/src/component-registry.coffee" ---

Summary

@@ -24,7 +25,7 @@ to dynamically render components registered with the ComponentRegistry.

register(componentoptions)

- +

Register a new component with the Component Registry. Typically, packages call this method from their main activate method @@ -33,7 +34,7 @@ to dynamically render components registered with the ComponentRegistry.

This method is chainable.

- + Parameters @@ -45,9 +46,9 @@ to dynamically render components registered with the ComponentRegistry.

component @@ -55,22 +56,22 @@ to dynamically render components registered with the ComponentRegistry.

options
- +

Object A React Component with a displayName

- +
- +

Object: Note that for advanced use cases, you can also pass (modes, roles, locations) with arrays instead of single values.

- +
- +

findComponentByName(name)

- +

Retrieve the registry entry for a given name.

- + Parameters @@ -82,13 +83,13 @@ to dynamically render components registered with the ComponentRegistry.

name
- +

The String name of the registered component to retrieve.

- +
- + Returns @@ -100,20 +101,20 @@ to dynamically render components registered with the ComponentRegistry.

findComponentsMatching(descriptor)

- +

Retrieve all of the registry entries matching a given descriptor.

  ComponentRegistry.findComponentsMatching({
         role: 'Composer:ActionButton'
       })
-    
+
       ComponentRegistry.findComponentsMatching({
         location: WorkspaceStore.Location.RootSidebar.Toolbar
       })

- + Parameters
@@ -125,13 +126,13 @@ to dynamically render components registered with the ComponentRegistry.

descriptor
- +

An Object that specifies set of components using the available keys below. Note that for advanced use cases, you can also pass (modes, roles, locations) with arrays instead of single values.

- +
- + Returns @@ -140,4 +141,3 @@ to dynamically render components registered with the ComponentRegistry.

Returns an Array of React.Component objects

- diff --git a/docs/Config.html b/docs/Config.html index fc90621aa..605908974 100644 --- a/docs/Config.html +++ b/docs/Config.html @@ -1,6 +1,7 @@ --- layout: docs title: Config +edit_url: "https://github.com/nylas/N1/blob/master/src/config.coffee" ---

Summary

@@ -226,7 +227,7 @@ you do not need to specify a title or description!

observe(keyPathoptionscallback)

- +

Add a listener for changes to a given key path. This is different than onDidChange in that it will immediately call your callback with the @@ -239,7 +240,7 @@ you do not need to specify a title or description!

- + Parameters @@ -251,9 +252,9 @@ you do not need to specify a title or description!

keyPath @@ -261,9 +262,9 @@ you do not need to specify a title or description!

options @@ -271,13 +272,13 @@ you do not need to specify a title or description!

callback
- +

String name of the key to observe

- +
- +

Object

- +
- +

Function to call when the value of the key changes.

- +
- + Returns @@ -290,13 +291,13 @@ you do not need to specify a title or description!

onDidChange([keyPath][optional]callback)

- +

Add a listener for changes to a given key path. If keyPath is not specified, your callback will be called on changes to any key.

- + Parameters
@@ -310,7 +311,7 @@ you do not need to specify a title or description!

@@ -320,7 +321,7 @@ you do not need to specify a title or description!

@@ -328,13 +329,13 @@ you do not need to specify a title or description!

callback
Optional

String name of the key to observe. Must be specified if scopeDescriptor is specified.

- +
Optional

Object

- +
- +

Function to call when the value of the key changes.

- +
- + Returns @@ -347,7 +348,7 @@ you do not need to specify a title or description!

get(keyPath[options])

- +

Retrieves the setting for the given key.

Examples

@@ -374,7 +375,7 @@ you do not need to specify a title or description!

- + Parameters
@@ -386,9 +387,9 @@ you do not need to specify a title or description!

keyPath @@ -398,11 +399,11 @@ you do not need to specify a title or description!

- +

The String name of the key to retrieve.

- +
Optional

Object

- +
- + Returns @@ -415,13 +416,13 @@ you do not need to specify a title or description!

getAll(keyPath[options])

- +

Get all of the values for the given key-path, along with their associated scope selector.

- + Parameters
@@ -433,9 +434,9 @@ you do not need to specify a title or description!

keyPath @@ -445,11 +446,11 @@ you do not need to specify a title or description!

- +

The String name of the key to retrieve

- +
Optional

Object see the options argument to get

- +
- + Returns @@ -465,7 +466,7 @@ you do not need to specify a title or description!

set(keyPathvalue[options])

- +

Sets the value for a configuration setting.

This value is stored in Atom's internal configuration file.

@@ -478,10 +479,10 @@ you do not need to specify a title or description!

atom.config.get('editor.tabLength') # => 4
     atom.config.get('editor.tabLength', scope: ['source.ruby']) # => 4
     atom.config.get('editor.tabLength', scope: ['source.js']) # => 4
-    
+
     # Set ruby to 2
     atom.config.set('editor.tabLength', 2, scopeSelector: 'source.ruby') # => true
-    
+
     # Notice it's only set to 2 in the case of ruby
     atom.config.get('editor.tabLength') # => 4
     atom.config.get('editor.tabLength', scope: ['source.ruby']) # => 2
@@ -489,7 +490,7 @@ you do not need to specify a title or description!

- + Parameters
@@ -501,9 +502,9 @@ you do not need to specify a title or description!

keyPath @@ -511,9 +512,9 @@ you do not need to specify a title or description!

value @@ -523,11 +524,11 @@ you do not need to specify a title or description!

- +

The String name of the key.

- +
- +

The value of the setting. Passing undefined will revert the setting to the default value.

- +
Optional

Object

- +
- + Returns @@ -543,12 +544,12 @@ you do not need to specify a title or description!

unset(keyPath[options])

- +

Restore the setting at keyPath to its default value.

- + Parameters
@@ -560,9 +561,9 @@ you do not need to specify a title or description!

keyPath @@ -572,33 +573,33 @@ you do not need to specify a title or description!

- +

The String name of the key.

- +
Optional

Object

- +
- +

getSources()

- +

Get an Array of all of the source Strings with which settings have been added via set.

- - + +

getSchema(keyPath)

- +

Retrieve the schema for a specific key path. The schema will tell you what type the keyPath expects, and other metadata about the config option.

- + Parameters @@ -610,13 +611,13 @@ you do not need to specify a title or description!

keyPath
- +

The String name of the key.

- +
- + Returns @@ -630,24 +631,24 @@ you do not need to specify a title or description!

getUserConfigPath()

- +

Get the String path to the config file being used.

- - + +

transact(callback)

- +

Suppress calls to handler functions registered with onDidChange and observe for the duration of callback. After callback executes, handlers will be called once if the value for their key-path has changed.

- + Parameters
@@ -659,11 +660,9 @@ you do not need to specify a title or description!

callback
- +

Function to execute while suppressing calls to handlers.

- +
- - diff --git a/docs/ScopeDescriptor.html b/docs/ScopeDescriptor.html index 81bb5073d..9bf880e14 100644 --- a/docs/ScopeDescriptor.html +++ b/docs/ScopeDescriptor.html @@ -1,6 +1,7 @@ --- layout: docs title: ScopeDescriptor +edit_url: "https://github.com/nylas/N1/blob/master/src/scope-descriptor.coffee" ---

Summary

@@ -38,12 +39,12 @@ for more information.

constructor(object)

- +

Create a ScopeDescriptor object.

- + Parameters @@ -55,22 +56,22 @@ for more information.

object
- +

Object

- +
- +

getScopesArray()

- +

- - + + Returns @@ -79,4 +80,3 @@ for more information.

Returns an Array of Strings

- diff --git a/docs/StyleManager.html b/docs/StyleManager.html index de2043c13..b00ed880a 100644 --- a/docs/StyleManager.html +++ b/docs/StyleManager.html @@ -1,6 +1,7 @@ --- layout: docs title: StyleManager +edit_url: "https://github.com/nylas/N1/blob/master/src/style-manager.coffee" ---

Summary

@@ -29,12 +30,12 @@ which clone and attach style elements in different contexts.

observeStyleElements(callback)

- +

Invoke callback for all current and future style elements.

- + Parameters @@ -46,13 +47,13 @@ which clone and attach style elements in different contexts.

callback
- +

Function that is called with style elements.

- +
- + Returns @@ -65,12 +66,12 @@ which clone and attach style elements in different contexts.

onDidAddStyleElement(callback)

- +

Invoke callback when a style element is added.

- + Parameters
@@ -82,13 +83,13 @@ which clone and attach style elements in different contexts.

callback
- +

Function that is called with style elements.

- +
- + Returns @@ -101,12 +102,12 @@ which clone and attach style elements in different contexts.

onDidRemoveStyleElement(callback)

- +

Invoke callback when a style element is removed.

- + Parameters
@@ -118,13 +119,13 @@ which clone and attach style elements in different contexts.

callback
- +

Function that is called with style elements.

- +
- + Returns @@ -137,12 +138,12 @@ which clone and attach style elements in different contexts.

onDidUpdateStyleElement(callback)

- +

Invoke callback when an existing style element is updated.

- + Parameters
@@ -154,13 +155,13 @@ which clone and attach style elements in different contexts.

callback
- +

Function that is called with style elements.

- +
- + Returns @@ -173,23 +174,23 @@ which clone and attach style elements in different contexts.

getStyleElements()

- +

Get all loaded style elements.

- - + +

getUserStyleSheetPath()

- +

Get the path of the user style sheet in ~/.atom.

- - + + Returns
@@ -198,4 +199,3 @@ which clone and attach style elements in different contexts.

Returns a String.

- diff --git a/docs/ThemeManager.html b/docs/ThemeManager.html index 98dc5191c..36bf52540 100644 --- a/docs/ThemeManager.html +++ b/docs/ThemeManager.html @@ -1,6 +1,7 @@ --- layout: docs title: ThemeManager +edit_url: "https://github.com/nylas/N1/blob/master/src/theme-manager.coffee" ---

Summary

@@ -27,13 +28,13 @@ title: ThemeManager

onDidChangeActiveThemes(callback)

- +

Invoke callback when style sheet changes associated with updating the list of active themes have completed.

- + Parameters @@ -45,63 +46,63 @@ title: ThemeManager callback
- +

Function

- +
- +

getLoadedThemeNames()

- +

Get an array of all the loaded theme names.

- - + +

getLoadedThemes()

- +

Get an array of all the loaded themes.

- - + +

getActiveThemeNames()

- +

Get an array of all the active theme names.

- - + +

getActiveThemes()

- +

Get an array of all the active themes.

- - + +

getEnabledThemeNames()

- +

Get the enabled theme names from the config.

- - + + Returns @@ -110,4 +111,3 @@ title: ThemeManager

Returns an array of theme names in the order that they should be activated.

-