3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
11 * Full author contact details are available in file CREDITS.
16 #include "LyXAction.h"
18 #include "FuncRequest.h"
20 #include "support/debug.h"
21 #include "support/lstrings.h"
23 #include <boost/assert.hpp>
26 using namespace lyx::support;
31 NAMING RULES FOR USER-COMMANDS
32 Here's the set of rules to apply when a new command name is introduced:
34 1) Use the object.event order. That is, use `word-forward'
35 instead of `forward-word'.
36 2) Don't introduce an alias for an already named object. Same for events.
37 3) Forward movement or focus is called `forward' (not `right').
38 4) Backward movement or focus is called `backward' (not `left').
39 5) Upward movement of focus is called `up'.
40 6) Downward movement is called `down'.
41 7) The begin of an object is called `begin' (not `start').
42 8) The end of an object is called `end'.
44 (May 19 1996, 12:04, RvdK)
47 /* LFUN documentation (a start at least, Chr 2007-08-12)
49 * The documentation below is primarily notes about restrictions and
50 * oddities relating to the different LFUNs.
52 * Try to find an appropriate (thematical) place when adding the new LFUN.
54 * Doxygen template below. Some notes: Parameters should be set in uppercase
55 * and put in <BRACKETS>, as so.
59 * \var lyx::FuncCode lyx::LFUN_
72 void LyXAction::newFunc(FuncCode action, string const & name,
73 unsigned int attrib, LyXAction::func_type type)
75 lyx_func_map[name] = action;
78 tmpinfo.attrib = attrib;
80 lyx_info_map[action] = tmpinfo;
84 // Needed for LFUNs documentation to be accepted, since doxygen won't take
85 // \var inside functions.
86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
87 void LyXAction::init()
89 // This function was changed to use the array below in initalization
90 // instead of calling newFunc numerous times because of compilation
91 // times. Since the array is not static we get back the memory it
92 // occupies after the init is completed. It compiles several
105 ev_item const items[] = {
108 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
109 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
110 to the next character typed.
111 * \li Syntax: accent-acute
114 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
116 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
117 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
118 to the next character typed.
119 * \li Syntax: accent-breve
122 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
124 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
125 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
126 to the next character typed.
127 * \li Syntax: accent-caron
130 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
132 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
133 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
134 to the next character typed.
135 * \li Syntax: accent-cedilla
138 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
140 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
141 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
142 to the next character typed.
143 * \li Syntax: accent-circle
146 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
148 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
149 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
150 to the next character typed.
151 * \li Syntax: accent-circumflex
154 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
156 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
157 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
158 to the next character typed.
159 * \li Syntax: accent-dot
162 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
164 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
165 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
166 to the next character typed.
167 * \li Syntax: accent-grave
170 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
172 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
173 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
174 to the next character typed.
175 * \li Syntax: accent-grave
178 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
180 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
181 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
182 to the next character typed.
183 * \li Syntax: accent-macron
186 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
188 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
189 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
190 to the next character typed.
191 * \li Syntax: accent-ogonek
194 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
195 { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
197 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
198 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
199 over the next two character typed.
200 * \li Notion: the following char will finish the tie.
201 * \li Syntax: accent-tie
204 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
206 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
207 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
208 over the next character typed.
209 * \li Syntax: accent-tilde
212 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
214 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
215 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
216 over the next character typed.
217 * \li Syntax: accent-umlaut
220 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
222 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
223 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
224 under the next character typed.
225 * \li Syntax: accent-underbar
228 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
230 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
231 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
232 under the next character typed.
233 * \li Syntax: accent-underdot
236 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
239 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
240 * \li Action: Inserts a caption inset.
241 * \li Syntax: caption-insert
242 * \li Origin: Lgb, 18 Jul 2000
245 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
247 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
248 * \li Action: Inserts the current date.
249 * \li Syntax: date-insert [<ARG>]
250 * \li Params: <ARG>: Format of date. The default value (%x) can be set
251 in Preferences->Date format. For possible formats
252 see manual page of strftime function.
253 * \li Origin: jdblair, 31 Jan 2000
256 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
258 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
259 * \li Action: Inserts a footnote inset.
260 * \li Syntax: footnote-insert
261 * \li Origin: Jug, 7 Mar 2000
264 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
266 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
267 * \li Action: Inserts an ERT inset.
268 * \li Syntax: ert-insert
269 * \li Origin: Jug, 18 Feb 2000
272 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
273 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
274 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
275 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
277 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
278 * \li Action: Inserts an optional-argument (short title) inset.
279 * \li Syntax: optional-insert
280 * \li Origin: Martin, 12 Aug 2002
283 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
285 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
286 * \li Action: Inserts a horizontal line.
287 * \li Syntax: line-insert
288 * \li Origin: poenitz, Oct 27 2003
291 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
293 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
294 * \li Action: Inserts a new page.
295 * \li Syntax: newpage-insert
296 * \li Origin: uwestoehr, 24 Nov 2007
299 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_PAGEBREAK_INSERT
302 * \li Action: Inserts a pagebreak.
303 * \li Syntax: pagebreak-insert
304 * \li Origin: poenitz, Oct 27 2003
307 { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
310 * \li Action: Inserts a marginal note.
311 * \li Syntax: marginalnote-insert
312 * \li Origin: Lgb, 26 Jun 2000
315 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
317 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
318 * \li Action: Inserts a single unicode character.
319 * \li Syntax: unicode-insert <CHAR>
320 * \li Params: <CHAR>: The character to insert, given as its code
321 point, in hexadecimal, e.g.: unicode-insert 0x0100.
322 * \li Origin: Lgb, 22 Oct 2006
325 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
327 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
328 * \li Action: Inserts a new listings inset.
329 * \li Syntax: listing-insert
330 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
333 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
334 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
335 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
336 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
337 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
339 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
340 * \li Action: Inserts CharStyle, Custom inset or XML short element.
341 * \li Notion: Look into the Customization manual for more information about
343 For dissolving the element see #LFUN_INSET_DISSOLVE.
344 * \li Syntax: flex-insert <TYPE:Name>
345 * \li Params: TYPE: CharStyle|Custom|Element|Standard
346 Identifies whether this is a Character Style, a
347 Custom Inset or an XML Element, and which dynamical
348 sub-menu this flex inset is in on the LyX menu tree.
349 If Standard (currently unused): none of these.
350 Name: This name must be defined either in your layout file
351 or imported by some module. The definition is\n
352 InsetLayout <TYPE:Name>
353 * \li Sample: flex-insert CharStyle:Code
356 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
357 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
359 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
360 * \li Action: Inserts one of horizontal space insets.
361 * \li Syntax: space-insert <NAME> [<LEN>]
362 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
363 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
365 <LEN>: length for custom spaces (hspace, hspace* for protected)
366 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
369 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
370 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
372 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
373 * \li Action: Inserts various characters into the document.
374 * \li Syntax: specialchar-insert <CHAR>
375 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
376 end-of-sentence, menu-separator.
377 * \li Origin: JSpitzm, 6 Dec 2007
380 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
381 { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit },
382 { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit },
383 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
384 { LFUN_APPENDIX, "appendix", Noop, Edit },
387 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
390 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
391 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
392 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
393 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
394 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
395 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
396 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
397 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
399 * \var lyx::FuncCode lyx::LFUN_SCROLL
400 * \li Action: Scroll the buffer view.
401 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
402 * \li Syntax: scroll <TYPE> <QUANTITY>
403 * \li Params: <TYPE>: line|page\n
404 <QUANTITY>: up|down|<number>
405 * \li Origin: Abdelrazak Younes, Dec 27 2007
408 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
410 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
411 * \li Action: Recenters the screen on the current cursor position.
412 * \li Syntax: screen-recenter
415 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
416 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
417 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
419 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
421 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
422 * \li Action: Moves the cursor one position logically backwards.
423 * \li Notion: This is not the action which should be bound to the arrow keys,
424 because backwards may be left or right, depending on the
425 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
426 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
427 * \li Syntax: char-backward
430 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
432 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
433 * \li Action: Moves the cursor one position logically backwards, adding
434 traversed position to the selection.
435 * \li Notion: See also #LFUN_CHAR_BACKWARD.
436 * \li Syntax: char-backward-select
439 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
440 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
441 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
443 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
444 * \li Action: Moves the cursor one position logically forward.
445 * \li Notion: This is not the action which should be bound to the arrow keys,
446 because forward may be left or right, depending on the language.
447 The arrow keys should be bound to #LFUN_CHAR_LEFT or
448 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
449 * \li Syntax: char-forward
452 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
454 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
455 * \li Action: Moves the cursor one position logically forward, adding
456 traversed position to the selection.
457 * \li Notion: See also #LFUN_CHAR_FORWARD.
458 * \li Syntax: char-forward-select
461 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
463 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
464 * \li Action: Moves the cursor one position "to the left".
465 * \li Notion: This is the action which should be taken when the "left" key
466 is pressed. Generally, it moves the cursor one position to the
467 left. However, in Bidi text this become slightly more
468 complicated, and there are different modes of cursor movement.
469 In "visual mode", this moves left, plain and simple. In "logical
470 mode", movement is logically forward in RTL paragraphs, and
471 logically backwards in LTR paragraphs.
472 * \li Syntax: char-left
475 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
477 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
478 * \li Action: Moves the cursor one position "to the left", adding
479 traversed position to the selection.
480 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
481 * \li Syntax: char-left-select
484 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
486 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
487 * \li Action: Moves the cursor one position "to the right".
488 * \li Notion: This is the action which should be taken when the "right" key
489 is pressed. Generally, it moves the cursor one position to the
490 right. However, in Bidi text this become slightly more
491 complicated, and there are different modes of cursor movement.
492 In "visual mode", this moves right, plain and simple. In "logical
493 mode", movement is logically forward in LTR paragraphs, and
494 logically backwards in RTL paragraphs.
495 * \li Syntax: char-right
498 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
500 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
501 * \li Action: Moves the cursor one position "to the right", adding
502 traversed position to the selection.
503 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
504 * \li Syntax: char-right-select
507 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
509 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
510 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
511 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
512 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
513 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
514 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
515 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
516 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
517 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
518 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
519 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
520 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
521 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
522 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
523 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
524 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
525 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
526 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
528 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
529 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
530 * \li Syntax: thesaurus-entry
531 * \li Origin: Levon, 20 Jul 2001
534 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
535 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
536 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
537 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
538 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
540 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
541 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
542 { LFUN_LINE_BREAK, "line-break", Noop, Edit },
543 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
544 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
545 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
546 { LFUN_NEW_LINE, "new-line", Noop, Edit },
549 * \var lyx::FuncCode lyx::LFUN_COPY
550 * \li Action: Copies to the clipboard the last edit.
554 { LFUN_COPY, "copy", ReadOnly, Edit },
556 * \var lyx::FuncCode lyx::LFUN_CUT
557 * \li Action: Cuts to the clipboard.
561 { LFUN_CUT, "cut", Noop, Edit },
563 * \var lyx::FuncCode lyx::LFUN_PASTE
564 * \li Action: Pastes from the active clipboard.
568 { LFUN_PASTE, "paste", Noop, Edit },
569 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
571 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
572 * \li Action: Pastes the material currently selected.
573 * \li Syntax: primary-selection-paste
576 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
578 * \var lyx::FuncCode lyx::LFUN_UNDO
579 * \li Action: Undoes the last edit.
583 { LFUN_UNDO, "undo", Noop, Edit },
585 * \var lyx::FuncCode lyx::LFUN_REDO
586 * \li Action: Redoes the last thing undone.
590 { LFUN_REDO, "redo", Noop, Edit },
591 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
592 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
594 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
595 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
596 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
598 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
599 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
600 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
601 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
602 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
603 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
604 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
605 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
606 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
607 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
608 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
609 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
610 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
611 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
612 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
614 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
615 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
617 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
618 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
620 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
621 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
623 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
624 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
625 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
626 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
629 * \var lyx::FuncCode lyx::LFUN_LAYOUT
630 * \li Action: Sets the layout (that is, environment) for the current paragraph.
631 * \li Syntax: layout <LAYOUT>
632 * \li Params: <LAYOUT>: the layout to use
635 { LFUN_LAYOUT, "layout", Noop, Layout },
637 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
638 * \li Action: Launches the paragraph settings dialog.
639 * \li Syntax: layout-paragraph
642 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
643 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
645 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
646 * \li Action: Displays list of layout choices.
647 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
648 dropbox allowing for choice of layout.
649 * \li Syntax: drop-layouts-choice
652 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
654 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
655 * \li Action: Clears the module list.
656 * \li Notion: Clears the list of included modules for the current buffer.
657 * \li Syntax: layout-modules-clear
658 * \li Origin: rgh, 25 August 2007
661 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
663 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
664 * \li Action: Adds a module.
665 * \li Notion: Adds a module to the list of included modules for the current buffer.
666 * \li Syntax: layout-module-add <MODULE>
667 * \li Params: <MODULE>: the module to be added
668 * \li Origin: rgh, 25 August 2007
671 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
673 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
674 * \li Action: Reloads layout information.
675 * \li Notion: Reloads all layout information for the current buffer from disk, thus
676 recognizing any changes that have been made to layout files on the fly.
677 This is intended to be used only by layout developers and should not be
678 used when one is trying to do actual work.
679 * \li Syntax: layout-reload
680 * \li Origin: rgh, 3 September 2007
683 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
685 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
686 * \li Action: Sets the text class for the current buffer.
687 * \li Syntax: textclass-apply <TEXTCLASS>
688 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
689 the filename, minus the ".layout" extension.
692 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
694 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
695 * \li Action: Loads information for a textclass from disk.
696 * \li Syntax: textclass-load <TEXTCLASS>
697 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
698 the filename, minus the ".layout" extension.
701 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
704 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
705 * \li Action: Disable selecting of text-region.
706 * \li Syntax: mark-off
709 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
711 * \var lyx::FuncCode lyx::LFUN_MARK_ON
712 * \li Action: Enable selecting of text-region.
713 * \li Notion: After enabling you can simply move arrow keys to get selected region.
714 * \li Syntax: mark-on
717 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
719 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
720 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
721 * \li Syntax: mark-toggle
722 * \li Origin: poenitz, May 5 2006
725 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
727 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
728 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
729 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
730 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
731 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
732 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
733 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
734 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
735 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
736 { LFUN_MATH_SPACE, "math-space", Noop, Math },
737 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
738 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
739 { LFUN_MATH_MODE, "math-mode", Noop, Math },
741 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
742 * \li Action: Toggles numbering of the current formula line.
743 * \li Notion: Must be in display formula mode.
744 * \li Syntax: math-number-line-toggle
745 * \li Origin: Alejandro 18 Jun 1996
748 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
750 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
751 * \li Action: Toggles numbering/labeling of the current formula.
752 * \li Notion: Must be in display formula mode.
753 * \li Syntax: math-number-toggle
754 * \li Origin: Alejandro 4 Jun 1996
757 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
758 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
759 { LFUN_MATH_SIZE, "math-size", Noop, Math },
761 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
762 * \li Action: Unfold a Math Macro.
763 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
765 * \li Syntax: math-macro-unfold
766 * \li Origin: sts, 06 January 2008
769 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
771 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
772 * \li Action: Fold a Math Macro.
773 * \li Notion: Fold the Math Macro the cursor is in if it was
774 unfolded, i.e. displayed as \foo before.
775 * \li Syntax: math-macro-fold
776 * \li Origin: sts, 06 January 2008
779 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
781 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
782 * \li Action: Add a parameter.
783 * \li Notion: Add a parameter to a Math Macro.
784 * \li Params: <NUM>: The number of the parameter behind which the new one
785 will be added (1 for the first, i.e. use 0 for add a
786 parameter at the left), defaults to the last one.
787 * \li Syntax: math-macro-add-param <NUM>
788 * \li Origin: sts, 06 January 2008
791 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
793 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
794 * \li Action: Remove the last parameter.
795 * \li Notion: Remove the last parameter of a Math Macro and
796 remove its value in all instances of the macro
798 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
799 the first), defaults to the last one.
800 * \li Syntax: math-macro-remove-param <NUM>
801 * \li Origin: sts, 06 January 2008
804 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
806 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
807 * \li Action: Append a greedy parameter.
808 * \li Notion: Append a greedy parameter to a Math Macro which
809 eats the following mathed cell in every instance of
810 the macro in the buffer.
811 * \li Syntax: math-macro-append-greedy-param
812 * \li Origin: sts, 06 January 2008
815 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
817 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
818 * \li Action: Remove a greedy parameter.
819 * \li Notion: Remove a greedy parameter of a Math Macro and spit
820 out the values of it in every instance of the macro
821 in the buffer. If it is an optional parameter the [valud]
823 * \li Syntax: math-macro-remove-greedy-param
824 * \li Origin: sts, 06 January 2008
827 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
829 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
830 * \li Action: Make a parameter optional.
831 * \li Notion: Turn the first non-optional parameter of a Math Macro
832 into an optional parameter with a default value.
833 * \li Syntax: math-macro-make-optional
834 * \li Origin: sts, 06 January 2008
837 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
839 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
840 * \li Action: Make a parameter non-optional.
841 * \li Notion: Turn the last optional parameter of a Math Macro
842 into a non-optional parameter. The default value is
843 remembered to be reused later if the user changes his mind.
844 * \li Syntax: math-macro-make-nonoptional
845 * \li Origin: sts, 06 January 2008
848 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
850 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
851 * \li Action: Add an optional parameter.
852 * \li Notion: Insert an optional parameter just behind the
853 already existing optional parameters.
854 * \li Syntax: math-macro-add-optional-param
855 * \li Origin: sts, 06 January 2008
858 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
860 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
861 * \li Action: Remove the last optional parameter.
862 * \li Notion: Remove the last optional parameter of a Math Macro and
863 remove it in all the instances of the macro in the buffer.
864 * \li Syntax: math-macro-remove-optional-param
865 * \li Origin: sts, 06 January 2008
868 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
870 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
871 * \li Action: Add a greedy optional parameter.
872 * \li Notion: Add a greedy optional parameter which eats the value
873 from the following cells in mathed which are in the [value]
875 * \li Syntax: math-macro-add-greedy-optional-param
876 * \li Origin: sts, 06 January 2008
879 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
881 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
882 * \li Action: Only active in Math Macro definition.
883 * \li Notion: Dummy function which is only active in a Math Macro definition.
884 It's used to toggle the Math Macro toolbar if the cursor moves
885 into a Math Macro definition.
886 * \li Syntax: in-mathmacrotemplate
887 * \li Origin: sts, 06 January 2008
890 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
893 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
894 * \li Action: Moves the current paragraph downwards in the document.
895 * \li Syntax: paragraph-move-down
896 * \li Origin: Edwin, 8 Apr 2006
899 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
901 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
902 * \li Action: Moves the current paragraph upwards in the document.
903 * \li Syntax: paragraph-move-up
904 * \li Origin: Edwin, 8 Apr 2006
907 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
909 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
910 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
911 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
912 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
913 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
915 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
916 * \li Action: Jump to a paragraph given by its id number.
917 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
918 seen on the screen. Moreover the id is unique for all opened buffers (documents).
919 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
920 * \li Origin: Dekel, 26 Aug 2000
923 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
925 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
926 * \li Action: Breaks the current paragraph at the current location.
927 * \li Syntax: break-paragraph
930 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
932 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
933 * \li Action: Breaks the current paragraph at the current location,
934 unless used at the beginning of a line, where it sets
935 the label width string to empty.
936 * \li Syntax: break-paragraph-skip
939 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
941 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
942 * \li Action: Change paragraph settings.
943 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
944 This function only modifies, and does not override, existing settings.
945 Note that the "leftindent" indent setting is deprecated.
946 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
947 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
948 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
949 <ALIGN>: \\align block|left|right|center|default\n
950 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
951 * \li Origin: rgh, Aug 15 2007
954 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
956 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
957 * \li Action: Change paragraph settings.
958 * \li Notion: Overwrite all nonspecified settings to the default ones.
959 Use paragraph-params lfun if you don't want to overwrite others settings.
960 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
961 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
962 * \li Origin: leeming, 30 Mar 2004
965 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
966 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
969 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
970 * \li Action: Move the current group in the upward direction in the
971 structure of the document.
972 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
973 the whole substructure of the group.
974 * \li Syntax: outline-up
975 * \li Origin: Vermeer, 23 Mar 2006
978 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
980 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
981 * \li Action: Move the current group in the downward direction in the
982 structure of the document.
983 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
984 the whole substructure of the group.
985 * \li Syntax: outline-down
986 * \li Origin: Vermeer, 23 Mar 2006
989 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
991 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
992 * \li Action: Moves the current group in the downward direction in the
993 hierarchy of the document structure.
994 * \li Notion: Part -> Chapter -> Section -> etc.
995 * \li Syntax: outline-in
996 * \li Origin: Vermeer, 23 Mar 2006
999 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1001 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1002 * \li Action: Moves the current group in the upward direction in the
1003 hierarchy of the document structure.
1004 * \li Notion: Part <- Chapter <- Section <- etc.
1005 * \li Syntax: outline-out
1006 * \li Origin: Vermeer, 23 Mar 2006
1009 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1011 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
1012 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
1014 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1015 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1016 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1017 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1018 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1020 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1021 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1022 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1023 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1024 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1026 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1027 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1028 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1029 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1030 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1031 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1032 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1033 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1036 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1037 * \li Action: Apply data for an inset.
1038 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1039 be applied. This is either changed to #LFUN_INSET_MODIFY or
1040 #LFUN_INSET_INSERT depending on the context where it is called.
1041 * \li Syntax: inset-apply <ARGS>
1042 * \li Params: See #LFUN_INSET_INSERT .
1045 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1046 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1048 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1049 * \li Action: Insert new inset (type given by the parameters).
1050 * \li Syntax: inset-insert <INSET> <ARGS>
1051 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1052 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1053 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1055 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1056 where <label name> is the name of the referenced label and
1057 <Format> is one of the following: \n
1058 ref -- <reference> \n
1059 eqref -- (<reference>) \n
1060 pageref -- <page> \n
1061 vpageref -- on <page> \n
1062 vref -- <reference> on <page> \n
1063 prettyref -- Formatted reference
1066 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1068 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1069 * \li Action: Modify existing inset.
1070 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1071 bibtex, ert, command, graphics, note, space, vspace, tabular,
1072 bibitem, inlude, ref insets.
1073 * \li Syntax: inset-modify <INSET> <ARGS>
1074 * \li Params: See #LFUN_INSET_INSERT for further details.
1077 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1079 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1080 * \li Action: Modify the inset at cursor position, if there is one.
1081 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1082 bibtex, ert, command, graphics, note, space, vspace, tabular,
1083 bibitem, inlude, ref insets.
1084 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1085 * \li Params: See #LFUN_INSET_INSERT for further details.
1086 * \li Origin: JSpitzm, 23 Mar 2008
1089 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1090 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1092 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1093 * \li Action: Open the inset's properties dialog.
1094 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1095 * \li Syntax: inset-settings <INSET>
1096 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1099 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1101 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1102 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1103 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1104 be entered. Also cf. #LFUN_INSET_SETTINGS.
1105 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1106 bibtex, ert, command, graphics, note, space, vspace, tabular,
1107 bibitem, inlude, ref insets.
1108 * \li Syntax: next-inset-toggle
1111 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1112 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1114 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1115 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1116 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1117 * \li Syntax: all-insets-toggle <STATE> <INSET>
1118 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1119 * <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1122 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1125 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1126 * \li Action: Moves the cursor out of the current slice, going forward.
1127 * \li Notion: Cursor movement within an inset may be different than cursor
1128 movement in the surrounding text. This action should be called
1129 automatically by the cursor movement within the inset, when
1130 movement within the inset has ceased (reached the end of the
1131 last paragraph, for example), in order to move correctly
1132 back into the surrounding text.
1135 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1137 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1138 * \li Action: Moves the cursor out of the current slice, going backwards.
1139 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1142 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1144 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1145 * \li Action: Moves the cursor out of the current slice, going right.
1146 * \li Notion: See also #LFUN_FINISHED_FORWARD
1149 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1151 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1152 * \li Action: Moves the cursor out of the current slice, going left.
1153 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1156 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1158 { LFUN_LANGUAGE, "language", Noop, Edit },
1161 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1162 * \li Action: Goto a label.
1163 * \li Syntax: label-goto [<LABEL>]
1164 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1165 is on cursor position, Bookmark 0 is saved and
1166 cursor moves to the position of referenced label.
1167 * \li Origin: Ale, 6 Aug 1997
1170 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1171 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1173 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1174 * \li Action: Go to the next label or cross-reference.
1175 * \li Syntax: reference-next
1176 * \li Origin: Dekel, 14 Jan 2001
1179 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1182 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1183 * \li Action: Goto a bookmark.
1184 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1185 if necessary. Note that bookmarsk are saved per-session, not
1187 * \li Syntax: bookmark-goto <NUMBER>
1188 * \li Params: <NUMBER>: the number of the bookmark to restore.
1189 * \li Origin: Dekel, 27 January 2001
1192 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1194 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1195 * \li Action: Save a bookmark.
1196 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1197 must be between 1 and 9, inclusive. Note that bookmarks are
1198 saved per-session, not per file.
1199 * \li Syntax: bookmark-save <NUMBER>
1200 * \li Params: <NUMBER>: the number of the bookmark to save.
1201 * \li Origin: Dekel, 27 January 2001
1204 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1206 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1207 * \li Action: Clears the list of saved bookmarks.
1208 * \li Syntax: bookmark-clear
1209 * \li Origin: bpeng, 31 October 2006
1212 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1215 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1216 * \li Action: Open the given help file according to the language setting.
1217 * \li Syntax: help-open <FILE>[.lyx]
1218 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1219 * \li Author: Jug, 27 Jun 1999
1222 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1224 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1225 * \li Action: Terminates the current LyX instance.
1226 * \li Notion: Terminates the current LyX instance, asking whether to save
1227 modified documents, etc.
1228 * \li Syntax: lyx-quit
1231 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1233 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1234 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1235 * \li Notion: Skiping "auto" when allowauto is false.
1236 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1237 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1238 minibuffer|review|view/update|math_panels
1239 * \li Origin: Edwin, 21 May 2007
1242 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1243 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1245 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1246 * \li Action: Various UI visibility-toggling actions.
1247 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1248 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1249 menubar : Toggle visibility of the menubar.\n
1250 scrollbar : Toggle visibility of the scrollbar.\n
1251 frame : Toggle visibility of the frames around editing window.\n
1252 fullscreen : Toggle fullscreen mode. This also covers calling the
1253 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1254 custom tweaks of the toolbars should be used.
1255 * \li Origin: ps, 9 Feb 2007
1258 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1260 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1261 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1264 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1265 * \li Action: Creates another split view of current buffer.
1266 * \li Notion: All split views act in the same way indpendently.
1267 * \li Syntax: split-view <vertical|horizontal>
1268 * \li Params: horizontal : The work areas are laid out side by side.\n
1269 vertical : The work areas laid out vertically.\n
1270 * \li Origin: abdel, 20 Feb 2008
1273 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1276 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1277 * \li Action: Close the current tab group.
1278 * \li Notion: This only closes the work areas, not the buffer themselves.
1279 The still opened buffers can be visualized in another tab group.
1280 * \li Syntax: close-tab-group
1281 * \li Origin: abdel, 21 Feb 2008
1284 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1285 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1286 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1287 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1288 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1289 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1290 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1292 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1293 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1294 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1295 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1296 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1298 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1299 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1300 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1301 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1303 { LFUN_MESSAGE, "message", NoBuffer, System },
1304 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1305 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1307 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1308 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1309 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1310 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1311 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1313 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1314 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1315 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1316 * \li Origin: Edmar, 23 Dec 1998
1319 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1320 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1321 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1323 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1326 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1327 * \li Action: Saves the current buffer to a temporary file.
1328 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1329 is called automatically by LyX, to "autosave" the current buffer.
1330 * \li Syntax: buffer-auto-save
1333 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1334 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1335 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1337 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1338 * \li Action: Toggles compression of the current document on/off.
1339 * \li Syntax: buffer-toggle-compression
1340 * \li Origin: bpeng, 27 Apr 2006
1343 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1345 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_EMBEDDING
1346 * \li Action: Toggles the embeddding feature on/off.
1347 * \li Syntax: buffer-toggle-embedding
1348 * \li Origin: bpeng, 21 Oct 2007
1351 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1353 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1354 * \li Action: Closes the current buffer.
1355 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1356 if the buffer has been modified.
1357 * \li Syntax: buffer-close
1360 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1362 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1363 * \li Action: Exports the current buffer (document) to the given format.
1364 * \li Syntax: buffer-export <FORMAT>
1365 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1366 can find in Tools->Preferences->File formats->Format.
1367 Usual format you will enter is "pdf2" (pdflatex),
1368 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1369 In case of "custom" you will be asked for a format you
1370 want to start from and for the command that you want to
1371 apply to this format. Internally the control is then passed
1372 to #LFUN_BUFFER_EXPORT_CUSTOM.
1373 * \li Origin: Lgb, 29 Jul 1997
1376 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1378 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1379 * \li Action: Exports the current buffer (document) from the given format using
1380 the given command on it.
1381 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1382 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1383 intermediate file).\n
1384 <COMMAND> this command will be launched on the file. Note that you can
1385 use "$$FName" string to qualify the intermediate file.
1386 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1387 * \li Origin: leeming, 27 Mar 2004
1390 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1392 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1393 * \li Action: Prints the current document.
1394 * \li Notion: Many settings can be given via the preferences dialog.
1395 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1396 * \li Params: <TARGET> is either "printer" or "file".\n
1397 <TARGER-NAME> is either "default" or file name or printer name.\n
1398 <COMMAND> command ensuring the printing job.
1399 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1400 * \li Origin: leeming, 28 Mar 2004
1403 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1405 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1406 * \li Action: Import a given file as a lyx document.
1407 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1408 defined convertors in preferences. Look into File->Import menu to get
1409 an idea of the currently active import formats.
1410 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1411 * \li Origin: Asger, 24 Jul 1998
1414 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1416 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1417 * \li Action: Creates a new buffer (that is, document).
1418 * \li Notion: Implicit path can be set in Preferences dialog.
1419 * \li Syntax: buffer-new [<FILE>]
1420 * \li Params: <FILE>: filename of created file with absolute path.
1423 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1425 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1426 * \li Action: Creates a new buffer (that is, document) from a template.
1427 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1428 Template will be asked for via Open-dialog.
1429 * \li Syntax: buffer-new-template [<FILE>]
1430 * \li Params: <FILE>: filename of created file with absolute path.
1433 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1435 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1436 * \li Action: Reverts opened document.
1437 * \li Syntax: buffer-reload
1438 * \li Origin: Asger, 2 Feb 1997
1441 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1443 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1444 * \li Action: Switch to the given buffer.
1445 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1446 document in different LyX windows.
1447 * \li Syntax: buffer-new-template <BUFFER>
1448 * \li Params: <BUFFER>: already opened document which is to be shown.
1451 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1453 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1454 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1455 * \li Syntax: buffer-toggle-read-only
1456 * \li Origin: Lgb, 27 May 1997
1459 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1461 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1462 * \li Action: Displays current buffer in chosen format.
1463 * \li Notion: Displays the contents of the current buffer in the chosen
1464 format, for example, PDF or DVI. This runs the necessary
1465 converter, calls the defined viewer, and so forth.
1466 * \li Syntax: buffer-view <FORMAT>
1467 * \li Params: <FORMAT>: The format to display, where this is one of the
1468 formats defined (in the current GUI) in the
1469 Tools>Preferences>File Formats dialog.
1472 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1474 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1475 * \li Action: Exports the current document and put the result into the
1476 temporary directory.
1477 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1478 the output will be rewriten - updated. This is useful in case your viewer
1479 is able to detect such changes (e.g. ghostview for postscript).
1480 * \li Syntax: buffer-update <FORMAT>
1481 * \li Params: <FORMAT>: The format to display, where this is one of the
1482 formats defined (in the current GUI) in the
1483 Tools>Preferences>File Formats dialog.
1484 * \li Origin: Dekel, 5 Aug 2000
1487 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1490 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1491 * \li Action: Saves the current buffer.
1492 * \li Notion: Saves the current buffer to disk, using the filename that
1493 is already associated with the buffer, asking for one if
1494 none is yet assigned.
1495 * \li Syntax: buffer-write
1498 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1500 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1501 * \li Action: Rename and save current buffer.
1502 * \li Syntax: buffer-write-as <FILENAME>
1503 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1504 is with respect to the original location of the buffer/file.
1507 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1508 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1509 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1510 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1511 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1512 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1513 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1514 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1515 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1518 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1519 * \li Action: Inserts another LyX file.
1520 * \li Syntax: file-insert [<FILE>]
1521 * \li Params: <FILE>: Filename to be inserted.
1524 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1526 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1527 * \li Action: Inserts plain text file.
1528 * \li Syntax: file-insert-plaintext [<FILE>]
1529 * \li Params: <FILE>: Filename to be inserted.
1530 * \li Origin: CFO-G, 19 Nov 1997
1533 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1535 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1536 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1537 * \li Syntax: file-insert-plaintext-para [<FILE>]
1538 * \li Params: <FILE>: Filename to be inserted.
1539 * \li Origin: Levon, 14 Feb 2001
1542 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1544 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1545 * \li Action: Open LyX document.
1546 * \li Syntax: file-open [<FILE>]
1547 * \li Params: <FILE>: Filename to be opened.
1550 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1553 * \var lyx::FuncCode lyx::LFUN_CALL
1554 * \li Action: Executes a command defined in a .def file.
1555 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1556 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1557 where <NAME> is the name of the new command and <LFUN> is the lfun code
1558 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1559 \\def_file "FileName" allows to include another .def file. \n
1560 This is particularly useful in connection with toolbar buttons:
1561 Since the name of the button image for this lfun is
1562 lib/images/commands/<NAME>.png this is the way to assign an image
1563 to a complex command-sequence.
1564 * \li Syntax: call <NAME>
1565 * \li Params: <NAME>: Name of the command that must be called.
1566 * \li Origin: broider, 2 Oct 2007
1569 { LFUN_CALL, "call", NoBuffer, System },
1571 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1572 * \li Action: Simulate halting Meta key (Alt key on PCs).
1573 * \li Notion: Used for buffer editation not for GUI control.
1574 * \li Syntax: meta-prefix
1577 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1579 * \var lyx::FuncCode lyx::LFUN_CANCEL
1580 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1581 * \li Syntax: cancel
1584 { LFUN_CANCEL, "cancel", NoBuffer, System },
1587 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1588 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1589 * \li Notion: Usually bound to M-x shortcut.
1590 * \li Syntax: command-execute
1593 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1594 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1596 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1597 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1598 * \li Syntax: command-sequence <CMDS>
1599 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1600 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1601 * \li Origin: Andre', 11 Nov 1999
1604 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1607 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1608 * \li Action: Save user preferences.
1609 * \li Syntax: preferences-save
1610 * \li Origin: Lgb, 27 Nov 1999
1613 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1615 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1616 * \li Action: Reconfigure the automatic settings.
1617 * \li Syntax: reconfigure
1618 * \li Origin: Asger, 14 Feb 1997
1621 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1623 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1624 * \li Action: Apply the given settings to user preferences.
1625 * \li Syntax: lyxrc-apply <SETTINGS>
1626 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1627 to get an idea which commands to use and their syntax.
1628 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1631 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1633 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1634 * \li Action: Determine whether keep cursor inside the editing window regardless
1635 the scrollbar movement.
1636 * \li Syntax: toggle-cursor-follows-scrollbar
1637 * \li Origin: ARRae, 2 Dec 1997
1640 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1642 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1643 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1644 * \li Notion: A new color entry is created if the color is unknown.
1645 Color names can be stored as a part of user settings.
1646 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1647 * \li Origin: SLior, 11 Jun 2000
1650 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1652 * \var lyx::FuncCode lyx::LFUN_STATISTICS
1653 * \li Action: Count the statistics (number of words and characters)
1654 in the document or in the given selection.
1655 * \li Notion: Note that this function gives the number of words/chars written,
1656 not the number of characters which will be typeset.
1657 * \li Syntax: statistics
1658 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1661 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1663 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1664 * \li Action: Show the inline completion at the cursor position.
1665 * \li Syntax: completion-inline
1666 * \li Origin: sts, Feb 19 2008
1669 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1671 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1672 * \li Action: Show the completion popup at the cursor position.
1673 * \li Syntax: completion-popup
1674 * \li Origin: sts, Feb 19 2008
1677 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1679 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1680 * \li Action: Try to complete the word or command at the cursor position.
1681 * \li Syntax: completion-complete
1682 * \li Origin: sts, Feb 19 2008
1685 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1687 { LFUN_NOACTION, "", Noop, Hidden }
1688 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1691 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1692 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1699 LyXAction::LyXAction()
1705 // Returns an action tag from a string.
1706 FuncRequest LyXAction::lookupFunc(string const & func) const
1708 string const func2 = trim(func);
1710 if (func2.empty()) {
1711 return FuncRequest(LFUN_NOACTION);
1715 string const arg = split(func2, cmd, ' ');
1717 func_map::const_iterator fit = lyx_func_map.find(cmd);
1719 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1723 string const LyXAction::getActionName(FuncCode action) const
1725 info_map::const_iterator const it = lyx_info_map.find(action);
1726 return it != lyx_info_map.end() ? it->second.name : string();
1730 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1732 info_map::const_iterator const it = lyx_info_map.find(action);
1733 return it != lyx_info_map.end() ? it->second.type : Hidden;
1737 bool LyXAction::funcHasFlag(FuncCode action,
1738 LyXAction::func_attrib flag) const
1740 info_map::const_iterator ici = lyx_info_map.find(action);
1742 if (ici == lyx_info_map.end()) {
1743 LYXERR0("action: " << action << " is not known.");
1744 BOOST_ASSERT(false);
1747 return ici->second.attrib & flag;
1751 LyXAction::const_func_iterator LyXAction::func_begin() const
1753 return lyx_func_map.begin();
1757 LyXAction::const_func_iterator LyXAction::func_end() const
1759 return lyx_func_map.end();