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 "support/lassert.h"
26 using namespace lyx::support;
31 NAMING RULES FOR USER-COMMANDS
32 Here's the set of rules to apply when a new command name is introduced:
34 1) Use the object.event order. That is, use `word-forward'
35 instead of `forward-word'.
36 2) Don't introduce an alias for an already named object. Same for events.
37 3) Forward movement or focus is called `forward' (not `right').
38 4) Backward movement or focus is called `backward' (not `left').
39 5) Upward movement of focus is called `up'.
40 6) Downward movement is called `down'.
41 7) The begin of an object is called `begin' (not `start').
42 8) The end of an object is called `end'.
44 (May 19 1996, 12:04, RvdK)
47 /* LFUN documentation (a start at least, Chr 2007-08-12)
49 * The documentation below is primarily notes about restrictions and
50 * oddities relating to the different LFUNs.
52 * Try to find an appropriate (thematical) place when adding the new LFUN.
54 * Doxygen template below. Some notes: Parameters should be set in uppercase
55 * and put in <BRACKETS>, as so.
59 * \var lyx::FuncCode lyx::LFUN_
72 void LyXAction::newFunc(FuncCode action, string const & name,
73 unsigned int attrib, LyXAction::func_type type)
75 lyx_func_map[name] = action;
78 tmpinfo.attrib = attrib;
80 lyx_info_map[action] = tmpinfo;
84 // Needed for LFUNs documentation to be accepted, since doxygen won't take
85 // \var inside functions.
86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
87 void LyXAction::init()
89 // This function was changed to use the array below in initalization
90 // instead of calling newFunc numerous times because of compilation
91 // times. Since the array is not static we get back the memory it
92 // occupies after the init is completed. It compiles several
105 ev_item const items[] = {
108 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
109 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
110 to the next character typed.
111 * \li Syntax: accent-acute
114 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
116 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
117 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
118 to the next character typed.
119 * \li Syntax: accent-breve
122 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
124 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
125 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
126 to the next character typed.
127 * \li Syntax: accent-caron
130 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
132 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
133 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
134 to the next character typed.
135 * \li Syntax: accent-cedilla
138 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
140 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
141 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
142 to the next character typed.
143 * \li Syntax: accent-circle
146 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
148 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
149 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
150 to the next character typed.
151 * \li Syntax: accent-circumflex
154 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
156 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
157 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
158 to the next character typed.
159 * \li Syntax: accent-dot
162 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
164 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
165 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
166 to the next character typed.
167 * \li Syntax: accent-grave
170 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
172 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
173 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
174 to the next character typed.
175 * \li Syntax: accent-grave
178 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
180 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
181 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
182 to the next character typed.
183 * \li Syntax: accent-macron
186 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
188 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
189 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
190 to the next character typed.
191 * \li Syntax: accent-ogonek
194 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
196 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
197 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
198 over the next two character typed.
199 * \li Notion: the following char will finish the tie.
200 * \li Syntax: accent-tie
203 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
205 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
206 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
207 over the next character typed.
208 * \li Syntax: accent-tilde
211 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
213 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
214 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
215 over the next character typed.
216 * \li Syntax: accent-umlaut
219 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
221 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
222 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
223 under the next character typed.
224 * \li Syntax: accent-underbar
227 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
229 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
230 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
231 under the next character typed.
232 * \li Syntax: accent-underdot
235 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
238 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
239 * \li Action: Inserts a caption inset.
240 * \li Syntax: caption-insert
241 * \li Origin: Lgb, 18 Jul 2000
244 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
246 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
247 * \li Action: Inserts the current date.
248 * \li Syntax: date-insert [<ARG>]
249 * \li Params: <ARG>: Format of date. The default value (%x) can be set
250 in Preferences->Date format. For possible formats
251 see manual page of strftime function.
252 * \li Origin: jdblair, 31 Jan 2000
255 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
257 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
258 * \li Action: Inserts a footnote inset.
259 * \li Syntax: footnote-insert
260 * \li Origin: Jug, 7 Mar 2000
263 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
265 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
266 * \li Action: Inserts an ERT inset.
267 * \li Syntax: ert-insert
268 * \li Origin: Jug, 18 Feb 2000
271 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
272 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
273 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
274 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
276 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
277 * \li Action: Inserts an optional-argument (short title) inset.
278 * \li Syntax: optional-insert
279 * \li Origin: Martin, 12 Aug 2002
282 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
284 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
285 * \li Action: Inserts a horizontal line.
286 * \li Syntax: line-insert
287 * \li Origin: poenitz, Oct 27 2003
290 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
292 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
293 * \li Action: Inserts a new page.
294 * \li Syntax: newpage-insert<ARG>
295 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
296 * \li Origin: uwestoehr, 24 Nov 2007
299 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
302 * \li Action: Inserts a marginal note.
303 * \li Syntax: marginalnote-insert
304 * \li Origin: Lgb, 26 Jun 2000
307 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
310 * \li Action: Inserts a single unicode character.
311 * \li Syntax: unicode-insert <CHAR>
312 * \li Params: <CHAR>: The character to insert, given as its code
313 point, in hexadecimal, e.g.: unicode-insert 0x0100.
314 * \li Origin: Lgb, 22 Oct 2006
317 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
319 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
320 * \li Action: Inserts a new listings inset.
321 * \li Syntax: listing-insert
322 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
325 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
327 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
328 * \li Action: Inserts quotes according to the type and quote-language preference.
329 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
331 * \li Syntax: quote-insert [<TYPE>]
332 * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
335 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
337 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
338 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
339 information in a non-editable boxed InsetText.
340 * \li Notion: Apart from lfun arguments you can use the following method: \n
341 1. input the type and argument of this inset, e.g. "menu paste", in
343 2. select the text and run info-insert lfun.\n
344 * \li Syntax: info-insert <TYPE> <ARG>
345 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
346 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
348 * \li Origin: bpeng, 7 Oct 2007
351 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
353 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
354 * \li Action: Inserts branch inset.
355 * \li Syntax: branch-insert <BRANCH-NAME>
356 * \li Origin: vermeer, 17 Aug 2003
359 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
361 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
362 * \li Action: Inserts Box inset.
363 * \li Syntax: box-insert [<TYPE>]
364 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
365 Framed is the default one.
366 * \li Origin: vermeer, 7 Oct 2003
369 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
371 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
372 * \li Action: Inserts CharStyle, Custom inset or XML short element.
373 * \li Notion: Look into the Customization manual for more information about
375 For dissolving the element see #LFUN_INSET_DISSOLVE.
376 * \li Syntax: flex-insert <TYPE:Name>
377 * \li Params: TYPE: CharStyle|Custom|Element|Standard
378 Identifies whether this is a Character Style, a
379 Custom Inset or an XML Element, and which dynamical
380 sub-menu this flex inset is in on the LyX menu tree.
381 If Standard (currently unused): none of these.
382 Name: This name must be defined either in your layout file
383 or imported by some module. The definition is\n
384 InsetLayout <TYPE:Name>
385 * \li Sample: flex-insert CharStyle:Code
388 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
390 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
391 * \li Action: Inserts the given string (accordingly to the correct keymap).
392 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
393 settings "auto_region_delete".
394 * \li Syntax: self-insert <STRING>
397 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
399 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
400 * \li Action: Inserts one of horizontal space insets.
401 * \li Syntax: space-insert <NAME> [<LEN>]
402 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
403 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
405 <LEN>: length for custom spaces (hspace, hspace* for protected)
406 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
409 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
411 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
412 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
413 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
414 * \li Syntax: href-insert [<TARGET>]
415 * \li Origin: CFO-G, 21 Nov 1997
418 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
420 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
421 * \li Action: Inserts various characters into the document.
422 * \li Syntax: specialchar-insert <CHAR>
423 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
424 end-of-sentence, menu-separator.
425 * \li Origin: JSpitzm, 6 Dec 2007
428 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
430 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
431 * \li Action: Inserts table of contents.
432 * \li Syntax: toc-insert
433 * \li Origin: Lgb, 27 May 97
436 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
438 * \var lyx::FuncCode lyx::LFUN_APPENDIX
439 * \li Action: Start (or remove) Appendix on the given cursor position.
440 * \li Syntax: appendix
441 * \li Origin: ettrich, 5 May 1998
444 { LFUN_APPENDIX, "appendix", Noop, Edit },
446 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
447 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
449 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
450 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
452 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
453 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
455 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
456 * \li Action: Inserts a line break or new line.
457 * \li Syntax: newline-insert <ARG>
458 * \li Params: <ARG>: <newline|linebreak> default: newline
459 * \li Origin: JSpitzm, 25 Mar 2008
462 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
466 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
470 * \var lyx::FuncCode lyx::LFUN_ESCAPE
471 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
473 * \li Origin: Lgb, 17 May 2001
476 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
477 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
478 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
479 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
480 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
481 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
482 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
483 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
484 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
486 * \var lyx::FuncCode lyx::LFUN_SCROLL
487 * \li Action: Scroll the buffer view.
488 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
489 * \li Syntax: scroll <TYPE> <QUANTITY>
490 * \li Params: <TYPE>: line|page\n
491 <QUANTITY>: up|down|<number>
492 * \li Origin: Abdelrazak Younes, Dec 27 2007
495 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
497 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
498 * \li Action: Recenters the screen on the current cursor position.
499 * \li Syntax: screen-recenter
502 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
503 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
504 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
506 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
508 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
509 * \li Action: Moves the cursor one position logically backwards.
510 * \li Notion: This is not the action which should be bound to the arrow keys,
511 because backwards may be left or right, depending on the
512 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
513 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
514 * \li Syntax: char-backward
517 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
519 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
520 * \li Action: Moves the cursor one position logically backwards, adding
521 traversed position to the selection.
522 * \li Notion: See also #LFUN_CHAR_BACKWARD.
523 * \li Syntax: char-backward-select
526 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
527 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
528 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
530 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
531 * \li Action: Moves the cursor one position logically forward.
532 * \li Notion: This is not the action which should be bound to the arrow keys,
533 because forward may be left or right, depending on the language.
534 The arrow keys should be bound to #LFUN_CHAR_LEFT or
535 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
536 * \li Syntax: char-forward
539 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
541 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
542 * \li Action: Moves the cursor one position logically forward, adding
543 traversed position to the selection.
544 * \li Notion: See also #LFUN_CHAR_FORWARD.
545 * \li Syntax: char-forward-select
548 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
550 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
551 * \li Action: Moves the cursor one position "to the left".
552 * \li Notion: This is the action which should be taken when the "left" key
553 is pressed. Generally, it moves the cursor one position to the
554 left. However, in Bidi text this become slightly more
555 complicated, and there are different modes of cursor movement.
556 In "visual mode", this moves left, plain and simple. In "logical
557 mode", movement is logically forward in RTL paragraphs, and
558 logically backwards in LTR paragraphs.
559 * \li Syntax: char-left
562 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
564 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
565 * \li Action: Moves the cursor one position "to the left", adding
566 traversed position to the selection.
567 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
568 * \li Syntax: char-left-select
571 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
573 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
574 * \li Action: Moves the cursor one position "to the right".
575 * \li Notion: This is the action which should be taken when the "right" key
576 is pressed. Generally, it moves the cursor one position to the
577 right. However, in Bidi text this become slightly more
578 complicated, and there are different modes of cursor movement.
579 In "visual mode", this moves right, plain and simple. In "logical
580 mode", movement is logically forward in LTR paragraphs, and
581 logically backwards in RTL paragraphs.
582 * \li Syntax: char-right
585 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
587 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
588 * \li Action: Moves the cursor one position "to the right", adding
589 traversed position to the selection.
590 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
591 * \li Syntax: char-right-select
594 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
597 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
598 * \li Action: Moves the cursor to the logically previous beginning of a word.
599 * \li Notion: This is not the action which should be bound to the arrow keys,
600 because backwards may be left or right, depending on the
601 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
602 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
603 * \li Syntax: word-backward
606 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
608 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
609 * \li Action: Moves the cursor to the logically previous beginning of a word,
610 adding the logically traversed text to the selection.
611 * \li Notion: See also #LFUN_WORD_BACKWARD.
612 * \li Syntax: word-backward-select
615 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
616 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
617 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
619 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
620 * \li Action: Search for a given string in forward direction.
621 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
622 * \li Syntax: word-find-forward [<STRING>]
623 * \li Origin: Etienne, 16 Feb 1998
626 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
628 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
629 * \li Action: Search for a given string in backward direction.
630 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
631 * \li Syntax: word-find-backward [<STRING>]
632 * \li Origin: Etienne, 20 Feb 1998
635 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
637 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
638 * \li Action: Search for next occurence of a string.
639 * \li Syntax: word-find [<DATA>]
640 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
641 If no parameter is given, search with last find-dialog
642 data is used for search (i.e. find-next).
643 * \li Origin: poenitz, Jan 7 2004
646 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
647 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
649 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
650 * \li Action: Moves the cursor to the logically next beginning of a word.
651 * \li Notion: This is not the action which should be bound to the arrow keys,
652 because forward may be left or right, depending on the language.
653 The arrow keys should be bound to #LFUN_WORD_LEFT or
654 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
655 * \li Syntax: word-forward
658 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
660 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
661 * \li Action: Moves the cursor to the logically next beginning of a word,
662 adding the logically traversed text to the selection.
663 * \li Notion: See also #LFUN_WORD_FORWARD.
664 * \li Syntax: word-forward-select
667 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
669 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
670 * \li Action: Moves the cursor to the next beginning of a word "on the left".
671 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
672 "left" key is pressed. Generally, it moves the cursor to the
673 next beginning of a word on the left. However, in Bidi text this
674 become slightly more complicated, and there are different modes
675 of cursor movement. In "visual mode", this moves left, plain and
676 simple. In "logical mode", movement is logically forward in RTL
677 paragraphs, and logically backwards in LTR paragraphs.
678 * \li Syntax: word-left
679 * \li Origin: dov, 28 Oct 2007
682 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
684 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
685 * \li Action: Moves the cursor to the next beginning of a word "on the left",
686 adding *logically* traversed text to the selection.
687 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
688 * \li Syntax: word-left-select
689 * \li Origin: dov, 28 Oct 2007
692 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
694 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
695 * \li Action: Moves the cursor to the next beginning of a word "on the right".
696 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
697 "right" key is pressed. Generally, it moves the cursor to the
698 next beginning of a word on the right. However, in Bidi text
699 this become slightly more complicated, and there are different
700 modes of cursor movement. In "visual mode", this moves right,
701 plain and simple. In "logical mode", movement is logically
702 forward in LTR paragraphs, and logically backwards in RTL
704 * \li Syntax: word-right
705 * \li Origin: dov, 28 Oct 2007
708 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
710 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
711 * \li Action: Moves the cursor to the next beginning of a word "on the right",
712 adding *logically* traversed text to the selection.
713 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
714 * \li Syntax: word-right-select
715 * \li Origin: dov, 28 Oct 2007
718 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
719 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
721 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
722 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
723 or the letter on the cursor position.
724 * \li Syntax: word-capitalize
727 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
729 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
730 * \li Action: Change the words in the selection or from the cursor position
731 to the end of word to the upper case.
732 * \li Syntax: word-upcase
735 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
737 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
738 * \li Action: Change the words in the selection or from the cursor position
739 to the end of word to the lower case.
740 * \li Syntax: word-lowcase
743 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
745 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
746 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
747 * \li Syntax: thesaurus-entry
748 * \li Origin: Levon, 20 Jul 2001
751 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
752 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
753 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
754 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
755 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
757 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
758 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
759 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
760 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
761 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
763 * \var lyx::FuncCode lyx::LFUN_COPY
764 * \li Action: Copies to the clipboard the last edit.
768 { LFUN_COPY, "copy", ReadOnly, Edit },
770 * \var lyx::FuncCode lyx::LFUN_CUT
771 * \li Action: Cuts to the clipboard.
775 { LFUN_CUT, "cut", Noop, Edit },
777 * \var lyx::FuncCode lyx::LFUN_PASTE
778 * \li Action: Pastes from the active clipboard.
782 { LFUN_PASTE, "paste", Noop, Edit },
783 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
785 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
786 * \li Action: Pastes the material currently selected.
787 * \li Syntax: primary-selection-paste
790 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
792 * \var lyx::FuncCode lyx::LFUN_UNDO
793 * \li Action: Undoes the last edit.
797 { LFUN_UNDO, "undo", Noop, Edit },
799 * \var lyx::FuncCode lyx::LFUN_REDO
800 * \li Action: Redoes the last thing undone.
804 { LFUN_REDO, "redo", Noop, Edit },
806 * \var lyx::FuncCode lyx::LFUN_REPEAT
807 * \li Action: Repeat the given command.
808 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
809 * \li Author: poenitz, 27 Oct 2003
812 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
814 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
815 * \li Action: Transposes the character at the cursor with the one before it.
816 * \li Syntax: chars-transpose
817 * \li Author: Lgb, 25 Apr 2001
820 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
822 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
823 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
824 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
827 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
828 * \li Action: Toggles the bold font (selection-wise).
829 * \li Syntax: font-bold
832 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
834 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
835 * \li Action: Toggles the typewriter family font (selection-wise).
836 * \li Syntax: font-typewriter
839 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
841 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
842 * \li Action: Toggles underline in the font (selection-wise).
843 * \li Syntax: font-underline
846 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
848 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
849 * \li Action: Toggles the emphasis font style (selection-wise).
850 * \li Syntax: font-emph
853 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
855 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
856 * \li Action: Toggles Noun text style font (selection-wise).
857 * \li Syntax: font-noun
860 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
862 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
863 * \li Action: Toggles Roman family font (selection-wise).
864 * \li Syntax: font-roman
867 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
869 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
870 * \li Action: Toggles Sans Serif family font (selection-wise).
871 * \li Syntax: font-sans
874 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
876 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
877 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
878 * \li Syntax: font-frak
879 * \li Origin: vermeer, 10 Jan 2002
882 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
884 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
885 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
886 * \li Syntax: font-ital
887 * \li Origin: vermeer, 10 Jan 2002
890 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
892 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
893 * \li Action: Reverts the settings of the font to the default values (selection-wise).
894 * \li Syntax: font-default
897 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
898 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
899 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
900 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
901 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
903 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
904 * \li Action: Returns the info about the current font.
905 * \li Syntax: font-state
908 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
910 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
911 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
912 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
913 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
916 * \var lyx::FuncCode lyx::LFUN_LAYOUT
917 * \li Action: Sets the layout (that is, environment) for the current paragraph.
918 * \li Syntax: layout <LAYOUT>
919 * \li Params: <LAYOUT>: the layout to use
922 { LFUN_LAYOUT, "layout", Noop, Layout },
924 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
925 * \li Action: Launches the paragraph settings dialog.
926 * \li Syntax: layout-paragraph
929 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
931 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
932 * \li Action: Launches the tabular settings dialog.
933 * \li Syntax: layout-tabular
934 * \li Origin: Jug, 31 Jul 2000
937 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
939 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
940 * \li Action: Displays list of layout choices.
941 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
942 dropbox allowing for choice of layout.
943 * \li Syntax: drop-layouts-choice
946 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
948 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
949 * \li Action: Clears the module list.
950 * \li Notion: Clears the list of included modules for the current buffer.
951 * \li Syntax: layout-modules-clear
952 * \li Origin: rgh, 25 August 2007
955 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
957 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
958 * \li Action: Adds a module.
959 * \li Notion: Adds a module to the list of included modules for the current buffer.
960 * \li Syntax: layout-module-add <MODULE>
961 * \li Params: <MODULE>: the module to be added
962 * \li Origin: rgh, 25 August 2007
965 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
967 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
968 * \li Action: Reloads layout information.
969 * \li Notion: Reloads all layout information for the current buffer from disk, thus
970 recognizing any changes that have been made to layout files on the fly.
971 This is intended to be used only by layout developers and should not be
972 used when one is trying to do actual work.
973 * \li Syntax: layout-reload
974 * \li Origin: rgh, 3 September 2007
977 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
979 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
980 * \li Action: Sets the text class for the current buffer.
981 * \li Syntax: textclass-apply <TEXTCLASS>
982 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
983 the filename, minus the ".layout" extension.
986 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
988 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
989 * \li Action: Loads information for a textclass from disk.
990 * \li Syntax: textclass-load <TEXTCLASS>
991 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
992 the filename, minus the ".layout" extension.
995 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
998 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
999 * \li Action: Disable selecting of text-region.
1000 * \li Syntax: mark-off
1003 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1005 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1006 * \li Action: Enable selecting of text-region.
1007 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1008 * \li Syntax: mark-on
1011 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1013 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1014 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1015 * \li Syntax: mark-toggle
1016 * \li Origin: poenitz, May 5 2006
1019 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1021 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1022 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1023 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1024 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1025 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1026 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1027 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1028 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1029 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1030 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1031 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1032 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1033 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1035 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1036 * \li Action: Toggles numbering of the current formula line.
1037 * \li Notion: Must be in display formula mode.
1038 * \li Syntax: math-number-line-toggle
1039 * \li Origin: Alejandro 18 Jun 1996
1042 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1044 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1045 * \li Action: Toggles numbering/labeling of the current formula.
1046 * \li Notion: Must be in display formula mode.
1047 * \li Syntax: math-number-toggle
1048 * \li Origin: Alejandro 4 Jun 1996
1051 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1052 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1053 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1055 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1056 * \li Action: Unfold a Math Macro.
1057 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1059 * \li Syntax: math-macro-unfold
1060 * \li Origin: sts, 06 January 2008
1063 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1065 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1066 * \li Action: Fold a Math Macro.
1067 * \li Notion: Fold the Math Macro the cursor is in if it was
1068 unfolded, i.e. displayed as \foo before.
1069 * \li Syntax: math-macro-fold
1070 * \li Origin: sts, 06 January 2008
1073 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1075 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1076 * \li Action: Add a parameter.
1077 * \li Notion: Add a parameter to a Math Macro.
1078 * \li Params: <NUM>: The number of the parameter behind which the new one
1079 will be added (1 for the first, i.e. use 0 for add a
1080 parameter at the left), defaults to the last one.
1081 * \li Syntax: math-macro-add-param <NUM>
1082 * \li Origin: sts, 06 January 2008
1085 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1087 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1088 * \li Action: Remove the last parameter.
1089 * \li Notion: Remove the last parameter of a Math Macro and
1090 remove its value in all instances of the macro
1092 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1093 the first), defaults to the last one.
1094 * \li Syntax: math-macro-remove-param <NUM>
1095 * \li Origin: sts, 06 January 2008
1098 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1100 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1101 * \li Action: Append a greedy parameter.
1102 * \li Notion: Append a greedy parameter to a Math Macro which
1103 eats the following mathed cell in every instance of
1104 the macro in the buffer.
1105 * \li Syntax: math-macro-append-greedy-param
1106 * \li Origin: sts, 06 January 2008
1109 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1111 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1112 * \li Action: Remove a greedy parameter.
1113 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1114 out the values of it in every instance of the macro
1115 in the buffer. If it is an optional parameter the [valud]
1117 * \li Syntax: math-macro-remove-greedy-param
1118 * \li Origin: sts, 06 January 2008
1121 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1123 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1124 * \li Action: Make a parameter optional.
1125 * \li Notion: Turn the first non-optional parameter of a Math Macro
1126 into an optional parameter with a default value.
1127 * \li Syntax: math-macro-make-optional
1128 * \li Origin: sts, 06 January 2008
1131 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1133 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1134 * \li Action: Make a parameter non-optional.
1135 * \li Notion: Turn the last optional parameter of a Math Macro
1136 into a non-optional parameter. The default value is
1137 remembered to be reused later if the user changes his mind.
1138 * \li Syntax: math-macro-make-nonoptional
1139 * \li Origin: sts, 06 January 2008
1142 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1144 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1145 * \li Action: Add an optional parameter.
1146 * \li Notion: Insert an optional parameter just behind the
1147 already existing optional parameters.
1148 * \li Syntax: math-macro-add-optional-param
1149 * \li Origin: sts, 06 January 2008
1152 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1154 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1155 * \li Action: Remove the last optional parameter.
1156 * \li Notion: Remove the last optional parameter of a Math Macro and
1157 remove it in all the instances of the macro in the buffer.
1158 * \li Syntax: math-macro-remove-optional-param
1159 * \li Origin: sts, 06 January 2008
1162 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1164 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1165 * \li Action: Add a greedy optional parameter.
1166 * \li Notion: Add a greedy optional parameter which eats the value
1167 from the following cells in mathed which are in the [value]
1169 * \li Syntax: math-macro-add-greedy-optional-param
1170 * \li Origin: sts, 06 January 2008
1173 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1175 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1176 * \li Action: Only active in Math Macro definition.
1177 * \li Notion: Dummy function which is only active in a Math Macro definition.
1178 It's used to toggle the Math Macro toolbar if the cursor moves
1179 into a Math Macro definition.
1180 * \li Syntax: in-mathmacrotemplate
1181 * \li Origin: sts, 06 January 2008
1184 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1187 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1188 * \li Action: Moves the current paragraph downwards in the document.
1189 * \li Syntax: paragraph-move-down
1190 * \li Origin: Edwin, 8 Apr 2006
1193 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1196 * \li Action: Moves the current paragraph upwards in the document.
1197 * \li Syntax: paragraph-move-up
1198 * \li Origin: Edwin, 8 Apr 2006
1201 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1205 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1206 in upward direction.
1207 * \li Syntax: paragraph-up
1208 * \li Origin: Asger, 1 Oct 1996
1211 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1214 * \li Action: Move the cursor and select the text to the next paragraph (or
1215 begining of the current one) in upward direction.
1216 * \li Syntax: paragraph-up-select
1217 * \li Origin: Asger, 1 Oct 1996
1220 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1223 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1224 in downward direction.
1225 * \li Syntax: paragraph-down
1226 * \li Origin: Asger, 1 Oct 1996
1229 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1231 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1232 * \li Action: Move the cursor and select the text to the next paragraph (or
1233 begining of the current one) in downward direction.
1234 * \li Syntax: paragraph-down-select
1235 * \li Origin: Asger, 1 Oct 1996
1238 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1240 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1241 * \li Action: Jump to a paragraph given by its id number and optionally the
1242 desired position within the paragraph.
1243 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1244 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1245 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1246 * \li Params: <PAR_ID_NUMBER>: paragraph id
1247 <POSITION_IN_PAR>: desired position within the paragraph
1248 * \li Origin: Dekel, 26 Aug 2000
1251 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1253 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1254 * \li Action: Breaks the current paragraph at the current location.
1255 * \li Syntax: break-paragraph
1258 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1260 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1261 * \li Action: Breaks the current paragraph at the current location.
1262 * \li Notion: Removes the selection.
1263 * \li Syntax: break-paragraph [<LAYOUT>]
1264 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1265 to default layout) when the cursor is at the end of
1269 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1271 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1272 * \li Action: Breaks the current paragraph at the current location,
1273 unless used at the beginning of a line, where it sets
1274 the label width string to empty.
1275 * \li Syntax: break-paragraph-skip
1278 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1280 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1281 * \li Action: Change paragraph settings.
1282 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1283 This function only modifies, and does not override, existing settings.
1284 Note that the "leftindent" indent setting is deprecated.
1285 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1286 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1287 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1288 <ALIGN>: \\align block|left|right|center|default\n
1289 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1290 * \li Origin: rgh, Aug 15 2007
1293 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1295 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1296 * \li Action: Change paragraph settings.
1297 * \li Notion: Overwrite all nonspecified settings to the default ones.
1298 Use paragraph-params lfun if you don't want to overwrite others settings.
1299 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1300 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1301 * \li Origin: leeming, 30 Mar 2004
1304 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1305 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1308 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1309 * \li Action: Move the current group in the upward direction in the
1310 structure of the document.
1311 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1312 the whole substructure of the group.
1313 * \li Syntax: outline-up
1314 * \li Origin: Vermeer, 23 Mar 2006
1317 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1319 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1320 * \li Action: Move the current group in the downward direction in the
1321 structure of the document.
1322 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1323 the whole substructure of the group.
1324 * \li Syntax: outline-down
1325 * \li Origin: Vermeer, 23 Mar 2006
1328 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1330 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1331 * \li Action: Moves the current group in the downward direction in the
1332 hierarchy of the document structure.
1333 * \li Notion: Part -> Chapter -> Section -> etc.
1334 * \li Syntax: outline-in
1335 * \li Origin: Vermeer, 23 Mar 2006
1338 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1340 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1341 * \li Action: Moves the current group in the upward direction in the
1342 hierarchy of the document structure.
1343 * \li Notion: Part <- Chapter <- Section <- etc.
1344 * \li Syntax: outline-out
1345 * \li Origin: Vermeer, 23 Mar 2006
1348 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1350 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1351 * \li Action: Edit the inset at cursor with an external application,
1352 * if one is attributed.
1353 * \li Syntax: inset-edit [<INSET_PARAMS>]
1354 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1355 Currently only the filename will be considered.
1356 * \li Origin: JSpitzm, 27 Apr 2006
1359 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1361 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1362 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1363 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1364 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1365 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1367 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1368 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1369 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1370 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1371 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1373 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1374 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1375 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1376 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1377 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1378 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1379 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1380 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1383 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1384 * \li Action: Apply data for an inset.
1385 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1386 be applied. This is either changed to #LFUN_INSET_MODIFY or
1387 #LFUN_INSET_INSERT depending on the context where it is called.
1388 * \li Syntax: inset-apply <ARGS>
1389 * \li Params: See #LFUN_INSET_INSERT .
1392 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1394 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1395 * \li Action: Dissolve the current inset into text.
1396 * \li Syntax: inset-dissolve [<INSET>]
1397 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1398 is dissolved. For example "dissolve" entry in the charstyles
1399 sub-menu should only dissolve the charstyle inset, even if the
1400 cursor is inside several nested insets of different type.\n
1401 For values see #lyx::InsetLayout::lyxtype_ .
1402 * \li Author: JSpitz, 7 Aug 2006
1405 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1407 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1408 * \li Action: Insert new inset (type given by the parameters).
1409 * \li Syntax: inset-insert <INSET> <ARGS>
1410 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1411 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1412 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1414 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1415 where <label name> is the name of the referenced label and
1416 <Format> is one of the following: \n
1417 ref -- <reference> \n
1418 eqref -- (<reference>) \n
1419 pageref -- <page> \n
1420 vpageref -- on <page> \n
1421 vref -- <reference> on <page> \n
1422 prettyref -- Formatted reference
1425 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1427 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1428 * \li Action: Modify existing inset.
1429 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1430 bibtex, ert, command, graphics, note, space, vspace, tabular,
1431 bibitem, inlude, ref insets.
1432 * \li Syntax: inset-modify <INSET> <ARGS>
1433 * \li Params: See #LFUN_INSET_INSERT for further details.
1436 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1438 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1439 * \li Action: Modify the inset at cursor position, if there is one.
1440 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1441 bibtex, ert, command, graphics, note, space, vspace, tabular,
1442 bibitem, inlude, ref insets.
1443 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1444 * \li Params: See #LFUN_INSET_INSERT for further details.
1445 * \li Origin: JSpitzm, 23 Mar 2008
1448 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1449 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1451 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1452 * \li Action: Open the inset's properties dialog.
1453 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1454 * \li Syntax: inset-settings <INSET>
1455 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1458 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1460 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1461 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1462 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1463 be entered. Also cf. #LFUN_INSET_SETTINGS.
1464 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1465 bibtex, ert, command, graphics, note, space, vspace, tabular,
1466 bibitem, inlude, ref insets.
1467 * \li Syntax: next-inset-toggle <ARG>
1468 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1469 * \li Origin: leeming, 30 Mar 2004
1472 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1474 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1475 * \li Action: Toggles the collapsable inset we are currently in.
1476 * \li Syntax: inset-toggle [<ARG>]
1477 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1478 open/close/toggle are for collapsable insets. close can be currently used
1479 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1480 assign is for branch inset.
1481 * \li Origin: lasgouttes, 19 Jul 2001
1484 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1486 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1487 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1488 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1489 * \li Syntax: all-insets-toggle <STATE> <INSET>
1490 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1491 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1492 * \li Origin: leeming, 30 Mar 2004
1495 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1497 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1498 * \li Action: Unify all graphics insets with the one given as an parameter.
1499 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1500 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1501 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1502 (syntax can be seen in .lyx files).
1503 * \li Origin: sanda, 6 May 2008
1506 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1508 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1509 * \li Action: Set the group for the graphics inset on the cursor position.
1510 * \li Syntax: set-graphics-group [<GROUP>]
1511 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1512 the graphics inset is removed from the current group.
1513 * \li Origin: sanda, 6 May 2008
1516 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1519 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1520 * \li Action: Moves the cursor out of the current slice, going forward.
1521 * \li Notion: Cursor movement within an inset may be different than cursor
1522 movement in the surrounding text. This action should be called
1523 automatically by the cursor movement within the inset, when
1524 movement within the inset has ceased (reached the end of the
1525 last paragraph, for example), in order to move correctly
1526 back into the surrounding text.
1529 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1531 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1532 * \li Action: Moves the cursor out of the current slice, going backwards.
1533 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1536 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1538 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1539 * \li Action: Moves the cursor out of the current slice, going right.
1540 * \li Notion: See also #LFUN_FINISHED_FORWARD
1543 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1545 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1546 * \li Action: Moves the cursor out of the current slice, going left.
1547 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1550 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1552 { LFUN_LANGUAGE, "language", Noop, Edit },
1555 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1556 * \li Action: Goto a label.
1557 * \li Syntax: label-goto [<LABEL>]
1558 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1559 is on cursor position, Bookmark 0 is saved and
1560 cursor moves to the position of referenced label.
1561 * \li Origin: Ale, 6 Aug 1997
1564 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1566 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1567 * \li Action: Inserts label to text or displayed formula.
1568 * \li Syntax: label-insert [<LABEL>]
1569 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1570 name will be opened.
1573 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1575 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1576 * \li Action: Go to the next label or cross-reference.
1577 * \li Syntax: reference-next
1578 * \li Origin: Dekel, 14 Jan 2001
1581 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1584 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1585 * \li Action: Goto a bookmark.
1586 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1587 if necessary. Note that bookmarsk are saved per-session, not
1589 * \li Syntax: bookmark-goto <NUMBER>
1590 * \li Params: <NUMBER>: the number of the bookmark to restore.
1591 * \li Origin: Dekel, 27 January 2001
1594 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1596 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1597 * \li Action: Save a bookmark.
1598 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1599 must be between 1 and 9, inclusive. Note that bookmarks are
1600 saved per-session, not per file.
1601 * \li Syntax: bookmark-save <NUMBER>
1602 * \li Params: <NUMBER>: the number of the bookmark to save.
1603 * \li Origin: Dekel, 27 January 2001
1606 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1608 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1609 * \li Action: Clears the list of saved bookmarks.
1610 * \li Syntax: bookmark-clear
1611 * \li Origin: bpeng, 31 October 2006
1614 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1617 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1618 * \li Action: Open the given help file according to the language setting.
1619 * \li Syntax: help-open <FILE>[.lyx]
1620 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1621 * \li Author: Jug, 27 Jun 1999
1624 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1626 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1627 * \li Action: Terminates the current LyX instance.
1628 * \li Notion: Terminates the current LyX instance, asking whether to save
1629 modified documents, etc.
1630 * \li Syntax: lyx-quit
1633 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1635 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1636 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1637 * \li Notion: Skiping "auto" when allowauto is false.
1638 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1639 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1640 minibuffer|review|view/update|math_panels
1641 * \li Origin: Edwin, 21 May 2007
1644 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1646 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1647 * \li Action: Opens the menu given by its name.
1648 * \li Syntax: menu-open <NAME>
1649 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1652 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1654 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1655 * \li Action: Various UI visibility-toggling actions.
1656 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1657 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1658 menubar : Toggle visibility of the menubar.\n
1659 scrollbar : Toggle visibility of the scrollbar.\n
1660 frame : Toggle visibility of the frames around editing window.\n
1661 fullscreen : Toggle fullscreen mode. This also covers calling the
1662 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1663 custom tweaks of the toolbars should be used.
1664 * \li Origin: ps, 9 Feb 2007
1667 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1670 * \var lyx::FuncCode lyx::WINDOW_NEW
1671 * \li Action: Creates new empty LyX window.
1672 * \li Notion: Already opened documents from the previous window can be found under View menu.
1673 * \li Syntax: window-new [<GEOMETRY>]
1674 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1675 accepted only on Windows platform.
1676 * \li Origin: Abdel, 21 Oct 2006
1679 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1681 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1682 * \li Action: Closes the current LyX window.
1683 * \li Syntax: window-close
1684 * \li Origin: Abdel, 23 Oct 2006
1687 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1690 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1691 * \li Action: Creates another split view of current buffer.
1692 * \li Notion: All split views act in the same way indpendently.
1693 * \li Syntax: split-view <vertical|horizontal>
1694 * \li Params: horizontal : The work areas are laid out side by side.\n
1695 vertical : The work areas laid out vertically.\n
1696 * \li Origin: abdel, 20 Feb 2008
1699 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1702 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1703 * \li Action: Close the current tab group.
1704 * \li Notion: This only closes the work areas, not the buffer themselves.
1705 The still opened buffers can be visualized in another tab group.
1706 * \li Syntax: close-tab-group
1707 * \li Origin: abdel, 21 Feb 2008
1710 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1711 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1712 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1713 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1714 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1715 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1716 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1718 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1719 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1720 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1721 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1722 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1724 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1725 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1726 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1727 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1729 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1731 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1732 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1733 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1735 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1736 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1737 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1738 * \li Origin: Edmar, 23 Dec 1998
1741 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1742 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1744 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1745 * \li Action: Sets the cursor position based on the editing area coordinates
1746 (similar as clicking on that point with left mouse button).
1747 * \li Syntax: server-set-xy <X> <Y>
1750 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1752 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1753 * \li Action: Returns the coordinates of cursor position in the editing area.
1754 * \li Syntax: server-get-xy
1757 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1760 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1761 * \li Action: Generates the code (literate programming).
1762 * \li Notion: Latex file with extension \literate_extension is generated.
1763 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1764 \build_error_filter to process the compilation error messages. \n
1765 In case you want to process your literate file with a script, or some other program,
1766 just insert in your lyxrc file an entry with:\n
1767 \build_command "my_script my_arguments" \n
1768 The \build_error_filter differs from the \literate_error_filter only in that the
1769 former will identify error messages from your compiler.
1770 * \li Syntax: build-program
1773 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1776 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1777 * \li Action: Saves the current buffer to a temporary file.
1778 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1779 is called automatically by LyX, to "autosave" the current buffer.
1780 * \li Syntax: buffer-auto-save
1783 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1785 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1786 * \li Action: Loads the given child document.
1787 * \li Notion: The current document is treated as a parent.
1788 * \li Syntax: buffer-child-open <FILE>
1789 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1790 * \li Origin: Ale, 28 May 1997
1793 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1795 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1796 * \li Action: Runs chktex for the current document.
1797 * \li Syntax: buffer-chktex
1798 * \li Origin: Asger, 30 Oct 1997
1801 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1803 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1804 * \li Action: Toggles compression of the current document on/off.
1805 * \li Syntax: buffer-toggle-compression
1806 * \li Origin: bpeng, 27 Apr 2006
1809 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1811 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1812 * \li Action: Closes the current buffer.
1813 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1814 if the buffer has been modified.
1815 * \li Syntax: buffer-close
1818 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1820 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1821 * \li Action: Exports the current buffer (document) to the given format.
1822 * \li Syntax: buffer-export <FORMAT>
1823 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1824 can find in Tools->Preferences->File formats->Format.
1825 Usual format you will enter is "pdf2" (pdflatex),
1826 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1827 In case of "custom" you will be asked for a format you
1828 want to start from and for the command that you want to
1829 apply to this format. Internally the control is then passed
1830 to #LFUN_BUFFER_EXPORT_CUSTOM.
1831 * \li Origin: Lgb, 29 Jul 1997
1834 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1836 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1837 * \li Action: Exports the current buffer (document) from the given format using
1838 the given command on it.
1839 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1840 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1841 intermediate file).\n
1842 <COMMAND> this command will be launched on the file. Note that you can
1843 use "$$FName" string to qualify the intermediate file.
1844 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1845 * \li Origin: leeming, 27 Mar 2004
1848 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1850 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1851 * \li Action: Prints the current document.
1852 * \li Notion: Many settings can be given via the preferences dialog.
1853 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1854 * \li Params: <TARGET> is either "printer" or "file".\n
1855 <TARGER-NAME> is either "default" or file name or printer name.\n
1856 <COMMAND> command ensuring the printing job.
1857 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1858 * \li Origin: leeming, 28 Mar 2004
1861 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1863 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1864 * \li Action: Import a given file as a lyx document.
1865 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1866 defined convertors in preferences. Look into File->Import menu to get
1867 an idea of the currently active import formats.
1868 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1869 * \li Origin: Asger, 24 Jul 1998
1872 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1874 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1875 * \li Action: Creates a new buffer (that is, document).
1876 * \li Notion: Implicit path can be set in Preferences dialog.
1877 * \li Syntax: buffer-new [<FILE>]
1878 * \li Params: <FILE>: filename of created file with absolute path.
1881 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1883 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1884 * \li Action: Creates a new buffer (that is, document) from a template.
1885 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1886 Template will be asked for via Open-dialog.
1887 * \li Syntax: buffer-new-template [<FILE>]
1888 * \li Params: <FILE>: filename of created file with absolute path.
1891 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1893 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1894 * \li Action: Reverts opened document.
1895 * \li Syntax: buffer-reload
1896 * \li Origin: Asger, 2 Feb 1997
1899 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1901 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1902 * \li Action: Switch to the given buffer.
1903 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1904 document in different LyX windows.
1905 * \li Syntax: buffer-new-template <BUFFER>
1906 * \li Params: <BUFFER>: already opened document which is to be shown.
1909 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1911 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1912 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1913 * \li Syntax: buffer-toggle-read-only
1914 * \li Origin: Lgb, 27 May 1997
1917 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1919 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1920 * \li Action: Displays current buffer in chosen format.
1921 * \li Notion: Displays the contents of the current buffer in the chosen
1922 format, for example, PDF or DVI. This runs the necessary
1923 converter, calls the defined viewer, and so forth.
1924 * \li Syntax: buffer-view <FORMAT>
1925 * \li Params: <FORMAT>: The format to display, where this is one of the
1926 formats defined (in the current GUI) in the
1927 Tools>Preferences>File Formats dialog.
1930 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1932 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1933 * \li Action: Exports the current document and put the result into the
1934 temporary directory.
1935 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1936 the output will be rewriten - updated. This is useful in case your viewer
1937 is able to detect such changes (e.g. ghostview for postscript).
1938 * \li Syntax: buffer-update <FORMAT>
1939 * \li Params: <FORMAT>: The format to display, where this is one of the
1940 formats defined (in the current GUI) in the
1941 Tools>Preferences>File Formats dialog.
1942 * \li Origin: Dekel, 5 Aug 2000
1945 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1948 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1949 * \li Action: Saves the current buffer.
1950 * \li Notion: Saves the current buffer to disk, using the filename that
1951 is already associated with the buffer, asking for one if
1952 none is yet assigned.
1953 * \li Syntax: buffer-write
1956 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1958 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1959 * \li Action: Rename and save current buffer.
1960 * \li Syntax: buffer-write-as <FILENAME>
1961 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1962 is with respect to the original location of the buffer/file.
1965 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1967 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1968 * \li Action: Save all changed documents.
1969 * \li Syntax: buffer-write-all
1970 * \li Origin: rgh, gpothier 6 Aug 2007
1973 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1975 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1976 * \li Action: Switch to the next opened document.
1977 * \li Notion: Note that this does not necessarily mean next in tabbar
1978 (for full list see View menu).
1979 * \li Syntax: buffer-next
1982 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1984 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1985 * \li Action: Switch to the previous opened document.
1986 * \li Syntax: buffer-previous
1989 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1991 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1992 * \li Action: When run from a child document, this updates (exports) document built
1993 from the master buffer. If a master is not found, it updates the
1995 * \li Syntax: master-buffer-update
1996 * \li Author: Tommaso, 20 Sep 2007
1999 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2001 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2002 * \li Action: When run from a child document, this command shows a preview built
2003 from the master buffer. If a master is not found, it previews the
2005 * \li Syntax: master-buffer-view
2006 * \li Author: Tommaso, 20 Sep 2007
2009 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2011 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2012 * \li Action: Set language of the current document.
2013 * \li Syntax: buffer-language <LANG>
2014 * \li Params: <LANG>: language name. See lib/languages for list.
2015 * \li Author: leeming, 30 Mar 2004
2018 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2020 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2021 * \li Action: Save the current document settings as default.
2022 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2023 * \li Syntax: buffer-save-as-default [<ARGS>]
2024 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2025 you can find in document header of usual .lyx file.
2026 * \li Author: leeming, 30 Mar 2004
2029 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2031 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2032 * \li Action: Apply the given settings to the current document.
2033 * \li Syntax: buffer-params-apply [<ARGS>]
2034 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2035 you can find in document header of usual .lyx file.
2036 * \li Author: leeming, 30 Mar 2004
2039 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2042 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2043 * \li Action: Inserts another LyX file.
2044 * \li Syntax: file-insert [<FILE>]
2045 * \li Params: <FILE>: Filename to be inserted.
2048 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2050 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2051 * \li Action: Inserts plain text file.
2052 * \li Syntax: file-insert-plaintext [<FILE>]
2053 * \li Params: <FILE>: Filename to be inserted.
2054 * \li Origin: CFO-G, 19 Nov 1997
2057 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2059 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2060 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2061 * \li Syntax: file-insert-plaintext-para [<FILE>]
2062 * \li Params: <FILE>: Filename to be inserted.
2063 * \li Origin: Levon, 14 Feb 2001
2066 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2068 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2069 * \li Action: Open LyX document.
2070 * \li Syntax: file-open [<FILE>]
2071 * \li Params: <FILE>: Filename to be opened.
2074 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2077 * \var lyx::FuncCode lyx::LFUN_CALL
2078 * \li Action: Executes a command defined in a .def file.
2079 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2080 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2081 where <NAME> is the name of the new command and <LFUN> is the lfun code
2082 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2083 \\def_file "FileName" allows to include another .def file. \n
2084 This is particularly useful in connection with toolbar buttons:
2085 Since the name of the button image for this lfun is
2086 lib/images/commands/<NAME>.png this is the way to assign an image
2087 to a complex command-sequence.
2088 * \li Syntax: call <NAME>
2089 * \li Params: <NAME>: Name of the command that must be called.
2090 * \li Origin: broider, 2 Oct 2007
2093 { LFUN_CALL, "call", NoBuffer, System },
2095 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2096 * \li Action: Simulate halting Meta key (Alt key on PCs).
2097 * \li Notion: Used for buffer editation not for GUI control.
2098 * \li Syntax: meta-prefix
2101 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2103 * \var lyx::FuncCode lyx::LFUN_CANCEL
2104 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2105 * \li Syntax: cancel
2108 { LFUN_CANCEL, "cancel", NoBuffer, System },
2111 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2112 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2113 * \li Notion: Usually bound to M-x shortcut.
2114 * \li Syntax: command-execute
2117 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2118 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2120 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2121 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2122 * \li Syntax: command-sequence <CMDS>
2123 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2124 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2125 * \li Origin: Andre', 11 Nov 1999
2128 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2130 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2131 * \li Action: Shows message in statusbar (for script purposes).
2132 * \li Syntax: message <STRING>
2133 * \li Origin: Lgb, 8 Apr 2001
2136 { LFUN_MESSAGE, "message", NoBuffer, System },
2138 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2139 * \li Action: Save user preferences.
2140 * \li Syntax: preferences-save
2141 * \li Origin: Lgb, 27 Nov 1999
2144 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2146 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2147 * \li Action: Reconfigure the automatic settings.
2148 * \li Syntax: reconfigure
2149 * \li Origin: Asger, 14 Feb 1997
2152 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2154 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2155 * \li Action: Apply the given settings to user preferences.
2156 * \li Syntax: lyxrc-apply <SETTINGS>
2157 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2158 to get an idea which commands to use and their syntax.
2159 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2162 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2164 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2165 * \li Action: Determine whether keep cursor inside the editing window regardless
2166 the scrollbar movement.
2167 * \li Syntax: toggle-cursor-follows-scrollbar
2168 * \li Origin: ARRae, 2 Dec 1997
2171 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2173 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2174 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2175 * \li Notion: A new color entry is created if the color is unknown.
2176 Color names can be stored as a part of user settings.
2177 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2178 * \li Origin: SLior, 11 Jun 2000
2181 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2183 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2184 * \li Action: Count the statistics (number of words and characters)
2185 in the document or in the given selection.
2186 * \li Notion: Note that this function gives the number of words/chars written,
2187 not the number of characters which will be typeset.
2188 * \li Syntax: statistics
2189 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2192 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2194 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2195 * \li Action: Show the inline completion at the cursor position.
2196 * \li Syntax: completion-inline
2197 * \li Origin: sts, Feb 19 2008
2200 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2202 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2203 * \li Action: Show the completion popup at the cursor position.
2204 * \li Syntax: completion-popup
2205 * \li Origin: sts, Feb 19 2008
2208 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2210 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2211 * \li Action: Try to complete the word or command at the cursor position.
2212 * \li Syntax: completion-complete
2213 * \li Origin: sts, Feb 19 2008
2216 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2218 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2219 * \li Action: Activate the branch
2220 * \li Syntax: branch-activate <BRANCH>
2221 * \li Params: <BRANCH>: The branch to activate
2222 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2223 could be used to export a pdf with the answers branch included
2224 without one's having to open LyX and activate the branch manually.
2225 * \li Origin: rgh, 27 May 2008
2228 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2230 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2231 * \li Action: De-activate the branch
2232 * \li Syntax: branch-deactivate <BRANCH>
2233 * \li Params: <BRANCH>: The branch to deactivate
2234 * \li Origin: rgh, 27 May 2008
2237 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2239 { LFUN_NOACTION, "", Noop, Hidden }
2240 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2243 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2244 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2251 LyXAction::LyXAction()
2257 // Returns an action tag from a string.
2258 FuncRequest LyXAction::lookupFunc(string const & func) const
2260 string const func2 = trim(func);
2262 if (func2.empty()) {
2263 return FuncRequest(LFUN_NOACTION);
2267 string const arg = split(func2, cmd, ' ');
2269 func_map::const_iterator fit = lyx_func_map.find(cmd);
2271 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2275 string const LyXAction::getActionName(FuncCode action) const
2277 info_map::const_iterator const it = lyx_info_map.find(action);
2278 return it != lyx_info_map.end() ? it->second.name : string();
2282 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2284 info_map::const_iterator const it = lyx_info_map.find(action);
2285 return it != lyx_info_map.end() ? it->second.type : Hidden;
2289 bool LyXAction::funcHasFlag(FuncCode action,
2290 LyXAction::func_attrib flag) const
2292 info_map::const_iterator ici = lyx_info_map.find(action);
2294 if (ici == lyx_info_map.end()) {
2295 LYXERR0("action: " << action << " is not known.");
2296 LASSERT(false, /**/);
2299 return ici->second.attrib & flag;
2303 LyXAction::const_func_iterator LyXAction::func_begin() const
2305 return lyx_func_map.begin();
2309 LyXAction::const_func_iterator LyXAction::func_end() const
2311 return lyx_func_map.end();