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<ARG>
296 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
297 * \li Origin: uwestoehr, 24 Nov 2007
300 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
302 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
303 * \li Action: Inserts a marginal note.
304 * \li Syntax: marginalnote-insert
305 * \li Origin: Lgb, 26 Jun 2000
308 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
310 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
311 * \li Action: Inserts a single unicode character.
312 * \li Syntax: unicode-insert <CHAR>
313 * \li Params: <CHAR>: The character to insert, given as its code
314 point, in hexadecimal, e.g.: unicode-insert 0x0100.
315 * \li Origin: Lgb, 22 Oct 2006
318 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
321 * \li Action: Inserts a new listings inset.
322 * \li Syntax: listing-insert
323 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
326 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
327 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
328 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
329 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
330 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
332 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
333 * \li Action: Inserts CharStyle, Custom inset or XML short element.
334 * \li Notion: Look into the Customization manual for more information about
336 For dissolving the element see #LFUN_INSET_DISSOLVE.
337 * \li Syntax: flex-insert <TYPE:Name>
338 * \li Params: TYPE: CharStyle|Custom|Element|Standard
339 Identifies whether this is a Character Style, a
340 Custom Inset or an XML Element, and which dynamical
341 sub-menu this flex inset is in on the LyX menu tree.
342 If Standard (currently unused): none of these.
343 Name: This name must be defined either in your layout file
344 or imported by some module. The definition is\n
345 InsetLayout <TYPE:Name>
346 * \li Sample: flex-insert CharStyle:Code
349 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
350 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
352 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
353 * \li Action: Inserts one of horizontal space insets.
354 * \li Syntax: space-insert <NAME> [<LEN>]
355 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
356 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
358 <LEN>: length for custom spaces (hspace, hspace* for protected)
359 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
362 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
363 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
365 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
366 * \li Action: Inserts various characters into the document.
367 * \li Syntax: specialchar-insert <CHAR>
368 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
369 end-of-sentence, menu-separator.
370 * \li Origin: JSpitzm, 6 Dec 2007
373 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
374 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
375 { LFUN_APPENDIX, "appendix", Noop, Edit },
378 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
381 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
382 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
383 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
384 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
385 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
386 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
387 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
388 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
390 * \var lyx::FuncCode lyx::LFUN_SCROLL
391 * \li Action: Scroll the buffer view.
392 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
393 * \li Syntax: scroll <TYPE> <QUANTITY>
394 * \li Params: <TYPE>: line|page\n
395 <QUANTITY>: up|down|<number>
396 * \li Origin: Abdelrazak Younes, Dec 27 2007
399 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
401 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
402 * \li Action: Recenters the screen on the current cursor position.
403 * \li Syntax: screen-recenter
406 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
407 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
408 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
410 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
412 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
413 * \li Action: Moves the cursor one position logically backwards.
414 * \li Notion: This is not the action which should be bound to the arrow keys,
415 because backwards may be left or right, depending on the
416 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
417 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
418 * \li Syntax: char-backward
421 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
423 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
424 * \li Action: Moves the cursor one position logically backwards, adding
425 traversed position to the selection.
426 * \li Notion: See also #LFUN_CHAR_BACKWARD.
427 * \li Syntax: char-backward-select
430 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
431 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
432 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
434 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
435 * \li Action: Moves the cursor one position logically forward.
436 * \li Notion: This is not the action which should be bound to the arrow keys,
437 because forward may be left or right, depending on the language.
438 The arrow keys should be bound to #LFUN_CHAR_LEFT or
439 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
440 * \li Syntax: char-forward
443 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
445 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
446 * \li Action: Moves the cursor one position logically forward, adding
447 traversed position to the selection.
448 * \li Notion: See also #LFUN_CHAR_FORWARD.
449 * \li Syntax: char-forward-select
452 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
454 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
455 * \li Action: Moves the cursor one position "to the left".
456 * \li Notion: This is the action which should be taken when the "left" key
457 is pressed. Generally, it moves the cursor one position to the
458 left. However, in Bidi text this become slightly more
459 complicated, and there are different modes of cursor movement.
460 In "visual mode", this moves left, plain and simple. In "logical
461 mode", movement is logically forward in RTL paragraphs, and
462 logically backwards in LTR paragraphs.
463 * \li Syntax: char-left
466 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
468 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
469 * \li Action: Moves the cursor one position "to the left", adding
470 traversed position to the selection.
471 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
472 * \li Syntax: char-left-select
475 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
477 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
478 * \li Action: Moves the cursor one position "to the right".
479 * \li Notion: This is the action which should be taken when the "right" key
480 is pressed. Generally, it moves the cursor one position to the
481 right. However, in Bidi text this become slightly more
482 complicated, and there are different modes of cursor movement.
483 In "visual mode", this moves right, plain and simple. In "logical
484 mode", movement is logically forward in LTR paragraphs, and
485 logically backwards in RTL paragraphs.
486 * \li Syntax: char-right
489 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
491 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
492 * \li Action: Moves the cursor one position "to the right", adding
493 traversed position to the selection.
494 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
495 * \li Syntax: char-right-select
498 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
500 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
501 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
502 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
503 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
504 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
507 * \li Action: Search for a given string in forward direction.
508 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
509 * \li Syntax: word-find-forward [<STRING>]
510 * \li Origin: Etienne, 16 Feb 1998
513 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
515 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
516 * \li Action: Search for a given string in backward direction.
517 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
518 * \li Syntax: word-find-backward [<STRING>]
519 * \li Origin: Etienne, 20 Feb 1998
522 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
524 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
525 * \li Action: Search for next occurence of a string.
526 * \li Syntax: word-find <DATA>
527 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
528 * \li Origin: poenitz, Jan 7 2004
531 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
532 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
533 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
534 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
535 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
536 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
537 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
538 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
539 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
540 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
541 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
543 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
544 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
545 * \li Syntax: thesaurus-entry
546 * \li Origin: Levon, 20 Jul 2001
549 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
550 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
551 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
552 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
553 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
555 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
556 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
557 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
558 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
559 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
561 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
562 * \li Action: Inserts a line break or new line.
563 * \li Syntax: newline-insert<ARG>
564 * \li Params: <ARG>: <newline|linebreak> default: newline
565 * \li Origin: JSpitzm, 25 Mar 2008
568 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
571 * \var lyx::FuncCode lyx::LFUN_COPY
572 * \li Action: Copies to the clipboard the last edit.
576 { LFUN_COPY, "copy", ReadOnly, Edit },
578 * \var lyx::FuncCode lyx::LFUN_CUT
579 * \li Action: Cuts to the clipboard.
583 { LFUN_CUT, "cut", Noop, Edit },
585 * \var lyx::FuncCode lyx::LFUN_PASTE
586 * \li Action: Pastes from the active clipboard.
590 { LFUN_PASTE, "paste", Noop, Edit },
591 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
593 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
594 * \li Action: Pastes the material currently selected.
595 * \li Syntax: primary-selection-paste
598 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
600 * \var lyx::FuncCode lyx::LFUN_UNDO
601 * \li Action: Undoes the last edit.
605 { LFUN_UNDO, "undo", Noop, Edit },
607 * \var lyx::FuncCode lyx::LFUN_REDO
608 * \li Action: Redoes the last thing undone.
612 { LFUN_REDO, "redo", Noop, Edit },
613 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
614 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
616 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
617 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
618 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
620 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
621 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
622 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
623 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
624 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
625 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
626 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
627 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
628 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
629 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
630 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
631 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
632 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
633 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
634 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
636 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
637 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
639 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
640 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
642 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
643 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
645 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
646 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
647 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
648 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
651 * \var lyx::FuncCode lyx::LFUN_LAYOUT
652 * \li Action: Sets the layout (that is, environment) for the current paragraph.
653 * \li Syntax: layout <LAYOUT>
654 * \li Params: <LAYOUT>: the layout to use
657 { LFUN_LAYOUT, "layout", Noop, Layout },
659 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
660 * \li Action: Launches the paragraph settings dialog.
661 * \li Syntax: layout-paragraph
664 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
665 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
667 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
668 * \li Action: Displays list of layout choices.
669 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
670 dropbox allowing for choice of layout.
671 * \li Syntax: drop-layouts-choice
674 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
676 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
677 * \li Action: Clears the module list.
678 * \li Notion: Clears the list of included modules for the current buffer.
679 * \li Syntax: layout-modules-clear
680 * \li Origin: rgh, 25 August 2007
683 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
685 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
686 * \li Action: Adds a module.
687 * \li Notion: Adds a module to the list of included modules for the current buffer.
688 * \li Syntax: layout-module-add <MODULE>
689 * \li Params: <MODULE>: the module to be added
690 * \li Origin: rgh, 25 August 2007
693 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
695 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
696 * \li Action: Reloads layout information.
697 * \li Notion: Reloads all layout information for the current buffer from disk, thus
698 recognizing any changes that have been made to layout files on the fly.
699 This is intended to be used only by layout developers and should not be
700 used when one is trying to do actual work.
701 * \li Syntax: layout-reload
702 * \li Origin: rgh, 3 September 2007
705 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
707 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
708 * \li Action: Sets the text class for the current buffer.
709 * \li Syntax: textclass-apply <TEXTCLASS>
710 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
711 the filename, minus the ".layout" extension.
714 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
716 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
717 * \li Action: Loads information for a textclass from disk.
718 * \li Syntax: textclass-load <TEXTCLASS>
719 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
720 the filename, minus the ".layout" extension.
723 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
726 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
727 * \li Action: Disable selecting of text-region.
728 * \li Syntax: mark-off
731 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
733 * \var lyx::FuncCode lyx::LFUN_MARK_ON
734 * \li Action: Enable selecting of text-region.
735 * \li Notion: After enabling you can simply move arrow keys to get selected region.
736 * \li Syntax: mark-on
739 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
741 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
742 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
743 * \li Syntax: mark-toggle
744 * \li Origin: poenitz, May 5 2006
747 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
749 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
750 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
751 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
752 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
753 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
754 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
755 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
756 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
757 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
758 { LFUN_MATH_SPACE, "math-space", Noop, Math },
759 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
760 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
761 { LFUN_MATH_MODE, "math-mode", Noop, Math },
763 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
764 * \li Action: Toggles numbering of the current formula line.
765 * \li Notion: Must be in display formula mode.
766 * \li Syntax: math-number-line-toggle
767 * \li Origin: Alejandro 18 Jun 1996
770 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
772 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
773 * \li Action: Toggles numbering/labeling of the current formula.
774 * \li Notion: Must be in display formula mode.
775 * \li Syntax: math-number-toggle
776 * \li Origin: Alejandro 4 Jun 1996
779 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
780 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
781 { LFUN_MATH_SIZE, "math-size", Noop, Math },
783 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
784 * \li Action: Unfold a Math Macro.
785 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
787 * \li Syntax: math-macro-unfold
788 * \li Origin: sts, 06 January 2008
791 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
793 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
794 * \li Action: Fold a Math Macro.
795 * \li Notion: Fold the Math Macro the cursor is in if it was
796 unfolded, i.e. displayed as \foo before.
797 * \li Syntax: math-macro-fold
798 * \li Origin: sts, 06 January 2008
801 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
803 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
804 * \li Action: Add a parameter.
805 * \li Notion: Add a parameter to a Math Macro.
806 * \li Params: <NUM>: The number of the parameter behind which the new one
807 will be added (1 for the first, i.e. use 0 for add a
808 parameter at the left), defaults to the last one.
809 * \li Syntax: math-macro-add-param <NUM>
810 * \li Origin: sts, 06 January 2008
813 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
815 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
816 * \li Action: Remove the last parameter.
817 * \li Notion: Remove the last parameter of a Math Macro and
818 remove its value in all instances of the macro
820 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
821 the first), defaults to the last one.
822 * \li Syntax: math-macro-remove-param <NUM>
823 * \li Origin: sts, 06 January 2008
826 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
828 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
829 * \li Action: Append a greedy parameter.
830 * \li Notion: Append a greedy parameter to a Math Macro which
831 eats the following mathed cell in every instance of
832 the macro in the buffer.
833 * \li Syntax: math-macro-append-greedy-param
834 * \li Origin: sts, 06 January 2008
837 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
839 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
840 * \li Action: Remove a greedy parameter.
841 * \li Notion: Remove a greedy parameter of a Math Macro and spit
842 out the values of it in every instance of the macro
843 in the buffer. If it is an optional parameter the [valud]
845 * \li Syntax: math-macro-remove-greedy-param
846 * \li Origin: sts, 06 January 2008
849 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
851 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
852 * \li Action: Make a parameter optional.
853 * \li Notion: Turn the first non-optional parameter of a Math Macro
854 into an optional parameter with a default value.
855 * \li Syntax: math-macro-make-optional
856 * \li Origin: sts, 06 January 2008
859 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
861 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
862 * \li Action: Make a parameter non-optional.
863 * \li Notion: Turn the last optional parameter of a Math Macro
864 into a non-optional parameter. The default value is
865 remembered to be reused later if the user changes his mind.
866 * \li Syntax: math-macro-make-nonoptional
867 * \li Origin: sts, 06 January 2008
870 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
872 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
873 * \li Action: Add an optional parameter.
874 * \li Notion: Insert an optional parameter just behind the
875 already existing optional parameters.
876 * \li Syntax: math-macro-add-optional-param
877 * \li Origin: sts, 06 January 2008
880 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
882 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
883 * \li Action: Remove the last optional parameter.
884 * \li Notion: Remove the last optional parameter of a Math Macro and
885 remove it in all the instances of the macro in the buffer.
886 * \li Syntax: math-macro-remove-optional-param
887 * \li Origin: sts, 06 January 2008
890 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
892 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
893 * \li Action: Add a greedy optional parameter.
894 * \li Notion: Add a greedy optional parameter which eats the value
895 from the following cells in mathed which are in the [value]
897 * \li Syntax: math-macro-add-greedy-optional-param
898 * \li Origin: sts, 06 January 2008
901 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
903 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
904 * \li Action: Only active in Math Macro definition.
905 * \li Notion: Dummy function which is only active in a Math Macro definition.
906 It's used to toggle the Math Macro toolbar if the cursor moves
907 into a Math Macro definition.
908 * \li Syntax: in-mathmacrotemplate
909 * \li Origin: sts, 06 January 2008
912 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
915 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
916 * \li Action: Moves the current paragraph downwards in the document.
917 * \li Syntax: paragraph-move-down
918 * \li Origin: Edwin, 8 Apr 2006
921 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
923 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
924 * \li Action: Moves the current paragraph upwards in the document.
925 * \li Syntax: paragraph-move-up
926 * \li Origin: Edwin, 8 Apr 2006
929 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
931 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
932 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
933 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
934 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
935 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
937 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
938 * \li Action: Jump to a paragraph given by its id number.
939 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
940 seen on the screen. Moreover the id is unique for all opened buffers (documents).
941 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
942 * \li Origin: Dekel, 26 Aug 2000
945 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
947 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
948 * \li Action: Breaks the current paragraph at the current location.
949 * \li Syntax: break-paragraph
952 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
954 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
955 * \li Action: Breaks the current paragraph at the current location,
956 unless used at the beginning of a line, where it sets
957 the label width string to empty.
958 * \li Syntax: break-paragraph-skip
961 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
963 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
964 * \li Action: Change paragraph settings.
965 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
966 This function only modifies, and does not override, existing settings.
967 Note that the "leftindent" indent setting is deprecated.
968 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
969 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
970 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
971 <ALIGN>: \\align block|left|right|center|default\n
972 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
973 * \li Origin: rgh, Aug 15 2007
976 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
978 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
979 * \li Action: Change paragraph settings.
980 * \li Notion: Overwrite all nonspecified settings to the default ones.
981 Use paragraph-params lfun if you don't want to overwrite others settings.
982 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
983 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
984 * \li Origin: leeming, 30 Mar 2004
987 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
988 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
991 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
992 * \li Action: Move the current group in the upward direction in the
993 structure of the document.
994 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
995 the whole substructure of the group.
996 * \li Syntax: outline-up
997 * \li Origin: Vermeer, 23 Mar 2006
1000 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1002 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1003 * \li Action: Move the current group in the downward direction in the
1004 structure of the document.
1005 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1006 the whole substructure of the group.
1007 * \li Syntax: outline-down
1008 * \li Origin: Vermeer, 23 Mar 2006
1011 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1013 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1014 * \li Action: Moves the current group in the downward direction in the
1015 hierarchy of the document structure.
1016 * \li Notion: Part -> Chapter -> Section -> etc.
1017 * \li Syntax: outline-in
1018 * \li Origin: Vermeer, 23 Mar 2006
1021 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1023 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1024 * \li Action: Moves the current group in the upward direction in the
1025 hierarchy of the document structure.
1026 * \li Notion: Part <- Chapter <- Section <- etc.
1027 * \li Syntax: outline-out
1028 * \li Origin: Vermeer, 23 Mar 2006
1031 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1033 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
1034 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
1036 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1037 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1038 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1039 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1040 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1042 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1043 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1044 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1045 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1046 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1048 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1049 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1050 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1051 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1052 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1053 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1054 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1055 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1058 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1059 * \li Action: Apply data for an inset.
1060 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1061 be applied. This is either changed to #LFUN_INSET_MODIFY or
1062 #LFUN_INSET_INSERT depending on the context where it is called.
1063 * \li Syntax: inset-apply <ARGS>
1064 * \li Params: See #LFUN_INSET_INSERT .
1067 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1068 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1070 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1071 * \li Action: Insert new inset (type given by the parameters).
1072 * \li Syntax: inset-insert <INSET> <ARGS>
1073 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1074 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1075 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1077 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1078 where <label name> is the name of the referenced label and
1079 <Format> is one of the following: \n
1080 ref -- <reference> \n
1081 eqref -- (<reference>) \n
1082 pageref -- <page> \n
1083 vpageref -- on <page> \n
1084 vref -- <reference> on <page> \n
1085 prettyref -- Formatted reference
1088 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1090 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1091 * \li Action: Modify existing inset.
1092 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1093 bibtex, ert, command, graphics, note, space, vspace, tabular,
1094 bibitem, inlude, ref insets.
1095 * \li Syntax: inset-modify <INSET> <ARGS>
1096 * \li Params: See #LFUN_INSET_INSERT for further details.
1099 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1101 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1102 * \li Action: Modify the inset at cursor position, if there is one.
1103 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1104 bibtex, ert, command, graphics, note, space, vspace, tabular,
1105 bibitem, inlude, ref insets.
1106 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1107 * \li Params: See #LFUN_INSET_INSERT for further details.
1108 * \li Origin: JSpitzm, 23 Mar 2008
1111 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1112 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1114 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1115 * \li Action: Open the inset's properties dialog.
1116 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1117 * \li Syntax: inset-settings <INSET>
1118 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1121 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1123 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1124 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1125 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1126 be entered. Also cf. #LFUN_INSET_SETTINGS.
1127 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1128 bibtex, ert, command, graphics, note, space, vspace, tabular,
1129 bibitem, inlude, ref insets.
1130 * \li Syntax: next-inset-toggle
1133 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1134 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1136 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1137 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1138 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1139 * \li Syntax: all-insets-toggle <STATE> <INSET>
1140 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1141 * <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1144 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1147 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1148 * \li Action: Moves the cursor out of the current slice, going forward.
1149 * \li Notion: Cursor movement within an inset may be different than cursor
1150 movement in the surrounding text. This action should be called
1151 automatically by the cursor movement within the inset, when
1152 movement within the inset has ceased (reached the end of the
1153 last paragraph, for example), in order to move correctly
1154 back into the surrounding text.
1157 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1159 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1160 * \li Action: Moves the cursor out of the current slice, going backwards.
1161 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1164 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1166 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1167 * \li Action: Moves the cursor out of the current slice, going right.
1168 * \li Notion: See also #LFUN_FINISHED_FORWARD
1171 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1173 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1174 * \li Action: Moves the cursor out of the current slice, going left.
1175 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1178 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1180 { LFUN_LANGUAGE, "language", Noop, Edit },
1183 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1184 * \li Action: Goto a label.
1185 * \li Syntax: label-goto [<LABEL>]
1186 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1187 is on cursor position, Bookmark 0 is saved and
1188 cursor moves to the position of referenced label.
1189 * \li Origin: Ale, 6 Aug 1997
1192 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1193 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1196 * \li Action: Go to the next label or cross-reference.
1197 * \li Syntax: reference-next
1198 * \li Origin: Dekel, 14 Jan 2001
1201 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1205 * \li Action: Goto a bookmark.
1206 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1207 if necessary. Note that bookmarsk are saved per-session, not
1209 * \li Syntax: bookmark-goto <NUMBER>
1210 * \li Params: <NUMBER>: the number of the bookmark to restore.
1211 * \li Origin: Dekel, 27 January 2001
1214 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1216 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1217 * \li Action: Save a bookmark.
1218 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1219 must be between 1 and 9, inclusive. Note that bookmarks are
1220 saved per-session, not per file.
1221 * \li Syntax: bookmark-save <NUMBER>
1222 * \li Params: <NUMBER>: the number of the bookmark to save.
1223 * \li Origin: Dekel, 27 January 2001
1226 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1228 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1229 * \li Action: Clears the list of saved bookmarks.
1230 * \li Syntax: bookmark-clear
1231 * \li Origin: bpeng, 31 October 2006
1234 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1237 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1238 * \li Action: Open the given help file according to the language setting.
1239 * \li Syntax: help-open <FILE>[.lyx]
1240 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1241 * \li Author: Jug, 27 Jun 1999
1244 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1246 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1247 * \li Action: Terminates the current LyX instance.
1248 * \li Notion: Terminates the current LyX instance, asking whether to save
1249 modified documents, etc.
1250 * \li Syntax: lyx-quit
1253 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1255 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1256 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1257 * \li Notion: Skiping "auto" when allowauto is false.
1258 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1259 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1260 minibuffer|review|view/update|math_panels
1261 * \li Origin: Edwin, 21 May 2007
1264 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1265 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1267 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1268 * \li Action: Various UI visibility-toggling actions.
1269 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1270 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1271 menubar : Toggle visibility of the menubar.\n
1272 scrollbar : Toggle visibility of the scrollbar.\n
1273 frame : Toggle visibility of the frames around editing window.\n
1274 fullscreen : Toggle fullscreen mode. This also covers calling the
1275 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1276 custom tweaks of the toolbars should be used.
1277 * \li Origin: ps, 9 Feb 2007
1280 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1282 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1283 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1286 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1287 * \li Action: Creates another split view of current buffer.
1288 * \li Notion: All split views act in the same way indpendently.
1289 * \li Syntax: split-view <vertical|horizontal>
1290 * \li Params: horizontal : The work areas are laid out side by side.\n
1291 vertical : The work areas laid out vertically.\n
1292 * \li Origin: abdel, 20 Feb 2008
1295 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1298 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1299 * \li Action: Close the current tab group.
1300 * \li Notion: This only closes the work areas, not the buffer themselves.
1301 The still opened buffers can be visualized in another tab group.
1302 * \li Syntax: close-tab-group
1303 * \li Origin: abdel, 21 Feb 2008
1306 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1307 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1308 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1309 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1310 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1311 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1312 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1314 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1315 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1316 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1317 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1318 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1320 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1321 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1322 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1323 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1325 { LFUN_MESSAGE, "message", NoBuffer, System },
1326 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1327 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1329 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1330 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1331 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1332 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1333 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1335 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1336 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1337 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1338 * \li Origin: Edmar, 23 Dec 1998
1341 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1342 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1343 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1345 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1348 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1349 * \li Action: Saves the current buffer to a temporary file.
1350 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1351 is called automatically by LyX, to "autosave" the current buffer.
1352 * \li Syntax: buffer-auto-save
1355 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1356 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1357 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1359 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1360 * \li Action: Toggles compression of the current document on/off.
1361 * \li Syntax: buffer-toggle-compression
1362 * \li Origin: bpeng, 27 Apr 2006
1365 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1367 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_EMBEDDING
1368 * \li Action: Toggles the embeddding feature on/off.
1369 * \li Syntax: buffer-toggle-embedding
1370 * \li Origin: bpeng, 21 Oct 2007
1373 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1375 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1376 * \li Action: Closes the current buffer.
1377 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1378 if the buffer has been modified.
1379 * \li Syntax: buffer-close
1382 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1384 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1385 * \li Action: Exports the current buffer (document) to the given format.
1386 * \li Syntax: buffer-export <FORMAT>
1387 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1388 can find in Tools->Preferences->File formats->Format.
1389 Usual format you will enter is "pdf2" (pdflatex),
1390 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1391 In case of "custom" you will be asked for a format you
1392 want to start from and for the command that you want to
1393 apply to this format. Internally the control is then passed
1394 to #LFUN_BUFFER_EXPORT_CUSTOM.
1395 * \li Origin: Lgb, 29 Jul 1997
1398 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1400 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1401 * \li Action: Exports the current buffer (document) from the given format using
1402 the given command on it.
1403 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1404 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1405 intermediate file).\n
1406 <COMMAND> this command will be launched on the file. Note that you can
1407 use "$$FName" string to qualify the intermediate file.
1408 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1409 * \li Origin: leeming, 27 Mar 2004
1412 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1414 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1415 * \li Action: Prints the current document.
1416 * \li Notion: Many settings can be given via the preferences dialog.
1417 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1418 * \li Params: <TARGET> is either "printer" or "file".\n
1419 <TARGER-NAME> is either "default" or file name or printer name.\n
1420 <COMMAND> command ensuring the printing job.
1421 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1422 * \li Origin: leeming, 28 Mar 2004
1425 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1427 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1428 * \li Action: Import a given file as a lyx document.
1429 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1430 defined convertors in preferences. Look into File->Import menu to get
1431 an idea of the currently active import formats.
1432 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1433 * \li Origin: Asger, 24 Jul 1998
1436 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1438 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1439 * \li Action: Creates a new buffer (that is, document).
1440 * \li Notion: Implicit path can be set in Preferences dialog.
1441 * \li Syntax: buffer-new [<FILE>]
1442 * \li Params: <FILE>: filename of created file with absolute path.
1445 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1447 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1448 * \li Action: Creates a new buffer (that is, document) from a template.
1449 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1450 Template will be asked for via Open-dialog.
1451 * \li Syntax: buffer-new-template [<FILE>]
1452 * \li Params: <FILE>: filename of created file with absolute path.
1455 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1457 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1458 * \li Action: Reverts opened document.
1459 * \li Syntax: buffer-reload
1460 * \li Origin: Asger, 2 Feb 1997
1463 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1465 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1466 * \li Action: Switch to the given buffer.
1467 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1468 document in different LyX windows.
1469 * \li Syntax: buffer-new-template <BUFFER>
1470 * \li Params: <BUFFER>: already opened document which is to be shown.
1473 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1475 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1476 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1477 * \li Syntax: buffer-toggle-read-only
1478 * \li Origin: Lgb, 27 May 1997
1481 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1483 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1484 * \li Action: Displays current buffer in chosen format.
1485 * \li Notion: Displays the contents of the current buffer in the chosen
1486 format, for example, PDF or DVI. This runs the necessary
1487 converter, calls the defined viewer, and so forth.
1488 * \li Syntax: buffer-view <FORMAT>
1489 * \li Params: <FORMAT>: The format to display, where this is one of the
1490 formats defined (in the current GUI) in the
1491 Tools>Preferences>File Formats dialog.
1494 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1496 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1497 * \li Action: Exports the current document and put the result into the
1498 temporary directory.
1499 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1500 the output will be rewriten - updated. This is useful in case your viewer
1501 is able to detect such changes (e.g. ghostview for postscript).
1502 * \li Syntax: buffer-update <FORMAT>
1503 * \li Params: <FORMAT>: The format to display, where this is one of the
1504 formats defined (in the current GUI) in the
1505 Tools>Preferences>File Formats dialog.
1506 * \li Origin: Dekel, 5 Aug 2000
1509 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1512 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1513 * \li Action: Saves the current buffer.
1514 * \li Notion: Saves the current buffer to disk, using the filename that
1515 is already associated with the buffer, asking for one if
1516 none is yet assigned.
1517 * \li Syntax: buffer-write
1520 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1522 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1523 * \li Action: Rename and save current buffer.
1524 * \li Syntax: buffer-write-as <FILENAME>
1525 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1526 is with respect to the original location of the buffer/file.
1529 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1530 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1531 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1532 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1533 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1534 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1535 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1536 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1537 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1540 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1541 * \li Action: Inserts another LyX file.
1542 * \li Syntax: file-insert [<FILE>]
1543 * \li Params: <FILE>: Filename to be inserted.
1546 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1548 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1549 * \li Action: Inserts plain text file.
1550 * \li Syntax: file-insert-plaintext [<FILE>]
1551 * \li Params: <FILE>: Filename to be inserted.
1552 * \li Origin: CFO-G, 19 Nov 1997
1555 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1557 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1558 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1559 * \li Syntax: file-insert-plaintext-para [<FILE>]
1560 * \li Params: <FILE>: Filename to be inserted.
1561 * \li Origin: Levon, 14 Feb 2001
1564 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1566 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1567 * \li Action: Open LyX document.
1568 * \li Syntax: file-open [<FILE>]
1569 * \li Params: <FILE>: Filename to be opened.
1572 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1575 * \var lyx::FuncCode lyx::LFUN_CALL
1576 * \li Action: Executes a command defined in a .def file.
1577 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1578 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1579 where <NAME> is the name of the new command and <LFUN> is the lfun code
1580 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1581 \\def_file "FileName" allows to include another .def file. \n
1582 This is particularly useful in connection with toolbar buttons:
1583 Since the name of the button image for this lfun is
1584 lib/images/commands/<NAME>.png this is the way to assign an image
1585 to a complex command-sequence.
1586 * \li Syntax: call <NAME>
1587 * \li Params: <NAME>: Name of the command that must be called.
1588 * \li Origin: broider, 2 Oct 2007
1591 { LFUN_CALL, "call", NoBuffer, System },
1593 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1594 * \li Action: Simulate halting Meta key (Alt key on PCs).
1595 * \li Notion: Used for buffer editation not for GUI control.
1596 * \li Syntax: meta-prefix
1599 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1601 * \var lyx::FuncCode lyx::LFUN_CANCEL
1602 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1603 * \li Syntax: cancel
1606 { LFUN_CANCEL, "cancel", NoBuffer, System },
1609 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1610 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1611 * \li Notion: Usually bound to M-x shortcut.
1612 * \li Syntax: command-execute
1615 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1616 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1618 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1619 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1620 * \li Syntax: command-sequence <CMDS>
1621 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1622 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1623 * \li Origin: Andre', 11 Nov 1999
1626 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1629 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1630 * \li Action: Save user preferences.
1631 * \li Syntax: preferences-save
1632 * \li Origin: Lgb, 27 Nov 1999
1635 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1637 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1638 * \li Action: Reconfigure the automatic settings.
1639 * \li Syntax: reconfigure
1640 * \li Origin: Asger, 14 Feb 1997
1643 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1645 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1646 * \li Action: Apply the given settings to user preferences.
1647 * \li Syntax: lyxrc-apply <SETTINGS>
1648 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1649 to get an idea which commands to use and their syntax.
1650 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1653 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1655 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1656 * \li Action: Determine whether keep cursor inside the editing window regardless
1657 the scrollbar movement.
1658 * \li Syntax: toggle-cursor-follows-scrollbar
1659 * \li Origin: ARRae, 2 Dec 1997
1662 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1664 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1665 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1666 * \li Notion: A new color entry is created if the color is unknown.
1667 Color names can be stored as a part of user settings.
1668 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1669 * \li Origin: SLior, 11 Jun 2000
1672 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1674 * \var lyx::FuncCode lyx::LFUN_STATISTICS
1675 * \li Action: Count the statistics (number of words and characters)
1676 in the document or in the given selection.
1677 * \li Notion: Note that this function gives the number of words/chars written,
1678 not the number of characters which will be typeset.
1679 * \li Syntax: statistics
1680 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1683 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1685 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1686 * \li Action: Show the inline completion at the cursor position.
1687 * \li Syntax: completion-inline
1688 * \li Origin: sts, Feb 19 2008
1691 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1693 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1694 * \li Action: Show the completion popup at the cursor position.
1695 * \li Syntax: completion-popup
1696 * \li Origin: sts, Feb 19 2008
1699 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1701 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1702 * \li Action: Try to complete the word or command at the cursor position.
1703 * \li Syntax: completion-complete
1704 * \li Origin: sts, Feb 19 2008
1707 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1709 { LFUN_NOACTION, "", Noop, Hidden }
1710 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1713 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1714 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1721 LyXAction::LyXAction()
1727 // Returns an action tag from a string.
1728 FuncRequest LyXAction::lookupFunc(string const & func) const
1730 string const func2 = trim(func);
1732 if (func2.empty()) {
1733 return FuncRequest(LFUN_NOACTION);
1737 string const arg = split(func2, cmd, ' ');
1739 func_map::const_iterator fit = lyx_func_map.find(cmd);
1741 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1745 string const LyXAction::getActionName(FuncCode action) const
1747 info_map::const_iterator const it = lyx_info_map.find(action);
1748 return it != lyx_info_map.end() ? it->second.name : string();
1752 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1754 info_map::const_iterator const it = lyx_info_map.find(action);
1755 return it != lyx_info_map.end() ? it->second.type : Hidden;
1759 bool LyXAction::funcHasFlag(FuncCode action,
1760 LyXAction::func_attrib flag) const
1762 info_map::const_iterator ici = lyx_info_map.find(action);
1764 if (ici == lyx_info_map.end()) {
1765 LYXERR0("action: " << action << " is not known.");
1766 BOOST_ASSERT(false);
1769 return ici->second.attrib & flag;
1773 LyXAction::const_func_iterator LyXAction::func_begin() const
1775 return lyx_func_map.begin();
1779 LyXAction::const_func_iterator LyXAction::func_end() const
1781 return lyx_func_map.end();