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 },
326 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
329 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
330 information in a non-editable boxed InsetText.
331 * \li Notion: Apart from lfun arguments you can use the following method: \n
332 1. input the type and argument of this inset, e.g. "menu paste", in
334 2. select the text and run info-insert lfun.\n
335 * \li Syntax: info-insert <TYPE> <ARG>
336 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
337 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
339 * \li Origin: bpeng, 7 Oct 2007
342 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
344 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
345 * \li Action: Inserts branch inset.
346 * \li Syntax: branch-insert <BRANCH-NAME>
347 * \li Origin: vermeer, Aug 17 Aug 2003
350 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
351 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
353 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
354 * \li Action: Inserts CharStyle, Custom inset or XML short element.
355 * \li Notion: Look into the Customization manual for more information about
357 For dissolving the element see #LFUN_INSET_DISSOLVE.
358 * \li Syntax: flex-insert <TYPE:Name>
359 * \li Params: TYPE: CharStyle|Custom|Element|Standard
360 Identifies whether this is a Character Style, a
361 Custom Inset or an XML Element, and which dynamical
362 sub-menu this flex inset is in on the LyX menu tree.
363 If Standard (currently unused): none of these.
364 Name: This name must be defined either in your layout file
365 or imported by some module. The definition is\n
366 InsetLayout <TYPE:Name>
367 * \li Sample: flex-insert CharStyle:Code
370 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
371 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
373 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
374 * \li Action: Inserts one of horizontal space insets.
375 * \li Syntax: space-insert <NAME> [<LEN>]
376 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
377 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
379 <LEN>: length for custom spaces (hspace, hspace* for protected)
380 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
383 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
384 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
386 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
387 * \li Action: Inserts various characters into the document.
388 * \li Syntax: specialchar-insert <CHAR>
389 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
390 end-of-sentence, menu-separator.
391 * \li Origin: JSpitzm, 6 Dec 2007
394 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
395 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
396 { LFUN_APPENDIX, "appendix", Noop, Edit },
398 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
399 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
401 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
402 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
404 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
405 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
407 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
408 * \li Action: Inserts a line break or new line.
409 * \li Syntax: newline-insert <ARG>
410 * \li Params: <ARG>: <newline|linebreak> default: newline
411 * \li Origin: JSpitzm, 25 Mar 2008
414 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
418 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
421 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
422 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
423 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
424 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
425 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
426 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
427 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
428 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
430 * \var lyx::FuncCode lyx::LFUN_SCROLL
431 * \li Action: Scroll the buffer view.
432 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
433 * \li Syntax: scroll <TYPE> <QUANTITY>
434 * \li Params: <TYPE>: line|page\n
435 <QUANTITY>: up|down|<number>
436 * \li Origin: Abdelrazak Younes, Dec 27 2007
439 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
441 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
442 * \li Action: Recenters the screen on the current cursor position.
443 * \li Syntax: screen-recenter
446 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
447 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
448 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
450 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
452 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
453 * \li Action: Moves the cursor one position logically backwards.
454 * \li Notion: This is not the action which should be bound to the arrow keys,
455 because backwards may be left or right, depending on the
456 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
457 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
458 * \li Syntax: char-backward
461 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
463 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
464 * \li Action: Moves the cursor one position logically backwards, adding
465 traversed position to the selection.
466 * \li Notion: See also #LFUN_CHAR_BACKWARD.
467 * \li Syntax: char-backward-select
470 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
471 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
472 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
474 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
475 * \li Action: Moves the cursor one position logically forward.
476 * \li Notion: This is not the action which should be bound to the arrow keys,
477 because forward may be left or right, depending on the language.
478 The arrow keys should be bound to #LFUN_CHAR_LEFT or
479 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
480 * \li Syntax: char-forward
483 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
485 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
486 * \li Action: Moves the cursor one position logically forward, adding
487 traversed position to the selection.
488 * \li Notion: See also #LFUN_CHAR_FORWARD.
489 * \li Syntax: char-forward-select
492 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
494 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
495 * \li Action: Moves the cursor one position "to the left".
496 * \li Notion: This is the action which should be taken when the "left" key
497 is pressed. Generally, it moves the cursor one position to the
498 left. However, in Bidi text this become slightly more
499 complicated, and there are different modes of cursor movement.
500 In "visual mode", this moves left, plain and simple. In "logical
501 mode", movement is logically forward in RTL paragraphs, and
502 logically backwards in LTR paragraphs.
503 * \li Syntax: char-left
506 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
508 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
509 * \li Action: Moves the cursor one position "to the left", adding
510 traversed position to the selection.
511 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
512 * \li Syntax: char-left-select
515 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
517 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
518 * \li Action: Moves the cursor one position "to the right".
519 * \li Notion: This is the action which should be taken when the "right" key
520 is pressed. Generally, it moves the cursor one position to the
521 right. However, in Bidi text this become slightly more
522 complicated, and there are different modes of cursor movement.
523 In "visual mode", this moves right, plain and simple. In "logical
524 mode", movement is logically forward in LTR paragraphs, and
525 logically backwards in RTL paragraphs.
526 * \li Syntax: char-right
529 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
531 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
532 * \li Action: Moves the cursor one position "to the right", adding
533 traversed position to the selection.
534 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
535 * \li Syntax: char-right-select
538 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
540 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
541 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
542 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
543 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
544 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
547 * \li Action: Search for a given string in forward direction.
548 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
549 * \li Syntax: word-find-forward [<STRING>]
550 * \li Origin: Etienne, 16 Feb 1998
553 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
555 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
556 * \li Action: Search for a given string in backward direction.
557 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
558 * \li Syntax: word-find-backward [<STRING>]
559 * \li Origin: Etienne, 20 Feb 1998
562 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
564 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
565 * \li Action: Search for next occurence of a string.
566 * \li Syntax: word-find [<DATA>]
567 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
568 If no parameter is given, search with last find-dialog
569 data is used for search (i.e. find-next).
570 * \li Origin: poenitz, Jan 7 2004
573 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
574 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
575 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
576 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
577 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
578 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
579 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
580 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
581 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
582 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
583 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
585 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
586 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
587 * \li Syntax: thesaurus-entry
588 * \li Origin: Levon, 20 Jul 2001
591 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
592 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
593 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
594 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
595 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
597 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
598 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
599 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
600 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
601 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
603 * \var lyx::FuncCode lyx::LFUN_COPY
604 * \li Action: Copies to the clipboard the last edit.
608 { LFUN_COPY, "copy", ReadOnly, Edit },
610 * \var lyx::FuncCode lyx::LFUN_CUT
611 * \li Action: Cuts to the clipboard.
615 { LFUN_CUT, "cut", Noop, Edit },
617 * \var lyx::FuncCode lyx::LFUN_PASTE
618 * \li Action: Pastes from the active clipboard.
622 { LFUN_PASTE, "paste", Noop, Edit },
623 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
625 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
626 * \li Action: Pastes the material currently selected.
627 * \li Syntax: primary-selection-paste
630 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
632 * \var lyx::FuncCode lyx::LFUN_UNDO
633 * \li Action: Undoes the last edit.
637 { LFUN_UNDO, "undo", Noop, Edit },
639 * \var lyx::FuncCode lyx::LFUN_REDO
640 * \li Action: Redoes the last thing undone.
644 { LFUN_REDO, "redo", Noop, Edit },
646 * \var lyx::FuncCode lyx::LFUN_REPEAT
647 * \li Action: Repeat the given command.
648 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
649 * \li Author: poenitz, 27 Oct 2003
652 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
653 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
655 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
656 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
657 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
659 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
660 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
661 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
662 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
663 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
664 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
665 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
666 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
667 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
668 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
669 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
670 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
671 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
672 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
673 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
675 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
676 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
677 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
678 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
681 * \var lyx::FuncCode lyx::LFUN_LAYOUT
682 * \li Action: Sets the layout (that is, environment) for the current paragraph.
683 * \li Syntax: layout <LAYOUT>
684 * \li Params: <LAYOUT>: the layout to use
687 { LFUN_LAYOUT, "layout", Noop, Layout },
689 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
690 * \li Action: Launches the paragraph settings dialog.
691 * \li Syntax: layout-paragraph
694 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
695 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
697 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
698 * \li Action: Displays list of layout choices.
699 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
700 dropbox allowing for choice of layout.
701 * \li Syntax: drop-layouts-choice
704 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
706 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
707 * \li Action: Clears the module list.
708 * \li Notion: Clears the list of included modules for the current buffer.
709 * \li Syntax: layout-modules-clear
710 * \li Origin: rgh, 25 August 2007
713 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
715 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
716 * \li Action: Adds a module.
717 * \li Notion: Adds a module to the list of included modules for the current buffer.
718 * \li Syntax: layout-module-add <MODULE>
719 * \li Params: <MODULE>: the module to be added
720 * \li Origin: rgh, 25 August 2007
723 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
725 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
726 * \li Action: Reloads layout information.
727 * \li Notion: Reloads all layout information for the current buffer from disk, thus
728 recognizing any changes that have been made to layout files on the fly.
729 This is intended to be used only by layout developers and should not be
730 used when one is trying to do actual work.
731 * \li Syntax: layout-reload
732 * \li Origin: rgh, 3 September 2007
735 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
737 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
738 * \li Action: Sets the text class for the current buffer.
739 * \li Syntax: textclass-apply <TEXTCLASS>
740 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
741 the filename, minus the ".layout" extension.
744 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
746 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
747 * \li Action: Loads information for a textclass from disk.
748 * \li Syntax: textclass-load <TEXTCLASS>
749 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
750 the filename, minus the ".layout" extension.
753 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
756 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
757 * \li Action: Disable selecting of text-region.
758 * \li Syntax: mark-off
761 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
763 * \var lyx::FuncCode lyx::LFUN_MARK_ON
764 * \li Action: Enable selecting of text-region.
765 * \li Notion: After enabling you can simply move arrow keys to get selected region.
766 * \li Syntax: mark-on
769 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
771 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
772 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
773 * \li Syntax: mark-toggle
774 * \li Origin: poenitz, May 5 2006
777 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
779 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
780 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
781 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
782 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
783 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
784 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
785 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
786 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
787 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
788 { LFUN_MATH_SPACE, "math-space", Noop, Math },
789 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
790 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
791 { LFUN_MATH_MODE, "math-mode", Noop, Math },
793 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
794 * \li Action: Toggles numbering of the current formula line.
795 * \li Notion: Must be in display formula mode.
796 * \li Syntax: math-number-line-toggle
797 * \li Origin: Alejandro 18 Jun 1996
800 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
802 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
803 * \li Action: Toggles numbering/labeling of the current formula.
804 * \li Notion: Must be in display formula mode.
805 * \li Syntax: math-number-toggle
806 * \li Origin: Alejandro 4 Jun 1996
809 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
810 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
811 { LFUN_MATH_SIZE, "math-size", Noop, Math },
813 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
814 * \li Action: Unfold a Math Macro.
815 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
817 * \li Syntax: math-macro-unfold
818 * \li Origin: sts, 06 January 2008
821 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
823 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
824 * \li Action: Fold a Math Macro.
825 * \li Notion: Fold the Math Macro the cursor is in if it was
826 unfolded, i.e. displayed as \foo before.
827 * \li Syntax: math-macro-fold
828 * \li Origin: sts, 06 January 2008
831 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
833 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
834 * \li Action: Add a parameter.
835 * \li Notion: Add a parameter to a Math Macro.
836 * \li Params: <NUM>: The number of the parameter behind which the new one
837 will be added (1 for the first, i.e. use 0 for add a
838 parameter at the left), defaults to the last one.
839 * \li Syntax: math-macro-add-param <NUM>
840 * \li Origin: sts, 06 January 2008
843 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
845 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
846 * \li Action: Remove the last parameter.
847 * \li Notion: Remove the last parameter of a Math Macro and
848 remove its value in all instances of the macro
850 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
851 the first), defaults to the last one.
852 * \li Syntax: math-macro-remove-param <NUM>
853 * \li Origin: sts, 06 January 2008
856 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
858 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
859 * \li Action: Append a greedy parameter.
860 * \li Notion: Append a greedy parameter to a Math Macro which
861 eats the following mathed cell in every instance of
862 the macro in the buffer.
863 * \li Syntax: math-macro-append-greedy-param
864 * \li Origin: sts, 06 January 2008
867 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
869 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
870 * \li Action: Remove a greedy parameter.
871 * \li Notion: Remove a greedy parameter of a Math Macro and spit
872 out the values of it in every instance of the macro
873 in the buffer. If it is an optional parameter the [valud]
875 * \li Syntax: math-macro-remove-greedy-param
876 * \li Origin: sts, 06 January 2008
879 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
881 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
882 * \li Action: Make a parameter optional.
883 * \li Notion: Turn the first non-optional parameter of a Math Macro
884 into an optional parameter with a default value.
885 * \li Syntax: math-macro-make-optional
886 * \li Origin: sts, 06 January 2008
889 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
891 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
892 * \li Action: Make a parameter non-optional.
893 * \li Notion: Turn the last optional parameter of a Math Macro
894 into a non-optional parameter. The default value is
895 remembered to be reused later if the user changes his mind.
896 * \li Syntax: math-macro-make-nonoptional
897 * \li Origin: sts, 06 January 2008
900 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
902 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
903 * \li Action: Add an optional parameter.
904 * \li Notion: Insert an optional parameter just behind the
905 already existing optional parameters.
906 * \li Syntax: math-macro-add-optional-param
907 * \li Origin: sts, 06 January 2008
910 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
912 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
913 * \li Action: Remove the last optional parameter.
914 * \li Notion: Remove the last optional parameter of a Math Macro and
915 remove it in all the instances of the macro in the buffer.
916 * \li Syntax: math-macro-remove-optional-param
917 * \li Origin: sts, 06 January 2008
920 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
922 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
923 * \li Action: Add a greedy optional parameter.
924 * \li Notion: Add a greedy optional parameter which eats the value
925 from the following cells in mathed which are in the [value]
927 * \li Syntax: math-macro-add-greedy-optional-param
928 * \li Origin: sts, 06 January 2008
931 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
933 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
934 * \li Action: Only active in Math Macro definition.
935 * \li Notion: Dummy function which is only active in a Math Macro definition.
936 It's used to toggle the Math Macro toolbar if the cursor moves
937 into a Math Macro definition.
938 * \li Syntax: in-mathmacrotemplate
939 * \li Origin: sts, 06 January 2008
942 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
945 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
946 * \li Action: Moves the current paragraph downwards in the document.
947 * \li Syntax: paragraph-move-down
948 * \li Origin: Edwin, 8 Apr 2006
951 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
953 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
954 * \li Action: Moves the current paragraph upwards in the document.
955 * \li Syntax: paragraph-move-up
956 * \li Origin: Edwin, 8 Apr 2006
959 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
962 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
963 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
965 * \li Syntax: paragraph-up
966 * \li Origin: Asger, 1 Oct 1996
969 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
971 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
972 * \li Action: Move the cursor and select the text to the next paragraph (or
973 begining of the current one) in upward direction.
974 * \li Syntax: paragraph-up-select
975 * \li Origin: Asger, 1 Oct 1996
978 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
980 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
981 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
982 in downward direction.
983 * \li Syntax: paragraph-down
984 * \li Origin: Asger, 1 Oct 1996
987 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
989 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
990 * \li Action: Move the cursor and select the text to the next paragraph (or
991 begining of the current one) in downward direction.
992 * \li Syntax: paragraph-down-select
993 * \li Origin: Asger, 1 Oct 1996
996 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
998 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
999 * \li Action: Jump to a paragraph given by its id number.
1000 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1001 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1002 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
1003 * \li Origin: Dekel, 26 Aug 2000
1006 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1008 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1009 * \li Action: Breaks the current paragraph at the current location.
1010 * \li Syntax: break-paragraph
1013 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1014 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1016 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1017 * \li Action: Breaks the current paragraph at the current location,
1018 unless used at the beginning of a line, where it sets
1019 the label width string to empty.
1020 * \li Syntax: break-paragraph-skip
1023 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1025 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1026 * \li Action: Change paragraph settings.
1027 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1028 This function only modifies, and does not override, existing settings.
1029 Note that the "leftindent" indent setting is deprecated.
1030 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1031 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1032 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1033 <ALIGN>: \\align block|left|right|center|default\n
1034 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1035 * \li Origin: rgh, Aug 15 2007
1038 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1040 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1041 * \li Action: Change paragraph settings.
1042 * \li Notion: Overwrite all nonspecified settings to the default ones.
1043 Use paragraph-params lfun if you don't want to overwrite others settings.
1044 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1045 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1046 * \li Origin: leeming, 30 Mar 2004
1049 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1050 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1053 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1054 * \li Action: Move the current group in the upward direction in the
1055 structure of the document.
1056 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1057 the whole substructure of the group.
1058 * \li Syntax: outline-up
1059 * \li Origin: Vermeer, 23 Mar 2006
1062 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1064 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1065 * \li Action: Move the current group in the downward direction in the
1066 structure of the document.
1067 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1068 the whole substructure of the group.
1069 * \li Syntax: outline-down
1070 * \li Origin: Vermeer, 23 Mar 2006
1073 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1075 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1076 * \li Action: Moves the current group in the downward direction in the
1077 hierarchy of the document structure.
1078 * \li Notion: Part -> Chapter -> Section -> etc.
1079 * \li Syntax: outline-in
1080 * \li Origin: Vermeer, 23 Mar 2006
1083 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1085 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1086 * \li Action: Moves the current group in the upward direction in the
1087 hierarchy of the document structure.
1088 * \li Notion: Part <- Chapter <- Section <- etc.
1089 * \li Syntax: outline-out
1090 * \li Origin: Vermeer, 23 Mar 2006
1093 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1095 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1096 * \li Action: Edit the inset at cursor with an external application,
1097 * if one is attributed.
1098 * \li Syntax: inset-edit [<INSET_PARAMS>]
1099 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1100 Currently only the filename will be considered.
1101 * \li Origin: JSpitzm, 27 Apr 2006
1104 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1106 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1107 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1108 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1109 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1110 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1112 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1113 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1114 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1115 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1116 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1118 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1119 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1120 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1121 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1122 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1123 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1124 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1125 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1128 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1129 * \li Action: Apply data for an inset.
1130 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1131 be applied. This is either changed to #LFUN_INSET_MODIFY or
1132 #LFUN_INSET_INSERT depending on the context where it is called.
1133 * \li Syntax: inset-apply <ARGS>
1134 * \li Params: See #LFUN_INSET_INSERT .
1137 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1139 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1140 * \li Action: Dissolve the current inset into text.
1141 * \li Syntax: inset-dissolve [<INSET>]
1142 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1143 is dissolved. For example "dissolve" entry in the charstyles
1144 sub-menu should only dissolve the charstyle inset, even if the
1145 cursor is inside several nested insets of different type.\n
1146 For values see #lyx::InsetLayout::lyxtype_ .
1147 * \li Author: JSpitz, 7 Aug 2006
1150 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1152 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1153 * \li Action: Insert new inset (type given by the parameters).
1154 * \li Syntax: inset-insert <INSET> <ARGS>
1155 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1156 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1157 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1159 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1160 where <label name> is the name of the referenced label and
1161 <Format> is one of the following: \n
1162 ref -- <reference> \n
1163 eqref -- (<reference>) \n
1164 pageref -- <page> \n
1165 vpageref -- on <page> \n
1166 vref -- <reference> on <page> \n
1167 prettyref -- Formatted reference
1170 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1172 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1173 * \li Action: Modify existing inset.
1174 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1175 bibtex, ert, command, graphics, note, space, vspace, tabular,
1176 bibitem, inlude, ref insets.
1177 * \li Syntax: inset-modify <INSET> <ARGS>
1178 * \li Params: See #LFUN_INSET_INSERT for further details.
1181 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1183 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1184 * \li Action: Modify the inset at cursor position, if there is one.
1185 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1186 bibtex, ert, command, graphics, note, space, vspace, tabular,
1187 bibitem, inlude, ref insets.
1188 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1189 * \li Params: See #LFUN_INSET_INSERT for further details.
1190 * \li Origin: JSpitzm, 23 Mar 2008
1193 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1194 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1196 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1197 * \li Action: Open the inset's properties dialog.
1198 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1199 * \li Syntax: inset-settings <INSET>
1200 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1203 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1205 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1206 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1207 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1208 be entered. Also cf. #LFUN_INSET_SETTINGS.
1209 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1210 bibtex, ert, command, graphics, note, space, vspace, tabular,
1211 bibitem, inlude, ref insets.
1212 * \li Syntax: next-inset-toggle <ARG>
1213 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1214 * \li Origin: leeming, 30 Mar 2004
1217 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1219 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1220 * \li Action: Toggles the collapsable inset we are currently in.
1221 * \li Syntax: inset-toggle [<ARG>]
1222 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1223 open/close/toggle are for collapsable insets. close can be currently used
1224 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1225 assign is for branch inset.
1226 * \li Origin: lasgouttes, 19 Jul 2001
1229 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1231 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1232 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1233 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1234 * \li Syntax: all-insets-toggle <STATE> <INSET>
1235 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1236 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1237 * \li Origin: leeming, 30 Mar 2004
1240 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1242 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1243 * \li Action: Unify all graphics insets with the one given as an parameter.
1244 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1245 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1246 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1247 (syntax can be seen in .lyx files).
1248 * \li Origin: sanda, 6 May 2008
1251 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1253 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1254 * \li Action: Set the group for the graphics inset on the cursor position.
1255 * \li Syntax: set-graphics-group [<GROUP>]
1256 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1257 the graphics inset is removed from the current group.
1258 * \li Origin: sanda, 6 May 2008
1261 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1264 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1265 * \li Action: Moves the cursor out of the current slice, going forward.
1266 * \li Notion: Cursor movement within an inset may be different than cursor
1267 movement in the surrounding text. This action should be called
1268 automatically by the cursor movement within the inset, when
1269 movement within the inset has ceased (reached the end of the
1270 last paragraph, for example), in order to move correctly
1271 back into the surrounding text.
1274 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1276 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1277 * \li Action: Moves the cursor out of the current slice, going backwards.
1278 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1281 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1283 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1284 * \li Action: Moves the cursor out of the current slice, going right.
1285 * \li Notion: See also #LFUN_FINISHED_FORWARD
1288 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1290 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1291 * \li Action: Moves the cursor out of the current slice, going left.
1292 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1295 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1297 { LFUN_LANGUAGE, "language", Noop, Edit },
1300 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1301 * \li Action: Goto a label.
1302 * \li Syntax: label-goto [<LABEL>]
1303 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1304 is on cursor position, Bookmark 0 is saved and
1305 cursor moves to the position of referenced label.
1306 * \li Origin: Ale, 6 Aug 1997
1309 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1310 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1312 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1313 * \li Action: Go to the next label or cross-reference.
1314 * \li Syntax: reference-next
1315 * \li Origin: Dekel, 14 Jan 2001
1318 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1321 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1322 * \li Action: Goto a bookmark.
1323 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1324 if necessary. Note that bookmarsk are saved per-session, not
1326 * \li Syntax: bookmark-goto <NUMBER>
1327 * \li Params: <NUMBER>: the number of the bookmark to restore.
1328 * \li Origin: Dekel, 27 January 2001
1331 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1333 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1334 * \li Action: Save a bookmark.
1335 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1336 must be between 1 and 9, inclusive. Note that bookmarks are
1337 saved per-session, not per file.
1338 * \li Syntax: bookmark-save <NUMBER>
1339 * \li Params: <NUMBER>: the number of the bookmark to save.
1340 * \li Origin: Dekel, 27 January 2001
1343 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1345 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1346 * \li Action: Clears the list of saved bookmarks.
1347 * \li Syntax: bookmark-clear
1348 * \li Origin: bpeng, 31 October 2006
1351 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1354 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1355 * \li Action: Open the given help file according to the language setting.
1356 * \li Syntax: help-open <FILE>[.lyx]
1357 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1358 * \li Author: Jug, 27 Jun 1999
1361 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1363 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1364 * \li Action: Terminates the current LyX instance.
1365 * \li Notion: Terminates the current LyX instance, asking whether to save
1366 modified documents, etc.
1367 * \li Syntax: lyx-quit
1370 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1372 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1373 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1374 * \li Notion: Skiping "auto" when allowauto is false.
1375 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1376 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1377 minibuffer|review|view/update|math_panels
1378 * \li Origin: Edwin, 21 May 2007
1381 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1383 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1384 * \li Action: Opens the menu given by its name.
1385 * \li Syntax: menu-open <NAME>
1386 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1389 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1391 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1392 * \li Action: Various UI visibility-toggling actions.
1393 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1394 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1395 menubar : Toggle visibility of the menubar.\n
1396 scrollbar : Toggle visibility of the scrollbar.\n
1397 frame : Toggle visibility of the frames around editing window.\n
1398 fullscreen : Toggle fullscreen mode. This also covers calling the
1399 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1400 custom tweaks of the toolbars should be used.
1401 * \li Origin: ps, 9 Feb 2007
1404 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1407 * \var lyx::FuncCode lyx::WINDOW_NEW
1408 * \li Action: Creates new empty LyX window.
1409 * \li Notion: Already opened documents from the previous window can be found under View menu.
1410 * \li Syntax: window-new [<GEOMETRY>]
1411 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1412 accepted only on Windows platform.
1413 * \li Origin: Abdel, 21 Oct 2006
1416 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1418 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1419 * \li Action: Closes the current LyX window.
1420 * \li Syntax: window-close
1421 * \li Origin: Abdel, 23 Oct 2006
1424 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1427 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1428 * \li Action: Creates another split view of current buffer.
1429 * \li Notion: All split views act in the same way indpendently.
1430 * \li Syntax: split-view <vertical|horizontal>
1431 * \li Params: horizontal : The work areas are laid out side by side.\n
1432 vertical : The work areas laid out vertically.\n
1433 * \li Origin: abdel, 20 Feb 2008
1436 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1439 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1440 * \li Action: Close the current tab group.
1441 * \li Notion: This only closes the work areas, not the buffer themselves.
1442 The still opened buffers can be visualized in another tab group.
1443 * \li Syntax: close-tab-group
1444 * \li Origin: abdel, 21 Feb 2008
1447 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1448 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1449 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1450 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1451 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1452 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1453 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1455 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1456 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1457 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1458 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1459 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1461 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1462 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1463 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1464 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1466 { LFUN_MESSAGE, "message", NoBuffer, System },
1467 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1468 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1470 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1471 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1472 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1474 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1475 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1476 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1477 * \li Origin: Edmar, 23 Dec 1998
1480 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1481 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1483 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1484 * \li Action: Sets the cursor position based on the editing area coordinates
1485 (similar as clicking on that point with left mouse button).
1486 * \li Syntax: server-set-xy <X> <Y>
1489 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1491 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1492 * \li Action: Returns the coordinates of cursor position in the editing area.
1493 * \li Syntax: server-get-xy
1496 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1499 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1500 * \li Action: Generates the code (literate programming).
1501 * \li Notion: Latex file with extension \literate_extension is generated.
1502 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1503 \build_error_filter to process the compilation error messages. \n
1504 In case you want to process your literate file with a script, or some other program,
1505 just insert in your lyxrc file an entry with:\n
1506 \build_command "my_script my_arguments" \n
1507 The \build_error_filter differs from the \literate_error_filter only in that the
1508 former will identify error messages from your compiler.
1509 * \li Syntax: build-program
1512 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1515 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1516 * \li Action: Saves the current buffer to a temporary file.
1517 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1518 is called automatically by LyX, to "autosave" the current buffer.
1519 * \li Syntax: buffer-auto-save
1522 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1524 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1525 * \li Action: Loads the given child document.
1526 * \li Notion: The current document is treated as a parent.
1527 * \li Syntax: buffer-child-open <FILE>
1528 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1529 * \li Origin: Ale, 28 May 1997
1532 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1534 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1535 * \li Action: Runs chktex for the current document.
1536 * \li Syntax: buffer-chktex
1537 * \li Origin: Asger, 30 Oct 1997
1540 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1542 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1543 * \li Action: Toggles compression of the current document on/off.
1544 * \li Syntax: buffer-toggle-compression
1545 * \li Origin: bpeng, 27 Apr 2006
1548 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1550 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1551 * \li Action: Closes the current buffer.
1552 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1553 if the buffer has been modified.
1554 * \li Syntax: buffer-close
1557 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1559 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1560 * \li Action: Exports the current buffer (document) to the given format.
1561 * \li Syntax: buffer-export <FORMAT>
1562 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1563 can find in Tools->Preferences->File formats->Format.
1564 Usual format you will enter is "pdf2" (pdflatex),
1565 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1566 In case of "custom" you will be asked for a format you
1567 want to start from and for the command that you want to
1568 apply to this format. Internally the control is then passed
1569 to #LFUN_BUFFER_EXPORT_CUSTOM.
1570 * \li Origin: Lgb, 29 Jul 1997
1573 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1575 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1576 * \li Action: Exports the current buffer (document) from the given format using
1577 the given command on it.
1578 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1579 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1580 intermediate file).\n
1581 <COMMAND> this command will be launched on the file. Note that you can
1582 use "$$FName" string to qualify the intermediate file.
1583 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1584 * \li Origin: leeming, 27 Mar 2004
1587 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1589 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1590 * \li Action: Prints the current document.
1591 * \li Notion: Many settings can be given via the preferences dialog.
1592 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1593 * \li Params: <TARGET> is either "printer" or "file".\n
1594 <TARGER-NAME> is either "default" or file name or printer name.\n
1595 <COMMAND> command ensuring the printing job.
1596 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1597 * \li Origin: leeming, 28 Mar 2004
1600 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1602 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1603 * \li Action: Import a given file as a lyx document.
1604 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1605 defined convertors in preferences. Look into File->Import menu to get
1606 an idea of the currently active import formats.
1607 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1608 * \li Origin: Asger, 24 Jul 1998
1611 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1613 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1614 * \li Action: Creates a new buffer (that is, document).
1615 * \li Notion: Implicit path can be set in Preferences dialog.
1616 * \li Syntax: buffer-new [<FILE>]
1617 * \li Params: <FILE>: filename of created file with absolute path.
1620 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1622 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1623 * \li Action: Creates a new buffer (that is, document) from a template.
1624 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1625 Template will be asked for via Open-dialog.
1626 * \li Syntax: buffer-new-template [<FILE>]
1627 * \li Params: <FILE>: filename of created file with absolute path.
1630 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1632 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1633 * \li Action: Reverts opened document.
1634 * \li Syntax: buffer-reload
1635 * \li Origin: Asger, 2 Feb 1997
1638 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1640 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1641 * \li Action: Switch to the given buffer.
1642 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1643 document in different LyX windows.
1644 * \li Syntax: buffer-new-template <BUFFER>
1645 * \li Params: <BUFFER>: already opened document which is to be shown.
1648 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1650 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1651 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1652 * \li Syntax: buffer-toggle-read-only
1653 * \li Origin: Lgb, 27 May 1997
1656 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1658 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1659 * \li Action: Displays current buffer in chosen format.
1660 * \li Notion: Displays the contents of the current buffer in the chosen
1661 format, for example, PDF or DVI. This runs the necessary
1662 converter, calls the defined viewer, and so forth.
1663 * \li Syntax: buffer-view <FORMAT>
1664 * \li Params: <FORMAT>: The format to display, where this is one of the
1665 formats defined (in the current GUI) in the
1666 Tools>Preferences>File Formats dialog.
1669 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1671 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1672 * \li Action: Exports the current document and put the result into the
1673 temporary directory.
1674 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1675 the output will be rewriten - updated. This is useful in case your viewer
1676 is able to detect such changes (e.g. ghostview for postscript).
1677 * \li Syntax: buffer-update <FORMAT>
1678 * \li Params: <FORMAT>: The format to display, where this is one of the
1679 formats defined (in the current GUI) in the
1680 Tools>Preferences>File Formats dialog.
1681 * \li Origin: Dekel, 5 Aug 2000
1684 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1687 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1688 * \li Action: Saves the current buffer.
1689 * \li Notion: Saves the current buffer to disk, using the filename that
1690 is already associated with the buffer, asking for one if
1691 none is yet assigned.
1692 * \li Syntax: buffer-write
1695 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1697 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1698 * \li Action: Rename and save current buffer.
1699 * \li Syntax: buffer-write-as <FILENAME>
1700 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1701 is with respect to the original location of the buffer/file.
1704 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1706 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1707 * \li Action: Save all changed documents.
1708 * \li Syntax: buffer-write-all
1709 * \li Origin: rgh, gpothier 6 Aug 2007
1712 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1714 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1715 * \li Action: Switch to the next opened document.
1716 * \li Notion: Note that this does not necessarily mean next in tabbar
1717 (for full list see View menu).
1718 * \li Syntax: buffer-next
1721 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1723 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1724 * \li Action: Switch to the previous opened document.
1725 * \li Syntax: buffer-previous
1728 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1730 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1731 * \li Action: When run from a child document, this updates (exports) document built
1732 from the master buffer. If a master is not found, it updates the
1734 * \li Syntax: master-buffer-update
1735 * \li Author: Tommaso, 20 Sep 2007
1738 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1740 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1741 * \li Action: When run from a child document, this command shows a preview built
1742 from the master buffer. If a master is not found, it previews the
1744 * \li Syntax: master-buffer-view
1745 * \li Author: Tommaso, 20 Sep 2007
1748 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1750 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1751 * \li Action: Set language of the current document.
1752 * \li Syntax: buffer-language <LANG>
1753 * \li Params: <LANG>: language name. See lib/languages for list.
1754 * \li Author: leeming, 30 Mar 2004
1757 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1759 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1760 * \li Action: Save the current document settings as default.
1761 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1762 * \li Syntax: buffer-save-as-default [<ARGS>]
1763 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1764 you can find in document header of usual .lyx file.
1765 * \li Author: leeming, 30 Mar 2004
1768 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1770 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1771 * \li Action: Apply the given settings to the current document.
1772 * \li Syntax: buffer-params-apply [<ARGS>]
1773 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1774 you can find in document header of usual .lyx file.
1775 * \li Author: leeming, 30 Mar 2004
1778 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1781 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1782 * \li Action: Inserts another LyX file.
1783 * \li Syntax: file-insert [<FILE>]
1784 * \li Params: <FILE>: Filename to be inserted.
1787 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1789 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1790 * \li Action: Inserts plain text file.
1791 * \li Syntax: file-insert-plaintext [<FILE>]
1792 * \li Params: <FILE>: Filename to be inserted.
1793 * \li Origin: CFO-G, 19 Nov 1997
1796 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1798 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1799 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1800 * \li Syntax: file-insert-plaintext-para [<FILE>]
1801 * \li Params: <FILE>: Filename to be inserted.
1802 * \li Origin: Levon, 14 Feb 2001
1805 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1807 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1808 * \li Action: Open LyX document.
1809 * \li Syntax: file-open [<FILE>]
1810 * \li Params: <FILE>: Filename to be opened.
1813 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1816 * \var lyx::FuncCode lyx::LFUN_CALL
1817 * \li Action: Executes a command defined in a .def file.
1818 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1819 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1820 where <NAME> is the name of the new command and <LFUN> is the lfun code
1821 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1822 \\def_file "FileName" allows to include another .def file. \n
1823 This is particularly useful in connection with toolbar buttons:
1824 Since the name of the button image for this lfun is
1825 lib/images/commands/<NAME>.png this is the way to assign an image
1826 to a complex command-sequence.
1827 * \li Syntax: call <NAME>
1828 * \li Params: <NAME>: Name of the command that must be called.
1829 * \li Origin: broider, 2 Oct 2007
1832 { LFUN_CALL, "call", NoBuffer, System },
1834 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1835 * \li Action: Simulate halting Meta key (Alt key on PCs).
1836 * \li Notion: Used for buffer editation not for GUI control.
1837 * \li Syntax: meta-prefix
1840 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1842 * \var lyx::FuncCode lyx::LFUN_CANCEL
1843 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1844 * \li Syntax: cancel
1847 { LFUN_CANCEL, "cancel", NoBuffer, System },
1850 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1851 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1852 * \li Notion: Usually bound to M-x shortcut.
1853 * \li Syntax: command-execute
1856 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1857 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1859 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1860 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1861 * \li Syntax: command-sequence <CMDS>
1862 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1863 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1864 * \li Origin: Andre', 11 Nov 1999
1867 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1870 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1871 * \li Action: Save user preferences.
1872 * \li Syntax: preferences-save
1873 * \li Origin: Lgb, 27 Nov 1999
1876 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1878 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1879 * \li Action: Reconfigure the automatic settings.
1880 * \li Syntax: reconfigure
1881 * \li Origin: Asger, 14 Feb 1997
1884 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1886 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1887 * \li Action: Apply the given settings to user preferences.
1888 * \li Syntax: lyxrc-apply <SETTINGS>
1889 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1890 to get an idea which commands to use and their syntax.
1891 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1894 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1896 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1897 * \li Action: Determine whether keep cursor inside the editing window regardless
1898 the scrollbar movement.
1899 * \li Syntax: toggle-cursor-follows-scrollbar
1900 * \li Origin: ARRae, 2 Dec 1997
1903 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1905 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1906 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1907 * \li Notion: A new color entry is created if the color is unknown.
1908 Color names can be stored as a part of user settings.
1909 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1910 * \li Origin: SLior, 11 Jun 2000
1913 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1915 * \var lyx::FuncCode lyx::LFUN_STATISTICS
1916 * \li Action: Count the statistics (number of words and characters)
1917 in the document or in the given selection.
1918 * \li Notion: Note that this function gives the number of words/chars written,
1919 not the number of characters which will be typeset.
1920 * \li Syntax: statistics
1921 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1924 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1926 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1927 * \li Action: Show the inline completion at the cursor position.
1928 * \li Syntax: completion-inline
1929 * \li Origin: sts, Feb 19 2008
1932 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1934 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1935 * \li Action: Show the completion popup at the cursor position.
1936 * \li Syntax: completion-popup
1937 * \li Origin: sts, Feb 19 2008
1940 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1942 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1943 * \li Action: Try to complete the word or command at the cursor position.
1944 * \li Syntax: completion-complete
1945 * \li Origin: sts, Feb 19 2008
1948 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1950 { LFUN_NOACTION, "", Noop, Hidden }
1951 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1954 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1955 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1962 LyXAction::LyXAction()
1968 // Returns an action tag from a string.
1969 FuncRequest LyXAction::lookupFunc(string const & func) const
1971 string const func2 = trim(func);
1973 if (func2.empty()) {
1974 return FuncRequest(LFUN_NOACTION);
1978 string const arg = split(func2, cmd, ' ');
1980 func_map::const_iterator fit = lyx_func_map.find(cmd);
1982 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1986 string const LyXAction::getActionName(FuncCode action) const
1988 info_map::const_iterator const it = lyx_info_map.find(action);
1989 return it != lyx_info_map.end() ? it->second.name : string();
1993 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1995 info_map::const_iterator const it = lyx_info_map.find(action);
1996 return it != lyx_info_map.end() ? it->second.type : Hidden;
2000 bool LyXAction::funcHasFlag(FuncCode action,
2001 LyXAction::func_attrib flag) const
2003 info_map::const_iterator ici = lyx_info_map.find(action);
2005 if (ici == lyx_info_map.end()) {
2006 LYXERR0("action: " << action << " is not known.");
2007 LASSERT(false, /**/);
2010 return ici->second.attrib & flag;
2014 LyXAction::const_func_iterator LyXAction::func_begin() const
2016 return lyx_func_map.begin();
2020 LyXAction::const_func_iterator LyXAction::func_end() const
2022 return lyx_func_map.end();