3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
11 * Full author contact details are available in file CREDITS.
16 #include "LyXAction.h"
18 #include "FuncRequest.h"
20 #include "support/debug.h"
21 #include "support/lstrings.h"
23 #include <boost/assert.hpp>
26 using namespace lyx::support;
31 NAMING RULES FOR USER-COMMANDS
32 Here's the set of rules to apply when a new command name is introduced:
34 1) Use the object.event order. That is, use `word-forward'
35 instead of `forward-word'.
36 2) Don't introduce an alias for an already named object. Same for events.
37 3) Forward movement or focus is called `forward' (not `right').
38 4) Backward movement or focus is called `backward' (not `left').
39 5) Upward movement of focus is called `up'.
40 6) Downward movement is called `down'.
41 7) The begin of an object is called `begin' (not `start').
42 8) The end of an object is called `end'.
44 (May 19 1996, 12:04, RvdK)
47 /* LFUN documentation (a start at least, Chr 2007-08-12)
49 * The documentation below is primarily notes about restrictions and
50 * oddities relating to the different LFUNs.
52 * Try to find an appropriate (thematical) place when adding the new LFUN.
54 * Doxygen template below. Some notes: Parameters should be set in uppercase
55 * and put in <BRACKETS>, as so.
59 * \var lyx::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 Identifies whether this is a Character Style, a
370 Custom Inset or an XML Element, and which dynamical
371 sub-menu this flex inset is in on the LyX menu tree.
372 If Standard (currently unused): none of these.
373 Name: This name must be defined either in your layout file
374 or imported by some module. The definition is\n
375 InsetLayout <TYPE:Name>
376 * \li Sample: flex-insert CharStyle:Code
379 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
380 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
381 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
382 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
383 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
384 { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit },
385 { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit },
386 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
387 { LFUN_APPENDIX, "appendix", Noop, Edit },
390 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
393 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
394 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
395 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
396 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
397 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
398 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
399 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
400 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
402 * \var lyx::kb_action lyx::LFUN_SCROLL
403 * \li Action: Scroll the buffer view.
404 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
405 * \li Syntax: scroll <TYPE> <QUANTITY>
406 * \li Params: <TYPE>: line|page\n
407 <QUANTITY>: up|down|<number>
408 * \li Origin: Abdelrazak Younes, Dec 27 2007
411 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
413 * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER
414 * \li Action: Recenters the screen on the current cursor position.
415 * \li Syntax: screen-recenter
418 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
419 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
420 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
422 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
424 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD
425 * \li Action: Moves the cursor one position logically backwards.
426 * \li Notion: This is not the action which should be bound to the arrow keys,
427 because backwards may be left or right, depending on the
428 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
429 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
430 * \li Syntax: char-backward
433 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
435 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD_SELECT
436 * \li Action: Moves the cursor one position logically backwards, adding
437 traversed position to the selection.
438 * \li Notion: See also #LFUN_CHAR_BACKWARD.
439 * \li Syntax: char-backward-select
442 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
443 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
444 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
446 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD
447 * \li Action: Moves the cursor one position logically forward.
448 * \li Notion: This is not the action which should be bound to the arrow keys,
449 because forward may be left or right, depending on the language.
450 The arrow keys should be bound to #LFUN_CHAR_LEFT or
451 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
452 * \li Syntax: char-forward
455 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
457 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD_SELECT
458 * \li Action: Moves the cursor one position logically forward, adding
459 traversed position to the selection.
460 * \li Notion: See also #LFUN_CHAR_FORWARD.
461 * \li Syntax: char-forward-select
464 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
466 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT
467 * \li Action: Moves the cursor one position "to the left".
468 * \li Notion: This is the action which should be taken when the "left" key
469 is pressed. Generally, it moves the cursor one position to the
470 left. However, in Bidi text this become slightly more
471 complicated, and there are different modes of cursor movement.
472 In "visual mode", this moves left, plain and simple. In "logical
473 mode", movement is logically forward in RTL paragraphs, and
474 logically backwards in LTR paragraphs.
475 * \li Syntax: char-left
478 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
480 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT_SELECT
481 * \li Action: Moves the cursor one position "to the left", adding
482 traversed position to the selection.
483 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
484 * \li Syntax: char-left-select
487 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
489 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT
490 * \li Action: Moves the cursor one position "to the right".
491 * \li Notion: This is the action which should be taken when the "right" key
492 is pressed. Generally, it moves the cursor one position to the
493 right. However, in Bidi text this become slightly more
494 complicated, and there are different modes of cursor movement.
495 In "visual mode", this moves right, plain and simple. In "logical
496 mode", movement is logically forward in LTR paragraphs, and
497 logically backwards in RTL paragraphs.
498 * \li Syntax: char-right
501 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
503 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT_SELECT
504 * \li Action: Moves the cursor one position "to the right", adding
505 traversed position to the selection.
506 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
507 * \li Syntax: char-right-select
510 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
512 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
513 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
514 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
515 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
516 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
517 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
518 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
519 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
520 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
521 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
522 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
523 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
524 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
525 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
526 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
527 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
528 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
529 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
531 * \var lyx::kb_action lyx::LFUN_THESAURUS_ENTRY
532 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
533 * \li Syntax: thesaurus-entry
534 * \li Origin: Levon, 20 Jul 2001
537 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
538 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
539 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
540 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
541 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
543 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
544 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
545 { LFUN_LINE_BREAK, "line-break", Noop, Edit },
546 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
547 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
548 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
549 { LFUN_NEW_LINE, "new-line", Noop, Edit },
552 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_DOWN
553 * \li Action: Moves the current paragraph downwards in the document.
554 * \li Syntax: paragraph-move-down
555 * \li Origin: Edwin, 8 Apr 2006
558 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
560 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_UP
561 * \li Action: Moves the current paragraph upwards in the document.
562 * \li Syntax: paragraph-move-up
563 * \li Origin: Edwin, 8 Apr 2006
566 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
568 * \var lyx::kb_action lyx::LFUN_COPY
569 * \li Action: Copies to the clipboard the last edit.
573 { LFUN_COPY, "copy", ReadOnly, Edit },
575 * \var lyx::kb_action lyx::LFUN_CUT
576 * \li Action: Cuts to the clipboard.
580 { LFUN_CUT, "cut", Noop, Edit },
582 * \var lyx::kb_action lyx::LFUN_PASTE
583 * \li Action: Pastes from the active clipboard.
587 { LFUN_PASTE, "paste", Noop, Edit },
588 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
590 * \var lyx::kb_action lyx::LFUN_PRIMARY_SELECTION_PASTE
591 * \li Action: Pastes the material currently selected.
592 * \li Syntax: primary-selection-paste
595 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
597 * \var lyx::kb_action lyx::LFUN_UNDO
598 * \li Action: Undoes the last edit.
602 { LFUN_UNDO, "undo", Noop, Edit },
604 * \var lyx::kb_action lyx::LFUN_REDO
605 * \li Action: Redoes the last thing undone.
609 { LFUN_REDO, "redo", Noop, Edit },
610 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
611 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
613 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
614 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
615 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
617 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
618 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
619 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
620 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
621 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
622 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
623 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
624 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
625 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
626 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
627 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
628 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
629 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
630 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
631 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
633 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
634 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
636 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
637 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
639 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
640 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
642 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
643 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
644 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
645 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
648 * \var lyx::kb_action lyx::LFUN_LAYOUT
649 * \li Action: Sets the layout (that is, environment) for the current paragraph.
650 * \li Syntax: layout <LAYOUT>
651 * \li Params: <LAYOUT>: the layout to use
654 { LFUN_LAYOUT, "layout", Noop, Layout },
656 * \var lyx::kb_action lyx::LFUN_LAYOUT_PARAGRAPH
657 * \li Action: Launches the paragraph settings dialog.
658 * \li Syntax: layout-paragraph
661 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
662 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
664 * \var lyx::kb_action lyx::LFUN_DROP_LAYOUTS_CHOICE
665 * \li Action: Displays list of layout choices.
666 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
667 dropbox allowing for choice of layout.
668 * \li Syntax: drop-layouts-choice
671 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
673 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULES_CLEAR
674 * \li Action: Clears the module list.
675 * \li Notion: Clears the list of included modules for the current buffer.
676 * \li Syntax: layout-modules-clear
677 * \li Origin: rgh, 25 August 2007
680 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
682 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULE_ADD
683 * \li Action: Adds a module.
684 * \li Notion: Adds a module to the list of included modules for the current buffer.
685 * \li Syntax: layout-module-add <MODULE>
686 * \li Params: <MODULE>: the module to be added
687 * \li Origin: rgh, 25 August 2007
690 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
692 * \var lyx::kb_action lyx::LFUN_LAYOUT_RELOAD
693 * \li Action: Reloads layout information.
694 * \li Notion: Reloads all layout information for the current buffer from disk, thus
695 recognizing any changes that have been made to layout files on the fly.
696 This is intended to be used only by layout developers and should not be
697 used when one is trying to do actual work.
698 * \li Syntax: layout-reload
699 * \li Origin: rgh, 3 September 2007
702 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
704 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_APPLY
705 * \li Action: Sets the text class for the current buffer.
706 * \li Syntax: textclass-apply <TEXTCLASS>
707 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
708 the filename, minus the ".layout" extension.
711 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
713 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD
714 * \li Action: Loads information for a textclass from disk.
715 * \li Syntax: textclass-load <TEXTCLASS>
716 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
717 the filename, minus the ".layout" extension.
720 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
723 * \var lyx::kb_action lyx::LFUN_MARK_OFF
724 * \li Action: Disable selecting of text-region.
725 * \li Syntax: mark-off
728 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
730 * \var lyx::kb_action lyx::LFUN_MARK_ON
731 * \li Action: Enable selecting of text-region.
732 * \li Notion: After enabling you can simply move arrow keys to get selected region.
733 * \li Syntax: mark-on
736 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
738 * \var lyx::kb_action lyx::LFUN_MARK_TOGGLE
739 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
740 * \li Syntax: mark-toggle
741 * \li Origin: poenitz, May 5 2006
744 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
746 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
747 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
748 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
749 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
750 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
751 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
752 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
753 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
754 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
755 { LFUN_MATH_SPACE, "math-space", Noop, Math },
756 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
757 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
758 { LFUN_MATH_MODE, "math-mode", Noop, Math },
760 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
761 * \li Action: Toggles numbering of the current formula line.
762 * \li Notion: Must be in display formula mode.
763 * \li Syntax: math-number-line-toggle
764 * \li Origin: Alejandro 18 Jun 1996
767 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
769 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_TOGGLE
770 * \li Action: Toggles numbering/labeling of the current formula.
771 * \li Notion: Must be in display formula mode.
772 * \li Syntax: math-number-toggle
773 * \li Origin: Alejandro 4 Jun 1996
776 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
777 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
778 { LFUN_MATH_SIZE, "math-size", Noop, Math },
780 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_UNFOLD
781 * \li Action: Unfold a Math Macro.
782 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
784 * \li Syntax: math-macro-unfold
785 * \li Origin: sts, 06 January 2008
788 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
790 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_FOLD
791 * \li Action: Fold a Math Macro.
792 * \li Notion: Fold the Math Macro the cursor is in if it was
793 unfolded, i.e. displayed as \foo before.
794 * \li Syntax: math-macro-fold
795 * \li Origin: sts, 06 January 2008
798 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
800 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_PARAM
801 * \li Action: Add a parameter.
802 * \li Notion: Add a parameter to a Math Macro.
803 * \li Params: <NUM>: The number of the parameter behind which the new one
804 will be added (1 for the first, i.e. use 0 for add a
805 parameter at the left), defaults to the last one.
806 * \li Syntax: math-macro-add-param <NUM>
807 * \li Origin: sts, 06 January 2008
810 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
812 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_PARAM
813 * \li Action: Remove the last parameter.
814 * \li Notion: Remove the last parameter of a Math Macro and
815 remove its value in all instances of the macro
817 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
818 the first), defaults to the last one.
819 * \li Syntax: math-macro-remove-param <NUM>
820 * \li Origin: sts, 06 January 2008
823 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
825 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
826 * \li Action: Append a greedy parameter.
827 * \li Notion: Append a greedy parameter to a Math Macro which
828 eats the following mathed cell in every instance of
829 the macro in the buffer.
830 * \li Syntax: math-macro-append-greedy-param
831 * \li Origin: sts, 06 January 2008
834 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
836 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
837 * \li Action: Remove a greedy parameter.
838 * \li Notion: Remove a greedy parameter of a Math Macro and spit
839 out the values of it in every instance of the macro
840 in the buffer. If it is an optional parameter the [valud]
842 * \li Syntax: math-macro-remove-greedy-param
843 * \li Origin: sts, 06 January 2008
846 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
848 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
849 * \li Action: Make a parameter optional.
850 * \li Notion: Turn the first non-optional parameter of a Math Macro
851 into an optional parameter with a default value.
852 * \li Syntax: math-macro-make-optional
853 * \li Origin: sts, 06 January 2008
856 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
858 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
859 * \li Action: Make a parameter non-optional.
860 * \li Notion: Turn the last optional parameter of a Math Macro
861 into a non-optional parameter. The default value is
862 remembered to be reused later if the user changes his mind.
863 * \li Syntax: math-macro-make-nonoptional
864 * \li Origin: sts, 06 January 2008
867 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
869 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
870 * \li Action: Add an optional parameter.
871 * \li Notion: Insert an optional parameter just behind the
872 already existing optional parameters.
873 * \li Syntax: math-macro-add-optional-param
874 * \li Origin: sts, 06 January 2008
877 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
879 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
880 * \li Action: Remove the last optional parameter.
881 * \li Notion: Remove the last optional parameter of a Math Macro and
882 remove it in all the instances of the macro in the buffer.
883 * \li Syntax: math-macro-remove-optional-param
884 * \li Origin: sts, 06 January 2008
887 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
889 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
890 * \li Action: Add a greedy optional parameter.
891 * \li Notion: Add a greedy optional parameter which eats the value
892 from the following cells in mathed which are in the [value]
894 * \li Syntax: math-macro-add-greedy-optional-param
895 * \li Origin: sts, 06 January 2008
898 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
900 * \var lyx::kb_action lyx::LFUN_IN_MATHMACROTEMPLATE
901 * \li Action: Only active in Math Macro definition.
902 * \li Notion: Dummy function which is only active in a Math Macro definition.
903 It's used to toggle the Math Macro toolbar if the cursor moves
904 into a Math Macro definition.
905 * \li Syntax: in-mathmacrotemplate
906 * \li Origin: sts, 06 January 2008
909 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
911 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
912 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
913 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
915 * \var lyx::kb_action lyx::LFUN_OUTLINE_UP
916 * \li Action: Move the current group in the upward direction in the
917 structure of the document.
918 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
919 the whole substructure of the group.
920 * \li Syntax: outline-up
921 * \li Origin: Vermeer, 23 Mar 2006
924 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
926 * \var lyx::kb_action lyx::LFUN_OUTLINE_DOWN
927 * \li Action: Move the current group in the downward direction in the
928 structure of the document.
929 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
930 the whole substructure of the group.
931 * \li Syntax: outline-down
932 * \li Origin: Vermeer, 23 Mar 2006
935 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
937 * \var lyx::kb_action lyx::LFUN_OUTLINE_IN
938 * \li Action: Moves the current group in the downward direction in the
939 hierarchy of the document structure.
940 * \li Notion: Part -> Chapter -> Section -> etc.
941 * \li Syntax: outline-in
942 * \li Origin: Vermeer, 23 Mar 2006
945 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
947 * \var lyx::kb_action lyx::LFUN_OUTLINE_OUT
948 * \li Action: Moves the current group in the upward direction in the
949 hierarchy of the document structure.
950 * \li Notion: Part <- Chapter <- Section <- etc.
951 * \li Syntax: outline-out
952 * \li Origin: Vermeer, 23 Mar 2006
955 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
957 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
958 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
959 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
961 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
962 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
964 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
965 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
966 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
967 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
968 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
970 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
971 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
972 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
973 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
974 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
976 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
977 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
978 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
979 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
980 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
981 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
982 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
983 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
986 * \var lyx::kb_action lyx::LFUN_INSET_APPLY
987 * \li Action: Apply data for an inset.
988 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
989 be applied. This is either changed to #LFUN_INSET_MODIFY or
990 #LFUN_INSET_INSERT depending on the context where it is called.
991 * \li Syntax: inset-apply <ARGS>
992 * \li Params: See #LFUN_INSET_INSERT .
995 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
996 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
998 * \var lyx::kb_action lyx::LFUN_INSET_INSERT
999 * \li Action: Insert new inset (type given by the parameters).
1000 * \li Syntax: inset-insert <INSET> <ARGS>
1001 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1002 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1003 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1005 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1006 where <label name> is the name of the referenced label and
1007 <Format> is one of the following: \n
1008 ref -- <reference> \n
1009 eqref -- (<reference>) \n
1010 pageref -- <page> \n
1011 vpageref -- on <page> \n
1012 vref -- <reference> on <page> \n
1013 prettyref -- Formatted reference
1016 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1018 * \var lyx::kb_action lyx::LFUN_INSET_MODIFY
1019 * \li Action: Modify existing inset.
1020 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1021 bibtex, ert, command, grahocs, note, vspace, tabular, bibitem,
1023 * \li Syntax: inset-modify <INSET> <ARGS>
1024 * \li Params: See #LFUN_INSET_INSERT for further details.
1027 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1028 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1029 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1030 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1031 { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
1032 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1035 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS
1036 * \li Action: Change paragraph settings.
1037 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1038 This function only modifies, and does not override, existing settings.
1039 Note that the "leftindent" indent setting is deprecated.
1040 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1041 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1042 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1043 <ALIGN>: \\align block|left|right|center|default\n
1044 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1045 * \li Origin: rgh, Aug 15 2007
1048 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1050 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1051 * \li Action: Change paragraph settings.
1052 * \li Notion: Overwrite all nonspecified settings to the default ones.
1053 Use paragraph-params lfun if you don't want to overwrite others settings.
1054 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1055 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1056 * \li Origin: leeming, 30 Mar 2004
1059 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1060 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1063 * \var lyx::kb_action lyx::LFUN_FINISHED_FORWARD
1064 * \li Action: Moves the cursor out of the current slice, going forward.
1065 * \li Notion: Cursor movement within an inset may be different than cursor
1066 movement in the surrounding text. This action should be called
1067 automatically by the cursor movement within the inset, when
1068 movement within the inset has ceased (reached the end of the
1069 last paragraph, for example), in order to move correctly
1070 back into the surrounding text.
1071 * \li Syntax: finished-forward
1074 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1076 * \var lyx::kb_action lyx::LFUN_FINISHED_BACKWARD
1077 * \li Action: Moves the cursor out of the current slice, going backwards.
1078 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1079 * \li Syntax: finished-backward
1082 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1084 * \var lyx::kb_action lyx::LFUN_FINISHED_RIGHT
1085 * \li Action: Moves the cursor out of the current slice, going right.
1086 * \li Notion: See also #LFUN_FINISHED_FORWARD
1087 * \li Syntax: finished-right
1090 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1092 * \var lyx::kb_action lyx::LFUN_FINISHED_LEFT
1093 * \li Action: Moves the cursor out of the current slice, going left.
1094 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1095 * \li Syntax: finished-left
1098 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1100 { LFUN_LANGUAGE, "language", Noop, Edit },
1102 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1103 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1104 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1107 * \var lyx::kb_action lyx::LFUN_BOOKMARK_GOTO
1108 * \li Action: Goto a bookmark.
1109 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1110 if necessary. Note that bookmarsk are saved per-session, not
1112 * \li Syntax: bookmark-goto <NUMBER>
1113 * \li Params: <NUMBER>: the number of the bookmark to restore.
1114 * \li Origin: Dekel, 27 January 2001
1117 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1119 * \var lyx::kb_action lyx::LFUN_BOOKMARK_SAVE
1120 * \li Action: Save a bookmark.
1121 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1122 must be between 1 and 9, inclusive. Note that bookmarks are
1123 saved per-session, not per file.
1124 * \li Syntax: bookmark-save <NUMBER>
1125 * \li Params: <NUMBER>: the number of the bookmark to save.
1126 * \li Origin: Dekel, 27 January 2001
1129 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1131 * \var lyx::kb_action lyx::LFUN_BOOKMARK_CLEAR
1132 * \li Action: Clears the list of saved bookmarks.
1133 * \li Syntax: bookmark-clear
1134 * \li Origin: bpeng, 31 October 2006
1137 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1139 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1141 * \var lyx::kb_action lyx::LFUN_LYX_QUIT
1142 * \li Action: Terminates the current LyX instance.
1143 * \li Notion: Terminates the current LyX instance, asking whether to save
1144 modified documents, etc.
1145 * \li Syntax: lyx-quit
1148 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1150 * \var lyx::kb_action lyx::LFUN_TOOLBAR_TOGGLE
1151 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1152 * \li Notion: Skiping "auto" when allowauto is false.
1153 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1154 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1155 minibuffer|review|view/update|math_panels
1156 * \li Origin: Edwin, 21 May 2007
1159 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1160 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1162 * \var lyx::kb_action lyx::LFUN_UI_TOGGLE
1163 * \li Action: Various UI visibility-toggling actions.
1164 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1165 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1166 menubar : Toggle visibility of the menubar.\n
1167 scrollbar : Toggle visibility of the scrollbar.\n
1168 frame : Toggle visibility of the frames around editing window.\n
1169 fullscreen : Toggle fullscreen mode. This also covers calling the
1170 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1171 custom tweaks of the toolbars should be used.
1172 * \li Origin: ps, 9 Feb 2007
1175 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1177 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1178 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1181 * \var lyx::kb_action lyx::LFUN_SPLIT_VIEW
1182 * \li Action: Creates another split view of current buffer.
1183 * \li Notion: All split views act in the same way indpendently.
1184 * \li Syntax: split-view <vertical|horizontal>
1185 * \li Params: horizontal : The work areas are laid out side by side.\n
1186 vertical : The work areas laid out vertically.\n
1187 * \li Origin: abdel, 20 Feb 2008
1190 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1193 * \var lyx::kb_action lyx::LFUN_CLOSE_TAB_GROUP
1194 * \li Action: Close the current tab group.
1195 * \li Notion: This only closes the work areas, not the buffer themselves.
1196 The still opened buffers can be visualized in another tab group.
1197 * \li Syntax: close-tab-group
1198 * \li Origin: abdel, 21 Feb 2008
1201 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1202 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1203 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1204 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1205 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1206 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1207 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1209 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1210 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1211 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1212 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1213 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1215 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1216 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1217 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1218 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1220 { LFUN_MESSAGE, "message", NoBuffer, System },
1221 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1222 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1224 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1225 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1226 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1227 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1228 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1230 * \var lyx::kb_action lyx::LFUN_SERVER_GOTO_FILE_ROW
1231 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1232 * \li Syntax: server-goto-file-row <FILE_NAME> <ROW_NUMBER>
1233 * \li Origin: Edmar, 23 Dec 1998
1236 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1237 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1238 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1240 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1243 * \var lyx::kb_action lyx::LFUN_BUFFER_AUTO_SAVE
1244 * \li Action: Saves the current buffer to a temporary file.
1245 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1246 is called automatically by LyX, to "autosave" the current buffer.
1247 * \li Syntax: buffer-auto-save
1250 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1251 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1252 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1253 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1254 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1256 * \var lyx::kb_action lyx::LFUN_BUFFER_CLOSE
1257 * \li Action: Closes the current buffer.
1258 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1259 if the buffer has been modified.
1260 * \li Syntax: buffer-close
1263 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1265 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT
1266 * \li Action: Exports the current buffer (document) to the given format.
1267 * \li Syntax: buffer-export <FORMAT>
1268 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1269 can find in Tools->Preferences->File formats->Format.
1270 Usual format you will enter is "pdf2" (pdflatex),
1271 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1272 In case of "custom" you will be asked for a format you
1273 want to start from and for the command that you want to
1274 apply to this format. Internally the control is then passed
1275 to #LFUN_BUFFER_EXPORT_CUSTOM.
1276 * \li Origin: Lgb, 29 Jul 1997
1279 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1281 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT_CUSTOM
1282 * \li Action: Exports the current buffer (document) from the given format using
1283 the given command on it.
1284 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1285 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1286 intermediate file).\n
1287 <COMMAND> this command will be launched on the file. Note that you can
1288 use "$$FName" string to qualify the intermediate file.
1289 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1290 * \li Origin: leeming, 27 Mar 2004
1293 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1295 * \var lyx::kb_action lyx::LFUN_BUFFER_PRINT
1296 * \li Action: Prints the current document.
1297 * \li Notion: Many settings can be given via the preferences dialog.
1298 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1299 * \li Params: <TARGET> is either "printer" or "file".\n
1300 <TARGER-NAME> is either "default" or file name or printer name.\n
1301 <COMMAND> command ensuring the printing job.
1302 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1303 * \li Origin: leeming, 28 Mar 2004
1306 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1308 * \var lyx::kb_action lyx::LFUN_BUFFER_IMPORT
1309 * \li Action: Import a given file as a lyx document.
1310 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1311 defined convertors in preferences. Look into File->Import menu to get
1312 an idea of the currently active import formats.
1313 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1314 * \li Origin: Asger, 24 Jul 1998
1317 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1319 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
1320 * \li Action: Creates a new buffer (that is, document).
1321 * \li Notion: Implicit path can be set in Preferences dialog.
1322 * \li Syntax: buffer-new [<FILE>]
1323 * \li Params: <FILE>: filename of created file with absolute path.
1326 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1328 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW_TEMPLATE
1329 * \li Action: Creates a new buffer (that is, document) from a template.
1330 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1331 Template will be asked for via Open-dialog.
1332 * \li Syntax: buffer-new-template [<FILE>]
1333 * \li Params: <FILE>: filename of created file with absolute path.
1336 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1337 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1339 * \var lyx::kb_action lyx::LFUN_BUFFER_SWITCH
1340 * \li Action: Switch to the given buffer.
1341 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1342 document in different LyX windows.
1343 * \li Syntax: buffer-new-template <BUFFER>
1344 * \li Params: <BUFFER>: already opened document which is to be shown.
1347 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1349 * \var lyx::kb_action lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1350 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1351 * \li Syntax: buffer-toggle-read-only
1352 * \li Origin: Lgb, 27 May 1997
1355 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1357 * \var lyx::kb_action lyx::LFUN_BUFFER_VIEW
1358 * \li Action: Displays current buffer in chosen format.
1359 * \li Notion: Displays the contents of the current buffer in the chosen
1360 format, for example, PDF or DVI. This runs the necessary
1361 converter, calls the defined viewer, and so forth.
1362 * \li Syntax: buffer-view <FORMAT>
1363 * \li Params: <FORMAT>: The format to display, where this is one of the
1364 formats defined (in the current GUI) in the
1365 Tools>Preferences>File Formats dialog.
1368 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1370 * \var lyx::kb_action lyx::LFUN_BUFFER_UPDATE
1371 * \li Action: Exports the current document and put the result into the
1372 temporary directory.
1373 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1374 the output will be rewriten - updated. This is useful in case your viewer
1375 is able to detect such changes (e.g. ghostview for postscript).
1376 * \li Syntax: buffer-update <FORMAT>
1377 * \li Params: <FORMAT>: The format to display, where this is one of the
1378 formats defined (in the current GUI) in the
1379 Tools>Preferences>File Formats dialog.
1380 * \li Origin: Dekel, 5 Aug 2000
1383 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1386 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE
1387 * \li Action: Saves the current buffer.
1388 * \li Notion: Saves the current buffer to disk, using the filename that
1389 is already associated with the buffer, asking for one if
1390 none is yet assigned.
1391 * \li Syntax: buffer-write
1394 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1396 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS
1397 * \li Action: Rename and save current buffer.
1398 * \li Syntax: buffer-write-as <FILENAME>
1399 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1400 is with respect to the original location of the buffer/file.
1403 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1404 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1405 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1406 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1407 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1408 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1409 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1410 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1411 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1414 * \var lyx::kb_action lyx::LFUN_FILE_INSERT
1415 * \li Action: Inserts another LyX file.
1416 * \li Syntax: file-insert [<FILE>]
1417 * \li Params: <FILE>: Filename to be inserted.
1420 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1422 * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT
1423 * \li Action: Inserts plain text file.
1424 * \li Syntax: file-insert-plaintext [<FILE>]
1425 * \li Params: <FILE>: Filename to be inserted.
1426 * \li Origin: CFO-G, 19 Nov 1997
1429 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1431 * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1432 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1433 * \li Syntax: file-insert-plaintext-para [<FILE>]
1434 * \li Params: <FILE>: Filename to be inserted.
1435 * \li Origin: Levon, 14 Feb 2001
1438 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1440 * \var lyx::kb_action lyx::LFUN_FILE_OPEN
1441 * \li Action: Open LyX document.
1442 * \li Syntax: file-open [<FILE>]
1443 * \li Params: <FILE>: Filename to be opened.
1446 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1450 * \var lyx::kb_action lyx::LFUN_CALL
1451 * \li Action: Executes a command defined in a .def file.
1452 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1453 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1454 where <NAME> is the name of the new command and <LFUN> is the lfun code
1455 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1456 \\def_file "FileName" allows to include another .def file. \n
1457 This is particularly useful in connection with toolbar buttons:
1458 Since the name of the button image for this lfun is
1459 lib/images/commands/<NAME>.png this is the way to assign an image
1460 to a complex command-sequence.
1461 * \li Syntax: call <NAME>
1462 * \li Params: <NAME>: Name of the command that must be called.
1463 * \li Origin: broider, 2 Oct 2007
1466 { LFUN_CALL, "call", NoBuffer, System },
1468 * \var lyx::kb_action lyx::LFUN_META_PREFIX
1469 * \li Action: Simulate halting Meta key (Alt key on PCs).
1470 * \li Notion: Used for buffer editation not for GUI control.
1471 * \li Syntax: meta-prefix
1474 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1476 * \var lyx::kb_action lyx::LFUN_CANCEL
1477 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1478 * \li Syntax: cancel
1481 { LFUN_CANCEL, "cancel", NoBuffer, System },
1484 * \var lyx::kb_action lyx::LFUN_COMMAND_EXECUTE
1485 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1486 * \li Notion: Usually bound to M-x shortcut.
1487 * \li Syntax: command-execute
1490 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1491 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1493 * \var lyx::kb_action lyx::LFUN_COMMAND_SEQUENCE
1494 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1495 * \li Syntax: command-sequence <CMDS>
1496 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1497 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1498 * \li Origin: Andre', 11 Nov 1999
1501 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1504 * \var lyx::kb_action lyx::LFUN_PREFERENCES_SAVE
1505 * \li Action: Save user preferences.
1506 * \li Syntax: preferences-save
1507 * \li Origin: Lgb, 27 Nov 1999
1510 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1512 * \var lyx::kb_action lyx::LFUN_RECONFIGURE
1513 * \li Action: Reconfigure the automatic settings.
1514 * \li Syntax: reconfigure
1515 * \li Origin: Asger, 14 Feb 1997
1518 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1520 * \var lyx::kb_action lyx::LFUN_LYXRC_APPLY
1521 * \li Action: Apply the given settings to user preferences.
1522 * \li Syntax: lyxrc-apply <SETTINGS>
1523 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1524 to get an idea which commands to use and their syntax.
1525 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1528 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1530 * \var lyx::kb_action lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1531 * \li Action: Determine whether keep cursor inside the editing window regardless
1532 the scrollbar movement.
1533 * \li Syntax: toggle-cursor-follows-scrollbar
1534 * \li Origin: ARRae, 2 Dec 1997
1537 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1539 * \var lyx::kb_action lyx::LFUN_SET_COLOR
1540 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1541 * \li Notion: A new color entry is created if the color is unknown.
1542 Color names can be stored as a part of user settings.
1543 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1544 * \li Origin: SLior, 11 Jun 2000
1547 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1549 * \var lyx::kb_action lyx::LFUN_STATISTICS
1550 * \li Action: Count the statistics (number of words and characters)
1551 in the document or in the given selection.
1552 * \li Notion: Note that this function gives the number of words/chars written,
1553 not the number of characters which will be typeset.
1554 * \li Syntax: statistics
1555 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1558 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1560 * \var lyx::kb_action lyx::LFUN_COMPLETION_INLINE
1561 * \li Action: Show the inline completion at the cursor position.
1562 * \li Syntax: completion-inline
1563 * \li Origin: sts, Feb 19 2008
1566 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1568 * \var lyx::kb_action lyx::LFUN_COMPLETION_POPUP
1569 * \li Action: Show the completion popup at the cursor position.
1570 * \li Syntax: completion-popup
1571 * \li Origin: sts, Feb 19 2008
1574 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1576 * \var lyx::kb_action lyx::LFUN_COMPLETION_COMPLETE
1577 * \li Action: Try to complete the word or command at the cursor position.
1578 * \li Syntax: complete
1579 * \li Origin: sts, Feb 19 2008
1582 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1584 { LFUN_NOACTION, "", Noop, Hidden }
1585 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1588 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1589 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1596 LyXAction::LyXAction()
1602 // Returns an action tag from a string.
1603 FuncRequest LyXAction::lookupFunc(string const & func) const
1605 string const func2 = trim(func);
1607 if (func2.empty()) {
1608 return FuncRequest(LFUN_NOACTION);
1612 string const arg = split(func2, cmd, ' ');
1614 func_map::const_iterator fit = lyx_func_map.find(cmd);
1616 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1620 string const LyXAction::getActionName(kb_action action) const
1622 info_map::const_iterator const it = lyx_info_map.find(action);
1623 return it != lyx_info_map.end() ? it->second.name : string();
1627 LyXAction::func_type const LyXAction::getActionType(kb_action action) const
1629 info_map::const_iterator const it = lyx_info_map.find(action);
1630 return it != lyx_info_map.end() ? it->second.type : Hidden;
1634 bool LyXAction::funcHasFlag(kb_action action,
1635 LyXAction::func_attrib flag) const
1637 info_map::const_iterator ici = lyx_info_map.find(action);
1639 if (ici == lyx_info_map.end()) {
1640 LYXERR0("action: " << action << " is not known.");
1641 BOOST_ASSERT(false);
1644 return ici->second.attrib & flag;
1648 LyXAction::const_func_iterator LyXAction::func_begin() const
1650 return lyx_func_map.begin();
1654 LyXAction::const_func_iterator LyXAction::func_end() const
1656 return lyx_func_map.end();