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 "support/debug.h"
19 #include "FuncRequest.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::kb_action lyx::LFUN_
72 void LyXAction::newFunc(kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action 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::kb_action lyx::LFUN_BREAK_PARAGRAPH
240 * \li Action: Breaks the current paragraph at the current location.
241 * \li Syntax: break-paragraph
244 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
246 * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH_SKIP
247 * \li Action: Breaks the current paragraph at the current location,
248 unless used at the beginning of a line, where it sets
249 the label width string to empty.
250 * \li Syntax: break-paragraph-skip
253 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
255 * \var lyx::kb_action lyx::LFUN_CAPTION_INSERT
256 * \li Action: Inserts a caption inset.
257 * \li Syntax: caption-insert
258 * \li Origin: Lgb, 18 Jul 2000
261 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
263 * \var lyx::kb_action lyx::LFUN_DATE_INSERT
264 * \li Action: Inserts the current date.
265 * \li Syntax: date-insert [<ARG>]
266 * \li Params: <ARG>: Format of date. The default value (%x) can be set
267 in Preferences->Date format. For possible formats
268 see manual page of strftime function.
269 * \li Origin: jdblair, 31 Jan 2000
272 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
274 * \var lyx::kb_action lyx::LFUN_FOOTNOTE_INSERT
275 * \li Action: Inserts a footnote inset.
276 * \li Syntax: footnote-insert
277 * \li Origin: Jug, 7 Mar 2000
280 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
282 * \var lyx::kb_action lyx::LFUN_ERT_INSERT
283 * \li Action: Inserts an ERT inset.
284 * \li Syntax: ert-insert
285 * \li Origin: Jug, 18 Feb 2000
288 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
289 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
290 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
291 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
293 * \var lyx::kb_action lyx::LFUN_HFILL_INSERT
294 * \li Action: Inserts an hfill inset.
295 * \li Syntax: hfill-insert
298 { LFUN_HFILL_INSERT, "hfill-insert", Noop, Edit },
300 * \var lyx::kb_action lyx::LFUN_OPTIONAL_INSERT
301 * \li Action: Inserts an optional-argument (short title) inset.
302 * \li Syntax: optional-insert
303 * \li Origin: Martin, 12 Aug 2002
306 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
308 * \var lyx::kb_action lyx::LFUN_LINE_INSERT
309 * \li Action: Inserts a horizontal line.
310 * \li Syntax: line-insert
311 * \li Origin: poenitz, Oct 27 2003
314 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
316 * \var lyx::kb_action lyx::LFUN_NEWPAGE_INSERT
317 * \li Action: Inserts a new page.
318 * \li Syntax: newpage-insert
319 * \li Origin: uwestoehr, 24 Nov 2007
322 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
324 * \var lyx::kb_action lyx::LFUN_PAGEBREAK_INSERT
325 * \li Action: Inserts a pagebreak.
326 * \li Syntax: pagebreak-insert
327 * \li Origin: poenitz, Oct 27 2003
330 { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
332 * \var lyx::kb_action lyx::LFUN_MARGINALNOTE_INSERT
333 * \li Action: Inserts a marginal note.
334 * \li Syntax: marginalnote-insert
335 * \li Origin: Lgb, 26 Jun 2000
338 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
340 * \var lyx::kb_action lyx::LFUN_UNICODE_INSERT
341 * \li Action: Inserts a single unicode character.
342 * \li Syntax: unicode-insert <CHAR>
343 * \li Params: <CHAR>: The character to insert, given as its code
344 point, in hexadecimal, e.g.: unicode-insert 0x0100.
345 * \li Origin: Lgb, 22 Oct 2006
348 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
350 * \var lyx::kb_action lyx::LFUN_LISTING_INSERT
351 * \li Action: Inserts a new listings inset.
352 * \li Syntax: listing-insert
353 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
356 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
357 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
358 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
359 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
360 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
362 * \var lyx::kb_action lyx::LFUN_FLEX_INSERT
363 * \li Action: Inserts CharStyle, Custom inset or XML short element.
364 * \li Notion: Look into the Customization manual for more information about
366 For dissolving the element see #LFUN_INSET_DISSOLVE.
367 * \li Syntax: flex-insert <TYPE:Name>
368 * \li Params: TYPE: CharStyle|Custom|Element|Standard
369 Name: The identificator of a given character style, custom inset
371 This name must be defined either in your layout file
372 or imported by some module.
373 * \li Sample: flex-insert CharStyle:Code
376 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
377 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
378 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
379 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
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 },
388 { LFUN_THEOREM_INSERT, "theorem-insert", Noop, Edit },
391 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
392 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
393 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
394 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
395 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
396 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
397 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
398 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
400 * \var lyx::kb_action lyx::LFUN_SCROLL
401 * \li Action: Scroll the buffer view.
402 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
403 * \li Syntax: scroll <TYPE> <QUANTITY>
404 * \li Params: <TYPE>: line|page\n
405 <QUANTITY>: up|down|<number>
406 * \li Origin: Abdelrazak Younes, Dec 27 2007
409 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
411 * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER
412 * \li Action: Recenters the screen on the current cursor position.
413 * \li Syntax: screen-recenter
416 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
417 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
418 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
420 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
422 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD
423 * \li Action: Moves the cursor one position logically backwards.
424 * \li Notion: This is not the action which should be bound to the arrow keys,
425 because backwards may be left or right, depending on the
426 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
427 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
428 * \li Syntax: char-backward
431 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
433 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD_SELECT
434 * \li Action: Moves the cursor one position logically backwards, adding
435 traversed position to the selection.
436 * \li Notion: See also #LFUN_CHAR_BACKWARD.
437 * \li Syntax: char-backward-select
440 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
441 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
442 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
444 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD
445 * \li Action: Moves the cursor one position logically forward.
446 * \li Notion: This is not the action which should be bound to the arrow keys,
447 because forward may be left or right, depending on the language.
448 The arrow keys should be bound to #LFUN_CHAR_LEFT or
449 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
450 * \li Syntax: char-forward
453 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
455 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD_SELECT
456 * \li Action: Moves the cursor one position logically forward, adding
457 traversed position to the selection.
458 * \li Notion: See also #LFUN_CHAR_FORWARD.
459 * \li Syntax: char-forward-select
462 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
464 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT
465 * \li Action: Moves the cursor one position "to the left".
466 * \li Notion: This is the action which should be taken when the "left" key
467 is pressed. Generally, it moves the cursor one position to the
468 left. However, in Bidi text this become slightly more
469 complicated, and there are different modes of cursor movement.
470 In "visual mode", this moves left, plain and simple. In "logical
471 mode", movement is logically forward in RTL paragraphs, and
472 logically backwards in LTR paragraphs.
473 * \li Syntax: char-left
476 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
478 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT_SELECT
479 * \li Action: Moves the cursor one position "to the left", adding
480 traversed position to the selection.
481 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
482 * \li Syntax: char-left-select
485 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
487 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT
488 * \li Action: Moves the cursor one position "to the right".
489 * \li Notion: This is the action which should be taken when the "right" key
490 is pressed. Generally, it moves the cursor one position to the
491 right. However, in Bidi text this become slightly more
492 complicated, and there are different modes of cursor movement.
493 In "visual mode", this moves right, plain and simple. In "logical
494 mode", movement is logically forward in LTR paragraphs, and
495 logically backwards in RTL paragraphs.
496 * \li Syntax: char-right
499 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
501 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT_SELECT
502 * \li Action: Moves the cursor one position "to the right", adding
503 traversed position to the selection.
504 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
505 * \li Syntax: char-right-select
508 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
510 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
511 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
512 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
513 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
514 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
515 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
516 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
517 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
518 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
519 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
520 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
521 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
522 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
523 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
524 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
525 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
526 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
527 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
529 * \var lyx::kb_action lyx::LFUN_THESAURUS_ENTRY
530 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
531 * \li Syntax: thesaurus-entry
532 * \li Origin: Levon, 20 Jul 2001
535 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
536 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
537 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
538 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
539 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
541 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
542 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
543 { LFUN_LINE_BREAK, "line-break", Noop, Edit },
544 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
545 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
546 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
547 { LFUN_NEW_LINE, "new-line", Noop, Edit },
550 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_DOWN
551 * \li Action: Moves the current paragraph downwards in the document.
552 * \li Syntax: paragraph-move-down
553 * \li Origin: Edwin, 8 Apr 2006
556 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
558 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_UP
559 * \li Action: Moves the current paragraph upwards in the document.
560 * \li Syntax: paragraph-move-up
561 * \li Origin: Edwin, 8 Apr 2006
564 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
566 * \var lyx::kb_action lyx::LFUN_COPY
567 * \li Action: Copies to the clipboard the last edit.
571 { LFUN_COPY, "copy", ReadOnly, Edit },
573 * \var lyx::kb_action lyx::LFUN_CUT
574 * \li Action: Cuts to the clipboard.
578 { LFUN_CUT, "cut", Noop, Edit },
580 * \var lyx::kb_action lyx::LFUN_PASTE
581 * \li Action: Pastes from the active clipboard.
585 { LFUN_PASTE, "paste", Noop, Edit },
586 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
588 * \var lyx::kb_action lyx::LFUN_PRIMARY_SELECTION_PASTE
589 * \li Action: Pastes the material currently selected.
590 * \li Syntax: primary-selection-paste
593 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
595 * \var lyx::kb_action lyx::LFUN_UNDO
596 * \li Action: Undoes the last edit.
600 { LFUN_UNDO, "undo", Noop, Edit },
602 * \var lyx::kb_action lyx::LFUN_REDO
603 * \li Action: Redoes the last thing undone.
607 { LFUN_REDO, "redo", Noop, Edit },
608 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
609 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
611 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
612 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
613 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
615 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
616 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
617 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
618 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
619 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
620 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
621 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
622 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
623 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
624 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
625 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
626 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
627 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
628 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
629 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
631 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
632 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
634 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
635 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
637 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
638 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
640 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
641 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
642 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
643 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
646 * \var lyx::kb_action lyx::LFUN_LAYOUT
647 * \li Action: Sets the layout (that is, environment) for the current paragraph.
648 * \li Syntax: layout <LAYOUT>
649 * \li Params: <LAYOUT>: the layout to use
652 { LFUN_LAYOUT, "layout", Noop, Layout },
654 * \var lyx::kb_action lyx::LFUN_LAYOUT_PARAGRAPH
655 * \li Action: Launches the paragraph settings dialog.
656 * \li Syntax: layout-paragraph
659 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
660 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
662 * \var lyx::kb_action lyx::LFUN_DROP_LAYOUTS_CHOICE
663 * \li Action: Displays list of layout choices.
664 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
665 dropbox allowing for choice of layout.
666 * \li Syntax: drop-layouts-choice
669 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
671 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULES_CLEAR
672 * \li Action: Clears the module list.
673 * \li Notion: Clears the list of included modules for the current buffer.
674 * \li Syntax: layout-modules-clear
675 * \li Origin: rgh, 25 August 2007
678 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
680 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULE_ADD
681 * \li Action: Adds a module.
682 * \li Notion: Adds a module to the list of included modules for the current buffer.
683 * \li Syntax: layout-module-add <MODULE>
684 * \li Params: <MODULE>: the module to be added
685 * \li Origin: rgh, 25 August 2007
688 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
690 * \var lyx::kb_action lyx::LFUN_LAYOUT_RELOAD
691 * \li Action: Reloads layout information.
692 * \li Notion: Reloads all layout information for the current buffer from disk, thus
693 recognizing any changes that have been made to layout files on the fly.
694 This is intended to be used only by layout developers and should not be
695 used when one is trying to do actual work.
696 * \li Syntax: layout-reload
697 * \li Origin: rgh, 3 September 2007
700 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
702 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_APPLY
703 * \li Action: Sets the text class for the current buffer.
704 * \li Syntax: textclass-apply <TEXTCLASS>
705 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
706 the filename, minus the ".layout" extension.
709 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
711 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD
712 * \li Action: Loads information for a textclass from disk.
713 * \li Syntax: textclass-load <TEXTCLASS>
714 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
715 the filename, minus the ".layout" extension.
718 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
721 * \var lyx::kb_action lyx::LFUN_MARK_OFF
722 * \li Action: Disable selecting of text-region.
723 * \li Syntax: mark-off
726 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
728 * \var lyx::kb_action lyx::LFUN_MARK_ON
729 * \li Action: Enable selecting of text-region.
730 * \li Notion: After enabling you can simply move arrow keys to get selected region.
731 * \li Syntax: mark-on
734 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
736 * \var lyx::kb_action lyx::LFUN_MARK_TOGGLE
737 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
738 * \li Syntax: mark-toggle
739 * \li Origin: poenitz, May 5 2006
742 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
744 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
745 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
746 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
747 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
748 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
749 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
750 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
751 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
752 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
753 { LFUN_MATH_SPACE, "math-space", Noop, Math },
754 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
755 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
756 { LFUN_MATH_MODE, "math-mode", Noop, Math },
758 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
759 * \li Action: Toggles numbering of the current formula line.
760 * \li Notion: Must be in display formula mode.
761 * \li Syntax: math-number-line-toggle
762 * \li Origin: Alejandro 18 Jun 1996
765 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
767 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_TOGGLE
768 * \li Action: Toggles numbering of the current formula.
769 * \li Notion: Must be in display formula mode.
770 * \li Syntax: math-number-toggle
771 * \li Origin: Alejandro 4 Jun 1996
774 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
775 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
776 { LFUN_MATH_SIZE, "math-size", Noop, Math },
778 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_UNFOLD
779 * \li Action: Unfold a Math Macro.
780 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
782 * \li Syntax: math-macro-unfold
783 * \li Origin: sts, 06 January 2008
786 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
788 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_FOLD
789 * \li Action: Fold a Math Macro.
790 * \li Notion: Fold the Math Macro the cursor is in if it was
791 unfolded, i.e. displayed as \foo before.
792 * \li Syntax: math-macro-fold
793 * \li Origin: sts, 06 January 2008
796 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
798 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_PARAM
799 * \li Action: Add a parameter.
800 * \li Notion: Add a parameter to a Math Macro.
801 * \li Params: <NUM>: The number of the parameter behind which the new one
802 will be added (1 for the first, i.e. use 0 for add a
803 parameter at the left), defaults to the last one.
804 * \li Syntax: math-macro-add-param <NUM>
805 * \li Origin: sts, 06 January 2008
808 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
810 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_PARAM
811 * \li Action: Remove the last parameter.
812 * \li Notion: Remove the last parameter of a Math Macro and
813 remove its value in all instances of the macro
815 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
816 the first), defaults to the last one.
817 * \li Syntax: math-macro-remove-param <NUM>
818 * \li Origin: sts, 06 January 2008
821 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
823 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
824 * \li Action: Append a greedy parameter.
825 * \li Notion: Append a greedy parameter to a Math Macro which
826 eats the following mathed cell in every instance of
827 the macro in the buffer.
828 * \li Syntax: math-macro-append-greedy-param
829 * \li Origin: sts, 06 January 2008
832 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
834 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
835 * \li Action: Remove a greedy parameter.
836 * \li Notion: Remove a greedy parameter of a Math Macro and spit
837 out the values of it in every instance of the macro
838 in the buffer. If it is an optional parameter the [valud]
840 * \li Syntax: math-macro-remove-greedy-param
841 * \li Origin: sts, 06 January 2008
844 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
846 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
847 * \li Action: Make a parameter optional.
848 * \li Notion: Turn the first non-optional parameter of a Math Macro
849 into an optional parameter with a default value.
850 * \li Syntax: math-macro-make-optional
851 * \li Origin: sts, 06 January 2008
854 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
856 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
857 * \li Action: Make a parameter non-optional.
858 * \li Notion: Turn the last optional parameter of a Math Macro
859 into a non-optional parameter. The default value is
860 remembered to be reused later if the user changes his mind.
861 * \li Syntax: math-macro-make-nonoptional
862 * \li Origin: sts, 06 January 2008
865 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
867 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
868 * \li Action: Add an optional parameter.
869 * \li Notion: Insert an optional parameter just behind the
870 already existing optional parameters.
871 * \li Syntax: math-macro-add-optional-param
872 * \li Origin: sts, 06 January 2008
875 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
877 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
878 * \li Action: Remove the last optional parameter.
879 * \li Notion: Remove the last optional parameter of a Math Macro and
880 remove it in all the instances of the macro in the buffer.
881 * \li Syntax: math-macro-remove-optional-param
882 * \li Origin: sts, 06 January 2008
885 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
887 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
888 * \li Action: Add a greedy optional parameter.
889 * \li Notion: Add a greedy optional parameter which eats the value
890 from the following cells in mathed which are in the [value]
892 * \li Syntax: math-macro-add-greedy-optional-param
893 * \li Origin: sts, 06 January 2008
896 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
898 * \var lyx::kb_action lyx::LFUN_IN_MATHMACROTEMPLATE
899 * \li Action: Only active in Math Macro definition.
900 * \li Notion: Dummy function which is only active in a Math Macro definition.
901 It's used to toggle the Math Macro toolbar if the cursor moves
902 into a Math Macro definition.
903 * \li Syntax: in-mathmacrotemplate
904 * \li Origin: sts, 06 January 2008
907 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
909 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
910 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
911 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
913 * \var lyx::kb_action lyx::LFUN_OUTLINE_UP
914 * \li Action: Move the current group in the upward direction in the
915 structure of the document.
916 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
917 the whole substructure of the group.
918 * \li Syntax: outline-up
919 * \li Origin: Vermeer, 23 Mar 2006
922 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
924 * \var lyx::kb_action lyx::LFUN_OUTLINE_DOWN
925 * \li Action: Move the current group in the downward direction in the
926 structure of the document.
927 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
928 the whole substructure of the group.
929 * \li Syntax: outline-down
930 * \li Origin: Vermeer, 23 Mar 2006
933 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
935 * \var lyx::kb_action lyx::LFUN_OUTLINE_IN
936 * \li Action: Moves the current group in the downward direction in the
937 hierarchy of the document structure.
938 * \li Notion: Part -> Chapter -> Section -> etc.
939 * \li Syntax: outline-in
940 * \li Origin: Vermeer, 23 Mar 2006
943 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
945 * \var lyx::kb_action lyx::LFUN_OUTLINE_OUT
946 * \li Action: Moves the current group in the upward direction in the
947 hierarchy of the document structure.
948 * \li Notion: Part <- Chapter <- Section <- etc.
949 * \li Syntax: outline-out
950 * \li Origin: Vermeer, 23 Mar 2006
953 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
955 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
956 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
957 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
959 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
960 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
962 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
963 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
964 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
965 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
966 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
968 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
969 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
970 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
971 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
972 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
974 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
975 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
976 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
977 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
978 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
979 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
980 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
981 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
983 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
984 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
985 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
986 { LFUN_INSET_MODIFY, "", Noop, Hidden },
987 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
988 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
989 { LFUN_INSET_REFRESH, "", Noop, Hidden },
990 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
991 { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
992 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
995 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS
996 * \li Action: Change paragraph settings.
997 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
998 This function only modifies, and does not override, existing settings.
999 Note that the "leftindent" indent setting is deprecated.
1000 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1001 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1002 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1003 <ALIGN>: \\align block|left|right|center|default\n
1004 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1005 * \li Origin: rgh, Aug 15 2007
1008 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1010 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1011 * \li Action: Change paragraph settings.
1012 * \li Notion: Overwrite all nonspecified settings to the default ones.
1013 Use paragraph-params lfun if you don't want to overwrite others settings.
1014 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1015 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1016 * \li Origin: leeming, 30 Mar 2004
1019 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1020 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1023 * \var lyx::kb_action lyx::LFUN_FINISHED_FORWARD
1024 * \li Action: Moves the cursor out of the current slice, going forward.
1025 * \li Notion: Cursor movement within an inset may be different than cursor
1026 movement in the surrounding text. This action should be called
1027 automatically by the cursor movement within the inset, when
1028 movement within the inset has ceased (reached the end of the
1029 last paragraph, for example), in order to move correctly
1030 back into the surrounding text.
1031 * \li Syntax: finished-forward
1034 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1036 * \var lyx::kb_action lyx::LFUN_FINISHED_BACKWARD
1037 * \li Action: Moves the cursor out of the current slice, going backwards.
1038 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1039 * \li Syntax: finished-backward
1042 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1044 * \var lyx::kb_action lyx::LFUN_FINISHED_RIGHT
1045 * \li Action: Moves the cursor out of the current slice, going right.
1046 * \li Notion: See also #LFUN_FINISHED_FORWARD
1047 * \li Syntax: finished-right
1050 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1052 * \var lyx::kb_action lyx::LFUN_FINISHED_LEFT
1053 * \li Action: Moves the cursor out of the current slice, going left.
1054 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1055 * \li Syntax: finished-left
1058 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1060 { LFUN_LANGUAGE, "language", Noop, Edit },
1062 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1063 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1064 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1067 * \var lyx::kb_action lyx::LFUN_BOOKMARK_GOTO
1068 * \li Action: Goto a bookmark.
1069 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1070 if necessary. Note that bookmarsk are saved per-session, not
1072 * \li Syntax: bookmark-goto <NUMBER>
1073 * \li Params: <NUMBER>: the number of the bookmark to restore.
1074 * \li Origin: Dekel, 27 January 2001
1077 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1079 * \var lyx::kb_action lyx::LFUN_BOOKMARK_SAVE
1080 * \li Action: Save a bookmark.
1081 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1082 must be between 1 and 9, inclusive. Note that bookmarks are
1083 saved per-session, not per file.
1084 * \li Syntax: bookmark-save <NUMBER>
1085 * \li Params: <NUMBER>: the number of the bookmark to save.
1086 * \li Origin: Dekel, 27 January 2001
1089 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1091 * \var lyx::kb_action lyx::LFUN_BOOKMARK_CLEAR
1092 * \li Action: Clears the list of saved bookmarks.
1093 * \li Syntax: bookmark-clear
1094 * \li Origin: bpeng, 31 October 2006
1097 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1099 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1101 * \var lyx::kb_action lyx::LFUN_LYX_QUIT
1102 * \li Action: Terminates the current LyX instance.
1103 * \li Notion: Terminates the current LyX instance, asking whether to save
1104 modified documents, etc.
1105 * \li Syntax: lyx-quit
1108 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1110 * \var lyx::kb_action lyx::LFUN_TOOLBAR_TOGGLE
1111 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1112 * \li Notion: Skiping "auto" when allowauto is false.
1113 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1114 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1115 minibuffer|review|view/update|math_panels
1116 * \li Origin: Edwin, 21 May 2007
1119 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1120 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1122 * \var lyx::kb_action lyx::LFUN_UI_TOGGLE
1123 * \li Action: Various UI visibility-toggling actions.
1124 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1125 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1126 menubar : Toggle visibility of the menubar.\n
1127 scrollbar : Toggle visibility of the scrollbar.\n
1128 frame : Toggle visibility of the frames around editing window.\n
1129 fullscreen : Toggle fullscreen mode. This also covers calling the
1130 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1131 custom tweaks of the toolbars should be used.
1132 * \li Origin: ps, 9 Feb 2007
1135 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1137 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1138 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1140 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1141 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1142 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1143 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1144 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1145 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1147 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1148 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1149 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1150 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1151 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1153 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1154 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1155 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1156 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1158 { LFUN_MESSAGE, "message", NoBuffer, System },
1159 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1160 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1162 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1163 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1164 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1165 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1166 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1167 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1168 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1169 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1171 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1174 * \var lyx::kb_action lyx::LFUN_BUFFER_AUTO_SAVE
1175 * \li Action: Saves the current buffer to a temporary file.
1176 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1177 is called automatically by LyX, to "autosave" the current buffer.
1178 * \li Syntax: buffer-auto-save
1181 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1182 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1183 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1184 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1185 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1187 * \var lyx::kb_action lyx::LFUN_BUFFER_CLOSE
1188 * \li Action: Closes the current buffer.
1189 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1190 if the buffer has been modified.
1191 * \li Syntax: buffer-close
1194 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1196 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT
1197 * \li Action: Exports the current buffer (document) to the given format.
1198 * \li Syntax: buffer-export <FORMAT>
1199 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1200 can find in Tools->Preferences->File formats->Format.
1201 Usual format you will enter is "pdf2" (pdflatex),
1202 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1203 In case of "custom" you will be asked for a format you
1204 want to start from and for the command that you want to
1205 apply to this format. Internally the control is then passed
1206 to #LFUN_BUFFER_EXPORT_CUSTOM.
1207 * \li Origin: Lgb, 29 Jul 1997
1210 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1212 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT_CUSTOM
1213 * \li Action: Exports the current buffer (document) from the given format using
1214 the given command on it.
1215 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1216 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1217 intermediate file).\n
1218 <COMMAND> this command will be launched on the file. Note that you can
1219 use "$$FName" string to qualify the intermediate file.
1220 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1221 * \li Origin: leeming, 27 Mar 2004
1224 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1226 * \var lyx::kb_action lyx::LFUN_BUFFER_PRINT
1227 * \li Action: Prints the current document.
1228 * \li Notion: Many settings can be given via the preferences dialog.
1229 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1230 * \li Params: <TARGET> is either "printer" or "file".\n
1231 <TARGER-NAME> is either "default" or file name or printer name.\n
1232 <COMMAND> command ensuring the printing job.
1233 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1234 * \li Origin: leeming, 28 Mar 2004
1237 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1239 * \var lyx::kb_action lyx::LFUN_BUFFER_IMPORT
1240 * \li Action: Import a given file as a lyx document.
1241 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1242 defined convertors in preferences. Look into File->Import menu to get
1243 an idea of the currently active import formats.
1244 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1245 * \li Origin: Asger, 24 Jul 1998
1248 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1250 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
1251 * \li Action: Creates a new buffer (that is, document).
1252 * \li Notion: Implicit path can be set in Preferences dialog.
1253 * \li Syntax: buffer-new [<FILE>]
1254 * \li Params: <FILE>: filename of created file with absolute path.
1257 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1259 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW_TEMPLATE
1260 * \li Action: Creates a new buffer (that is, document) from a template.
1261 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1262 Template will be asked for via Open-dialog.
1263 * \li Syntax: buffer-new-template [<FILE>]
1264 * \li Params: <FILE>: filename of created file with absolute path.
1267 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1268 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1270 * \var lyx::kb_action lyx::LFUN_BUFFER_SWITCH
1271 * \li Action: Switch to the given buffer.
1272 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1273 document in different LyX windows.
1274 * \li Syntax: buffer-new-template <BUFFER>
1275 * \li Params: <BUFFER>: already opened document which is to be shown.
1278 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1279 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1280 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1282 * \var lyx::kb_action lyx::LFUN_BUFFER_VIEW
1283 * \li Action: Displays current buffer in chosen format.
1284 * \li Notion: Displays the contents of the current buffer in the chosen
1285 format, for example, PDF or DVI. This runs the necessary
1286 converter, calls the defined viewer, and so forth.
1287 * \li Syntax: buffer-view <FORMAT>
1288 * \li Params: <FORMAT>: The format to display, where this is one of the
1289 formats defined (in the current GUI) in the
1290 Tools>Preferences>File Formats dialog.
1293 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1295 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE
1296 * \li Action: Saves the current buffer.
1297 * \li Notion: Saves the current buffer to disk, using the filename that
1298 is already associated with the buffer, asking for one if
1299 none is yet assigned.
1300 * \li Syntax: buffer-write
1303 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1305 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS
1306 * \li Action: Rename and save current buffer.
1307 * \li Syntax: buffer-write-as <FILENAME>
1308 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1309 is with respect to the original location of the buffer/file.
1312 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1313 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1314 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1315 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1316 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1317 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1318 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1319 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1320 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1322 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1323 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1324 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1326 * \var lyx::kb_action lyx::LFUN_FILE_OPEN
1327 * \li Action: Open LyX document.
1328 * \li Syntax: file-open [<FILE>]
1329 * \li Params: <FILE>: Filename to be opened.
1332 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1336 * \var lyx::kb_action lyx::LFUN_CALL
1337 * \li Action: Executes a command defined in a .def file.
1338 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1339 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1340 where <NAME> is the name of the new command and <LFUN> is the lfun code
1341 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1342 \\def_file "FileName" allows to include another .def file. \n
1343 This is particularly useful in connection with toolbar buttons:
1344 Since the name of the button image for this lfun is
1345 lib/images/commands/<NAME>.png this is the way to assign an image
1346 to a complex command-sequence.
1347 * \li Syntax: call <NAME>
1348 * \li Params: <NAME>: Name of the command that must be called.
1349 * \li Origin: broider, 2 Oct 2007
1352 { LFUN_CALL, "call", NoBuffer, System },
1354 * \var lyx::kb_action lyx::LFUN_META_PREFIX
1355 * \li Action: Simulate halting Meta key (Alt key on PCs).
1356 * \li Notion: Used for buffer editation not for GUI control.
1357 * \li Syntax: meta-prefix
1360 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1362 * \var lyx::kb_action lyx::LFUN_CANCEL
1363 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1364 * \li Syntax: cancel
1367 { LFUN_CANCEL, "cancel", NoBuffer, System },
1370 * \var lyx::kb_action lyx::LFUN_COMMAND_EXECUTE
1371 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1372 * \li Notion: Usually bound to M-x shortcut.
1373 * \li Syntax: command-execute
1376 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1377 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1379 * \var lyx::kb_action lyx::LFUN_COMMAND_SEQUENCE
1380 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1381 * \li Syntax: command-sequence <CMDS>
1382 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1383 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1384 * \li Origin: Andre', 11 Nov 1999
1387 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1390 * \var lyx::kb_action lyx::LFUN_PREFERENCES_SAVE
1391 * \li Action: Save user preferences.
1392 * \li Syntax: preferences-save
1393 * \li Origin: Lgb, 27 Nov 1999
1396 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1398 * \var lyx::kb_action lyx::LFUN_RECONFIGURE
1399 * \li Action: Reconfigure the automatic settings.
1400 * \li Syntax: reconfigure
1401 * \li Origin: Asger, 14 Feb 1997
1404 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1406 * \var lyx::kb_action lyx::LFUN_LYXRC_APPLY
1407 * \li Action: Apply the given settings to user preferences.
1408 * \li Syntax: lyxrc-apply <SETTINGS>
1409 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1410 to get an idea which commands to use and their syntax.
1411 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1414 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1416 * \var lyx::kb_action lyx::LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR
1417 * \li Action: Determine whether keep cursor inside the editing window regardless
1418 the scrollbar movement.
1419 * \li Syntax: toggle-cursor-follows-scrollbar
1420 * \li Origin: ARRae, 2 Dec 1997
1423 { LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar", ReadOnly, System },
1425 * \var lyx::kb_action lyx::LFUN_SET_COLOR
1426 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1427 * \li Notion: A new color entry is created if the color is unknown.
1428 Color names can be stored as a part of user settings.
1429 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1430 * \li Origin: SLior, 11 Jun 2000
1433 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1435 * \var lyx::kb_action lyx::LFUN_STATISTICS
1436 * \li Action: Count the statistics (number of words and characters)
1437 in the document or in the given selection.
1438 * \li Notion: Note that this function gives the number of words/chars written,
1439 not the number of characters which will be typeset.
1440 * \li Syntax: statistics
1441 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1444 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1446 { LFUN_NOACTION, "", Noop, Hidden }
1447 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1450 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1451 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1458 LyXAction::LyXAction()
1464 // Returns an action tag from a string.
1465 FuncRequest LyXAction::lookupFunc(string const & func) const
1467 string const func2 = trim(func);
1469 if (func2.empty()) {
1470 return FuncRequest(LFUN_NOACTION);
1474 string const arg = split(func2, cmd, ' ');
1476 func_map::const_iterator fit = lyx_func_map.find(cmd);
1478 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1482 string const LyXAction::getActionName(kb_action action) const
1484 info_map::const_iterator const it = lyx_info_map.find(action);
1485 return it != lyx_info_map.end() ? it->second.name : string();
1489 LyXAction::func_type const LyXAction::getActionType(kb_action action) const
1491 info_map::const_iterator const it = lyx_info_map.find(action);
1492 return it != lyx_info_map.end() ? it->second.type : Hidden;
1496 bool LyXAction::funcHasFlag(kb_action action,
1497 LyXAction::func_attrib flag) const
1499 info_map::const_iterator ici = lyx_info_map.find(action);
1501 if (ici == lyx_info_map.end()) {
1502 LYXERR0("action: " << action << " is not known.");
1503 BOOST_ASSERT(false);
1506 return ici->second.attrib & flag;
1510 LyXAction::const_func_iterator LyXAction::func_begin() const
1512 return lyx_func_map.begin();
1516 LyXAction::const_func_iterator LyXAction::func_end() const
1518 return lyx_func_map.end();