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_CAPTION_INSERT
240 * \li Action: Inserts a caption inset.
241 * \li Syntax: caption-insert
242 * \li Origin: Lgb, 18 Jul 2000
245 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
247 * \var lyx::kb_action lyx::LFUN_DATE_INSERT
248 * \li Action: Inserts the current date.
249 * \li Syntax: date-insert [<ARG>]
250 * \li Params: <ARG>: Format of date. The default value (%x) can be set
251 in Preferences->Date format. For possible formats
252 see manual page of strftime function.
253 * \li Origin: jdblair, 31 Jan 2000
256 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
258 * \var lyx::kb_action lyx::LFUN_FOOTNOTE_INSERT
259 * \li Action: Inserts a footnote inset.
260 * \li Syntax: footnote-insert
261 * \li Origin: Jug, 7 Mar 2000
264 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
266 * \var lyx::kb_action lyx::LFUN_ERT_INSERT
267 * \li Action: Inserts an ERT inset.
268 * \li Syntax: ert-insert
269 * \li Origin: Jug, 18 Feb 2000
272 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
273 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
274 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
275 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
277 * \var lyx::kb_action lyx::LFUN_HFILL_INSERT
278 * \li Action: Inserts an hfill inset.
279 * \li Syntax: hfill-insert
282 { LFUN_HFILL_INSERT, "hfill-insert", Noop, Edit },
284 * \var lyx::kb_action lyx::LFUN_OPTIONAL_INSERT
285 * \li Action: Inserts an optional-argument (short title) inset.
286 * \li Syntax: optional-insert
287 * \li Origin: Martin, 12 Aug 2002
290 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
292 * \var lyx::kb_action lyx::LFUN_LINE_INSERT
293 * \li Action: Inserts a horizontal line.
294 * \li Syntax: line-insert
295 * \li Origin: poenitz, Oct 27 2003
298 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
300 * \var lyx::kb_action lyx::LFUN_NEWPAGE_INSERT
301 * \li Action: Inserts a new page.
302 * \li Syntax: newpage-insert
303 * \li Origin: uwestoehr, 24 Nov 2007
306 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
308 * \var lyx::kb_action lyx::LFUN_PAGEBREAK_INSERT
309 * \li Action: Inserts a pagebreak.
310 * \li Syntax: pagebreak-insert
311 * \li Origin: poenitz, Oct 27 2003
314 { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
316 * \var lyx::kb_action lyx::LFUN_MARGINALNOTE_INSERT
317 * \li Action: Inserts a marginal note.
318 * \li Syntax: marginalnote-insert
319 * \li Origin: Lgb, 26 Jun 2000
322 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
324 * \var lyx::kb_action lyx::LFUN_UNICODE_INSERT
325 * \li Action: Inserts a single unicode character.
326 * \li Syntax: unicode-insert <CHAR>
327 * \li Params: <CHAR>: The character to insert, given as its code
328 point, in hexadecimal, e.g.: unicode-insert 0x0100.
329 * \li Origin: Lgb, 22 Oct 2006
332 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
334 * \var lyx::kb_action lyx::LFUN_LISTING_INSERT
335 * \li Action: Inserts a new listings inset.
336 * \li Syntax: listing-insert
337 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
340 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
341 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
342 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
343 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
344 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
346 * \var lyx::kb_action lyx::LFUN_FLEX_INSERT
347 * \li Action: Inserts CharStyle, Custom inset or XML short element.
348 * \li Notion: Look into the Customization manual for more information about
350 For dissolving the element see #LFUN_INSET_DISSOLVE.
351 * \li Syntax: flex-insert <TYPE:Name>
352 * \li Params: TYPE: CharStyle|Custom|Element|Standard
353 Identifies whether this is a Character Style, a
354 Custom Inset or an XML Element, and which dynamical
355 sub-menu this flex inset is in on the LyX menu tree.
356 If Standard (currently unused): none of these.
357 Name: This name must be defined either in your layout file
358 or imported by some module. The definition is\n
359 InsetLayout <TYPE:Name>
360 * \li Sample: flex-insert CharStyle:Code
363 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
364 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
365 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
366 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
367 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
368 { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit },
369 { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit },
370 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
371 { LFUN_APPENDIX, "appendix", Noop, Edit },
374 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
377 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
378 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
379 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
380 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
381 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
382 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
383 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
384 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
386 * \var lyx::kb_action lyx::LFUN_SCROLL
387 * \li Action: Scroll the buffer view.
388 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
389 * \li Syntax: scroll <TYPE> <QUANTITY>
390 * \li Params: <TYPE>: line|page\n
391 <QUANTITY>: up|down|<number>
392 * \li Origin: Abdelrazak Younes, Dec 27 2007
395 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
397 * \var lyx::kb_action lyx::LFUN_SCREEN_RECENTER
398 * \li Action: Recenters the screen on the current cursor position.
399 * \li Syntax: screen-recenter
402 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
403 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
404 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
406 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
408 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD
409 * \li Action: Moves the cursor one position logically backwards.
410 * \li Notion: This is not the action which should be bound to the arrow keys,
411 because backwards may be left or right, depending on the
412 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
413 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
414 * \li Syntax: char-backward
417 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
419 * \var lyx::kb_action lyx::LFUN_CHAR_BACKWARD_SELECT
420 * \li Action: Moves the cursor one position logically backwards, adding
421 traversed position to the selection.
422 * \li Notion: See also #LFUN_CHAR_BACKWARD.
423 * \li Syntax: char-backward-select
426 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
427 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
428 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
430 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD
431 * \li Action: Moves the cursor one position logically forward.
432 * \li Notion: This is not the action which should be bound to the arrow keys,
433 because forward may be left or right, depending on the language.
434 The arrow keys should be bound to #LFUN_CHAR_LEFT or
435 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
436 * \li Syntax: char-forward
439 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
441 * \var lyx::kb_action lyx::LFUN_CHAR_FORWARD_SELECT
442 * \li Action: Moves the cursor one position logically forward, adding
443 traversed position to the selection.
444 * \li Notion: See also #LFUN_CHAR_FORWARD.
445 * \li Syntax: char-forward-select
448 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
450 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT
451 * \li Action: Moves the cursor one position "to the left".
452 * \li Notion: This is the action which should be taken when the "left" key
453 is pressed. Generally, it moves the cursor one position to the
454 left. However, in Bidi text this become slightly more
455 complicated, and there are different modes of cursor movement.
456 In "visual mode", this moves left, plain and simple. In "logical
457 mode", movement is logically forward in RTL paragraphs, and
458 logically backwards in LTR paragraphs.
459 * \li Syntax: char-left
462 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
464 * \var lyx::kb_action lyx::LFUN_CHAR_LEFT_SELECT
465 * \li Action: Moves the cursor one position "to the left", adding
466 traversed position to the selection.
467 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
468 * \li Syntax: char-left-select
471 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
473 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT
474 * \li Action: Moves the cursor one position "to the right".
475 * \li Notion: This is the action which should be taken when the "right" key
476 is pressed. Generally, it moves the cursor one position to the
477 right. However, in Bidi text this become slightly more
478 complicated, and there are different modes of cursor movement.
479 In "visual mode", this moves right, plain and simple. In "logical
480 mode", movement is logically forward in LTR paragraphs, and
481 logically backwards in RTL paragraphs.
482 * \li Syntax: char-right
485 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
487 * \var lyx::kb_action lyx::LFUN_CHAR_RIGHT_SELECT
488 * \li Action: Moves the cursor one position "to the right", adding
489 traversed position to the selection.
490 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
491 * \li Syntax: char-right-select
494 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
496 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
497 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
498 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
499 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
500 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
501 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
502 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
503 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
504 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
505 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
506 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
507 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
508 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
509 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
510 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
511 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
512 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
513 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
515 * \var lyx::kb_action lyx::LFUN_THESAURUS_ENTRY
516 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
517 * \li Syntax: thesaurus-entry
518 * \li Origin: Levon, 20 Jul 2001
521 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
522 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
523 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
524 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
525 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
527 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
528 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
529 { LFUN_LINE_BREAK, "line-break", Noop, Edit },
530 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
531 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
532 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
533 { LFUN_NEW_LINE, "new-line", Noop, Edit },
536 * \var lyx::kb_action lyx::LFUN_COPY
537 * \li Action: Copies to the clipboard the last edit.
541 { LFUN_COPY, "copy", ReadOnly, Edit },
543 * \var lyx::kb_action lyx::LFUN_CUT
544 * \li Action: Cuts to the clipboard.
548 { LFUN_CUT, "cut", Noop, Edit },
550 * \var lyx::kb_action lyx::LFUN_PASTE
551 * \li Action: Pastes from the active clipboard.
555 { LFUN_PASTE, "paste", Noop, Edit },
556 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
558 * \var lyx::kb_action lyx::LFUN_PRIMARY_SELECTION_PASTE
559 * \li Action: Pastes the material currently selected.
560 * \li Syntax: primary-selection-paste
563 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
565 * \var lyx::kb_action lyx::LFUN_UNDO
566 * \li Action: Undoes the last edit.
570 { LFUN_UNDO, "undo", Noop, Edit },
572 * \var lyx::kb_action lyx::LFUN_REDO
573 * \li Action: Redoes the last thing undone.
577 { LFUN_REDO, "redo", Noop, Edit },
578 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
579 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
581 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
582 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
583 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
585 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
586 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
587 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
588 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
589 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
590 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
591 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
592 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
593 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
594 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
595 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
596 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
597 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
598 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
599 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
601 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
602 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
604 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
605 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
607 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
608 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
610 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
611 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
612 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
613 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
616 * \var lyx::kb_action lyx::LFUN_LAYOUT
617 * \li Action: Sets the layout (that is, environment) for the current paragraph.
618 * \li Syntax: layout <LAYOUT>
619 * \li Params: <LAYOUT>: the layout to use
622 { LFUN_LAYOUT, "layout", Noop, Layout },
624 * \var lyx::kb_action lyx::LFUN_LAYOUT_PARAGRAPH
625 * \li Action: Launches the paragraph settings dialog.
626 * \li Syntax: layout-paragraph
629 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
630 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
632 * \var lyx::kb_action lyx::LFUN_DROP_LAYOUTS_CHOICE
633 * \li Action: Displays list of layout choices.
634 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
635 dropbox allowing for choice of layout.
636 * \li Syntax: drop-layouts-choice
639 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
641 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULES_CLEAR
642 * \li Action: Clears the module list.
643 * \li Notion: Clears the list of included modules for the current buffer.
644 * \li Syntax: layout-modules-clear
645 * \li Origin: rgh, 25 August 2007
648 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
650 * \var lyx::kb_action lyx::LFUN_LAYOUT_MODULE_ADD
651 * \li Action: Adds a module.
652 * \li Notion: Adds a module to the list of included modules for the current buffer.
653 * \li Syntax: layout-module-add <MODULE>
654 * \li Params: <MODULE>: the module to be added
655 * \li Origin: rgh, 25 August 2007
658 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
660 * \var lyx::kb_action lyx::LFUN_LAYOUT_RELOAD
661 * \li Action: Reloads layout information.
662 * \li Notion: Reloads all layout information for the current buffer from disk, thus
663 recognizing any changes that have been made to layout files on the fly.
664 This is intended to be used only by layout developers and should not be
665 used when one is trying to do actual work.
666 * \li Syntax: layout-reload
667 * \li Origin: rgh, 3 September 2007
670 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
672 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_APPLY
673 * \li Action: Sets the text class for the current buffer.
674 * \li Syntax: textclass-apply <TEXTCLASS>
675 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
676 the filename, minus the ".layout" extension.
679 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
681 * \var lyx::kb_action lyx::LFUN_TEXTCLASS_LOAD
682 * \li Action: Loads information for a textclass from disk.
683 * \li Syntax: textclass-load <TEXTCLASS>
684 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
685 the filename, minus the ".layout" extension.
688 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
691 * \var lyx::kb_action lyx::LFUN_MARK_OFF
692 * \li Action: Disable selecting of text-region.
693 * \li Syntax: mark-off
696 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
698 * \var lyx::kb_action lyx::LFUN_MARK_ON
699 * \li Action: Enable selecting of text-region.
700 * \li Notion: After enabling you can simply move arrow keys to get selected region.
701 * \li Syntax: mark-on
704 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
706 * \var lyx::kb_action lyx::LFUN_MARK_TOGGLE
707 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
708 * \li Syntax: mark-toggle
709 * \li Origin: poenitz, May 5 2006
712 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
714 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
715 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
716 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
717 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
718 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
719 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
720 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
721 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
722 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
723 { LFUN_MATH_SPACE, "math-space", Noop, Math },
724 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
725 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
726 { LFUN_MATH_MODE, "math-mode", Noop, Math },
728 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
729 * \li Action: Toggles numbering of the current formula line.
730 * \li Notion: Must be in display formula mode.
731 * \li Syntax: math-number-line-toggle
732 * \li Origin: Alejandro 18 Jun 1996
735 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
737 * \var lyx::kb_action lyx::LFUN_MATH_NUMBER_TOGGLE
738 * \li Action: Toggles numbering/labeling of the current formula.
739 * \li Notion: Must be in display formula mode.
740 * \li Syntax: math-number-toggle
741 * \li Origin: Alejandro 4 Jun 1996
744 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
745 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
746 { LFUN_MATH_SIZE, "math-size", Noop, Math },
748 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_UNFOLD
749 * \li Action: Unfold a Math Macro.
750 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
752 * \li Syntax: math-macro-unfold
753 * \li Origin: sts, 06 January 2008
756 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
758 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_FOLD
759 * \li Action: Fold a Math Macro.
760 * \li Notion: Fold the Math Macro the cursor is in if it was
761 unfolded, i.e. displayed as \foo before.
762 * \li Syntax: math-macro-fold
763 * \li Origin: sts, 06 January 2008
766 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
768 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_PARAM
769 * \li Action: Add a parameter.
770 * \li Notion: Add a parameter to a Math Macro.
771 * \li Params: <NUM>: The number of the parameter behind which the new one
772 will be added (1 for the first, i.e. use 0 for add a
773 parameter at the left), defaults to the last one.
774 * \li Syntax: math-macro-add-param <NUM>
775 * \li Origin: sts, 06 January 2008
778 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
780 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_PARAM
781 * \li Action: Remove the last parameter.
782 * \li Notion: Remove the last parameter of a Math Macro and
783 remove its value in all instances of the macro
785 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
786 the first), defaults to the last one.
787 * \li Syntax: math-macro-remove-param <NUM>
788 * \li Origin: sts, 06 January 2008
791 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
793 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
794 * \li Action: Append a greedy parameter.
795 * \li Notion: Append a greedy parameter to a Math Macro which
796 eats the following mathed cell in every instance of
797 the macro in the buffer.
798 * \li Syntax: math-macro-append-greedy-param
799 * \li Origin: sts, 06 January 2008
802 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
804 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
805 * \li Action: Remove a greedy parameter.
806 * \li Notion: Remove a greedy parameter of a Math Macro and spit
807 out the values of it in every instance of the macro
808 in the buffer. If it is an optional parameter the [valud]
810 * \li Syntax: math-macro-remove-greedy-param
811 * \li Origin: sts, 06 January 2008
814 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
816 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
817 * \li Action: Make a parameter optional.
818 * \li Notion: Turn the first non-optional parameter of a Math Macro
819 into an optional parameter with a default value.
820 * \li Syntax: math-macro-make-optional
821 * \li Origin: sts, 06 January 2008
824 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
826 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
827 * \li Action: Make a parameter non-optional.
828 * \li Notion: Turn the last optional parameter of a Math Macro
829 into a non-optional parameter. The default value is
830 remembered to be reused later if the user changes his mind.
831 * \li Syntax: math-macro-make-nonoptional
832 * \li Origin: sts, 06 January 2008
835 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
837 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
838 * \li Action: Add an optional parameter.
839 * \li Notion: Insert an optional parameter just behind the
840 already existing optional parameters.
841 * \li Syntax: math-macro-add-optional-param
842 * \li Origin: sts, 06 January 2008
845 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
847 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
848 * \li Action: Remove the last optional parameter.
849 * \li Notion: Remove the last optional parameter of a Math Macro and
850 remove it in all the instances of the macro in the buffer.
851 * \li Syntax: math-macro-remove-optional-param
852 * \li Origin: sts, 06 January 2008
855 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
857 * \var lyx::kb_action lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
858 * \li Action: Add a greedy optional parameter.
859 * \li Notion: Add a greedy optional parameter which eats the value
860 from the following cells in mathed which are in the [value]
862 * \li Syntax: math-macro-add-greedy-optional-param
863 * \li Origin: sts, 06 January 2008
866 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
868 * \var lyx::kb_action lyx::LFUN_IN_MATHMACROTEMPLATE
869 * \li Action: Only active in Math Macro definition.
870 * \li Notion: Dummy function which is only active in a Math Macro definition.
871 It's used to toggle the Math Macro toolbar if the cursor moves
872 into a Math Macro definition.
873 * \li Syntax: in-mathmacrotemplate
874 * \li Origin: sts, 06 January 2008
877 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
880 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_DOWN
881 * \li Action: Moves the current paragraph downwards in the document.
882 * \li Syntax: paragraph-move-down
883 * \li Origin: Edwin, 8 Apr 2006
886 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
888 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_MOVE_UP
889 * \li Action: Moves the current paragraph upwards in the document.
890 * \li Syntax: paragraph-move-up
891 * \li Origin: Edwin, 8 Apr 2006
894 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
896 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
897 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
898 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
899 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
900 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
902 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_GOTO
903 * \li Action: Jump to a paragraph given by its id number.
904 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
905 seen on the screen. Moreover the id is unique for all opened buffers (documents).
906 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
907 * \li Origin: Dekel, 26 Aug 2000
910 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
912 * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH
913 * \li Action: Breaks the current paragraph at the current location.
914 * \li Syntax: break-paragraph
917 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
919 * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH_SKIP
920 * \li Action: Breaks the current paragraph at the current location,
921 unless used at the beginning of a line, where it sets
922 the label width string to empty.
923 * \li Syntax: break-paragraph-skip
926 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
929 * \var lyx::kb_action lyx::LFUN_OUTLINE_UP
930 * \li Action: Move the current group in the upward direction in the
931 structure of the document.
932 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
933 the whole substructure of the group.
934 * \li Syntax: outline-up
935 * \li Origin: Vermeer, 23 Mar 2006
938 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
940 * \var lyx::kb_action lyx::LFUN_OUTLINE_DOWN
941 * \li Action: Move the current group in the downward direction in the
942 structure of the document.
943 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
944 the whole substructure of the group.
945 * \li Syntax: outline-down
946 * \li Origin: Vermeer, 23 Mar 2006
949 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
951 * \var lyx::kb_action lyx::LFUN_OUTLINE_IN
952 * \li Action: Moves the current group in the downward direction in the
953 hierarchy of the document structure.
954 * \li Notion: Part -> Chapter -> Section -> etc.
955 * \li Syntax: outline-in
956 * \li Origin: Vermeer, 23 Mar 2006
959 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
961 * \var lyx::kb_action lyx::LFUN_OUTLINE_OUT
962 * \li Action: Moves the current group in the upward direction in the
963 hierarchy of the document structure.
964 * \li Notion: Part <- Chapter <- Section <- etc.
965 * \li Syntax: outline-out
966 * \li Origin: Vermeer, 23 Mar 2006
969 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
971 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
972 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
974 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
975 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
976 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
977 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
978 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
980 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
981 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
982 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
983 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
984 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
986 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
987 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
988 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
989 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
990 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
991 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
992 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
993 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
996 * \var lyx::kb_action lyx::LFUN_INSET_APPLY
997 * \li Action: Apply data for an inset.
998 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
999 be applied. This is either changed to #LFUN_INSET_MODIFY or
1000 #LFUN_INSET_INSERT depending on the context where it is called.
1001 * \li Syntax: inset-apply <ARGS>
1002 * \li Params: See #LFUN_INSET_INSERT .
1005 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1006 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1008 * \var lyx::kb_action lyx::LFUN_INSET_INSERT
1009 * \li Action: Insert new inset (type given by the parameters).
1010 * \li Syntax: inset-insert <INSET> <ARGS>
1011 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1012 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1013 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1015 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1016 where <label name> is the name of the referenced label and
1017 <Format> is one of the following: \n
1018 ref -- <reference> \n
1019 eqref -- (<reference>) \n
1020 pageref -- <page> \n
1021 vpageref -- on <page> \n
1022 vref -- <reference> on <page> \n
1023 prettyref -- Formatted reference
1026 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1028 * \var lyx::kb_action lyx::LFUN_INSET_MODIFY
1029 * \li Action: Modify existing inset.
1030 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1031 bibtex, ert, command, grahocs, note, vspace, tabular, bibitem,
1033 * \li Syntax: inset-modify <INSET> <ARGS>
1034 * \li Params: See #LFUN_INSET_INSERT for further details.
1037 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1038 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1039 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1040 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1041 { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
1042 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1045 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS
1046 * \li Action: Change paragraph settings.
1047 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1048 This function only modifies, and does not override, existing settings.
1049 Note that the "leftindent" indent setting is deprecated.
1050 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1051 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1052 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1053 <ALIGN>: \\align block|left|right|center|default\n
1054 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1055 * \li Origin: rgh, Aug 15 2007
1058 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1060 * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1061 * \li Action: Change paragraph settings.
1062 * \li Notion: Overwrite all nonspecified settings to the default ones.
1063 Use paragraph-params lfun if you don't want to overwrite others settings.
1064 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1065 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1066 * \li Origin: leeming, 30 Mar 2004
1069 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1070 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1073 * \var lyx::kb_action lyx::LFUN_FINISHED_FORWARD
1074 * \li Action: Moves the cursor out of the current slice, going forward.
1075 * \li Notion: Cursor movement within an inset may be different than cursor
1076 movement in the surrounding text. This action should be called
1077 automatically by the cursor movement within the inset, when
1078 movement within the inset has ceased (reached the end of the
1079 last paragraph, for example), in order to move correctly
1080 back into the surrounding text.
1083 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1085 * \var lyx::kb_action lyx::LFUN_FINISHED_BACKWARD
1086 * \li Action: Moves the cursor out of the current slice, going backwards.
1087 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1090 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1092 * \var lyx::kb_action lyx::LFUN_FINISHED_RIGHT
1093 * \li Action: Moves the cursor out of the current slice, going right.
1094 * \li Notion: See also #LFUN_FINISHED_FORWARD
1097 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1099 * \var lyx::kb_action lyx::LFUN_FINISHED_LEFT
1100 * \li Action: Moves the cursor out of the current slice, going left.
1101 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1104 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1106 { LFUN_LANGUAGE, "language", Noop, Edit },
1109 * \var lyx::kb_action lyx::LFUN_LABEL_GOTO
1110 * \li Action: Goto a label.
1111 * \li Syntax: label-goto [<LABEL>]
1112 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1113 is on cursor position, Bookmark 0 is saved and
1114 cursor moves to the position of referenced label.
1115 * \li Origin: Ale, 6 Aug 1997
1118 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1119 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1121 * \var lyx::kb_action lyx::LFUN_REFERENCE_NEXT
1122 * \li Action: Go to the next label or cross-reference.
1123 * \li Syntax: reference-next
1124 * \li Origin: Dekel, 14 Jan 2001
1127 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1130 * \var lyx::kb_action lyx::LFUN_BOOKMARK_GOTO
1131 * \li Action: Goto a bookmark.
1132 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1133 if necessary. Note that bookmarsk are saved per-session, not
1135 * \li Syntax: bookmark-goto <NUMBER>
1136 * \li Params: <NUMBER>: the number of the bookmark to restore.
1137 * \li Origin: Dekel, 27 January 2001
1140 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1142 * \var lyx::kb_action lyx::LFUN_BOOKMARK_SAVE
1143 * \li Action: Save a bookmark.
1144 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1145 must be between 1 and 9, inclusive. Note that bookmarks are
1146 saved per-session, not per file.
1147 * \li Syntax: bookmark-save <NUMBER>
1148 * \li Params: <NUMBER>: the number of the bookmark to save.
1149 * \li Origin: Dekel, 27 January 2001
1152 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1154 * \var lyx::kb_action lyx::LFUN_BOOKMARK_CLEAR
1155 * \li Action: Clears the list of saved bookmarks.
1156 * \li Syntax: bookmark-clear
1157 * \li Origin: bpeng, 31 October 2006
1160 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1162 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1164 * \var lyx::kb_action lyx::LFUN_LYX_QUIT
1165 * \li Action: Terminates the current LyX instance.
1166 * \li Notion: Terminates the current LyX instance, asking whether to save
1167 modified documents, etc.
1168 * \li Syntax: lyx-quit
1171 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1173 * \var lyx::kb_action lyx::LFUN_TOOLBAR_TOGGLE
1174 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1175 * \li Notion: Skiping "auto" when allowauto is false.
1176 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1177 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1178 minibuffer|review|view/update|math_panels
1179 * \li Origin: Edwin, 21 May 2007
1182 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1183 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1185 * \var lyx::kb_action lyx::LFUN_UI_TOGGLE
1186 * \li Action: Various UI visibility-toggling actions.
1187 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1188 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1189 menubar : Toggle visibility of the menubar.\n
1190 scrollbar : Toggle visibility of the scrollbar.\n
1191 frame : Toggle visibility of the frames around editing window.\n
1192 fullscreen : Toggle fullscreen mode. This also covers calling the
1193 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1194 custom tweaks of the toolbars should be used.
1195 * \li Origin: ps, 9 Feb 2007
1198 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1200 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1201 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1204 * \var lyx::kb_action lyx::LFUN_SPLIT_VIEW
1205 * \li Action: Creates another split view of current buffer.
1206 * \li Notion: All split views act in the same way indpendently.
1207 * \li Syntax: split-view <vertical|horizontal>
1208 * \li Params: horizontal : The work areas are laid out side by side.\n
1209 vertical : The work areas laid out vertically.\n
1210 * \li Origin: abdel, 20 Feb 2008
1213 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1216 * \var lyx::kb_action lyx::LFUN_CLOSE_TAB_GROUP
1217 * \li Action: Close the current tab group.
1218 * \li Notion: This only closes the work areas, not the buffer themselves.
1219 The still opened buffers can be visualized in another tab group.
1220 * \li Syntax: close-tab-group
1221 * \li Origin: abdel, 21 Feb 2008
1224 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1225 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1226 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1227 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1228 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1229 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1230 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1232 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1233 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1234 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1235 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1236 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1238 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1239 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1240 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1241 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1243 { LFUN_MESSAGE, "message", NoBuffer, System },
1244 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1245 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1247 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1248 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1249 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1250 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1251 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1253 * \var lyx::kb_action lyx::LFUN_SERVER_GOTO_FILE_ROW
1254 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1255 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1256 * \li Origin: Edmar, 23 Dec 1998
1259 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1260 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1261 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1263 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1266 * \var lyx::kb_action lyx::LFUN_BUFFER_AUTO_SAVE
1267 * \li Action: Saves the current buffer to a temporary file.
1268 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1269 is called automatically by LyX, to "autosave" the current buffer.
1270 * \li Syntax: buffer-auto-save
1273 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1274 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1275 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1276 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1277 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1279 * \var lyx::kb_action lyx::LFUN_BUFFER_CLOSE
1280 * \li Action: Closes the current buffer.
1281 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1282 if the buffer has been modified.
1283 * \li Syntax: buffer-close
1286 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1288 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT
1289 * \li Action: Exports the current buffer (document) to the given format.
1290 * \li Syntax: buffer-export <FORMAT>
1291 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1292 can find in Tools->Preferences->File formats->Format.
1293 Usual format you will enter is "pdf2" (pdflatex),
1294 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1295 In case of "custom" you will be asked for a format you
1296 want to start from and for the command that you want to
1297 apply to this format. Internally the control is then passed
1298 to #LFUN_BUFFER_EXPORT_CUSTOM.
1299 * \li Origin: Lgb, 29 Jul 1997
1302 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1304 * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT_CUSTOM
1305 * \li Action: Exports the current buffer (document) from the given format using
1306 the given command on it.
1307 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1308 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1309 intermediate file).\n
1310 <COMMAND> this command will be launched on the file. Note that you can
1311 use "$$FName" string to qualify the intermediate file.
1312 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1313 * \li Origin: leeming, 27 Mar 2004
1316 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1318 * \var lyx::kb_action lyx::LFUN_BUFFER_PRINT
1319 * \li Action: Prints the current document.
1320 * \li Notion: Many settings can be given via the preferences dialog.
1321 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1322 * \li Params: <TARGET> is either "printer" or "file".\n
1323 <TARGER-NAME> is either "default" or file name or printer name.\n
1324 <COMMAND> command ensuring the printing job.
1325 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1326 * \li Origin: leeming, 28 Mar 2004
1329 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1331 * \var lyx::kb_action lyx::LFUN_BUFFER_IMPORT
1332 * \li Action: Import a given file as a lyx document.
1333 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1334 defined convertors in preferences. Look into File->Import menu to get
1335 an idea of the currently active import formats.
1336 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1337 * \li Origin: Asger, 24 Jul 1998
1340 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1342 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
1343 * \li Action: Creates a new buffer (that is, document).
1344 * \li Notion: Implicit path can be set in Preferences dialog.
1345 * \li Syntax: buffer-new [<FILE>]
1346 * \li Params: <FILE>: filename of created file with absolute path.
1349 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1351 * \var lyx::kb_action lyx::LFUN_BUFFER_NEW_TEMPLATE
1352 * \li Action: Creates a new buffer (that is, document) from a template.
1353 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1354 Template will be asked for via Open-dialog.
1355 * \li Syntax: buffer-new-template [<FILE>]
1356 * \li Params: <FILE>: filename of created file with absolute path.
1359 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1360 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1362 * \var lyx::kb_action lyx::LFUN_BUFFER_SWITCH
1363 * \li Action: Switch to the given buffer.
1364 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1365 document in different LyX windows.
1366 * \li Syntax: buffer-new-template <BUFFER>
1367 * \li Params: <BUFFER>: already opened document which is to be shown.
1370 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1372 * \var lyx::kb_action lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1373 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1374 * \li Syntax: buffer-toggle-read-only
1375 * \li Origin: Lgb, 27 May 1997
1378 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1380 * \var lyx::kb_action lyx::LFUN_BUFFER_VIEW
1381 * \li Action: Displays current buffer in chosen format.
1382 * \li Notion: Displays the contents of the current buffer in the chosen
1383 format, for example, PDF or DVI. This runs the necessary
1384 converter, calls the defined viewer, and so forth.
1385 * \li Syntax: buffer-view <FORMAT>
1386 * \li Params: <FORMAT>: The format to display, where this is one of the
1387 formats defined (in the current GUI) in the
1388 Tools>Preferences>File Formats dialog.
1391 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1393 * \var lyx::kb_action lyx::LFUN_BUFFER_UPDATE
1394 * \li Action: Exports the current document and put the result into the
1395 temporary directory.
1396 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1397 the output will be rewriten - updated. This is useful in case your viewer
1398 is able to detect such changes (e.g. ghostview for postscript).
1399 * \li Syntax: buffer-update <FORMAT>
1400 * \li Params: <FORMAT>: The format to display, where this is one of the
1401 formats defined (in the current GUI) in the
1402 Tools>Preferences>File Formats dialog.
1403 * \li Origin: Dekel, 5 Aug 2000
1406 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1409 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE
1410 * \li Action: Saves the current buffer.
1411 * \li Notion: Saves the current buffer to disk, using the filename that
1412 is already associated with the buffer, asking for one if
1413 none is yet assigned.
1414 * \li Syntax: buffer-write
1417 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1419 * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS
1420 * \li Action: Rename and save current buffer.
1421 * \li Syntax: buffer-write-as <FILENAME>
1422 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1423 is with respect to the original location of the buffer/file.
1426 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1427 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1428 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1429 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1430 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1431 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1432 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1433 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1434 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1437 * \var lyx::kb_action lyx::LFUN_FILE_INSERT
1438 * \li Action: Inserts another LyX file.
1439 * \li Syntax: file-insert [<FILE>]
1440 * \li Params: <FILE>: Filename to be inserted.
1443 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1445 * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT
1446 * \li Action: Inserts plain text file.
1447 * \li Syntax: file-insert-plaintext [<FILE>]
1448 * \li Params: <FILE>: Filename to be inserted.
1449 * \li Origin: CFO-G, 19 Nov 1997
1452 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1454 * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1455 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1456 * \li Syntax: file-insert-plaintext-para [<FILE>]
1457 * \li Params: <FILE>: Filename to be inserted.
1458 * \li Origin: Levon, 14 Feb 2001
1461 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1463 * \var lyx::kb_action lyx::LFUN_FILE_OPEN
1464 * \li Action: Open LyX document.
1465 * \li Syntax: file-open [<FILE>]
1466 * \li Params: <FILE>: Filename to be opened.
1469 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1473 * \var lyx::kb_action lyx::LFUN_CALL
1474 * \li Action: Executes a command defined in a .def file.
1475 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1476 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1477 where <NAME> is the name of the new command and <LFUN> is the lfun code
1478 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1479 \\def_file "FileName" allows to include another .def file. \n
1480 This is particularly useful in connection with toolbar buttons:
1481 Since the name of the button image for this lfun is
1482 lib/images/commands/<NAME>.png this is the way to assign an image
1483 to a complex command-sequence.
1484 * \li Syntax: call <NAME>
1485 * \li Params: <NAME>: Name of the command that must be called.
1486 * \li Origin: broider, 2 Oct 2007
1489 { LFUN_CALL, "call", NoBuffer, System },
1491 * \var lyx::kb_action lyx::LFUN_META_PREFIX
1492 * \li Action: Simulate halting Meta key (Alt key on PCs).
1493 * \li Notion: Used for buffer editation not for GUI control.
1494 * \li Syntax: meta-prefix
1497 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1499 * \var lyx::kb_action lyx::LFUN_CANCEL
1500 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1501 * \li Syntax: cancel
1504 { LFUN_CANCEL, "cancel", NoBuffer, System },
1507 * \var lyx::kb_action lyx::LFUN_COMMAND_EXECUTE
1508 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1509 * \li Notion: Usually bound to M-x shortcut.
1510 * \li Syntax: command-execute
1513 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1514 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1516 * \var lyx::kb_action lyx::LFUN_COMMAND_SEQUENCE
1517 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1518 * \li Syntax: command-sequence <CMDS>
1519 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1520 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1521 * \li Origin: Andre', 11 Nov 1999
1524 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1527 * \var lyx::kb_action lyx::LFUN_PREFERENCES_SAVE
1528 * \li Action: Save user preferences.
1529 * \li Syntax: preferences-save
1530 * \li Origin: Lgb, 27 Nov 1999
1533 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1535 * \var lyx::kb_action lyx::LFUN_RECONFIGURE
1536 * \li Action: Reconfigure the automatic settings.
1537 * \li Syntax: reconfigure
1538 * \li Origin: Asger, 14 Feb 1997
1541 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1543 * \var lyx::kb_action lyx::LFUN_LYXRC_APPLY
1544 * \li Action: Apply the given settings to user preferences.
1545 * \li Syntax: lyxrc-apply <SETTINGS>
1546 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1547 to get an idea which commands to use and their syntax.
1548 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1551 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1553 * \var lyx::kb_action lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1554 * \li Action: Determine whether keep cursor inside the editing window regardless
1555 the scrollbar movement.
1556 * \li Syntax: toggle-cursor-follows-scrollbar
1557 * \li Origin: ARRae, 2 Dec 1997
1560 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1562 * \var lyx::kb_action lyx::LFUN_SET_COLOR
1563 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1564 * \li Notion: A new color entry is created if the color is unknown.
1565 Color names can be stored as a part of user settings.
1566 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1567 * \li Origin: SLior, 11 Jun 2000
1570 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1572 * \var lyx::kb_action lyx::LFUN_STATISTICS
1573 * \li Action: Count the statistics (number of words and characters)
1574 in the document or in the given selection.
1575 * \li Notion: Note that this function gives the number of words/chars written,
1576 not the number of characters which will be typeset.
1577 * \li Syntax: statistics
1578 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1581 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1583 * \var lyx::kb_action lyx::LFUN_COMPLETION_INLINE
1584 * \li Action: Show the inline completion at the cursor position.
1585 * \li Syntax: completion-inline
1586 * \li Origin: sts, Feb 19 2008
1589 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1591 * \var lyx::kb_action lyx::LFUN_COMPLETION_POPUP
1592 * \li Action: Show the completion popup at the cursor position.
1593 * \li Syntax: completion-popup
1594 * \li Origin: sts, Feb 19 2008
1597 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1599 * \var lyx::kb_action lyx::LFUN_COMPLETION_COMPLETE
1600 * \li Action: Try to complete the word or command at the cursor position.
1601 * \li Syntax: complete
1602 * \li Origin: sts, Feb 19 2008
1605 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1607 { LFUN_NOACTION, "", Noop, Hidden }
1608 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1611 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1612 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1619 LyXAction::LyXAction()
1625 // Returns an action tag from a string.
1626 FuncRequest LyXAction::lookupFunc(string const & func) const
1628 string const func2 = trim(func);
1630 if (func2.empty()) {
1631 return FuncRequest(LFUN_NOACTION);
1635 string const arg = split(func2, cmd, ' ');
1637 func_map::const_iterator fit = lyx_func_map.find(cmd);
1639 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1643 string const LyXAction::getActionName(kb_action action) const
1645 info_map::const_iterator const it = lyx_info_map.find(action);
1646 return it != lyx_info_map.end() ? it->second.name : string();
1650 LyXAction::func_type const LyXAction::getActionType(kb_action action) const
1652 info_map::const_iterator const it = lyx_info_map.find(action);
1653 return it != lyx_info_map.end() ? it->second.type : Hidden;
1657 bool LyXAction::funcHasFlag(kb_action action,
1658 LyXAction::func_attrib flag) const
1660 info_map::const_iterator ici = lyx_info_map.find(action);
1662 if (ici == lyx_info_map.end()) {
1663 LYXERR0("action: " << action << " is not known.");
1664 BOOST_ASSERT(false);
1667 return ici->second.attrib & flag;
1671 LyXAction::const_func_iterator LyXAction::func_begin() const
1673 return lyx_func_map.begin();
1677 LyXAction::const_func_iterator LyXAction::func_end() const
1679 return lyx_func_map.end();