Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2025-09-04 11:44:47 +08:00
Code Issues Projects Releases Packages Wiki Activity

add edit urls for src components

Browse source
This commit is contained in:
dillon 2015-10-03 13:39:16 -07:00
parent f293af4efc
commit 5ac975c0a7
11 changed files with 311 additions and 318 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

236
docs/Atom.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Atom
edit_url: "https://github.com/nylas/N1/blob/master/src/atom.coffee"
---
<h2>Summary</h2>
@ -29,12 +30,12 @@ title: Atom
<h4 id=onDidBeep class="function-name">
onDidBeep(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidBeep" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke the given callback whenever <a href='#beep'>beep</a> is called.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -46,13 +47,13 @@ title: Atom
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> to be called whenever <a href='#beep'>beep</a> is called.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -64,13 +65,13 @@ title: Atom
<h4 id=onWillThrowError class="function-name">
onWillThrowError(<span class="args"><span class="arg">callback</span></span>) <a href="#onWillThrowError" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke the given callback when there is an unhandled error, but
before the devtools pop open</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -82,13 +83,13 @@ title: Atom
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> to be called whenever there is an unhandled error</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -100,12 +101,12 @@ title: Atom
<h4 id=onDidThrowError class="function-name">
onDidThrowError(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidThrowError" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke the given callback whenever there is an unhandled error.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -117,13 +118,13 @@ title: Atom
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> to be called whenever there is an unhandled error</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -135,7 +136,7 @@ title: Atom
<h4 id=trace class="function-name">
trace(<span class="args"></span>) <a href="#trace" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>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. </p>
</p>
</div>
<h4 id=inDevMode class="function-name">
inDevMode(<span class="args"></span>) <a href="#inDevMode" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Is the current window in development mode? </p>
</p>
</div>
<h4 id=inSafeMode class="function-name">
inSafeMode(<span class="args"></span>) <a href="#inSafeMode" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Is the current window in safe mode? </p>
</p>
</div>
<h4 id=inSpecMode class="function-name">
inSpecMode(<span class="args"></span>) <a href="#inSpecMode" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Is the current window running specs? </p>
</p>
</div>
<h4 id=getVersion class="function-name">
getVersion(<span class="args"></span>) <a href="#getVersion" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get the version of the Atom application.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -197,25 +198,25 @@ title: Atom
<h4 id=isReleasedVersion class="function-name">
isReleasedVersion(<span class="args"></span>) <a href="#isReleasedVersion" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Determine whether the current version is an official release. </p>
</p>
</div>
<h4 id=getWindowLoadTime class="function-name">
getWindowLoadTime(<span class="args"></span>) <a href="#getWindowLoadTime" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get the time taken to completely load the current window.</p>
<p>This time include things like loading and activating packages, creating
DOM elements for the editor, and reading the config.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -228,23 +229,23 @@ title: Atom
<h4 id=close class="function-name">
close(<span class="args"></span>) <a href="#close" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Close the current window. </p>
</p>
</div>
<h4 id=getSize class="function-name">
getSize(<span class="args"></span>) <a href="#getSize" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get the size of current window.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -256,12 +257,12 @@ title: Atom
<h4 id=setSize class="function-name">
setSize(<span class="args"><span class="arg">width</span><span class="arg">height</span></span>) <a href="#setSize" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Set the size of current window.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -273,9 +274,9 @@ title: Atom
<em>width</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of pixels.</p>
</td>
</tr>
<tr>
@ -283,22 +284,22 @@ title: Atom
<em>height</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of pixels. </p>
</td>
</tr>
</table>
<h4 id=setSizeAnimated class="function-name">
setSizeAnimated(<span class="args"><span class="arg">width</span><span class="arg">height</span><span class="arg">duration</span></span>) <a href="#setSizeAnimated" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Transition and set the size of the current window.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -310,9 +311,9 @@ title: Atom
<em>width</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of pixels.</p>
</td>
</tr>
<tr>
@ -320,9 +321,9 @@ title: Atom
<em>height</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of pixels.</p>
</td>
</tr>
<tr>
@ -330,23 +331,23 @@ title: Atom
<em>duration</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of pixels. </p>
</td>
</tr>
</table>
<h4 id=getPosition class="function-name">
getPosition(<span class="args"></span>) <a href="#getPosition" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get the position of current window.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -358,12 +359,12 @@ title: Atom
<h4 id=setPosition class="function-name">
setPosition(<span class="args"><span class="arg">x</span><span class="arg">y</span></span>) <a href="#setPosition" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Set the position of current window.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -375,9 +376,9 @@ title: Atom
<em>x</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of pixels.</p>
</td>
</tr>
<tr>
@ -385,77 +386,77 @@ title: Atom
<em>y</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of pixels. </p>
</td>
</tr>
</table>
<h4 id=center class="function-name">
center(<span class="args"></span>) <a href="#center" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Move current window to the center of the screen. </p>
</p>
</div>
<h4 id=focus class="function-name">
focus(<span class="args"></span>) <a href="#focus" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Focus the current window. </p>
</p>
</div>
<h4 id=show class="function-name">
show(<span class="args"></span>) <a href="#show" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Show the current window. </p>
</p>
</div>
<h4 id=hide class="function-name">
hide(<span class="args"></span>) <a href="#hide" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Hide the current window. </p>
</p>
</div>
<h4 id=reload class="function-name">
reload(<span class="args"></span>) <a href="#reload" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Reload the current window. </p>
</p>
</div>
<h4 id=getWindowProps class="function-name">
getWindowProps(<span class="args"></span>) <a href="#getWindowProps" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>The windowProps passed when creating the window via <code>newWindow</code>.</p>
</p>
</div>
<h4 id=onWindowPropsReceived class="function-name">
onWindowPropsReceived(<span class="args"></span>) <a href="#onWindowPropsReceived" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>If your package declares hot-loaded window types, <code>onWindowPropsReceived</code>
fires when your hot-loaded window is about to be shown so you can update
@ -466,67 +467,67 @@ title: Atom
</ul>
</p>
</div>
<h4 id=isMaximixed class="function-name">
isMaximixed(<span class="args"></span>) <a href="#isMaximixed" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Is the current window maximized? </p>
</p>
</div>
<h4 id=isFullScreen class="function-name">
isFullScreen(<span class="args"></span>) <a href="#isFullScreen" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Is the current window in full screen mode? </p>
</p>
</div>
<h4 id=setFullScreen class="function-name">
setFullScreen(<span class="args"></span>) <a href="#setFullScreen" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Set the full screen state of the current window. </p>
</p>
</div>
<h4 id=toggleFullScreen class="function-name">
toggleFullScreen(<span class="args"></span>) <a href="#toggleFullScreen" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Toggle the full screen state of the current window. </p>
</p>
</div>
<h4 id=beep class="function-name">
beep(<span class="args"></span>) <a href="#beep" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Visually and audibly trigger a beep. </p>
</p>
</div>
<h4 id=confirm class="function-name">
confirm(<span class="args"><span class="arg">options</span></span>) <a href="#confirm" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>A flexible way to open a dialog akin to an alert dialog.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -538,13 +539,13 @@ title: Atom
<em>options</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with the following keys:</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -556,31 +557,28 @@ title: Atom
<h4 id=openDevTools class="function-name">
openDevTools(<span class="args"></span>) <a href="#openDevTools" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Open the dev tools for the current window. </p>
</p>
</div>
<h4 id=toggleDevTools class="function-name">
toggleDevTools(<span class="args"></span>) <a href="#toggleDevTools" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Toggle the visibility of the dev tools for the current window. </p>
</p>
</div>
<h4 id=executeJavaScriptInDevTools class="function-name">
executeJavaScriptInDevTools(<span class="args"></span>) <a href="#executeJavaScriptInDevTools" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Execute code in dev tools. </p>
</p>
</div>

11
docs/BufferedNodeProcess.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: BufferedNodeProcess
edit_url: "https://github.com/nylas/N1/blob/master/src/buffered-node-process.coffee"
---
<h2>Summary</h2>
@ -24,12 +25,12 @@ to run.</p>
<h4 id=constructor class="function-name">
constructor(<span class="args"><span class="arg">options</span></span>) <a href="#constructor" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Runs the given Node script by spawning a new child process.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -41,11 +42,9 @@ to run.</p>
<em>options</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with the following keys:</p>
</td>
</tr>
</table>

26
docs/BufferedProcess.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: BufferedProcess
edit_url: "https://github.com/nylas/N1/blob/master/src/buffered-process.coffee"
---
<h2>Summary</h2>
@ -26,12 +27,12 @@ Node&#39;s ChildProcess.</p>
<h4 id=constructor class="function-name">
constructor(<span class="args"><span class="arg">options</span></span>) <a href="#constructor" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Runs the given command by spawning a new child process.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -43,17 +44,17 @@ Node&#39;s ChildProcess.</p>
<em>options</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with the following keys:</p>
</td>
</tr>
</table>
<h4 id=onWillThrowError class="function-name">
onWillThrowError(<span class="args"><span class="arg">callback</span></span>) <a href="#onWillThrowError" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>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&#39;s ChildProcess.</p>
that you have handled this error.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -73,13 +74,13 @@ Node&#39;s ChildProcess.</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> callback</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -91,11 +92,8 @@ Node&#39;s ChildProcess.</p>
<h4 id=kill class="function-name">
kill(<span class="args"></span>) <a href="#kill" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Terminate the process. </p>
</p>
</div>

28
docs/Clipboard.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Clipboard
edit_url: "https://github.com/nylas/N1/blob/master/src/clipboard.coffee"
---
<h2>Summary</h2>
@ -23,14 +24,14 @@ title: Clipboard
<h4 id=write class="function-name">
write(<span class="args"><span class="arg">text</span><span class="arg">metadata</span></span>) <a href="#write" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Write the given text to the clipboard.</p>
<p>The metadata associated with the text is available by calling
<a href='#readWithMetadata'>readWithMetadata</a>.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -42,9 +43,9 @@ title: Clipboard
<em>text</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> to store.</p>
</td>
</tr>
<tr>
@ -52,23 +53,23 @@ title: Clipboard
<em>metadata</em>
</td>
<td class="markdown-from-sourecode">
<p>The additional info to associate with the text. </p>
</td>
</tr>
</table>
<h4 id=read class="function-name">
read(<span class="args"></span>) <a href="#read" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Read the text from the clipboard.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -80,14 +81,14 @@ title: Clipboard
<h4 id=readWithMetadata class="function-name">
readWithMetadata(<span class="args"></span>) <a href="#readWithMetadata" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Read the text from the clipboard and return both the text and the
associated metadata.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -100,4 +101,3 @@ title: Clipboard
</ul>
</td></tr>
</table>

24
docs/Color.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Color
edit_url: "https://github.com/nylas/N1/blob/master/src/color.coffee"
---
<h2>Summary</h2>
@ -21,12 +22,12 @@ at the key path is of type &#39;color&#39;.</p>
<h4 id=parse class="function-name">
parse(<span class="args"><span class="arg">value</span></span>) <a href="#parse" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Parse a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> or <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> into a <a href='color.html'>Color</a>.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -38,13 +39,13 @@ at the key path is of type &#39;color&#39;.</p>
<em>value</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> such as <code>&#39;white&#39;</code>, <code>#ff00ff</code>, or <code>&#39;rgba(255, 15, 60, .75)&#39;</code> or an <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with <code>red</code>, <code>green</code>, <code>blue</code>, and <code>alpha</code> properties.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -61,12 +62,12 @@ at the key path is of type &#39;color&#39;.</p>
<h4 id=toHexString class="function-name">
toHexString(<span class="args"></span>) <a href="#toHexString" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -78,12 +79,12 @@ at the key path is of type &#39;color&#39;.</p>
<h4 id=toRGBAString class="function-name">
toRGBAString(<span class="args"></span>) <a href="#toRGBAString" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -92,4 +93,3 @@ at the key path is of type &#39;color&#39;.</p>
<tr><td class="markdown-from-sourecode"><p>Returns a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> in the form <code>&#39;rgba(25, 50, 75, .9)&#39;</code>.</p>
</td></tr>
</table>

31
docs/CommandRegistry.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: CommandRegistry
edit_url: "https://github.com/nylas/N1/blob/master/src/command-registry.coffee"
---
<h2>Summary</h2>
@ -47,13 +48,13 @@ bubbling process and prevent invocation of additional listeners.</p>
<h4 id=add class="function-name">
add(<span class="args"></span>) <a href="#add" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Add one or more command listeners associated with a selector.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -66,12 +67,12 @@ bubbling process and prevent invocation of additional listeners.</p>
<h4 id=findCommands class="function-name">
findCommands(<span class="args"><span class="arg">params</span></span>) <a href="#findCommands" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Find all registered commands matching a query.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -83,13 +84,13 @@ bubbling process and prevent invocation of additional listeners.</p>
<em>params</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> containing one or more of the following keys:</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -108,7 +109,7 @@ bubbling process and prevent invocation of additional listeners.</p>
<h4 id=dispatch class="function-name">
dispatch(<span class="args"><span class="arg">target</span><span class="arg">commandName</span></span>) <a href="#dispatch" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Simulate the dispatch of a command on a DOM node.</p>
<p>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.</p>
processed.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -129,9 +130,9 @@ bubbling process and prevent invocation of additional listeners.</p>
<em>target</em>
</td>
<td class="markdown-from-sourecode">
<p>The DOM node at which to start bubbling the command event.</p>
</td>
</tr>
<tr>
@ -139,11 +140,9 @@ bubbling process and prevent invocation of additional listeners.</p>
<em>commandName</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> indicating the name of the command to dispatch. </p>
</td>
</tr>
</table>

38
docs/ComponentRegistry.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: ComponentRegistry
edit_url: "https://github.com/nylas/N1/blob/master/src/component-registry.coffee"
---
<h2>Summary</h2>
@ -24,7 +25,7 @@ to dynamically render components registered with the ComponentRegistry.</p>
<h4 id=register class="function-name">
register(<span class="args"><span class="arg">component</span><span class="arg">options</span></span>) <a href="#register" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Register a new component with the Component Registry.
Typically, packages call this method from their main <code>activate</code> method
@ -33,7 +34,7 @@ to dynamically render components registered with the ComponentRegistry.</p>
<p>This method is chainable.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -45,9 +46,9 @@ to dynamically render components registered with the ComponentRegistry.</p>
<em>component</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> A React Component with a <code>displayName</code></p>
</td>
</tr>
<tr>
@ -55,22 +56,22 @@ to dynamically render components registered with the ComponentRegistry.</p>
<em>options</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a>: Note that for advanced use cases, you can also pass (<code>modes</code>, <code>roles</code>, <code>locations</code>) with arrays instead of single values.</p>
</td>
</tr>
</table>
<h4 id=findComponentByName class="function-name">
findComponentByName(<span class="args"><span class="arg">name</span></span>) <a href="#findComponentByName" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Retrieve the registry entry for a given name.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -82,13 +83,13 @@ to dynamically render components registered with the ComponentRegistry.</p>
<em>name</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the registered component to retrieve.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -100,20 +101,20 @@ to dynamically render components registered with the ComponentRegistry.</p>
<h4 id=findComponentsMatching class="function-name">
findComponentsMatching(<span class="args"><span class="arg">descriptor</span></span>) <a href="#findComponentsMatching" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Retrieve all of the registry entries matching a given descriptor.</p>
<pre><code class="lang-coffee"> <span class="hljs-tag">ComponentRegistry</span><span class="hljs-class">.findComponentsMatching</span>(<span class="hljs-rules">{
<span class="hljs-rule"><span class="hljs-attribute">role</span>:<span class="hljs-value"> <span class="hljs-string">'Composer:ActionButton'</span>
})
ComponentRegistry.<span class="hljs-function">findComponentsMatching</span>({
location: WorkspaceStore.Location.RootSidebar.Toolbar
})</span></span></span>
</code></pre>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -125,13 +126,13 @@ to dynamically render components registered with the ComponentRegistry.</p>
<em>descriptor</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> that specifies set of components using the available keys below. Note that for advanced use cases, you can also pass (<code>modes</code>, <code>roles</code>, <code>locations</code>) with arrays instead of single values.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -140,4 +141,3 @@ to dynamically render components registered with the ComponentRegistry.</p>
<tr><td class="markdown-from-sourecode"><p>Returns an <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='https://facebook.github.io/react/docs/component-api.html'>React.Component</a> objects</p>
</td></tr>
</table>

121
docs/Config.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Config
edit_url: "https://github.com/nylas/N1/blob/master/src/config.coffee"
---
<h2>Summary</h2>
@ -226,7 +227,7 @@ you do not need to specify a title or description!</p>
<h4 id=observe class="function-name">
observe(<span class="args"><span class="arg">keyPath</span><span class="arg">options</span><span class="arg">callback</span></span>) <a href="#observe" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Add a listener for changes to a given key path. This is different
than <a href='#onDidChange'>onDidChange</a> in that it will immediately call your callback with the
@ -239,7 +240,7 @@ you do not need to specify a title or description!</p>
</code></pre>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -251,9 +252,9 @@ you do not need to specify a title or description!</p>
<em>keyPath</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the key to observe</p>
</td>
</tr>
<tr>
@ -261,9 +262,9 @@ you do not need to specify a title or description!</p>
<em>options</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a></p>
</td>
</tr>
<tr>
@ -271,13 +272,13 @@ you do not need to specify a title or description!</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> to call when the value of the key changes.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -290,13 +291,13 @@ you do not need to specify a title or description!</p>
<h4 id=onDidChange class="function-name">
onDidChange(<span class="args"><span class="arg">[keyPath]</span><span class="arg">[optional]</span><span class="arg">callback</span></span>) <a href="#onDidChange" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Add a listener for changes to a given key path. If <code>keyPath</code> is
not specified, your callback will be called on changes to any key.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -310,7 +311,7 @@ you do not need to specify a title or description!</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the key to observe. Must be specified if <code>scopeDescriptor</code> is specified.</p>
</td>
</tr>
<tr>
@ -320,7 +321,7 @@ you do not need to specify a title or description!</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a></p>
</td>
</tr>
<tr>
@ -328,13 +329,13 @@ you do not need to specify a title or description!</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> to call when the value of the key changes.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -347,7 +348,7 @@ you do not need to specify a title or description!</p>
<h4 id=get class="function-name">
get(<span class="args"><span class="arg">keyPath</span><span class="arg">[options]</span></span>) <a href="#get" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Retrieves the setting for the given key.</p>
<h3 id="examples">Examples</h3>
@ -374,7 +375,7 @@ you do not need to specify a title or description!</p>
</code></pre>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -386,9 +387,9 @@ you do not need to specify a title or description!</p>
<em>keyPath</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the key to retrieve.</p>
</td>
</tr>
<tr>
@ -398,11 +399,11 @@ you do not need to specify a title or description!</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a></p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -415,13 +416,13 @@ you do not need to specify a title or description!</p>
<h4 id=getAll class="function-name">
getAll(<span class="args"><span class="arg">keyPath</span><span class="arg">[options]</span></span>) <a href="#getAll" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get all of the values for the given key-path, along with their
associated scope selector.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -433,9 +434,9 @@ you do not need to specify a title or description!</p>
<em>keyPath</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the key to retrieve</p>
</td>
</tr>
<tr>
@ -445,11 +446,11 @@ you do not need to specify a title or description!</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> see the <code>options</code> argument to <a href='#get'>get</a></p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -465,7 +466,7 @@ you do not need to specify a title or description!</p>
<h4 id=set class="function-name">
set(<span class="args"><span class="arg">keyPath</span><span class="arg">value</span><span class="arg">[options]</span></span>) <a href="#set" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Sets the value for a configuration setting.</p>
<p>This value is stored in Atom&#39;s internal configuration file.</p>
@ -478,10 +479,10 @@ you do not need to specify a title or description!</p>
<pre><code class="lang-coffee">atom.config.get(<span class="hljs-symbol">'editor</span>.tabLength') # =&gt; <span class="hljs-number">4</span>
atom.config.get(<span class="hljs-symbol">'editor</span>.tabLength', scope: [<span class="hljs-symbol">'source</span>.ruby']) # =&gt; <span class="hljs-number">4</span>
atom.config.get(<span class="hljs-symbol">'editor</span>.tabLength', scope: [<span class="hljs-symbol">'source</span>.js']) # =&gt; <span class="hljs-number">4</span>
# <span class="hljs-type">Set</span> ruby <span class="hljs-keyword">to</span> <span class="hljs-number">2</span>
atom.config.set(<span class="hljs-symbol">'editor</span>.tabLength', <span class="hljs-number">2</span>, scopeSelector: <span class="hljs-symbol">'source</span>.ruby') # =&gt; <span class="hljs-literal">true</span>
# <span class="hljs-type">Notice</span> it's only set <span class="hljs-keyword">to</span> <span class="hljs-number">2</span> <span class="hljs-keyword">in</span> the case <span class="hljs-keyword">of</span> ruby
atom.config.get(<span class="hljs-symbol">'editor</span>.tabLength') # =&gt; <span class="hljs-number">4</span>
atom.config.get(<span class="hljs-symbol">'editor</span>.tabLength', scope: [<span class="hljs-symbol">'source</span>.ruby']) # =&gt; <span class="hljs-number">2</span>
@ -489,7 +490,7 @@ you do not need to specify a title or description!</p>
</code></pre>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -501,9 +502,9 @@ you do not need to specify a title or description!</p>
<em>keyPath</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the key.</p>
</td>
</tr>
<tr>
@ -511,9 +512,9 @@ you do not need to specify a title or description!</p>
<em>value</em>
</td>
<td class="markdown-from-sourecode">
<p>The value of the setting. Passing <code>undefined</code> will revert the setting to the default value.</p>
</td>
</tr>
<tr>
@ -523,11 +524,11 @@ you do not need to specify a title or description!</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a></p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -543,12 +544,12 @@ you do not need to specify a title or description!</p>
<h4 id=unset class="function-name">
unset(<span class="args"><span class="arg">keyPath</span><span class="arg">[options]</span></span>) <a href="#unset" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Restore the setting at <code>keyPath</code> to its default value.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -560,9 +561,9 @@ you do not need to specify a title or description!</p>
<em>keyPath</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the key.</p>
</td>
</tr>
<tr>
@ -572,33 +573,33 @@ you do not need to specify a title or description!</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a></p>
</td>
</tr>
</table>
<h4 id=getSources class="function-name">
getSources(<span class="args"></span>) <a href="#getSources" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get an <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of all of the <code>source</code> <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a>s with which
settings have been added via <a href='#set'>set</a>. </p>
</p>
</div>
<h4 id=getSchema class="function-name">
getSchema(<span class="args"><span class="arg">keyPath</span></span>) <a href="#getSchema" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>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.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -610,13 +611,13 @@ you do not need to specify a title or description!</p>
<em>keyPath</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of the key.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -630,24 +631,24 @@ you do not need to specify a title or description!</p>
<h4 id=getUserConfigPath class="function-name">
getUserConfigPath(<span class="args"></span>) <a href="#getUserConfigPath" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get the <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> path to the config file being used. </p>
</p>
</div>
<h4 id=transact class="function-name">
transact(<span class="args"><span class="arg">callback</span></span>) <a href="#transact" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Suppress calls to handler functions registered with <a href='#onDidChange'>onDidChange</a>
and <a href='#observe'>observe</a> for the duration of <code>callback</code>. After <code>callback</code> executes,
handlers will be called once if the value for their key-path has changed.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -659,11 +660,9 @@ you do not need to specify a title or description!</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> to execute while suppressing calls to handlers. </p>
</td>
</tr>
</table>

18
docs/ScopeDescriptor.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: ScopeDescriptor
edit_url: "https://github.com/nylas/N1/blob/master/src/scope-descriptor.coffee"
---
<h2>Summary</h2>
@ -38,12 +39,12 @@ for more information.</p>
<h4 id=constructor class="function-name">
constructor(<span class="args"><span class="arg">object</span></span>) <a href="#constructor" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Create a <a href='scopedescriptor.html'>ScopeDescriptor</a> object.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -55,22 +56,22 @@ for more information.</p>
<em>object</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a></p>
</td>
</tr>
</table>
<h4 id=getScopesArray class="function-name">
getScopesArray(<span class="args"></span>) <a href="#getScopesArray" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -79,4 +80,3 @@ for more information.</p>
<tr><td class="markdown-from-sourecode"><p>Returns an <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a>s</p>
</td></tr>
</table>

54
docs/StyleManager.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: StyleManager
edit_url: "https://github.com/nylas/N1/blob/master/src/style-manager.coffee"
---
<h2>Summary</h2>
@ -29,12 +30,12 @@ which clone and attach style elements in different contexts.</p>
<h4 id=observeStyleElements class="function-name">
observeStyleElements(<span class="args"><span class="arg">callback</span></span>) <a href="#observeStyleElements" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke <code>callback</code> for all current and future style elements.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -46,13 +47,13 @@ which clone and attach style elements in different contexts.</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> that is called with style elements.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -65,12 +66,12 @@ which clone and attach style elements in different contexts.</p>
<h4 id=onDidAddStyleElement class="function-name">
onDidAddStyleElement(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidAddStyleElement" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke <code>callback</code> when a style element is added.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -82,13 +83,13 @@ which clone and attach style elements in different contexts.</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> that is called with style elements.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -101,12 +102,12 @@ which clone and attach style elements in different contexts.</p>
<h4 id=onDidRemoveStyleElement class="function-name">
onDidRemoveStyleElement(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidRemoveStyleElement" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke <code>callback</code> when a style element is removed.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -118,13 +119,13 @@ which clone and attach style elements in different contexts.</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> that is called with style elements.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -137,12 +138,12 @@ which clone and attach style elements in different contexts.</p>
<h4 id=onDidUpdateStyleElement class="function-name">
onDidUpdateStyleElement(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidUpdateStyleElement" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke <code>callback</code> when an existing style element is updated.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -154,13 +155,13 @@ which clone and attach style elements in different contexts.</p>
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> that is called with style elements.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -173,23 +174,23 @@ which clone and attach style elements in different contexts.</p>
<h4 id=getStyleElements class="function-name">
getStyleElements(<span class="args"></span>) <a href="#getStyleElements" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get all loaded style elements. </p>
</p>
</div>
<h4 id=getUserStyleSheetPath class="function-name">
getUserStyleSheetPath(<span class="args"></span>) <a href="#getUserStyleSheetPath" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get the path of the user style sheet in <code>~/.atom</code>.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -198,4 +199,3 @@ which clone and attach style elements in different contexts.</p>
<tr><td class="markdown-from-sourecode"><p>Returns a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a>.</p>
</td></tr>
</table>

42
docs/ThemeManager.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: ThemeManager
edit_url: "https://github.com/nylas/N1/blob/master/src/theme-manager.coffee"
---
<h2>Summary</h2>
@ -27,13 +28,13 @@ title: ThemeManager
<h4 id=onDidChangeActiveThemes class="function-name">
onDidChangeActiveThemes(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidChangeActiveThemes" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Invoke <code>callback</code> when style sheet changes associated with
updating the list of active themes have completed.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -45,63 +46,63 @@ title: ThemeManager
<em>callback</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function'>Function</a> </p>
</td>
</tr>
</table>
<h4 id=getLoadedThemeNames class="function-name">
getLoadedThemeNames(<span class="args"></span>) <a href="#getLoadedThemeNames" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get an array of all the loaded theme names. </p>
</p>
</div>
<h4 id=getLoadedThemes class="function-name">
getLoadedThemes(<span class="args"></span>) <a href="#getLoadedThemes" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get an array of all the loaded themes. </p>
</p>
</div>
<h4 id=getActiveThemeNames class="function-name">
getActiveThemeNames(<span class="args"></span>) <a href="#getActiveThemeNames" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get an array of all the active theme names. </p>
</p>
</div>
<h4 id=getActiveThemes class="function-name">
getActiveThemes(<span class="args"></span>) <a href="#getActiveThemes" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get an array of all the active themes. </p>
</p>
</div>
<h4 id=getEnabledThemeNames class="function-name">
getEnabledThemeNames(<span class="args"></span>) <a href="#getEnabledThemeNames" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Get the enabled theme names from the config.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -110,4 +111,3 @@ title: ThemeManager
<tr><td class="markdown-from-sourecode"><p>Returns an array of theme names in the order that they should be activated.</p>
</td></tr>
</table>