Skip to content

Commit 7c20d27

Browse files
committed
chore: auto update API docs
1 parent c53cbc9 commit 7c20d27

3 files changed

Lines changed: 93 additions & 0 deletions

File tree

docs/API-Reference/command/Commands.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ Closes all open files
122122
## FILE\_CLOSE\_LIST
123123
Closes files from list
124124

125+
**Kind**: global variable
126+
<a name="FILE_PIN"></a>
127+
128+
## FILE\_PIN
129+
Pins the selected file
130+
131+
**Kind**: global variable
132+
<a name="FILE_UNPIN"></a>
133+
134+
## FILE\_UNPIN
135+
Unpins the selected file
136+
125137
**Kind**: global variable
126138
<a name="FILE_REOPEN_CLOSED"></a>
127139

docs/API-Reference/view/MainViewManager.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,48 @@ Adds the given file list to the end of the workingset.
346346
Switch between panes
347347

348348
**Kind**: global function
349+
<a name="pinFile"></a>
350+
351+
## pinFile(paneId, file) ⇒ <code>boolean</code>
352+
This function is called from DocumentCommandHandlers.js handleFilePin function
353+
it is to pin the file. the pinned file is displayed before the normal files in the working set and tab bar
354+
we also prevent the pinned files from being closed during bulk close operations
355+
356+
**Kind**: global function
357+
**Returns**: <code>boolean</code> - true if the file was pinned, false if it was already pinned or not in the working set
358+
359+
| Param | Type | Description |
360+
| --- | --- | --- |
361+
| paneId | <code>string</code> | the id of the pane in which to pin the file or ACTIVE_PANE |
362+
| file | <code>File</code> | the File to pin |
363+
364+
<a name="unpinFile"></a>
365+
366+
## unpinFile(paneId, file) ⇒ <code>boolean</code>
367+
called from DocumentCommandHandlers.js handleFileUnpin function,
368+
to unpin the file
369+
370+
**Kind**: global function
371+
**Returns**: <code>boolean</code> - true if the file was unpinned, false if it wasn't pinned
372+
373+
| Param | Type | Description |
374+
| --- | --- | --- |
375+
| paneId | <code>string</code> | the id of the pane in which to unpin the file or ACTIVE_PANE |
376+
| file | <code>File</code> | the File to unpin |
377+
378+
<a name="isPathPinned"></a>
379+
380+
## isPathPinned(paneId, path) ⇒ <code>boolean</code>
381+
checks if a file path is pinned in the working set.
382+
383+
**Kind**: global function
384+
**Returns**: <code>boolean</code> - true if the file is pinned
385+
386+
| Param | Type | Description |
387+
| --- | --- | --- |
388+
| paneId | <code>string</code> | the id of the pane in which to check or ACTIVE_PANE |
389+
| path | <code>string</code> | the full path to check |
390+
349391
<a name="traverseToNextViewByMRU"></a>
350392

351393
## traverseToNextViewByMRU(direction) ⇒ <code>Object</code>

docs/API-Reference/view/Pane.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ const Pane = brackets.getModule("view/Pane")
2222
* [.ITEM_NOT_FOUND](#Pane+ITEM_NOT_FOUND)
2323
* [.ITEM_FOUND_NO_SORT](#Pane+ITEM_FOUND_NO_SORT)
2424
* [.ITEM_FOUND_NEEDS_SORT](#Pane+ITEM_FOUND_NEEDS_SORT)
25+
* [.pinPath(path)](#Pane+pinPath) ⇒ <code>boolean</code>
26+
* [.unpinPath(path)](#Pane+unpinPath) ⇒ <code>boolean</code>
27+
* [.isPathPinned(path)](#Pane+isPathPinned) ⇒ <code>boolean</code>
2528
* [.mergeFrom(other)](#Pane+mergeFrom)
2629
* [.destroy()](#Pane+destroy)
2730
* [.getViewList()](#Pane+getViewList) ⇒ <code>Array.&lt;File&gt;</code>
@@ -143,6 +146,42 @@ and the workingset needs to be resorted
143146

144147
**Kind**: instance constant of [<code>Pane</code>](#Pane)
145148
**See**: [reorderItem](#Pane+reorderItem)
149+
<a name="Pane+pinPath"></a>
150+
151+
### pane.pinPath(path) ⇒ <code>boolean</code>
152+
this pins a file path
153+
154+
**Kind**: instance method of [<code>Pane</code>](#Pane)
155+
**Returns**: <code>boolean</code> - true if the file was pinned, false if it was already pinned or not in the view list
156+
157+
| Param | Type | Description |
158+
| --- | --- | --- |
159+
| path | <code>string</code> | the full path of the file to pin |
160+
161+
<a name="Pane+unpinPath"></a>
162+
163+
### pane.unpinPath(path) ⇒ <code>boolean</code>
164+
this unpins a file path.
165+
166+
**Kind**: instance method of [<code>Pane</code>](#Pane)
167+
**Returns**: <code>boolean</code> - true if the file was unpinned, false if it wasn't pinned
168+
169+
| Param | Type | Description |
170+
| --- | --- | --- |
171+
| path | <code>string</code> | the full path of the file to unpin |
172+
173+
<a name="Pane+isPathPinned"></a>
174+
175+
### pane.isPathPinned(path) ⇒ <code>boolean</code>
176+
checks if a file path is pinned
177+
178+
**Kind**: instance method of [<code>Pane</code>](#Pane)
179+
**Returns**: <code>boolean</code> - true if the file is pinned false otherwise
180+
181+
| Param | Type | Description |
182+
| --- | --- | --- |
183+
| path | <code>string</code> | the full path of the file |
184+
146185
<a name="Pane+mergeFrom"></a>
147186

148187
### pane.mergeFrom(other)

0 commit comments

Comments
 (0)