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::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 },
195 { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
197 * \var lyx::FuncCode 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::FuncCode 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::FuncCode 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::FuncCode 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::FuncCode 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::FuncCode 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::FuncCode 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::FuncCode 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::FuncCode 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::FuncCode lyx::LFUN_OPTIONAL_INSERT
278 * \li Action: Inserts an optional-argument (short title) inset.
279 * \li Syntax: optional-insert
280 * \li Origin: Martin, 12 Aug 2002
283 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
285 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
286 * \li Action: Inserts a horizontal line.
287 * \li Syntax: line-insert
288 * \li Origin: poenitz, Oct 27 2003
291 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
293 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
294 * \li Action: Inserts a new page.
295 * \li Syntax: newpage-insert<ARG>
296 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
297 * \li Origin: uwestoehr, 24 Nov 2007
300 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
302 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
303 * \li Action: Inserts a marginal note.
304 * \li Syntax: marginalnote-insert
305 * \li Origin: Lgb, 26 Jun 2000
308 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
310 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
311 * \li Action: Inserts a single unicode character.
312 * \li Syntax: unicode-insert <CHAR>
313 * \li Params: <CHAR>: The character to insert, given as its code
314 point, in hexadecimal, e.g.: unicode-insert 0x0100.
315 * \li Origin: Lgb, 22 Oct 2006
318 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
321 * \li Action: Inserts a new listings inset.
322 * \li Syntax: listing-insert
323 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
326 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
327 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
328 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
329 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
330 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
332 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
333 * \li Action: Inserts CharStyle, Custom inset or XML short element.
334 * \li Notion: Look into the Customization manual for more information about
336 For dissolving the element see #LFUN_INSET_DISSOLVE.
337 * \li Syntax: flex-insert <TYPE:Name>
338 * \li Params: TYPE: CharStyle|Custom|Element|Standard
339 Identifies whether this is a Character Style, a
340 Custom Inset or an XML Element, and which dynamical
341 sub-menu this flex inset is in on the LyX menu tree.
342 If Standard (currently unused): none of these.
343 Name: This name must be defined either in your layout file
344 or imported by some module. The definition is\n
345 InsetLayout <TYPE:Name>
346 * \li Sample: flex-insert CharStyle:Code
349 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
350 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
352 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
353 * \li Action: Inserts one of horizontal space insets.
354 * \li Syntax: space-insert <NAME> [<LEN>]
355 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
356 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
358 <LEN>: length for custom spaces (hspace, hspace* for protected)
359 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
362 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
363 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
365 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
366 * \li Action: Inserts various characters into the document.
367 * \li Syntax: specialchar-insert <CHAR>
368 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
369 end-of-sentence, menu-separator.
370 * \li Origin: JSpitzm, 6 Dec 2007
373 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
374 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
375 { LFUN_APPENDIX, "appendix", Noop, Edit },
378 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
381 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
382 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
383 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
384 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
385 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
386 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
387 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
388 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
390 * \var lyx::FuncCode lyx::LFUN_SCROLL
391 * \li Action: Scroll the buffer view.
392 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
393 * \li Syntax: scroll <TYPE> <QUANTITY>
394 * \li Params: <TYPE>: line|page\n
395 <QUANTITY>: up|down|<number>
396 * \li Origin: Abdelrazak Younes, Dec 27 2007
399 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
401 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
402 * \li Action: Recenters the screen on the current cursor position.
403 * \li Syntax: screen-recenter
406 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
407 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
408 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
410 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
412 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
413 * \li Action: Moves the cursor one position logically backwards.
414 * \li Notion: This is not the action which should be bound to the arrow keys,
415 because backwards may be left or right, depending on the
416 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
417 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
418 * \li Syntax: char-backward
421 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
423 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
424 * \li Action: Moves the cursor one position logically backwards, adding
425 traversed position to the selection.
426 * \li Notion: See also #LFUN_CHAR_BACKWARD.
427 * \li Syntax: char-backward-select
430 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
431 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
432 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
434 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
435 * \li Action: Moves the cursor one position logically forward.
436 * \li Notion: This is not the action which should be bound to the arrow keys,
437 because forward may be left or right, depending on the language.
438 The arrow keys should be bound to #LFUN_CHAR_LEFT or
439 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
440 * \li Syntax: char-forward
443 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
445 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
446 * \li Action: Moves the cursor one position logically forward, adding
447 traversed position to the selection.
448 * \li Notion: See also #LFUN_CHAR_FORWARD.
449 * \li Syntax: char-forward-select
452 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
454 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
455 * \li Action: Moves the cursor one position "to the left".
456 * \li Notion: This is the action which should be taken when the "left" key
457 is pressed. Generally, it moves the cursor one position to the
458 left. However, in Bidi text this become slightly more
459 complicated, and there are different modes of cursor movement.
460 In "visual mode", this moves left, plain and simple. In "logical
461 mode", movement is logically forward in RTL paragraphs, and
462 logically backwards in LTR paragraphs.
463 * \li Syntax: char-left
466 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
468 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
469 * \li Action: Moves the cursor one position "to the left", adding
470 traversed position to the selection.
471 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
472 * \li Syntax: char-left-select
475 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
477 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
478 * \li Action: Moves the cursor one position "to the right".
479 * \li Notion: This is the action which should be taken when the "right" key
480 is pressed. Generally, it moves the cursor one position to the
481 right. However, in Bidi text this become slightly more
482 complicated, and there are different modes of cursor movement.
483 In "visual mode", this moves right, plain and simple. In "logical
484 mode", movement is logically forward in LTR paragraphs, and
485 logically backwards in RTL paragraphs.
486 * \li Syntax: char-right
489 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
491 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
492 * \li Action: Moves the cursor one position "to the right", adding
493 traversed position to the selection.
494 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
495 * \li Syntax: char-right-select
498 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
500 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
501 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
502 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
503 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
504 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
507 * \li Action: Search for a given string in forward direction.
508 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
509 * \li Syntax: word-find-forward [<STRING>]
510 * \li Origin: Etienne, 16 Feb 1998
513 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
515 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
516 * \li Action: Search for a given string in backward direction.
517 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
518 * \li Syntax: word-find-backward [<STRING>]
519 * \li Origin: Etienne, 20 Feb 1998
522 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
524 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
525 * \li Action: Search for next occurence of a string.
526 * \li Syntax: word-find [<DATA>]
527 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
528 If no parameter is given, search with last find-dialog
529 data is used for search (i.e. find-next).
530 * \li Origin: poenitz, Jan 7 2004
533 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
534 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
535 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
536 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
537 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
538 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
539 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
540 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
541 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
542 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
543 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
545 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
546 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
547 * \li Syntax: thesaurus-entry
548 * \li Origin: Levon, 20 Jul 2001
551 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
552 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
553 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
554 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
555 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
557 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
558 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
559 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
560 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
561 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
563 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
564 * \li Action: Inserts a line break or new line.
565 * \li Syntax: newline-insert <ARG>
566 * \li Params: <ARG>: <newline|linebreak> default: newline
567 * \li Origin: JSpitzm, 25 Mar 2008
570 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
573 * \var lyx::FuncCode lyx::LFUN_COPY
574 * \li Action: Copies to the clipboard the last edit.
578 { LFUN_COPY, "copy", ReadOnly, Edit },
580 * \var lyx::FuncCode lyx::LFUN_CUT
581 * \li Action: Cuts to the clipboard.
585 { LFUN_CUT, "cut", Noop, Edit },
587 * \var lyx::FuncCode lyx::LFUN_PASTE
588 * \li Action: Pastes from the active clipboard.
592 { LFUN_PASTE, "paste", Noop, Edit },
593 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
595 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
596 * \li Action: Pastes the material currently selected.
597 * \li Syntax: primary-selection-paste
600 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
602 * \var lyx::FuncCode lyx::LFUN_UNDO
603 * \li Action: Undoes the last edit.
607 { LFUN_UNDO, "undo", Noop, Edit },
609 * \var lyx::FuncCode lyx::LFUN_REDO
610 * \li Action: Redoes the last thing undone.
614 { LFUN_REDO, "redo", Noop, Edit },
615 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
616 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
618 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
619 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
620 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
622 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
623 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
624 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
625 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
626 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
627 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
628 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
629 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
630 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
631 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
632 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
633 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
634 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
635 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
636 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
638 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
639 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
641 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
642 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
644 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
645 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
647 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
648 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
649 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
650 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
653 * \var lyx::FuncCode lyx::LFUN_LAYOUT
654 * \li Action: Sets the layout (that is, environment) for the current paragraph.
655 * \li Syntax: layout <LAYOUT>
656 * \li Params: <LAYOUT>: the layout to use
659 { LFUN_LAYOUT, "layout", Noop, Layout },
661 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
662 * \li Action: Launches the paragraph settings dialog.
663 * \li Syntax: layout-paragraph
666 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
667 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
669 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
670 * \li Action: Displays list of layout choices.
671 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
672 dropbox allowing for choice of layout.
673 * \li Syntax: drop-layouts-choice
676 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
678 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
679 * \li Action: Clears the module list.
680 * \li Notion: Clears the list of included modules for the current buffer.
681 * \li Syntax: layout-modules-clear
682 * \li Origin: rgh, 25 August 2007
685 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
687 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
688 * \li Action: Adds a module.
689 * \li Notion: Adds a module to the list of included modules for the current buffer.
690 * \li Syntax: layout-module-add <MODULE>
691 * \li Params: <MODULE>: the module to be added
692 * \li Origin: rgh, 25 August 2007
695 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
697 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
698 * \li Action: Reloads layout information.
699 * \li Notion: Reloads all layout information for the current buffer from disk, thus
700 recognizing any changes that have been made to layout files on the fly.
701 This is intended to be used only by layout developers and should not be
702 used when one is trying to do actual work.
703 * \li Syntax: layout-reload
704 * \li Origin: rgh, 3 September 2007
707 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
709 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
710 * \li Action: Sets the text class for the current buffer.
711 * \li Syntax: textclass-apply <TEXTCLASS>
712 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
713 the filename, minus the ".layout" extension.
716 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
718 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
719 * \li Action: Loads information for a textclass from disk.
720 * \li Syntax: textclass-load <TEXTCLASS>
721 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
722 the filename, minus the ".layout" extension.
725 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
728 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
729 * \li Action: Disable selecting of text-region.
730 * \li Syntax: mark-off
733 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
735 * \var lyx::FuncCode lyx::LFUN_MARK_ON
736 * \li Action: Enable selecting of text-region.
737 * \li Notion: After enabling you can simply move arrow keys to get selected region.
738 * \li Syntax: mark-on
741 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
743 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
744 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
745 * \li Syntax: mark-toggle
746 * \li Origin: poenitz, May 5 2006
749 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
751 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
752 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
753 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
754 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
755 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
756 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
757 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
758 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
759 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
760 { LFUN_MATH_SPACE, "math-space", Noop, Math },
761 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
762 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
763 { LFUN_MATH_MODE, "math-mode", Noop, Math },
765 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
766 * \li Action: Toggles numbering of the current formula line.
767 * \li Notion: Must be in display formula mode.
768 * \li Syntax: math-number-line-toggle
769 * \li Origin: Alejandro 18 Jun 1996
772 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
774 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
775 * \li Action: Toggles numbering/labeling of the current formula.
776 * \li Notion: Must be in display formula mode.
777 * \li Syntax: math-number-toggle
778 * \li Origin: Alejandro 4 Jun 1996
781 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
782 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
783 { LFUN_MATH_SIZE, "math-size", Noop, Math },
785 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
786 * \li Action: Unfold a Math Macro.
787 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
789 * \li Syntax: math-macro-unfold
790 * \li Origin: sts, 06 January 2008
793 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
795 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
796 * \li Action: Fold a Math Macro.
797 * \li Notion: Fold the Math Macro the cursor is in if it was
798 unfolded, i.e. displayed as \foo before.
799 * \li Syntax: math-macro-fold
800 * \li Origin: sts, 06 January 2008
803 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
805 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
806 * \li Action: Add a parameter.
807 * \li Notion: Add a parameter to a Math Macro.
808 * \li Params: <NUM>: The number of the parameter behind which the new one
809 will be added (1 for the first, i.e. use 0 for add a
810 parameter at the left), defaults to the last one.
811 * \li Syntax: math-macro-add-param <NUM>
812 * \li Origin: sts, 06 January 2008
815 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
817 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
818 * \li Action: Remove the last parameter.
819 * \li Notion: Remove the last parameter of a Math Macro and
820 remove its value in all instances of the macro
822 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
823 the first), defaults to the last one.
824 * \li Syntax: math-macro-remove-param <NUM>
825 * \li Origin: sts, 06 January 2008
828 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
830 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
831 * \li Action: Append a greedy parameter.
832 * \li Notion: Append a greedy parameter to a Math Macro which
833 eats the following mathed cell in every instance of
834 the macro in the buffer.
835 * \li Syntax: math-macro-append-greedy-param
836 * \li Origin: sts, 06 January 2008
839 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
841 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
842 * \li Action: Remove a greedy parameter.
843 * \li Notion: Remove a greedy parameter of a Math Macro and spit
844 out the values of it in every instance of the macro
845 in the buffer. If it is an optional parameter the [valud]
847 * \li Syntax: math-macro-remove-greedy-param
848 * \li Origin: sts, 06 January 2008
851 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
853 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
854 * \li Action: Make a parameter optional.
855 * \li Notion: Turn the first non-optional parameter of a Math Macro
856 into an optional parameter with a default value.
857 * \li Syntax: math-macro-make-optional
858 * \li Origin: sts, 06 January 2008
861 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
863 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
864 * \li Action: Make a parameter non-optional.
865 * \li Notion: Turn the last optional parameter of a Math Macro
866 into a non-optional parameter. The default value is
867 remembered to be reused later if the user changes his mind.
868 * \li Syntax: math-macro-make-nonoptional
869 * \li Origin: sts, 06 January 2008
872 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
874 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
875 * \li Action: Add an optional parameter.
876 * \li Notion: Insert an optional parameter just behind the
877 already existing optional parameters.
878 * \li Syntax: math-macro-add-optional-param
879 * \li Origin: sts, 06 January 2008
882 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
884 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
885 * \li Action: Remove the last optional parameter.
886 * \li Notion: Remove the last optional parameter of a Math Macro and
887 remove it in all the instances of the macro in the buffer.
888 * \li Syntax: math-macro-remove-optional-param
889 * \li Origin: sts, 06 January 2008
892 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
894 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
895 * \li Action: Add a greedy optional parameter.
896 * \li Notion: Add a greedy optional parameter which eats the value
897 from the following cells in mathed which are in the [value]
899 * \li Syntax: math-macro-add-greedy-optional-param
900 * \li Origin: sts, 06 January 2008
903 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
905 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
906 * \li Action: Only active in Math Macro definition.
907 * \li Notion: Dummy function which is only active in a Math Macro definition.
908 It's used to toggle the Math Macro toolbar if the cursor moves
909 into a Math Macro definition.
910 * \li Syntax: in-mathmacrotemplate
911 * \li Origin: sts, 06 January 2008
914 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
917 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
918 * \li Action: Moves the current paragraph downwards in the document.
919 * \li Syntax: paragraph-move-down
920 * \li Origin: Edwin, 8 Apr 2006
923 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
925 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
926 * \li Action: Moves the current paragraph upwards in the document.
927 * \li Syntax: paragraph-move-up
928 * \li Origin: Edwin, 8 Apr 2006
931 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
933 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
934 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
935 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
936 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
937 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
939 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
940 * \li Action: Jump to a paragraph given by its id number.
941 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
942 seen on the screen. Moreover the id is unique for all opened buffers (documents).
943 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
944 * \li Origin: Dekel, 26 Aug 2000
947 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
949 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
950 * \li Action: Breaks the current paragraph at the current location.
951 * \li Syntax: break-paragraph
954 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
956 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
957 * \li Action: Breaks the current paragraph at the current location,
958 unless used at the beginning of a line, where it sets
959 the label width string to empty.
960 * \li Syntax: break-paragraph-skip
963 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
965 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
966 * \li Action: Change paragraph settings.
967 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
968 This function only modifies, and does not override, existing settings.
969 Note that the "leftindent" indent setting is deprecated.
970 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
971 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
972 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
973 <ALIGN>: \\align block|left|right|center|default\n
974 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
975 * \li Origin: rgh, Aug 15 2007
978 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
980 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
981 * \li Action: Change paragraph settings.
982 * \li Notion: Overwrite all nonspecified settings to the default ones.
983 Use paragraph-params lfun if you don't want to overwrite others settings.
984 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
985 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
986 * \li Origin: leeming, 30 Mar 2004
989 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
990 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
993 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
994 * \li Action: Move the current group in the upward direction in the
995 structure of the document.
996 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
997 the whole substructure of the group.
998 * \li Syntax: outline-up
999 * \li Origin: Vermeer, 23 Mar 2006
1002 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1004 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1005 * \li Action: Move the current group in the downward direction in the
1006 structure of the document.
1007 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1008 the whole substructure of the group.
1009 * \li Syntax: outline-down
1010 * \li Origin: Vermeer, 23 Mar 2006
1013 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1015 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1016 * \li Action: Moves the current group in the downward direction in the
1017 hierarchy of the document structure.
1018 * \li Notion: Part -> Chapter -> Section -> etc.
1019 * \li Syntax: outline-in
1020 * \li Origin: Vermeer, 23 Mar 2006
1023 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1025 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1026 * \li Action: Moves the current group in the upward direction in the
1027 hierarchy of the document structure.
1028 * \li Notion: Part <- Chapter <- Section <- etc.
1029 * \li Syntax: outline-out
1030 * \li Origin: Vermeer, 23 Mar 2006
1033 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1035 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
1036 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
1038 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1039 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1040 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1041 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1042 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1044 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1045 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1046 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1047 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1048 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1050 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1051 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1052 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1053 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1054 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1055 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1056 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1057 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1060 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1061 * \li Action: Apply data for an inset.
1062 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1063 be applied. This is either changed to #LFUN_INSET_MODIFY or
1064 #LFUN_INSET_INSERT depending on the context where it is called.
1065 * \li Syntax: inset-apply <ARGS>
1066 * \li Params: See #LFUN_INSET_INSERT .
1069 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1072 * \li Action: Dissolve the current inset into text.
1073 * \li Syntax: inset-dissolve [<INSET>]
1074 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1075 is dissolved. For example "dissolve" entry in the charstyles
1076 sub-menu should only dissolve the charstyle inset, even if the
1077 cursor is inside several nested insets of different type.\n
1078 For values see #lyx::InsetLayout::lyxtype_ .
1079 * \li Author: JSpitz, 7 Aug 2006
1082 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1084 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1085 * \li Action: Insert new inset (type given by the parameters).
1086 * \li Syntax: inset-insert <INSET> <ARGS>
1087 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1088 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1089 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1091 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1092 where <label name> is the name of the referenced label and
1093 <Format> is one of the following: \n
1094 ref -- <reference> \n
1095 eqref -- (<reference>) \n
1096 pageref -- <page> \n
1097 vpageref -- on <page> \n
1098 vref -- <reference> on <page> \n
1099 prettyref -- Formatted reference
1102 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1104 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1105 * \li Action: Modify existing inset.
1106 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1107 bibtex, ert, command, graphics, note, space, vspace, tabular,
1108 bibitem, inlude, ref insets.
1109 * \li Syntax: inset-modify <INSET> <ARGS>
1110 * \li Params: See #LFUN_INSET_INSERT for further details.
1113 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1115 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1116 * \li Action: Modify the inset at cursor position, if there is one.
1117 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1118 bibtex, ert, command, graphics, note, space, vspace, tabular,
1119 bibitem, inlude, ref insets.
1120 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1121 * \li Params: See #LFUN_INSET_INSERT for further details.
1122 * \li Origin: JSpitzm, 23 Mar 2008
1125 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1126 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1128 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1129 * \li Action: Open the inset's properties dialog.
1130 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1131 * \li Syntax: inset-settings <INSET>
1132 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1135 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1137 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1138 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1139 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1140 be entered. Also cf. #LFUN_INSET_SETTINGS.
1141 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1142 bibtex, ert, command, graphics, note, space, vspace, tabular,
1143 bibitem, inlude, ref insets.
1144 * \li Syntax: next-inset-toggle <ARG>
1145 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1146 * \li Origin: leeming, 30 Mar 2004
1149 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1151 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1152 * \li Action: Toggles the collapsable inset we are currently in.
1153 * \li Syntax: inset-toggle [<ARG>]
1154 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1155 open/close/toggle are for collapsable insets. close can be currently used
1156 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1157 assign is for branch inset.
1158 * \li Origin: lasgouttes, 19 Jul 2001
1161 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1163 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1164 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1165 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1166 * \li Syntax: all-insets-toggle <STATE> <INSET>
1167 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1168 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1169 * \li Origin: leeming, 30 Mar 2004
1172 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1175 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1176 * \li Action: Moves the cursor out of the current slice, going forward.
1177 * \li Notion: Cursor movement within an inset may be different than cursor
1178 movement in the surrounding text. This action should be called
1179 automatically by the cursor movement within the inset, when
1180 movement within the inset has ceased (reached the end of the
1181 last paragraph, for example), in order to move correctly
1182 back into the surrounding text.
1185 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1187 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1188 * \li Action: Moves the cursor out of the current slice, going backwards.
1189 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1192 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1194 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1195 * \li Action: Moves the cursor out of the current slice, going right.
1196 * \li Notion: See also #LFUN_FINISHED_FORWARD
1199 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1201 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1202 * \li Action: Moves the cursor out of the current slice, going left.
1203 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1206 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1208 { LFUN_LANGUAGE, "language", Noop, Edit },
1211 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1212 * \li Action: Goto a label.
1213 * \li Syntax: label-goto [<LABEL>]
1214 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1215 is on cursor position, Bookmark 0 is saved and
1216 cursor moves to the position of referenced label.
1217 * \li Origin: Ale, 6 Aug 1997
1220 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1221 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1223 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1224 * \li Action: Go to the next label or cross-reference.
1225 * \li Syntax: reference-next
1226 * \li Origin: Dekel, 14 Jan 2001
1229 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1232 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1233 * \li Action: Goto a bookmark.
1234 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1235 if necessary. Note that bookmarsk are saved per-session, not
1237 * \li Syntax: bookmark-goto <NUMBER>
1238 * \li Params: <NUMBER>: the number of the bookmark to restore.
1239 * \li Origin: Dekel, 27 January 2001
1242 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1244 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1245 * \li Action: Save a bookmark.
1246 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1247 must be between 1 and 9, inclusive. Note that bookmarks are
1248 saved per-session, not per file.
1249 * \li Syntax: bookmark-save <NUMBER>
1250 * \li Params: <NUMBER>: the number of the bookmark to save.
1251 * \li Origin: Dekel, 27 January 2001
1254 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1256 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1257 * \li Action: Clears the list of saved bookmarks.
1258 * \li Syntax: bookmark-clear
1259 * \li Origin: bpeng, 31 October 2006
1262 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1265 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1266 * \li Action: Open the given help file according to the language setting.
1267 * \li Syntax: help-open <FILE>[.lyx]
1268 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1269 * \li Author: Jug, 27 Jun 1999
1272 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1274 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1275 * \li Action: Terminates the current LyX instance.
1276 * \li Notion: Terminates the current LyX instance, asking whether to save
1277 modified documents, etc.
1278 * \li Syntax: lyx-quit
1281 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1283 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1284 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1285 * \li Notion: Skiping "auto" when allowauto is false.
1286 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1287 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1288 minibuffer|review|view/update|math_panels
1289 * \li Origin: Edwin, 21 May 2007
1292 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1293 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1295 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1296 * \li Action: Various UI visibility-toggling actions.
1297 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1298 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1299 menubar : Toggle visibility of the menubar.\n
1300 scrollbar : Toggle visibility of the scrollbar.\n
1301 frame : Toggle visibility of the frames around editing window.\n
1302 fullscreen : Toggle fullscreen mode. This also covers calling the
1303 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1304 custom tweaks of the toolbars should be used.
1305 * \li Origin: ps, 9 Feb 2007
1308 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1311 * \var lyx::FuncCode lyx::WINDOW_NEW
1312 * \li Action: Creates new empty LyX window.
1313 * \li Notion: Already opened documents from the previous window can be found under View menu.
1314 * \li Syntax: window-new [<GEOMETRY>]
1315 * \li Params: <GEOMETRY>: pass the geometry of the window. Currently works only under Windows.
1316 * \li Origin: Abdel, 21 Oct 2006
1319 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1321 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1322 * \li Action: Closes the current LyX window.
1323 * \li Syntax: window-close
1324 * \li Origin: Abdel, 23 Oct 2006
1327 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1330 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1331 * \li Action: Creates another split view of current buffer.
1332 * \li Notion: All split views act in the same way indpendently.
1333 * \li Syntax: split-view <vertical|horizontal>
1334 * \li Params: horizontal : The work areas are laid out side by side.\n
1335 vertical : The work areas laid out vertically.\n
1336 * \li Origin: abdel, 20 Feb 2008
1339 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1342 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1343 * \li Action: Close the current tab group.
1344 * \li Notion: This only closes the work areas, not the buffer themselves.
1345 The still opened buffers can be visualized in another tab group.
1346 * \li Syntax: close-tab-group
1347 * \li Origin: abdel, 21 Feb 2008
1350 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1351 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1352 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1353 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1354 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1355 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1356 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1358 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1359 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1360 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1361 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1362 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1364 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1365 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1366 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1367 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1369 { LFUN_MESSAGE, "message", NoBuffer, System },
1370 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1371 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1373 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1374 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1375 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1376 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1377 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1379 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1380 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1381 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1382 * \li Origin: Edmar, 23 Dec 1998
1385 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1386 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1387 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1389 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1392 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1393 * \li Action: Saves the current buffer to a temporary file.
1394 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1395 is called automatically by LyX, to "autosave" the current buffer.
1396 * \li Syntax: buffer-auto-save
1399 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1401 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1402 * \li Action: Loads the given child document.
1403 * \li Notion: The current document is treated as a parent.
1404 * \li Syntax: buffer-child-open <FILE>
1405 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1406 * \li Origin: Ale, 28 May 1997
1409 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1411 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1412 * \li Action: Runs chktex for the current document.
1413 * \li Syntax: buffer-chktex
1414 * \li Origin: Asger, 30 Oct 1997
1417 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1419 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1420 * \li Action: Toggles compression of the current document on/off.
1421 * \li Syntax: buffer-toggle-compression
1422 * \li Origin: bpeng, 27 Apr 2006
1425 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1427 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_EMBEDDING
1428 * \li Action: Toggles the embeddding feature on/off.
1429 * \li Syntax: buffer-toggle-embedding
1430 * \li Origin: bpeng, 21 Oct 2007
1433 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1435 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1436 * \li Action: Closes the current buffer.
1437 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1438 if the buffer has been modified.
1439 * \li Syntax: buffer-close
1442 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1444 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1445 * \li Action: Exports the current buffer (document) to the given format.
1446 * \li Syntax: buffer-export <FORMAT>
1447 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1448 can find in Tools->Preferences->File formats->Format.
1449 Usual format you will enter is "pdf2" (pdflatex),
1450 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1451 In case of "custom" you will be asked for a format you
1452 want to start from and for the command that you want to
1453 apply to this format. Internally the control is then passed
1454 to #LFUN_BUFFER_EXPORT_CUSTOM.
1455 * \li Origin: Lgb, 29 Jul 1997
1458 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1460 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1461 * \li Action: Exports the current buffer (document) from the given format using
1462 the given command on it.
1463 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1464 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1465 intermediate file).\n
1466 <COMMAND> this command will be launched on the file. Note that you can
1467 use "$$FName" string to qualify the intermediate file.
1468 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1469 * \li Origin: leeming, 27 Mar 2004
1472 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1474 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1475 * \li Action: Prints the current document.
1476 * \li Notion: Many settings can be given via the preferences dialog.
1477 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1478 * \li Params: <TARGET> is either "printer" or "file".\n
1479 <TARGER-NAME> is either "default" or file name or printer name.\n
1480 <COMMAND> command ensuring the printing job.
1481 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1482 * \li Origin: leeming, 28 Mar 2004
1485 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1487 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1488 * \li Action: Import a given file as a lyx document.
1489 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1490 defined convertors in preferences. Look into File->Import menu to get
1491 an idea of the currently active import formats.
1492 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1493 * \li Origin: Asger, 24 Jul 1998
1496 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1498 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1499 * \li Action: Creates a new buffer (that is, document).
1500 * \li Notion: Implicit path can be set in Preferences dialog.
1501 * \li Syntax: buffer-new [<FILE>]
1502 * \li Params: <FILE>: filename of created file with absolute path.
1505 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1507 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1508 * \li Action: Creates a new buffer (that is, document) from a template.
1509 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1510 Template will be asked for via Open-dialog.
1511 * \li Syntax: buffer-new-template [<FILE>]
1512 * \li Params: <FILE>: filename of created file with absolute path.
1515 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1517 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1518 * \li Action: Reverts opened document.
1519 * \li Syntax: buffer-reload
1520 * \li Origin: Asger, 2 Feb 1997
1523 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1525 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1526 * \li Action: Switch to the given buffer.
1527 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1528 document in different LyX windows.
1529 * \li Syntax: buffer-new-template <BUFFER>
1530 * \li Params: <BUFFER>: already opened document which is to be shown.
1533 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1535 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1536 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1537 * \li Syntax: buffer-toggle-read-only
1538 * \li Origin: Lgb, 27 May 1997
1541 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1543 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1544 * \li Action: Displays current buffer in chosen format.
1545 * \li Notion: Displays the contents of the current buffer in the chosen
1546 format, for example, PDF or DVI. This runs the necessary
1547 converter, calls the defined viewer, and so forth.
1548 * \li Syntax: buffer-view <FORMAT>
1549 * \li Params: <FORMAT>: The format to display, where this is one of the
1550 formats defined (in the current GUI) in the
1551 Tools>Preferences>File Formats dialog.
1554 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1556 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1557 * \li Action: Exports the current document and put the result into the
1558 temporary directory.
1559 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1560 the output will be rewriten - updated. This is useful in case your viewer
1561 is able to detect such changes (e.g. ghostview for postscript).
1562 * \li Syntax: buffer-update <FORMAT>
1563 * \li Params: <FORMAT>: The format to display, where this is one of the
1564 formats defined (in the current GUI) in the
1565 Tools>Preferences>File Formats dialog.
1566 * \li Origin: Dekel, 5 Aug 2000
1569 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1572 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1573 * \li Action: Saves the current buffer.
1574 * \li Notion: Saves the current buffer to disk, using the filename that
1575 is already associated with the buffer, asking for one if
1576 none is yet assigned.
1577 * \li Syntax: buffer-write
1580 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1582 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1583 * \li Action: Rename and save current buffer.
1584 * \li Syntax: buffer-write-as <FILENAME>
1585 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1586 is with respect to the original location of the buffer/file.
1589 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1591 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1592 * \li Action: Save all changed documents.
1593 * \li Syntax: buffer-write-all
1594 * \li Origin: rgh, gpothier 6 Aug 2007
1597 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1599 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1600 * \li Action: Switch to the next opened document.
1601 * \li Notion: Note that this does not necessarily mean next in tabbar
1602 (for full list see View menu).
1603 * \li Syntax: buffer-next
1606 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1608 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1609 * \li Action: Switch to the previous opened document.
1610 * \li Syntax: buffer-previous
1613 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1615 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1616 * \li Action: When run from a child document, this updates (exports) document built
1617 from the master buffer. If a master is not found, it updates the
1619 * \li Syntax: master-buffer-update
1620 * \li Author: Tommaso, 20 Sep 2007
1623 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1625 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1626 * \li Action: When run from a child document, this command shows a preview built
1627 from the master buffer. If a master is not found, it previews the
1629 * \li Syntax: master-buffer-view
1630 * \li Author: Tommaso, 20 Sep 2007
1633 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1635 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1636 * \li Action: Set language of the current document.
1637 * \li Syntax: buffer-language <LANG>
1638 * \li Params: <LANG>: language name. See lib/languages for list.
1639 * \li Author: leeming, 30 Mar 2004
1642 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1644 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1645 * \li Action: Save the current document settings as default.
1646 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1647 * \li Syntax: buffer-save-as-default [<ARGS>]
1648 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1649 you can find in document header of usual .lyx file.
1650 * \li Author: leeming, 30 Mar 2004
1653 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1655 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1656 * \li Action: Apply the given settings to the current document.
1657 * \li Syntax: buffer-params-apply [<ARGS>]
1658 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1659 you can find in document header of usual .lyx file.
1660 * \li Author: leeming, 30 Mar 2004
1663 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1666 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1667 * \li Action: Inserts another LyX file.
1668 * \li Syntax: file-insert [<FILE>]
1669 * \li Params: <FILE>: Filename to be inserted.
1672 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1674 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1675 * \li Action: Inserts plain text file.
1676 * \li Syntax: file-insert-plaintext [<FILE>]
1677 * \li Params: <FILE>: Filename to be inserted.
1678 * \li Origin: CFO-G, 19 Nov 1997
1681 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1683 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1684 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1685 * \li Syntax: file-insert-plaintext-para [<FILE>]
1686 * \li Params: <FILE>: Filename to be inserted.
1687 * \li Origin: Levon, 14 Feb 2001
1690 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1692 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1693 * \li Action: Open LyX document.
1694 * \li Syntax: file-open [<FILE>]
1695 * \li Params: <FILE>: Filename to be opened.
1698 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1701 * \var lyx::FuncCode lyx::LFUN_CALL
1702 * \li Action: Executes a command defined in a .def file.
1703 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1704 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1705 where <NAME> is the name of the new command and <LFUN> is the lfun code
1706 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1707 \\def_file "FileName" allows to include another .def file. \n
1708 This is particularly useful in connection with toolbar buttons:
1709 Since the name of the button image for this lfun is
1710 lib/images/commands/<NAME>.png this is the way to assign an image
1711 to a complex command-sequence.
1712 * \li Syntax: call <NAME>
1713 * \li Params: <NAME>: Name of the command that must be called.
1714 * \li Origin: broider, 2 Oct 2007
1717 { LFUN_CALL, "call", NoBuffer, System },
1719 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1720 * \li Action: Simulate halting Meta key (Alt key on PCs).
1721 * \li Notion: Used for buffer editation not for GUI control.
1722 * \li Syntax: meta-prefix
1725 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1727 * \var lyx::FuncCode lyx::LFUN_CANCEL
1728 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1729 * \li Syntax: cancel
1732 { LFUN_CANCEL, "cancel", NoBuffer, System },
1735 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1736 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1737 * \li Notion: Usually bound to M-x shortcut.
1738 * \li Syntax: command-execute
1741 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1742 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1744 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1745 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1746 * \li Syntax: command-sequence <CMDS>
1747 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1748 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1749 * \li Origin: Andre', 11 Nov 1999
1752 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1755 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1756 * \li Action: Save user preferences.
1757 * \li Syntax: preferences-save
1758 * \li Origin: Lgb, 27 Nov 1999
1761 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1763 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1764 * \li Action: Reconfigure the automatic settings.
1765 * \li Syntax: reconfigure
1766 * \li Origin: Asger, 14 Feb 1997
1769 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1771 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1772 * \li Action: Apply the given settings to user preferences.
1773 * \li Syntax: lyxrc-apply <SETTINGS>
1774 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1775 to get an idea which commands to use and their syntax.
1776 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1779 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1781 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1782 * \li Action: Determine whether keep cursor inside the editing window regardless
1783 the scrollbar movement.
1784 * \li Syntax: toggle-cursor-follows-scrollbar
1785 * \li Origin: ARRae, 2 Dec 1997
1788 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1790 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1791 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1792 * \li Notion: A new color entry is created if the color is unknown.
1793 Color names can be stored as a part of user settings.
1794 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1795 * \li Origin: SLior, 11 Jun 2000
1798 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1800 * \var lyx::FuncCode lyx::LFUN_STATISTICS
1801 * \li Action: Count the statistics (number of words and characters)
1802 in the document or in the given selection.
1803 * \li Notion: Note that this function gives the number of words/chars written,
1804 not the number of characters which will be typeset.
1805 * \li Syntax: statistics
1806 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1809 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1811 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1812 * \li Action: Show the inline completion at the cursor position.
1813 * \li Syntax: completion-inline
1814 * \li Origin: sts, Feb 19 2008
1817 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1819 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1820 * \li Action: Show the completion popup at the cursor position.
1821 * \li Syntax: completion-popup
1822 * \li Origin: sts, Feb 19 2008
1825 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1827 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1828 * \li Action: Try to complete the word or command at the cursor position.
1829 * \li Syntax: completion-complete
1830 * \li Origin: sts, Feb 19 2008
1833 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1835 { LFUN_NOACTION, "", Noop, Hidden }
1836 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1839 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1840 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1847 LyXAction::LyXAction()
1853 // Returns an action tag from a string.
1854 FuncRequest LyXAction::lookupFunc(string const & func) const
1856 string const func2 = trim(func);
1858 if (func2.empty()) {
1859 return FuncRequest(LFUN_NOACTION);
1863 string const arg = split(func2, cmd, ' ');
1865 func_map::const_iterator fit = lyx_func_map.find(cmd);
1867 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1871 string const LyXAction::getActionName(FuncCode action) const
1873 info_map::const_iterator const it = lyx_info_map.find(action);
1874 return it != lyx_info_map.end() ? it->second.name : string();
1878 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1880 info_map::const_iterator const it = lyx_info_map.find(action);
1881 return it != lyx_info_map.end() ? it->second.type : Hidden;
1885 bool LyXAction::funcHasFlag(FuncCode action,
1886 LyXAction::func_attrib flag) const
1888 info_map::const_iterator ici = lyx_info_map.find(action);
1890 if (ici == lyx_info_map.end()) {
1891 LYXERR0("action: " << action << " is not known.");
1892 BOOST_ASSERT(false);
1895 return ici->second.attrib & flag;
1899 LyXAction::const_func_iterator LyXAction::func_begin() const
1901 return lyx_func_map.begin();
1905 LyXAction::const_func_iterator LyXAction::func_end() const
1907 return lyx_func_map.end();