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 },
361 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
362 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
363 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
364 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
365 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
366 { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit },
367 { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit },
368 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
369 { LFUN_APPENDIX, "appendix", Noop, Edit },
372 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
373 { LFUN_THEOREM_INSERT, "theorem-insert", Noop, Edit },
376 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
377 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
378 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
379 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
380 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
381 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
382 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
383 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
385 * \var lyx::kb_action lyx::LFUN_SCROLL
386 * \li Action: Scroll the buffer view.
387 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
388 * \li Syntax: scroll <TYPE> <QUANTITY>
389 * \li Params: <TYPE>: line|page\n
390 <QUANTITY>: up|down|<number>
391 * \li Origin: Abdelrazak Younes, Dec 27 2007
394 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
396 * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER
397 * \li Action: Recenters the screen on the current cursor position.
398 * \li Syntax: screen-recenter
401 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
402 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
403 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
405 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
407 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD
408 * \li Action: Moves the cursor one position logically backwards.
409 * \li Notion: This is not the action which should be bound to the arrow keys,
410 because backwards may be left or right, depending on the
411 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
412 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
413 * \li Syntax: char-backward
416 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
418 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD_SELECT
419 * \li Action: Moves the cursor one position logically backwards, adding
420 traversed position to the selection.
421 * \li Notion: See also #LFUN_CHAR_BACKWARD.
422 * \li Syntax: char-backward-select
425 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
426 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
427 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
429 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD
430 * \li Action: Moves the cursor one position logically forward.
431 * \li Notion: This is not the action which should be bound to the arrow keys,
432 because forward may be left or right, depending on the language.
433 The arrow keys should be bound to #LFUN_CHAR_LEFT or
434 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
435 * \li Syntax: char-forward
438 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
440 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD_SELECT
441 * \li Action: Moves the cursor one position logically forward, adding
442 traversed position to the selection.
443 * \li Notion: See also #LFUN_CHAR_FORWARD.
444 * \li Syntax: char-forward-select
447 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
449 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT
450 * \li Action: Moves the cursor one position "to the left".
451 * \li Notion: This is the action which should be taken when the "left" key
452 is pressed. Generally, it moves the cursor one position to the
453 left. However, in Bidi text this become slightly more
454 complicated, and there are different modes of cursor movement.
455 In "visual mode", this moves left, plain and simple. In "logical
456 mode", movement is logically forward in RTL paragraphs, and
457 logically backwards in LTR paragraphs.
458 * \li Syntax: char-left
461 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
463 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT_SELECT
464 * \li Action: Moves the cursor one position "to the left", adding
465 traversed position to the selection.
466 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
467 * \li Syntax: char-left-select
470 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
472 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT
473 * \li Action: Moves the cursor one position "to the right".
474 * \li Notion: This is the action which should be taken when the "right" key
475 is pressed. Generally, it moves the cursor one position to the
476 right. However, in Bidi text this become slightly more
477 complicated, and there are different modes of cursor movement.
478 In "visual mode", this moves right, plain and simple. In "logical
479 mode", movement is logically forward in LTR paragraphs, and
480 logically backwards in RTL paragraphs.
481 * \li Syntax: char-right
484 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
486 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT_SELECT
487 * \li Action: Moves the cursor one position "to the right", adding
488 traversed position to the selection.
489 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
490 * \li Syntax: char-right-select
493 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
495 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
496 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
497 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
498 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
499 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
500 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
501 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
502 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
503 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
504 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
505 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
506 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
507 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
508 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
509 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
510 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
511 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
512 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
514 * \var lyx::kb_action lyx::LFUN_THESAURUS_ENTRY
515 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
516 * \li Syntax: thesaurus-entry
517 * \li Origin: Levon, 20 Jul 2001
520 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
521 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
522 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
523 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
524 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
526 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
527 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
528 { LFUN_LINE_BREAK, "line-break", Noop, Edit },
529 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
530 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
531 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
532 { LFUN_NEW_LINE, "new-line", Noop, Edit },
535 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_DOWN
536 * \li Action: Moves the current paragraph downwards in the document.
537 * \li Syntax: paragraph-move-down
538 * \li Origin: Edwin, 8 Apr 2006
541 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
543 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_UP
544 * \li Action: Moves the current paragraph upwards in the document.
545 * \li Syntax: paragraph-move-up
546 * \li Origin: Edwin, 8 Apr 2006
549 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
551 * \var lyx::kb_action lyx::LFUN_COPY
552 * \li Action: Copies to the clipboard the last edit.
556 { LFUN_COPY, "copy", ReadOnly, Edit },
558 * \var lyx::kb_action lyx::LFUN_CUT
559 * \li Action: Cuts to the clipboard.
563 { LFUN_CUT, "cut", Noop, Edit },
565 * \var lyx::kb_action lyx::LFUN_PASTE
566 * \li Action: Pastes from the active clipboard.
570 { LFUN_PASTE, "paste", Noop, Edit },
571 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
573 * \var lyx::kb_action lyx::LFUN_PRIMARY_SELECTION_PASTE
574 * \li Action: Pastes the material currently selected.
575 * \li Syntax: primary-selection-paste
578 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
580 * \var lyx::kb_action lyx::LFUN_UNDO
581 * \li Action: Undoes the last edit.
585 { LFUN_UNDO, "undo", Noop, Edit },
587 * \var lyx::kb_action lyx::LFUN_REDO
588 * \li Action: Redoes the last thing undone.
592 { LFUN_REDO, "redo", Noop, Edit },
593 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
594 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
596 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
597 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
598 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
600 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
601 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
602 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
603 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
604 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
605 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
606 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
607 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
608 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
609 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
610 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
611 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
612 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
613 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
614 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
616 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
617 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
619 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
620 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
622 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
623 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
625 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
626 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
627 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
628 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
631 * \var lyx::kb_action lyx::LFUN_LAYOUT
632 * \li Action: Sets the layout (that is, environment) for the current paragraph.
633 * \li Syntax: layout <LAYOUT>
634 * \li Params: <LAYOUT>: the layout to use
637 { LFUN_LAYOUT, "layout", Noop, Layout },
639 * \var lyx::kb_action lyx::LFUN_LAYOUT_PARAGRAPH
640 * \li Action: Launches the paragraph settings dialog.
641 * \li Syntax: layout-paragraph
644 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
645 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
647 * \var lyx::kb_action lyx::LFUN_DROP_LAYOUTS_CHOICE
648 * \li Action: Displays list of layout choices.
649 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
650 dropbox allowing for choice of layout.
651 * \li Syntax: drop-layouts-choice
654 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
656 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULES_CLEAR
657 * \li Action: Clears the module list.
658 * \li Notion: Clears the list of included modules for the current buffer.
659 * \li Syntax: layout-modules-clear
660 * \li Origin: rgh, 25 August 2007
663 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
665 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULE_ADD
666 * \li Action: Adds a module.
667 * \li Notion: Adds a module to the list of included modules for the current buffer.
668 * \li Syntax: layout-module-add <MODULE>
669 * \li Params: <MODULE>: the module to be added
670 * \li Origin: rgh, 25 August 2007
673 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
675 * \var lyx::kb_action lyx::LFUN_LAYOUT_RELOAD
676 * \li Action: Reloads layout information.
677 * \li Notion: Reloads all layout information for the current buffer from disk, thus
678 recognizing any changes that have been made to layout files on the fly.
679 This is intended to be used only by layout developers and should not be
680 used when one is trying to do actual work.
681 * \li Syntax: layout-reload
682 * \li Origin: rgh, 3 September 2007
685 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
687 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_APPLY
688 * \li Action: Sets the text class for the current buffer.
689 * \li Syntax: textclass-apply <TEXTCLASS>
690 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
691 the filename, minus the ".layout" extension.
694 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
696 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD
697 * \li Action: Loads information for a textclass from disk.
698 * \li Syntax: textclass-load <TEXTCLASS>
699 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
700 the filename, minus the ".layout" extension.
703 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
706 * \var lyx::kb_action lyx::LFUN_MARK_OFF
707 * \li Action: Disable selecting of text-region.
708 * \li Syntax: mark-off
711 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
713 * \var lyx::kb_action lyx::LFUN_MARK_ON
714 * \li Action: Enable selecting of text-region.
715 * \li Notion: After enabling you can simply move arrow keys to get selected region.
716 * \li Syntax: mark-on
719 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
721 * \var lyx::kb_action lyx::LFUN_MARK_TOGGLE
722 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
723 * \li Syntax: mark-toggle
724 * \li Origin: poenitz, May 5 2006
727 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
729 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
730 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
731 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
732 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
733 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
734 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
735 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
736 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
737 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
738 { LFUN_MATH_SPACE, "math-space", Noop, Math },
739 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
740 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
741 { LFUN_MATH_MODE, "math-mode", Noop, Math },
743 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
744 * \li Action: Toggles numbering of the current formula line.
745 * \li Notion: Must be in display formula mode.
746 * \li Syntax: math-number-line-toggle
747 * \li Origin: Alejandro 18 Jun 1996
750 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
752 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_TOGGLE
753 * \li Action: Toggles numbering of the current formula.
754 * \li Notion: Must be in display formula mode.
755 * \li Syntax: math-number-toggle
756 * \li Origin: Alejandro 4 Jun 1996
759 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
760 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
761 { LFUN_MATH_SIZE, "math-size", Noop, Math },
763 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_UNFOLD
764 * \li Action: Unfold a Math Macro.
765 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
767 * \li Syntax: math-macro-unfold
768 * \li Origin: sts, 06 January 2008
771 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
773 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_FOLD
774 * \li Action: Fold a Math Macro.
775 * \li Notion: Fold the Math Macro the cursor is in if it was
776 unfolded, i.e. displayed as \foo before.
777 * \li Syntax: math-macro-fold
778 * \li Origin: sts, 06 January 2008
781 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
783 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_PARAM
784 * \li Action: Add a parameter.
785 * \li Notion: Add a parameter to a Math Macro.
786 * \li Params: <NUM>: The number of the parameter behind which the new one
787 will be added (1 for the first, i.e. use 0 for add a
788 parameter at the left), defaults to the last one.
789 * \li Syntax: math-macro-add-param <NUM>
790 * \li Origin: sts, 06 January 2008
793 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
795 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_PARAM
796 * \li Action: Remove the last parameter.
797 * \li Notion: Remove the last parameter of a Math Macro and
798 remove its value in all instances of the macro
800 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
801 the first), defaults to the last one.
802 * \li Syntax: math-macro-remove-param <NUM>
803 * \li Origin: sts, 06 January 2008
806 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
808 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
809 * \li Action: Append a greedy parameter.
810 * \li Notion: Append a greedy parameter to a Math Macro which
811 eats the following mathed cell in every instance of
812 the macro in the buffer.
813 * \li Syntax: math-macro-append-greedy-param
814 * \li Origin: sts, 06 January 2008
817 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
819 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
820 * \li Action: Remove a greedy parameter.
821 * \li Notion: Remove a greedy parameter of a Math Macro and spit
822 out the values of it in every instance of the macro
823 in the buffer. If it is an optional parameter the [valud]
825 * \li Syntax: math-macro-remove-greedy-param
826 * \li Origin: sts, 06 January 2008
829 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
831 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
832 * \li Action: Make a parameter optional.
833 * \li Notion: Turn the first non-optional parameter of a Math Macro
834 into an optional parameter with a default value.
835 * \li Syntax: math-macro-make-optional
836 * \li Origin: sts, 06 January 2008
839 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
841 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
842 * \li Action: Make a parameter non-optional.
843 * \li Notion: Turn the last optional parameter of a Math Macro
844 into a non-optional parameter. The default value is
845 remembered to be reused later if the user changes his mind.
846 * \li Syntax: math-macro-make-nonoptional
847 * \li Origin: sts, 06 January 2008
850 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
852 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
853 * \li Action: Add an optional parameter.
854 * \li Notion: Insert an optional parameter just behind the
855 already existing optional parameters.
856 * \li Syntax: math-macro-add-optional-param
857 * \li Origin: sts, 06 January 2008
860 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
862 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
863 * \li Action: Remove the last optional parameter.
864 * \li Notion: Remove the last optional parameter of a Math Macro and
865 remove it in all the instances of the macro in the buffer.
866 * \li Syntax: math-macro-remove-optional-param
867 * \li Origin: sts, 06 January 2008
870 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
872 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
873 * \li Action: Add a greedy optional parameter.
874 * \li Notion: Add a greedy optional parameter which eats the value
875 from the following cells in mathed which are in the [value]
877 * \li Syntax: math-macro-add-greedy-optional-param
878 * \li Origin: sts, 06 January 2008
881 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
883 * \var lyx::kb_action lyx::LFUN_IN_MATHMACROTEMPLATE
884 * \li Action: Only active in Math Macro definition.
885 * \li Notion: Dummy function which is only active in a Math Macro definition.
886 It's used to toggle the Math Macro toolbar if the cursor moves
887 into a Math Macro definition.
888 * \li Syntax: in-mathmacrotemplate
889 * \li Origin: sts, 06 January 2008
892 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
894 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
895 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
896 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
898 * \var lyx::kb_action lyx::LFUN_OUTLINE_UP
899 * \li Action: Move the current group in the upward direction in the
900 structure of the document.
901 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
902 the whole substructure of the group.
903 * \li Syntax: outline-up
904 * \li Origin: Vermeer, 23 Mar 2006
907 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
909 * \var lyx::kb_action lyx::LFUN_OUTLINE_DOWN
910 * \li Action: Move the current group in the downward direction in the
911 structure of the document.
912 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
913 the whole substructure of the group.
914 * \li Syntax: outline-down
915 * \li Origin: Vermeer, 23 Mar 2006
918 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
920 * \var lyx::kb_action lyx::LFUN_OUTLINE_IN
921 * \li Action: Moves the current group in the downward direction in the
922 hierarchy of the document structure.
923 * \li Notion: Part -> Chapter -> Section -> etc.
924 * \li Syntax: outline-in
925 * \li Origin: Vermeer, 23 Mar 2006
928 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
930 * \var lyx::kb_action lyx::LFUN_OUTLINE_OUT
931 * \li Action: Moves the current group in the upward direction in the
932 hierarchy of the document structure.
933 * \li Notion: Part <- Chapter <- Section <- etc.
934 * \li Syntax: outline-out
935 * \li Origin: Vermeer, 23 Mar 2006
938 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
940 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
941 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
942 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
944 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
945 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
947 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
948 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
949 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
950 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
951 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
953 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
954 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
955 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
956 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
957 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
959 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
960 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
961 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
962 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
963 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
964 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
965 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
966 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
968 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
969 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
970 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
971 { LFUN_INSET_MODIFY, "", Noop, Hidden },
972 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
973 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
974 { LFUN_INSET_REFRESH, "", Noop, Hidden },
975 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
976 { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
977 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
980 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS
981 * \li Action: Change paragraph settings.
982 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
983 This function only modifies, and does not override, existing settings.
984 Note that the "leftindent" indent setting is deprecated.
985 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
986 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
987 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
988 <ALIGN>: \\align block|left|right|center|default\n
989 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
990 * \li Origin: rgh, Aug 15 2007
993 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
995 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS_APPLY
996 * \li Action: Change paragraph settings.
997 * \li Notion: Overwrite all nonspecified settings to the default ones.
998 Use paragraph-params lfun if you don't want to overwrite others settings.
999 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1000 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1001 * \li Origin: leeming, 30 Mar 2004
1004 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1005 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1008 * \var lyx::kb_action lyx::LFUN_FINISHED_FORWARD
1009 * \li Action: Moves the cursor out of the current slice, going forward.
1010 * \li Notion: Cursor movement within an inset may be different than cursor
1011 movement in the surrounding text. This action should be called
1012 automatically by the cursor movement within the inset, when
1013 movement within the inset has ceased (reached the end of the
1014 last paragraph, for example), in order to move correctly
1015 back into the surrounding text.
1016 * \li Syntax: finished-forward
1019 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1021 * \var lyx::kb_action lyx::LFUN_FINISHED_BACKWARD
1022 * \li Action: Moves the cursor out of the current slice, going backwards.
1023 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1024 * \li Syntax: finished-backward
1027 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1029 * \var lyx::kb_action lyx::LFUN_FINISHED_RIGHT
1030 * \li Action: Moves the cursor out of the current slice, going right.
1031 * \li Notion: See also #LFUN_FINISHED_FORWARD
1032 * \li Syntax: finished-right
1035 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1037 * \var lyx::kb_action lyx::LFUN_FINISHED_LEFT
1038 * \li Action: Moves the cursor out of the current slice, going left.
1039 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1040 * \li Syntax: finished-left
1043 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1045 { LFUN_LANGUAGE, "language", Noop, Edit },
1047 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1048 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1049 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1052 * \var lyx::kb_action lyx::LFUN_BOOKMARK_GOTO
1053 * \li Action: Goto a bookmark.
1054 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1055 if necessary. Note that bookmarsk are saved per-session, not
1057 * \li Syntax: bookmark-goto <NUMBER>
1058 * \li Params: <NUMBER>: the number of the bookmark to restore.
1059 * \li Origin: Dekel, 27 January 2001
1062 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1064 * \var lyx::kb_action lyx::LFUN_BOOKMARK_SAVE
1065 * \li Action: Save a bookmark.
1066 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1067 must be between 1 and 9, inclusive. Note that bookmarks are
1068 saved per-session, not per file.
1069 * \li Syntax: bookmark-save <NUMBER>
1070 * \li Params: <NUMBER>: the number of the bookmark to save.
1071 * \li Origin: Dekel, 27 January 2001
1074 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1076 * \var lyx::kb_action lyx::LFUN_BOOKMARK_CLEAR
1077 * \li Action: Clears the list of saved bookmarks.
1078 * \li Syntax: bookmark-clear
1079 * \li Origin: bpeng, 31 October 2006
1082 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1084 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1086 * \var lyx::kb_action lyx::LFUN_LYX_QUIT
1087 * \li Action: Terminates the current LyX instance.
1088 * \li Notion: Terminates the current LyX instance, asking whether to save
1089 modified documents, etc.
1090 * \li Syntax: lyx-quit
1093 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1095 * \var lyx::kb_action lyx::LFUN_TOOLBAR_TOGGLE
1096 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1097 * \li Notion: Skiping "auto" when allowauto is false.
1098 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1099 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1100 minibuffer|review|view/update|math_panels
1101 * \li Origin: Edwin, 21 May 2007
1104 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1105 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1107 * \var lyx::kb_action lyx::LFUN_UI_TOGGLE
1108 * \li Action: Various UI visibility-toggling actions.
1109 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1110 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1111 menubar : Toggle visibility of the menubar.\n
1112 frame : Toggle visibility of the frames around editing window.\n
1113 fullscreen : Toggle fullscreen mode. This also covers calling the
1114 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1115 custom tweaks of the toolbars should be used.
1116 * \li Origin: ps, 9 Feb 2007
1119 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1121 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1122 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1124 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1125 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1126 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1127 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1128 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1129 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1131 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1132 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1133 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1134 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1135 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1137 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1138 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1139 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1140 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1142 { LFUN_MESSAGE, "message", NoBuffer, System },
1143 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1144 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1146 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1147 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1148 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1149 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1150 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1151 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1152 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1153 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1155 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1158 * \var lyx::kb_action lyx::LFUN_BUFFER_AUTO_SAVE
1159 * \li Action: Saves the current buffer to a temporary file.
1160 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1161 is called automatically by LyX, to "autosave" the current buffer.
1162 * \li Syntax: buffer-auto-save
1165 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1166 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1167 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1168 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1169 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1171 * \var lyx::kb_action lyx::LFUN_BUFFER_CLOSE
1172 * \li Action: Closes the current buffer.
1173 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1174 if the buffer has been modified.
1175 * \li Syntax: buffer-close
1178 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1180 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT
1181 * \li Action: Exports the current buffer (document) to the given format.
1182 * \li Syntax: buffer-export <FORMAT>
1183 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1184 can find in Tools->Preferences->File formats->Format.
1185 Usual format you will enter is "pdf2" (pdflatex),
1186 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1187 In case of "custom" you will be asked for a format you
1188 want to start from and for the command that you want to
1189 apply to this format. Internally the control is then passed
1190 to #LFUN_BUFFER_EXPORT_CUSTOM.
1191 * \li Origin: Lgb, 29 Jul 1997
1194 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1196 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT_CUSTOM
1197 * \li Action: Exports the current buffer (document) from the given format using
1198 the given command on it.
1199 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1200 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1201 intermediate file).\n
1202 <COMMAND> this command will be launched on the file. Note that you can
1203 use "$$FName" string to qualify the intermediate file.
1204 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1205 * \li Origin: leeming, 27 Mar 2004
1208 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1210 * \var lyx::kb_action lyx::LFUN_BUFFER_PRINT
1211 * \li Action: Prints the current document.
1212 * \li Notion: Many settings can be given via the preferences dialog.
1213 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1214 * \li Params: <TARGET> is either "printer" or "file".\n
1215 <TARGER-NAME> is either "default" or file name or printer name.\n
1216 <COMMAND> command ensuring the printing job.
1217 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1218 * \li Origin: leeming, 28 Mar 2004
1221 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1223 * \var lyx::kb_action lyx::LFUN_BUFFER_IMPORT
1224 * \li Action: Import a given file as a lyx document.
1225 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1226 defined convertors in preferences. Look into File->Import menu to get
1227 an idea of the currently active import formats.
1228 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1229 * \li Origin: Asger, 24 Jul 1998
1232 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1234 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
1235 * \li Action: Creates a new buffer (that is, document).
1236 * \li Notion: Implicit path can be set in Preferences dialog.
1237 * \li Syntax: buffer-new [<FILE>]
1238 * \li Params: <FILE>: filename of created file with absolute path.
1241 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1243 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW_TEMPLATE
1244 * \li Action: Creates a new buffer (that is, document) from a template.
1245 * \li Action: Path for new files and templates can be set in Preferences dialog.
1246 Template will be asked for via Open-dialog.
1247 * \li Syntax: buffer-new-template [<FILE>]
1248 * \li Params: <FILE>: filename of created file with absolute path.
1251 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1252 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1253 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1254 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1255 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1257 * \var lyx::kb_action lyx::LFUN_BUFFER_VIEW
1258 * \li Action: Displays current buffer in chosen format.
1259 * \li Notion: Displays the contents of the current buffer in the chosen
1260 format, for example, PDF or DVI. This runs the necessary
1261 converter, calls the defined viewer, and so forth.
1262 * \li Syntax: buffer-view <FORMAT>
1263 * \li Params: <FORMAT>: The format to display, where this is one of the
1264 formats defined (in the current GUI) in the
1265 Tools>Preferences>File Formats dialog.
1268 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1270 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE
1271 * \li Action: Saves the current buffer.
1272 * \li Notion: Saves the current buffer to disk, using the filename that
1273 is already associated with the buffer, asking for one if
1274 none is yet assigned.
1275 * \li Syntax: buffer-write
1278 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1280 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS
1281 * \li Action: Rename and save current buffer.
1282 * \li Syntax: buffer-write-as <FILENAME>
1283 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1284 is with respect to the original location of the buffer/file.
1287 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1288 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1289 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1290 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1291 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1292 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1293 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1294 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1295 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1297 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1298 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1299 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1300 { LFUN_FILE_NEW, "file-new", NoBuffer, Buffer },
1301 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1305 * \var lyx::kb_action lyx::LFUN_CALL
1306 * \li Action: Executes a command defined in a .def file.
1307 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1308 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1309 where <NAME> is the name of the new command and <LFUN> is the lfun code
1310 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1311 \\def_file "FileName" allows to include another .def file. \n
1312 This is particularly useful in connection with toolbar buttons:
1313 Since the name of the button image for this lfun is
1314 lib/images/commands/<NAME>.png this is the way to assign an image
1315 to a complex command-sequence.
1316 * \li Syntax: call <NAME>
1317 * \li Params: <NAME>: Name of the command that must be called.
1318 * \li Origin: broider, 2 Oct 2007
1321 { LFUN_CALL, "call", NoBuffer, System },
1323 * \var lyx::kb_action lyx::LFUN_META_PREFIX
1324 * \li Action: Simulate halting Meta key (Alt key on PCs).
1325 * \li Notion: Used for buffer editation not for GUI control.
1326 * \li Syntax: meta-prefix
1329 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1331 * \var lyx::kb_action lyx::LFUN_CANCEL
1332 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1333 * \li Syntax: cancel
1336 { LFUN_CANCEL, "cancel", NoBuffer, System },
1339 * \var lyx::kb_action lyx::LFUN_COMMAND_EXECUTE
1340 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1341 * \li Notion: Usually bound to M-x shortcut.
1342 * \li Syntax: command-execute
1345 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1346 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1348 * \var lyx::kb_action lyx::LFUN_COMMAND_SEQUENCE
1349 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1350 * \li Syntax: command-sequence <CMDS>
1351 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1352 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1353 * \li Origin: Andre', 11 Nov 1999
1356 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1359 * \var lyx::kb_action lyx::LFUN_PREFERENCES_SAVE
1360 * \li Action: Save user preferences.
1361 * \li Syntax: preferences-save
1362 * \li Origin: Lgb, 27 Nov 1999
1365 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1367 * \var lyx::kb_action lyx::LFUN_RECONFIGURE
1368 * \li Action: Reconfigure the automatic settings.
1369 * \li Syntax: reconfigure
1370 * \li Origin: Asger, 14 Feb 1997
1373 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1375 * \var lyx::kb_action lyx::LFUN_LYXRC_APPLY
1376 * \li Action: Apply the given settings to user preferences.
1377 * \li Syntax: lyxrc-apply <SETTINGS>
1378 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1379 to get an idea which commands to use and their syntax.
1380 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1383 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1385 * \var lyx::kb_action lyx::LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR
1386 * \li Action: Determine whether keep cursor inside the editing window regardless
1387 the scrollbar movement.
1388 * \li Syntax: toggle-cursor-follows-scrollbar
1389 * \li Origin: ARRae, 2 Dec 1997
1392 { LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar", ReadOnly, System },
1394 * \var lyx::kb_action lyx::LFUN_SET_COLOR
1395 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1396 * \li Notion: A new color entry is created if the color is unknown.
1397 Color names can be stored as a part of user settings.
1398 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1399 * \li Origin: SLior, 11 Jun 2000
1402 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1404 * \var lyx::kb_action lyx::LFUN_STATISTICS
1405 * \li Action: Count the statistics (number of words and characters)
1406 in the document or in the given selection.
1407 * \li Notion: Note that this function gives the number of words/chars written,
1408 not the number of characters which will be typeset.
1409 * \li Syntax: statistics
1410 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1413 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1415 { LFUN_NOACTION, "", Noop, Hidden }
1416 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1419 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1420 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1427 LyXAction::LyXAction()
1433 // Returns an action tag from a string.
1434 FuncRequest LyXAction::lookupFunc(string const & func) const
1436 string const func2 = trim(func);
1438 if (func2.empty()) {
1439 return FuncRequest(LFUN_NOACTION);
1443 string const arg = split(func2, cmd, ' ');
1445 func_map::const_iterator fit = lyx_func_map.find(cmd);
1447 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1451 string const LyXAction::getActionName(kb_action action) const
1453 info_map::const_iterator const it = lyx_info_map.find(action);
1454 return it != lyx_info_map.end() ? it->second.name : string();
1458 LyXAction::func_type const LyXAction::getActionType(kb_action action) const
1460 info_map::const_iterator const it = lyx_info_map.find(action);
1461 return it != lyx_info_map.end() ? it->second.type : Hidden;
1465 bool LyXAction::funcHasFlag(kb_action action,
1466 LyXAction::func_attrib flag) const
1468 info_map::const_iterator ici = lyx_info_map.find(action);
1470 if (ici == lyx_info_map.end()) {
1471 LYXERR0("action: " << action << " is not known.");
1472 BOOST_ASSERT(false);
1475 return ici->second.attrib & flag;
1479 LyXAction::const_func_iterator LyXAction::func_begin() const
1481 return lyx_func_map.begin();
1485 LyXAction::const_func_iterator LyXAction::func_end() const
1487 return lyx_func_map.end();