forked from fastmail/Squire
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathapi.txt
More file actions
268 lines (242 loc) · 8.4 KB
/
api.txt
File metadata and controls
268 lines (242 loc) · 8.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
function MarkedEditorController($scope, $attrs) {
var delegate, markdown, contentMode, toolbarCtrl;
var ctrl = this;
ctrl.getContentMode = getContentMode;
ctrl.getImages = getImages;
ctrl.setDelegate = setDelegate;
ctrl.setToolbarController = setToolbarController;
// Delegate methods
ctrl.addLinebreak = addLinebreak;
ctrl.canUndo = canUndo;
ctrl.canRedo = canRedo;
ctrl.getFormattingInfoFromCurrentSelection = getFormattingInfoFromCurrentSelection;
ctrl.getMarkdown = getMarkdown;
ctrl.redo = redo;
ctrl.setListFormatting = setListFormatting;
ctrl.setHeading = setHeading;
ctrl.setWidget = setWidget;
ctrl.toggleAside = toggleAside;
ctrl.toggleBlockquote = toggleBlockquote;
ctrl.toggleEm = toggleEm;
ctrl.toggleStrong = toggleStrong;
ctrl.toggleHr = toggleHr;
ctrl.undo = undo;
activate();
function activate() {
if ($attrs.contentMode === 'inline') {
contentMode = 'inline';
} else if ($attrs.contentMode === 'noWidgets') {
contentMode = 'noWidgets';
} else {
contentMode = 'full';
}
$scope.$on('$destroy', function() {
if (delegate) {
delegate.deactivate();
delegate = null;
}
toolbarCtrl = null;
});
ctrl.onControllerReady(ctrl);
}
/**
* Gets the current content mode.
* The content mode will never change during the editing session
*
* @returns {String} One of 'full', 'inline', 'noWidgets'
*/
function getContentMode() {
return contentMode;
}
/**
* Return the image objects that can be used in this editing session
*
* @returns {Array} List of smw.media.mediareference objects
*/
function getImages() {
return ctrl.images;
}
/**
* Deactivates current editor delegate and replace it with another.
*
* @param {Object} newDelegate - An angular controller implementing the delegate methods.
*/
function setDelegate(newDelegate) {
if (delegate) {
markdown = delegate.getMarkdown();
delegate.deactivate();
}
delegate = newDelegate;
delegate.activate(markdown, ctrl);
}
function setToolbarController(toolbarController) {
toolbarCtrl = toolbarController;
}
// DELEGATE METHODS ////////////////////////////////////////////////////
/**
* Adds a soft line break at the current cursor position
*/
function addLinebreak() {
if (delegate) {
return delegate.addLinebreak();
}
}
/**
* If the editor currently can perform undo actions
*
* @returns {boolean}
*/
function canUndo() {
if (delegate) {
return delegate.canUndo();
}
return false;
}
/**
* If the editor currently can perform redo actions
*
* @returns {boolean}
*/
function canRedo() {
if (delegate) {
return delegate.canRedo();
}
return false;
}
/**
* @typedef {Object} MarkedEditor~FormattingInfoMap
* Describes the returned object from getEnabledFormattingFromCurrentSelection()
* Each value in this object contains at least the boolean 'enabled'.
* Some properties contains additional information, defined in the property list below.
*
* If the current selection spans over several instances of the same type, e.g. several 'smwWidget'
* the implementation may return that no formatting is enabled for that type.
*
* @property {MarkedEditor~FormattingInfo} aside
* @property {MarkedEditor~FormattingInfo} blockquote
* @property {MarkedEditor~FormattingInfo} em
* @property {MarkedEditor~FormattingInfo} heading - Also contains number 'depth' describing the heading level depth.
* @property {MarkedEditor~FormattingInfo} hr
* @property {MarkedEditor~FormattingInfo} link
* @property {MarkedEditor~FormattingInfo} list - Also contains the string 'listType' which can be one of: 'ordered', 'bullet', 'noLabels'
* @property {MarkedEditor~FormattingInfo} strong
* @property {MarkedEditor~FormattingInfo} smwWidget - Also contains 'widgetType', 'widgetLabel' and 'widgetOptions'
*/
/**
* @typedef {Object} MarkedEditor~FormattingInfo
* Additional properties may also exist depending on markdown type
*
* @property {boolean} allowed - If a formatting action can be performed. i.e, added, removed, toggled or set.
* @property {boolean} enabled - If the formatting is enabled in the current selection
*/
/**
* Retrieves all formatting that is currently enabled within the current selection.
* This method will return an object
*
* @returns {MarkedEditor~FormattingInfoMap}
*/
function getFormattingInfoFromCurrentSelection() {
if (delegate) {
return delegate.getFormattingInfoFromCurrentSelection();
}
}
/**
* Returns the current content of the edited area as markdown
*
* @returns {String}
*/
function getMarkdown() {
if (delegate) {
markdown = delegate.getMarkdown();
}
return markdown;
}
/**
* Redo user action, going forward in action history
*/
function redo() {
if (delegate) {
delegate.redo();
}
}
/**
* Sets list formatting for the current selection.
* If null or undefined is passed, list formatting is removed if any is currently set
*
* @param {String} listType - One of 'ordered', 'bullet', 'noLabels' or null/undefined
*/
function setListFormatting(listType) {
if (delegate) {
delegate.setListFormatting(listType);
}
}
/**
* Sets heading formatting for the current selected line.
*
* @param {Number} depth - An integer between 1 to 4 to set the heading depth. 0 to remove heading formatting.
*/
function setHeading(depth) {
if (delegate) {
delegate.setHeading(depth);
}
}
/**
* Inserts or replaces a widget in the current selection
*
* @param {string} widgetType
* @param {string} label
* @param {Object} widgetOptions
*/
function setWidget(widgetType, label, widgetOptions) {
if (delegate) {
delegate.setWidget(widgetType, label, widgetOptions);
}
}
/**
* Toggles aside on the current selection
*/
function toggleAside() {
if (delegate) {
delegate.toggleAside();
}
}
/**
* Toggles blockquote on the current selection
*/
function toggleBlockquote() {
if (delegate) {
delegate.toggleBlockquote();
}
}
/**
* Toggle em formatting (italic) on the current selection
*/
function toggleEm() {
if (delegate) {
delegate.toggleEm();
}
}
/**
* Toggle page break on the current selection
*/
function toggleHr() {
if (delegate) {
delegate.toggleHr();
}
}
/**
* Toggle strong formatting (bold) on the current selection
*/
function toggleStrong() {
if (delegate) {
delegate.toggleStrong();
}
}
/**
* Undo user action, going backward in the action history.
*/
function undo() {
if (delegate) {
delegate.undo();
}
}