reorder.
[lyx.git] / src / LyXAction.cpp
blob01095ea3538eafde6eee9733d47e6d9e5ee7b067
1 /*!
2 * \file LyXAction.cpp
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
8 * \author John Levon
9 * \author André Pönitz
10 * \author Pavel Sanda
12 * Full author contact details are available in file CREDITS.
15 #include <config.h>
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
26 #include <iostream>
28 using namespace std;
29 using namespace lyx::support;
31 namespace lyx {
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
50 /* LFUN documentation
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
62 /*!
63 * \var lyx::FuncCode lyx::LFUN_
64 * \li Action:
65 * \li Notion:
66 * \li Syntax:
67 * \li Params:
68 * \li Sample:
69 * \li Origin:
70 * \endvar
73 LyXAction lyxaction;
76 void LyXAction::newFunc(FuncCode action, string const & name,
77 unsigned int attrib, LyXAction::func_type type)
79 lyx_func_map[name] = action;
80 FuncInfo tmpinfo;
81 tmpinfo.name = name;
82 tmpinfo.attrib = attrib;
83 tmpinfo.type = type;
84 lyx_info_map[action] = tmpinfo;
88 // Needed for LFUNs documentation to be accepted, since doxygen won't take
89 // \var inside functions.
90 #ifndef DOXYGEN_SHOULD_SKIP_THIS
91 void LyXAction::init()
93 // This function was changed to use the array below in initalization
94 // instead of calling newFunc numerous times because of compilation
95 // times. Since the array is not static we get back the memory it
96 // occupies after the init is completed. It compiles several
97 // magnitudes faster.
99 static bool init;
100 if (init) return;
102 struct ev_item {
103 FuncCode action;
104 char const * name;
105 unsigned int attrib;
106 func_type type;
109 ev_item const items[] = {
110 #endif
112 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
113 * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
114 to the next character typed.
115 * \li Syntax: accent-acute
116 * \endvar
118 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
120 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
121 * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
122 to the next character typed.
123 * \li Syntax: accent-breve
124 * \endvar
126 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
128 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
129 * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
130 to the next character typed.
131 * \li Syntax: accent-caron
132 * \endvar
134 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
136 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
137 * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
138 to the next character typed.
139 * \li Syntax: accent-cedilla
140 * \endvar
142 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
144 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
145 * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
146 to the next character typed.
147 * \li Syntax: accent-circle
148 * \endvar
150 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
152 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
153 * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
154 to the next character typed.
155 * \li Syntax: accent-circumflex
156 * \endvar
158 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
160 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
161 * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
162 to the next character typed.
163 * \li Syntax: accent-dot
164 * \endvar
166 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
168 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
169 * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
170 to the next character typed.
171 * \li Syntax: accent-grave
172 * \endvar
174 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
176 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
177 * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
178 to the next character typed.
179 * \li Syntax: accent-grave
180 * \endvar
182 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
184 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
185 * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
186 to the next character typed.
187 * \li Syntax: accent-macron
188 * \endvar
190 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
192 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
193 * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
194 to the next character typed.
195 * \li Syntax: accent-ogonek
196 * \endvar
198 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
200 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
201 * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
202 over the next two character typed.
203 * \li Notion: The following char will finish the tie.
204 * \li Syntax: accent-tie
205 * \endvar
207 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
209 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
210 * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
211 over the next character typed.
212 * \li Syntax: accent-tilde
213 * \endvar
215 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
217 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
218 * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
219 over the next character typed.
220 * \li Syntax: accent-umlaut
221 * \endvar
223 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
225 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
226 * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
227 under the next character typed.
228 * \li Syntax: accent-underbar
229 * \endvar
231 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
233 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
234 * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
235 under the next character typed.
236 * \li Syntax: accent-underdot
237 * \endvar
239 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
242 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
243 * \li Action: Inserts a caption inset.
244 * \li Syntax: caption-insert
245 * \li Origin: Lgb, 18 Jul 2000
246 * \endvar
248 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
250 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
251 * \li Action: Inserts the current date.
252 * \li Syntax: date-insert [<ARG>]
253 * \li Params: <ARG>: Format of date. The default value (%x) can be set
254 in Preferences->Date format. For possible formats
255 see manual page of strftime function.
256 * \li Origin: jdblair, 31 Jan 2000
257 * \endvar
259 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
261 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
262 * \li Action: Inserts a footnote inset.
263 * \li Syntax: footnote-insert
264 * \li Origin: Jug, 7 Mar 2000
265 * \endvar
267 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
269 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
270 * \li Action: Inserts an ERT inset.
271 * \li Syntax: ert-insert
272 * \li Origin: Jug, 18 Feb 2000
273 * \endvar
275 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
277 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
278 * \li Action: Inserts a float inset.
279 * \li Syntax: float-insert <TYPE>
280 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
281 "algorithm", "table", "figure" parameters can be given.
282 * \li Origin: Lgb, 27 Jun 2000
283 * \endvar
285 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
287 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
288 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
289 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
290 * \li Syntax: float-wide-insert <TYPE>
291 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
292 "algorithm", "table", "figure" parameters can be given.
293 * \li Origin: Lgb, 31 Oct 2001
294 * \endvar
296 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
298 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
299 * \li Action: Inserts the list of floats in the document.
300 * \li Syntax: float-list-insert <TYPE>
301 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
302 "algorithm", "table", "figure" parameters can be given.
303 * \li Origin: Lgb, 3 May 2001
304 * \endvar
306 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
308 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
309 * \li Action: Inserts floats wrapped by the text around.
310 * \li Syntax: wrap-insert <TYPE>
311 * \li Params: <TYPE>: table|figure
312 * \li Origin: Dekel, 7 Apr 2002
313 * \endvar
315 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
317 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
318 * \li Action: Inserts an optional-argument (short title) inset.
319 * \li Syntax: optional-insert
320 * \li Origin: vermeer, 12 Aug 2002
321 * \endvar
323 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
325 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
326 * \li Action: Inserts a horizontal line.
327 * \li Syntax: line-insert
328 * \li Origin: Andre, Oct 27 2003
329 * \endvar
331 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
333 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
334 * \li Action: Inserts a new page.
335 * \li Syntax: newpage-insert <ARG>
336 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
337 * \li Origin: uwestoehr, 24 Nov 2007
338 * \endvar
340 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
342 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
343 * \li Action: Inserts a marginal note.
344 * \li Syntax: marginalnote-insert
345 * \li Origin: Lgb, 26 Jun 2000
346 * \endvar
348 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
350 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
351 * \li Action: Inserts a single unicode character.
352 * \li Syntax: unicode-insert <CHAR>
353 * \li Params: <CHAR>: The character to insert, given as its code
354 point, in hexadecimal.
355 * \li Sample: unicode-insert 0x0100
356 * \li Origin: Lgb, 22 Oct 2006
357 * \endvar
359 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
361 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
362 * \li Action: Inserts a new listings inset.
363 * \li Syntax: listing-insert
364 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
365 * \endvar
367 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
369 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
370 * \li Action: Insert a tab into a listings inset.
371 * \li Notion: It also works on a selection.
372 * \li Syntax: tab-insert
373 * \li Origin: vfr, Sep 30 2008
374 * \endvar
376 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
378 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
379 * \li Action: Delete a tab or up to an equivalent amount of spaces from
380 a listings inset.
381 * \li Notion: It also works on a selection - it removes a tab or spaces from the
382 beginning of each line spanned by the selection. This is useful if
383 you want to indent/unindent multiple lines in one action.
384 * \li Syntax: tab-delete
385 * \li Origin: vfr, Sep 30 2008
386 * \endvar
388 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
390 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
391 * \li Action: Inserts quotes according to the type and quote-language preference.
392 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
393 are distinguished.
394 * \li Syntax: quote-insert [<TYPE>]
395 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
396 * \endvar
398 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
400 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
401 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
402 information in a non-editable boxed InsetText.
403 * \li Notion: Apart from lfun arguments you can use the following method: \n
404 1. input the type and argument of this inset, e.g. "menu paste", in
405 the work area.\n
406 2. select the text and run info-insert lfun.
407 * \li Syntax: info-insert <TYPE> <ARG>
408 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
409 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
410 description.
411 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
412 * \li Origin: bpeng, 7 Oct 2007
413 * \endvar
415 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
417 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
418 * \li Action: Inserts branch inset.
419 * \li Syntax: branch-insert <BRANCH-NAME>
420 * \li Origin: vermeer, 17 Aug 2003
421 * \endvar
423 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
425 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
426 * \li Action: Inserts Box inset.
427 * \li Syntax: box-insert [<TYPE>]
428 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
429 Framed is the default one.
430 * \li Origin: vermeer, 7 Oct 2003
431 * \endvar
433 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
435 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
436 * \li Action: Inserts CharStyle, Custom inset or XML short element.
437 * \li Notion: Look into the Customization manual for more information about
438 these elements.\n
439 To make this command enabled the layout file for the document
440 class you're using has to load the character styles. There are
441 a few contained in the Logical Markup module. You can also of
442 course create some yourself. \n
443 For dissolving the element see #LFUN_INSET_DISSOLVE.
444 * \li Syntax: flex-insert <TYPE:Name>
445 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
446 Identifies whether this is a Character Style, a
447 Custom Inset or an XML Element, and which dynamical
448 sub-menu this flex inset is in on the LyX menu tree.
449 If Standard (currently unused): none of these.\n
450 Name: This name must be defined either in your layout file
451 or imported by some module. The definition is
452 InsetLayout <TYPE:Name>
453 * \li Sample: flex-insert CharStyle:Code
454 * \endvar
456 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
458 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
459 * \li Action: Inserts the given string (accordingly to the correct keymap).
460 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
461 settings "auto_region_delete".
462 * \li Syntax: self-insert <STRING>
463 * \endvar
465 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
467 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
468 * \li Action: Inserts one of horizontal space insets.
469 * \li Syntax: space-insert <NAME> [<LEN>]
470 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
471 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
472 hspace* \n
473 <LEN>: length for custom spaces (hspace, hspace* for protected)
474 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
475 * \endvar
477 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
479 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
480 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
481 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
482 * \li Syntax: href-insert [<TARGET>]
483 * \li Origin: CFO-G, 21 Nov 1997
484 * \endvar
486 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
488 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
489 * \li Action: Inserts various characters into the document.
490 * \li Syntax: specialchar-insert <CHAR>
491 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
492 end-of-sentence, menu-separator.
493 * \li Origin: JSpitzm, 6 Dec 2007
494 * \endvar
496 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
498 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
499 * \li Action: Inserts table of contents.
500 * \li Syntax: toc-insert
501 * \li Origin: Lgb, 27 May 97
502 * \endvar
504 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_APPENDIX
507 * \li Action: Start (or remove) Appendix on the given cursor position.
508 * \li Syntax: appendix
509 * \li Origin: ettrich, 5 May 1998
510 * \endvar
512 { LFUN_APPENDIX, "appendix", Noop, Edit },
515 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
516 * \li Action: Inserts Index entry.
517 * \li Notion: It automatically takes the word on the cursor position.
518 * \li Syntax: index-insert [<TYPE:Name>]
519 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
520 with an empty argument, the default index is selected.
521 * \li Origin: leeming, 3 Aug 2000
522 * \endvar
524 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
526 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
527 * \li Action: Inserts list of Index entries on a new page.
528 * \li Syntax: index-print [<TYPE:Name>]
529 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
530 with an empty argument, the default index is selected.
531 * \li Origin: Lgb, 27 Feb 1997
532 * \endvar
534 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
537 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
538 * \li Action: Inserts Nomenclature entry.
539 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
540 * \li Syntax: nomencl-insert [<SYMBOL>]
541 * \li Origin: Ugras, 4 Nov 2006
542 * \endvar
544 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
547 * \li Action: Inserts list of Nomenclature entries.
548 * \li Syntax: nomenclature-print
549 * \li Origin: Ugras, 4 Nov 2006
550 * \endvar
552 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
556 * \li Action: Inserts Note on the current cursor postion,
557 move selection inside the inset.
558 * \li Syntax: note-insert [<TYPE>]
559 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
560 * \endvar
562 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
564 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
565 * \li Action: Moves the cursor to the begining of next Note inset.
566 * \li Syntax: note-next
567 * \endvar
569 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
571 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
572 * \li Action: Changes all Note insets of a particular type (source)
573 to a different type (target) fot the current document.
574 * \li Syntax: notes-mutate <SOURCE> <TARGET>
575 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
576 * \li Origin: sanda, 18 Jun 2008
577 * \endvar
579 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
581 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
582 * \li Action: Inserts phantom on the current cursor postion,
583 move selection inside the inset.
584 * \li Syntax: phantom-insert [<TYPE>]
585 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
586 * \li Origin: uwestoehr, 30 Jan 2009
587 * \endvar
589 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
591 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
592 * \li Action: Inserts a line break or new line.
593 * \li Syntax: newline-insert [<ARG>]
594 * \li Params: <ARG>: <newline|linebreak> default: newline
595 * \li Origin: JSpitzm, 25 Mar 2008
596 * \endvar
598 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
600 * \var lyx::FuncCode lyx::LFUN_ESCAPE
601 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
602 * \li Syntax: escape
603 * \li Origin: Lgb, 17 May 2001
604 * \endvar
606 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
608 * \var lyx::FuncCode lyx::LFUN_DOWN
609 * \li Action: Moves the cursor one line in downward direction.
610 * \li Syntax: down
611 * \endvar
613 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
615 * \var lyx::FuncCode lyx::LFUN_UP
616 * \li Action: Moves the cursor one line in upward direction.
617 * \li Syntax: up
618 * \endvar
620 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
622 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
623 * \li Action: Moves the cursor one line in downward direction adding the current
624 position to the selection.
625 * \li Syntax: down-select
626 * \endvar
628 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
630 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
631 * \li Action: Moves the cursor one line in upward direction adding the current
632 position to the selection.
633 * \li Syntax: up-select
634 * \endvar
636 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
638 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
639 * \li Action: Moves the cursor one page in downward direction.
640 * \li Syntax: screen-down
641 * \endvar
643 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
645 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
646 * \li Action: Moves the cursor one page in upward direction.
647 * \li Syntax: screen-up
648 * \endvar
650 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
652 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
653 * \li Action: Moves the cursor one screen in downward direction adding the current
654 position to the selection.
655 * \li Syntax: screen-down-select
656 * \endvar
658 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
660 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
661 * \li Action: Moves the cursor one page in upward direction adding the current
662 position to the selection.
663 * \li Syntax: screen-up-select
664 * \endvar
666 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
668 * \var lyx::FuncCode lyx::LFUN_SCROLL
669 * \li Action: Scroll the buffer view.
670 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
671 * \li Syntax: scroll <TYPE> <QUANTITY>
672 * \li Params: <TYPE>: line|page\n
673 <QUANTITY>: up|down|<number>
674 * \li Origin: Abdel, Dec 27 2007
675 * \endvar
677 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
679 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
680 * \li Action: Recenters the screen on the current cursor position.
681 * \li Syntax: screen-recenter
682 * \endvar
684 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
687 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
688 * \li Action: Repositions the screen such that the cursor is visible.
689 * \li Syntax: screen-show-cursor
690 * \li Origin: vfr, 25 Mar 2009
691 * \endvar
693 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
696 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
697 * \li Action: Moves the cursor one position logically backwards.
698 * \li Notion: This is not the action which should be bound to the arrow keys,
699 because backwards may be left or right, depending on the
700 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
701 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
702 * \li Syntax: char-backward
703 * \endvar
705 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
707 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
708 * \li Action: Moves the cursor one position logically backwards, adding
709 traversed position to the selection.
710 * \li Notion: See also #LFUN_CHAR_BACKWARD.
711 * \li Syntax: char-backward-select
712 * \endvar
714 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
716 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
717 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
718 * \li Syntax: char-delete-backward
719 * \endvar
721 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
723 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
724 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
725 * \li Syntax: char-delete-forward
726 * \endvar
728 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
730 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
731 * \li Action: Moves the cursor one position logically forward.
732 * \li Notion: This is not the action which should be bound to the arrow keys,
733 because forward may be left or right, depending on the language.
734 The arrow keys should be bound to #LFUN_CHAR_LEFT or
735 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
736 * \li Syntax: char-forward
737 * \endvar
739 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
741 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
742 * \li Action: Moves the cursor one position logically forward, adding
743 traversed position to the selection.
744 * \li Notion: See also #LFUN_CHAR_FORWARD.
745 * \li Syntax: char-forward-select
746 * \endvar
748 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
750 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
751 * \li Action: Moves the cursor one position "to the left".
752 * \li Notion: This is the action which should be taken when the "left" key
753 is pressed. Generally, it moves the cursor one position to the
754 left. However, in Bidi text this become slightly more
755 complicated, and there are different modes of cursor movement.
756 In "visual mode", this moves left, plain and simple. In "logical
757 mode", movement is logically forward in RTL paragraphs, and
758 logically backwards in LTR paragraphs.
759 * \li Syntax: char-left
760 * \endvar
762 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
764 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
765 * \li Action: Moves the cursor one position "to the left", adding
766 traversed position to the selection.
767 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
768 * \li Syntax: char-left-select
769 * \endvar
771 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
773 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
774 * \li Action: Moves the cursor one position "to the right".
775 * \li Notion: This is the action which should be taken when the "right" key
776 is pressed. Generally, it moves the cursor one position to the
777 right. However, in Bidi text this become slightly more
778 complicated, and there are different modes of cursor movement.
779 In "visual mode", this moves right, plain and simple. In "logical
780 mode", movement is logically forward in LTR paragraphs, and
781 logically backwards in RTL paragraphs.
782 * \li Syntax: char-right
783 * \endvar
785 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
787 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
788 * \li Action: Moves the cursor one position "to the right", adding
789 traversed position to the selection.
790 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
791 * \li Syntax: char-right-select
792 * \endvar
794 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
797 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
798 * \li Action: Moves the cursor to the logically previous beginning of a word.
799 * \li Notion: This is not the action which should be bound to the arrow keys,
800 because backwards may be left or right, depending on the
801 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
802 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
803 * \li Syntax: word-backward
804 * \endvar
806 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
808 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
809 * \li Action: Moves the cursor to the logically previous beginning of a word,
810 adding the logically traversed text to the selection.
811 * \li Notion: See also #LFUN_WORD_BACKWARD.
812 * \li Syntax: word-backward-select
813 * \endvar
815 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
817 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
818 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
819 * \li Syntax: word-delete-backward
820 * \endvar
822 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
824 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
825 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
826 * \li Syntax: word-delete-forward
827 * \endvar
829 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
831 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
832 * \li Action: Search for a given string in forward direction.
833 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
834 * \li Syntax: word-find-forward [<STRING>]
835 * \li Origin: Etienne, 16 Feb 1998
836 * \endvar
838 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
840 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
841 * \li Action: Search for a given string in backward direction.
842 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
843 * \li Syntax: word-find-backward [<STRING>]
844 * \li Origin: Etienne, 20 Feb 1998
845 * \endvar
847 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
849 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
850 * \li Action: Search for next occurence of a string.
851 * \li Syntax: word-find [<DATA>]
852 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
853 If no parameter is given, search with last find-dialog
854 data is used for search (i.e. find-next).
855 * \li Origin: Andre, Jan 7 2004
856 * \endvar
858 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
860 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
861 * \li Action: Replace a string in the document.
862 * \li Syntax: word-replace [<DATA>]
863 * \li Params: <DATA>: data is of the form
864 "<search> \n
865 <replace> \n
866 <casesensitive> <matchword> <all> <forward>"
867 * \li Origin: Andre, Jan 7 2004
868 * \endvar
870 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
872 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
873 * \li Action: Search for next occurence of a pattern.
874 * \li Syntax: word-findadv [<DATA>]
875 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
876 If no parameter is given, search with last find-dialog
877 data is used for search (i.e. find-next).
878 * \li Origin: Tommaso, Nov 15 2007
879 * \endvar
881 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly, Edit },
883 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
884 * \li Action: Moves the cursor to the logically next beginning of a word.
885 * \li Notion: This is not the action which should be bound to the arrow keys,
886 because forward may be left or right, depending on the language.
887 The arrow keys should be bound to #LFUN_WORD_LEFT or
888 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
889 * \li Syntax: word-forward
890 * \endvar
892 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
894 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
895 * \li Action: Moves the cursor to the logically next beginning of a word,
896 adding the logically traversed text to the selection.
897 * \li Notion: See also #LFUN_WORD_FORWARD.
898 * \li Syntax: word-forward-select
899 * \endvar
901 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
903 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
904 * \li Action: Moves the cursor to the next beginning of a word "on the left".
905 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
906 "left" key is pressed. Generally, it moves the cursor to the
907 next beginning of a word on the left. However, in Bidi text this
908 become slightly more complicated, and there are different modes
909 of cursor movement. In "visual mode", this moves left, plain and
910 simple. In "logical mode", movement is logically forward in RTL
911 paragraphs, and logically backwards in LTR paragraphs.
912 * \li Syntax: word-left
913 * \li Origin: dov, 28 Oct 2007
914 * \endvar
916 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
918 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
919 * \li Action: Moves the cursor to the next beginning of a word "on the left",
920 adding *logically* traversed text to the selection.
921 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
922 * \li Syntax: word-left-select
923 * \li Origin: dov, 28 Oct 2007
924 * \endvar
926 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
928 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
929 * \li Action: Moves the cursor to the next beginning of a word "on the right".
930 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
931 "right" key is pressed. Generally, it moves the cursor to the
932 next beginning of a word on the right. However, in Bidi text
933 this become slightly more complicated, and there are different
934 modes of cursor movement. In "visual mode", this moves right,
935 plain and simple. In "logical mode", movement is logically
936 forward in LTR paragraphs, and logically backwards in RTL
937 paragraphs.
938 * \li Syntax: word-right
939 * \li Origin: dov, 28 Oct 2007
940 * \endvar
942 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
944 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
945 * \li Action: Moves the cursor to the next beginning of a word "on the right",
946 adding *logically* traversed text to the selection.
947 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
948 * \li Syntax: word-right-select
949 * \li Origin: dov, 28 Oct 2007
950 * \endvar
952 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
954 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
955 * \li Action: Puts the word where the cursor stands into the selection.
956 * \li Syntax: word-select
957 * \li Origin: Andre, 11 Sep 2002
958 * \endvar
960 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
962 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
963 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
964 or the letter on the cursor position.
965 * \li Syntax: word-capitalize
966 * \endvar
968 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
970 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
971 * \li Action: Change the words in the selection or from the cursor position
972 to the end of word to the upper case.
973 * \li Syntax: word-upcase
974 * \endvar
976 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
978 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
979 * \li Action: Change the words in the selection or from the cursor position
980 to the end of word to the lower case.
981 * \li Syntax: word-lowcase
982 * \endvar
984 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
986 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
987 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
988 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
989 * \li Params: <STRING>: word to look up
990 <LANG>: language (see file languages)
991 * \li Origin: Levon, 20 Jul 2001
992 * \endvar
994 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
996 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
997 * \li Action: Move the cursor to the beginning of the document.
998 * \li Syntax: buffer-begin
999 * \endvar
1001 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1003 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1004 * \li Action: Move the cursor to the beginning of the document adding the
1005 traversed text to the selection.
1006 * \li Syntax: buffer-begin-select
1007 * \endvar
1009 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1011 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1012 * \li Action: Move the cursor to the end of the document.
1013 * \li Syntax: buffer-end
1014 * \endvar
1016 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1018 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1019 * \li Action: Move the cursor to the end of the document adding the
1020 traversed text to the selection.
1021 * \li Syntax: buffer-end-select
1022 * \endvar
1024 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1027 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1028 * \li Action: Move the cursor to the beginning of the current inset
1029 if it is not already there, or at the beginning of the
1030 enclosing inset otherwise
1031 * \li Syntax: inset-begin
1032 * \li Origin: lasgouttes, 16 Mar 2009
1033 * \endvar
1035 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1037 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1038 * \li Action: Move the cursor to the beginning of the current inset
1039 if it is not already there, or at the beginning of the
1040 enclosing inset otherwise (adding the
1041 traversed text to the selection).
1042 * \li Syntax: inset-begin-select
1043 * \li Origin: lasgouttes, 16 Mar 2009
1044 * \endvar
1046 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1048 * \var lyx::FuncCode lyx::LFUN_INSET_END
1049 * \li Action: Move the cursor to the end of the current inset
1050 if it is not already there, or at the end of the
1051 enclosing inset otherwise
1052 * \li Syntax: inset-end
1053 * \li Origin: lasgouttes, 16 Mar 2009
1054 * \endvar
1056 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1058 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1059 * \li Action: Move the cursor to the end of the current inset
1060 if it is not already there, or at the end of the
1061 enclosing inset otherwise (adding the
1062 traversed text to the selection).
1063 * \li Syntax: inset-end-select
1064 * \li Origin: lasgouttes, 16 Mar 2009
1065 * \endvar
1067 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1070 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1071 * \li Action: Move the cursor to the begining of the (screen) line.
1072 * \li Syntax: line-begin
1073 * \endvar
1075 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1077 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1078 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1079 traversed text to the selection.
1080 * \li Syntax: line-begin-select
1081 * \endvar
1083 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1085 * \var lyx::FuncCode lyx::LFUN_LINE_END
1086 * \li Action: Move the cursor to the end of the (screen) line.
1087 * \li Syntax: line-end
1088 * \endvar
1090 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1092 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1093 * \li Action: Move the cursor to the end of the (screen) line adding the
1094 traversed text to the selection.
1095 * \li Syntax: line-end-select
1096 * \endvar
1098 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1101 * \li Action: Deletes the letters to the end of the (screen) line or
1102 deletes the selection.
1103 * \li Syntax: line-delete-forward
1104 * \endvar
1106 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1108 * \var lyx::FuncCode lyx::LFUN_COPY
1109 * \li Action: Copies to the clipboard the last edit.
1110 * \li Syntax: copy
1111 * \endvar
1113 { LFUN_COPY, "copy", ReadOnly, Edit },
1115 * \var lyx::FuncCode lyx::LFUN_CUT
1116 * \li Action: Cuts to the clipboard.
1117 * \li Syntax: cut
1118 * \endvar
1120 { LFUN_CUT, "cut", Noop, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_PASTE
1123 * \li Action: Pastes material (text or picture) from the active clipboard.
1124 * \li Syntax: paste [<TYPE>|<NUM>]
1125 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1126 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1127 * \endvar
1129 { LFUN_PASTE, "paste", Noop, Edit },
1131 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1132 * \li Action: Pastes text from the active clipboard.
1133 * \li Syntax: clipboard-paste [<ARG>]
1134 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1135 * \li Origin: baum, 10 Jul 2006
1136 * \endvar
1138 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1140 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1141 * \li Action: Pastes the currently text selected text.
1142 * \li Notion: Primary selection mechanism is linux-only thing.
1143 * \li Syntax: primary-selection-paste [<ARG>]
1144 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1145 * \endvar
1147 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1149 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1150 * \li Action: Pastes the text in permanent selection.
1151 * \li Syntax: selection-paste
1152 * \endvar
1154 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1156 * \var lyx::FuncCode lyx::LFUN_UNDO
1157 * \li Action: Undoes the last edit.
1158 * \li Syntax: undo
1159 * \endvar
1161 { LFUN_UNDO, "undo", Noop, Edit },
1163 * \var lyx::FuncCode lyx::LFUN_REDO
1164 * \li Action: Redoes the last thing undone.
1165 * \li Syntax: redo
1166 * \endvar
1168 { LFUN_REDO, "redo", Noop, Edit },
1170 * \var lyx::FuncCode lyx::LFUN_REPEAT
1171 * \li Action: Repeat the given command.
1172 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1173 * \li Origin: Andre, 27 Oct 2003
1174 * \endvar
1176 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1178 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1179 * \li Action: Transposes the character at the cursor with the one before it.
1180 * \li Syntax: chars-transpose
1181 * \li Origin: Lgb, 25 Apr 2001
1182 * \endvar
1184 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1187 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1188 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1189 inside lists.
1190 * \li Syntax: depth-decrement
1191 * \endvar
1193 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1196 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1197 inside lists.
1198 * \li Syntax: depth-increment
1199 * \endvar
1201 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1205 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1206 * \li Syntax: font-bold
1207 * \endvar
1209 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1212 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1213 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1214 * \li Syntax: font-boldsymbol
1215 * \endvar
1217 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1219 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1220 * \li Action: Toggles the typewriter family font (selection-wise).
1221 * \li Syntax: font-typewriter
1222 * \endvar
1224 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1226 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1227 * \li Action: Toggles underline in the font (selection-wise).
1228 * \li Syntax: font-underline
1229 * \endvar
1231 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1233 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1234 * \li Action: Toggles double underline in the font (selection-wise).
1235 * \li Syntax: font-underunderline
1236 * \li Origin: sanda, 5 May 2009
1237 * \endvar
1239 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1241 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1242 * \li Action: Toggles wavy underline in the font (selection-wise).
1243 * \li Syntax: font-underwave
1244 * \li Origin: sanda, 5 May 2009
1245 * \endvar
1247 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1249 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1250 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1251 * \li Syntax: font-strikeout
1252 * \li Origin: sanda, 3 May 2009
1253 * \endvar
1255 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1257 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1258 * \li Action: Toggles the emphasis font style (selection-wise).
1259 * \li Syntax: font-emph
1260 * \endvar
1262 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1264 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1265 * \li Action: Toggles Noun text style font (selection-wise).
1266 * \li Syntax: font-noun
1267 * \endvar
1269 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1271 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1272 * \li Action: Toggles Roman family font (selection-wise).
1273 * \li Syntax: font-roman
1274 * \endvar
1276 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1278 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1279 * \li Action: Toggles Sans Serif family font (selection-wise).
1280 * \li Syntax: font-sans
1281 * \endvar
1283 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1285 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1286 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1287 * \li Syntax: font-frak
1288 * \li Origin: vermeer, 10 Jan 2002
1289 * \endvar
1291 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1293 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1294 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1295 * \li Syntax: font-ital
1296 * \li Origin: vermeer, 10 Jan 2002
1297 * \endvar
1299 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1301 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1302 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1303 * \li Syntax: font-default
1304 * \endvar
1306 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1308 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1309 * \li Action: Sets font size according to lyx format string.
1310 * \li Syntax: font-size <SIZE>
1311 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1312 largest|huge|giant|increase|decrease|default
1313 * \endvar
1315 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1317 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1318 * \li Action: Toggle user-defined (=last-time used) text style.
1319 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1320 automatically trigerred when using Text Style dialog.
1321 * \li Syntax: textstyle-apply
1322 * \li Origin: leeming, 12 Mar 2003
1323 * \endvar
1325 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1327 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1328 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1329 * \li Syntax: textstyle-update <FONT_INFO>
1330 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1331 size, emph, noun, underbar, number, color, language,
1332 toggleall.\n
1333 Use lyx -dbg action for exact syntax of text-style
1334 dialog parameters.
1335 * \li Origin: leeming, 12 Mar 2003
1336 * \endvar
1338 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1340 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1341 * \li Action: Update fonts and its metrics.
1342 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1343 * \li Syntax: screen-font-update
1344 * \li Origin: ARRae, 13 Aug 2000
1345 * \endvar
1347 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1349 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1350 * \li Action: Returns the info about the current font.
1351 * \li Syntax: font-state
1352 * \endvar
1354 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1357 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1358 * \li Action: Inserts citation from loaded citation database.
1359 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1360 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1361 <TEXT_BEFORE>: text which should appear before citation.
1362 * \li Origin: AAS, 97-02-23
1363 * \endvar
1365 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1367 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1368 * \li Action: Adds database, which will be used for bibtex citations.
1369 * \li Notion: Databases are added to the first BibTeX inset
1370 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1371 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1372 * \li Origin: Ale, 30 May 1997
1373 * \endvar
1375 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1377 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1378 * \li Action: Adds database, which will be used for bibtex citations.
1379 * \li Notion: Databases are deleted from the first BibTeX inset
1380 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1381 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1382 * \li Origin: Ale, 30 May 1997
1383 * \endvar
1385 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1388 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1389 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1390 * \li Syntax: layout <LAYOUT>
1391 * \li Params: <LAYOUT>: the layout to use
1392 * \endvar
1394 { LFUN_LAYOUT, "layout", Noop, Layout },
1396 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1397 * \li Action: Launches the paragraph settings dialog.
1398 * \li Syntax: layout-paragraph
1399 * \endvar
1401 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1403 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1404 * \li Action: Launches the tabular settings dialog.
1405 * \li Syntax: layout-tabular
1406 * \li Origin: Jug, 31 Jul 2000
1407 * \endvar
1409 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1411 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1412 * \li Action: Displays list of layout choices.
1413 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1414 dropbox allowing for choice of layout.
1415 * \li Syntax: drop-layouts-choice
1416 * \endvar
1418 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1420 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1421 * \li Action: Clears the module list.
1422 * \li Notion: Clears the list of included modules for the current buffer.
1423 * \li Syntax: layout-modules-clear
1424 * \li Origin: rgh, 25 August 2007
1425 * \endvar
1427 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1429 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1430 * \li Action: Adds a module.
1431 * \li Notion: Adds a module to the list of included modules for the current buffer.
1432 * \li Syntax: layout-module-add <MODULE>
1433 * \li Params: <MODULE>: the module to be added
1434 * \li Origin: rgh, 25 August 2007
1435 * \endvar
1437 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1439 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1440 * \li Action: Reloads layout information.
1441 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1442 recognizing any changes that have been made to layout files on the fly.
1443 This is intended to be used only by layout developers and should not be
1444 used when one is trying to do actual work.
1445 * \li Syntax: layout-reload
1446 * \li Origin: rgh, 3 September 2007
1447 * \endvar
1449 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1451 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1452 * \li Action: Sets the text class for the current buffer.
1453 * \li Syntax: textclass-apply <TEXTCLASS>
1454 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1455 the filename, minus the ".layout" extension.
1456 * \endvar
1458 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1460 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1461 * \li Action: Loads information for a textclass from disk.
1462 * \li Syntax: textclass-load <TEXTCLASS>
1463 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1464 the filename, minus the ".layout" extension.
1465 * \endvar
1467 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1470 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1471 * \li Action: Disable selecting of text-region.
1472 * \li Syntax: mark-off
1473 * \endvar
1475 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1477 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1478 * \li Action: Enable selecting of text-region.
1479 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1480 * \li Syntax: mark-on
1481 * \endvar
1483 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1485 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1486 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1487 * \li Syntax: mark-toggle
1488 * \li Origin: Andre, May 5 2006
1489 * \endvar
1491 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1494 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1495 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1496 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1497 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1498 either a LaTeX name or a valid character.
1499 ( is the default letter.
1500 * \li Sample: math-delim { rangle
1501 * \li Origin: Alejandro, 18 Jun 1996
1502 * \endvar
1504 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1506 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1507 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1508 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1509 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1510 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1511 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1512 * \li Origin: Enrico & Georg, 7 May 2006
1513 * \endvar
1515 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1517 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1518 * \li Action: Creates a new displayed equation in text mode.
1519 Toggles inlined/display formula in math mode.
1520 * \li Syntax: math-display [<ARG>]
1521 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1522 new equation from the text mode.
1523 * \li Origin: Alejandro, 18 Jun 1996
1524 * \endvar
1526 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1528 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1529 * \li Action: Inserts math objects and symbols.
1530 * \li Syntax: math-insert <ARG>
1531 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1532 * \endvar
1534 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1536 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1537 * \li Action: Enters subscript expression in math expression.
1538 * \li Syntax: math-subscript
1539 * \li Origin: vermeer, 12 Dec 2001
1540 * \endvar
1542 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1544 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1545 * \li Action: Enters subscript expression in math expression.
1546 * \li Syntax: math-superscript
1547 * \li Origin: vermeer, 12 Dec 2001
1548 * \endvar
1550 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1552 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1553 * \li Action: Toggles the position of the limits from above/below to the right
1554 side an vice versa in integral symbol, a limit, a summation, etc.
1555 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1556 math-limits.
1557 * \li Syntax: math-limits [<STATE>]
1558 * \li Params: <STATE>: limits|nolimits
1559 * \endvar
1561 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1563 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1564 * \li Action: Inserts a math macro definition at the cursor position in the text.
1565 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1566 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1567 <NARGS>: The number of parameters of the macro. Default is 0.
1568 "def": Has no effect anymore, just for compatibility with former LyX versions.
1569 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1570 * \endvar
1572 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1574 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1575 * \li Action: Mutates the type of math inset to the newly selected one.
1576 * \li Syntax: math-mutate <TYPE>
1577 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1578 multline|gather|flalign
1579 * \li Origin: Andre, 23 May 2001
1580 * \endvar
1582 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1584 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1585 * \li Action: Inserts space into math expression.
1586 * \li Notion: Use spacebar after entering this space to change type of space.
1587 * \li Syntax: math-space [<TYPE>] [<LEN>]
1588 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1589 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1590 custom space: hspace \n
1591 "," used by default.\n
1592 Note that ! is equivalent to negthinspace, , = thinspace,
1593 : = medspace, and ; = thickspace.\n
1594 <LEN>: length for custom spaces (hspace)
1595 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1596 * \endvar
1598 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1600 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1601 * \li Action: Inserts a matrix.
1602 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1603 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1604 (b, c or t) (i.e. 1 char) and the horizontal alignments
1605 (l, c or r) (i.e. <COL> chars).
1606 * \li Sample: math-matrix 3 3 bccc
1607 * \endvar
1609 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1611 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1612 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1613 cursor position), in math mode enters text mode inside math expression.
1614 * \li Notion: If there is some selected text, it puts the text inside created math box.
1615 * \li Syntax: math-mode [<ARG>]
1616 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1617 * \li Origin: Alejandro, 4 Jun 1996
1618 * \endvar
1620 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1622 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1623 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1624 cursor position). Used by the advanced search dialog.
1625 * \li Notion: If there is any selected text, then it is moved inside the created
1626 regexp inset.
1627 * \li Syntax: regexp-mode [<ARG>]
1628 * \li Params: <ARG>: eventual argument (regular expression).
1629 * \li Origin: Tommaso, 4 Oct 2008
1630 * \endvar
1632 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1634 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1635 * \li Action: Toggles numbering of the current formula line.
1636 * \li Notion: Must be in display formula mode.
1637 * \li Syntax: math-number-line-toggle
1638 * \li Origin: Alejandro, 18 Jun 1996
1639 * \endvar
1641 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1643 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1644 * \li Action: Toggles numbering/labeling of the current formula.
1645 * \li Notion: Must be in display formula mode.
1646 * \li Syntax: math-number-toggle
1647 * \li Origin: Alejandro, 4 Jun 1996
1648 * \endvar
1650 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1652 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1653 * \li Action: Calls external program and passes the current expression/equation
1654 as an argument for the calculation in the format appropriate to the
1655 given language.
1656 * \li Notion: Selection can be used to determine the input for the external program.
1657 * \li Syntax: math-extern <LANG> [<COMMAND>]
1658 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1659 where "script" stands fot the external script (normalized
1660 expression will be passed)
1661 * \li Origin: Andre, 24 Apr 2001
1662 * \li Sample: math-extern maple simplify
1663 * \endvar
1665 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1667 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1668 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1669 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1670 * \li Syntax: math-size <STYLE>
1671 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1672 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1673 * \endvar
1675 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1677 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1678 * \li Action: Changes the text style used in math.
1679 * \li Syntax: math-font-style <STYLE>
1680 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1681 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1682 |textsc|textsl|textup
1683 * \li Origin: vfr, 9 jan 2009
1684 * \endvar
1686 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1688 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1689 * \li Action: Unfold a Math Macro.
1690 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1691 display it as \foo.
1692 * \li Syntax: math-macro-unfold
1693 * \li Origin: sts, 06 January 2008
1694 * \endvar
1696 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1698 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1699 * \li Action: Fold a Math Macro.
1700 * \li Notion: Fold the Math Macro the cursor is in if it was
1701 unfolded, i.e. displayed as \foo before.
1702 * \li Syntax: math-macro-fold
1703 * \li Origin: sts, 06 January 2008
1704 * \endvar
1706 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1708 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1709 * \li Action: Add a parameter.
1710 * \li Notion: Add a parameter to a Math Macro.
1711 * \li Params: <NUM>: The number of the parameter behind which the new one
1712 will be added (1 for the first, i.e. use 0 for add a
1713 parameter at the left), defaults to the last one.
1714 * \li Syntax: math-macro-add-param <NUM>
1715 * \li Origin: sts, 06 January 2008
1716 * \endvar
1718 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1720 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1721 * \li Action: Remove the last parameter.
1722 * \li Notion: Remove the last parameter of a Math Macro and
1723 remove its value in all instances of the macro
1724 in the buffer.
1725 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1726 the first), defaults to the last one.
1727 * \li Syntax: math-macro-remove-param <NUM>
1728 * \li Origin: sts, 06 January 2008
1729 * \endvar
1731 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1733 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1734 * \li Action: Append a greedy parameter.
1735 * \li Notion: Append a greedy parameter to a Math Macro which
1736 eats the following mathed cell in every instance of
1737 the macro in the buffer.
1738 * \li Syntax: math-macro-append-greedy-param
1739 * \li Origin: sts, 06 January 2008
1740 * \endvar
1742 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1744 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1745 * \li Action: Remove a greedy parameter.
1746 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1747 out the values of it in every instance of the macro
1748 in the buffer. If it is an optional parameter the [valud]
1749 format is used.
1750 * \li Syntax: math-macro-remove-greedy-param
1751 * \li Origin: sts, 06 January 2008
1752 * \endvar
1754 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1756 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1757 * \li Action: Make a parameter optional.
1758 * \li Notion: Turn the first non-optional parameter of a Math Macro
1759 into an optional parameter with a default value.
1760 * \li Syntax: math-macro-make-optional
1761 * \li Origin: sts, 06 January 2008
1762 * \endvar
1764 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1766 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1767 * \li Action: Make a parameter non-optional.
1768 * \li Notion: Turn the last optional parameter of a Math Macro
1769 into a non-optional parameter. The default value is
1770 remembered to be reused later if the user changes his mind.
1771 * \li Syntax: math-macro-make-nonoptional
1772 * \li Origin: sts, 06 January 2008
1773 * \endvar
1775 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1777 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1778 * \li Action: Add an optional parameter.
1779 * \li Notion: Insert an optional parameter just behind the
1780 already existing optional parameters.
1781 * \li Syntax: math-macro-add-optional-param
1782 * \li Origin: sts, 06 January 2008
1783 * \endvar
1785 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1787 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1788 * \li Action: Remove the last optional parameter.
1789 * \li Notion: Remove the last optional parameter of a Math Macro and
1790 remove it in all the instances of the macro in the buffer.
1791 * \li Syntax: math-macro-remove-optional-param
1792 * \li Origin: sts, 06 January 2008
1793 * \endvar
1795 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1797 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1798 * \li Action: Add a greedy optional parameter.
1799 * \li Notion: Add a greedy optional parameter which eats the value
1800 from the following cells in mathed which are in the [value]
1801 format.
1802 * \li Syntax: math-macro-add-greedy-optional-param
1803 * \li Origin: sts, 06 January 2008
1804 * \endvar
1806 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1808 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1809 * \li Action: Only active in Math Macro definition.
1810 * \li Notion: Dummy function which is only active in a Math Macro definition.
1811 It's used to toggle the Math Macro toolbar if the cursor moves
1812 into a Math Macro definition.
1813 * \li Syntax: in-mathmacrotemplate
1814 * \li Origin: sts, 06 January 2008
1815 * \endvar
1817 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1820 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1821 * \li Action: Moves the current paragraph downwards in the document.
1822 * \li Syntax: paragraph-move-down
1823 * \li Origin: Edwin, 8 Apr 2006
1824 * \endvar
1826 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1828 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1829 * \li Action: Moves the current paragraph upwards in the document.
1830 * \li Syntax: paragraph-move-up
1831 * \li Origin: Edwin, 8 Apr 2006
1832 * \endvar
1834 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1837 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1838 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1839 in upward direction.
1840 * \li Syntax: paragraph-up
1841 * \li Origin: Asger, 1 Oct 1996
1842 * \endvar
1844 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1846 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1847 * \li Action: Move the cursor and select the text to the next paragraph (or
1848 begining of the current one) in upward direction.
1849 * \li Syntax: paragraph-up-select
1850 * \li Origin: Asger, 1 Oct 1996
1851 * \endvar
1853 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1855 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1856 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1857 in downward direction.
1858 * \li Syntax: paragraph-down
1859 * \li Origin: Asger, 1 Oct 1996
1860 * \endvar
1862 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1864 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1865 * \li Action: Move the cursor and select the text to the next paragraph (or
1866 begining of the current one) in downward direction.
1867 * \li Syntax: paragraph-down-select
1868 * \li Origin: Asger, 1 Oct 1996
1869 * \endvar
1871 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1873 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1874 * \li Action: Jump to a paragraph given by its id number and optionally the
1875 desired position within the paragraph.
1876 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1877 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1878 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1879 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1880 <POSITION_IN_PAR>: desired position within the paragraph
1881 * \li Origin: Dekel, 26 Aug 2000
1882 * \endvar
1884 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1886 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1887 * \li Action: Breaks the current paragraph at the current location.
1888 * \li Syntax: break-paragraph
1889 * \endvar
1891 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1893 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1894 * \li Action: Breaks the current paragraph at the current location.
1895 * \li Notion: Removes the selection.
1896 * \li Syntax: break-paragraph [<LAYOUT>]
1897 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1898 to default layout) when the cursor is at the end of
1899 the line.
1900 * \endvar
1902 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1904 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1905 * \li Action: Change paragraph settings.
1906 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1907 This function only modifies, and does not override, existing settings.
1908 Note that the "leftindent" indent setting is deprecated.
1909 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1910 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1911 <SPACING>: \paragraph_spacing default|single|onehalf|double|other\n
1912 <ALIGN>: \align block|left|right|center|default\n
1913 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1914 * \li Origin: rgh, Aug 15 2007
1915 * \endvar
1917 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1919 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1920 * \li Action: Change paragraph settings.
1921 * \li Notion: Overwrite all nonspecified settings to the default ones.
1922 Use paragraph-params lfun if you don't want to overwrite others settings.
1923 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1924 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1925 * \li Origin: leeming, 30 Mar 2004
1926 * \endvar
1928 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1930 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1931 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1932 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1933 by #LFUN_DIALOG_UPDATE.
1934 * \li Origin: leeming, 13 Mar 2003
1935 * \endvar
1937 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1940 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1941 * \li Action: Move the current group in the upward direction in the
1942 structure of the document.
1943 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1944 the whole substructure of the group.
1945 * \li Syntax: outline-up
1946 * \li Origin: Vermeer, 23 Mar 2006
1947 * \endvar
1949 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1951 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1952 * \li Action: Move the current group in the downward direction in the
1953 structure of the document.
1954 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1955 the whole substructure of the group.
1956 * \li Syntax: outline-down
1957 * \li Origin: Vermeer, 23 Mar 2006
1958 * \endvar
1960 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1962 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1963 * \li Action: Moves the current group in the downward direction in the
1964 hierarchy of the document structure.
1965 * \li Notion: Part -> Chapter -> Section -> etc.
1966 * \li Syntax: outline-in
1967 * \li Origin: Vermeer, 23 Mar 2006
1968 * \endvar
1970 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1972 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1973 * \li Action: Moves the current group in the upward direction in the
1974 hierarchy of the document structure.
1975 * \li Notion: Part <- Chapter <- Section <- etc.
1976 * \li Syntax: outline-out
1977 * \li Origin: Vermeer, 23 Mar 2006
1978 * \endvar
1980 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1982 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1983 * \li Action: Edit the inset at cursor with an external application,
1984 if one is attributed.
1985 * \li Syntax: inset-edit [<INSET_PARAMS>]
1986 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1987 Currently only the filename will be considered.
1988 * \li Origin: JSpitzm, 27 Apr 2006
1989 * \endvar
1991 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
1994 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1995 * \li Action: Inserts table into the document.
1996 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1997 * \li Params: In case no arguments are given show insert dialog.
1998 * \li Origin: Jug, 12 Apr 2000
1999 * \endvar
2001 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2003 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2004 * \li Action: Sets various features to the table/cell on the current cursor position.
2005 * \li Notion: Various math-environment features are handled here as well, e.g.
2006 add-vline-left/right for the Grid/Array environment
2007 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2008 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2009 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2010 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2011 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
2012 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
2013 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2014 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2015 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2016 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2017 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2018 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
2019 set-top-space|set-bottom-space|set-interline-space|set-border-lines|
2020 tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n
2021 <ARG>: additional argument for some commands, use debug mode to explore its values.
2022 * \li Origin: Jug, 28 Jul 2000
2023 * \endvar
2025 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2027 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2028 * \li Action: Moves the cursor to the previous cell inside the table.
2029 * \li Syntax: cell-backward
2030 * \li Origin: Jug, 22 May 2000
2031 * \endvar
2033 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2035 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2036 * \li Action: Moves the cursor to the next cell inside the table.
2037 * \li Syntax: cell-forward
2038 * \endvar
2040 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2042 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2043 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2044 * \li Syntax: cell-split
2045 * \li Origin: Ale, 15 May 1997
2046 * \endvar
2048 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2051 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2052 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2053 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2054 of cvs/svn/rcs entries in the document's directory. \n
2055 See LyX Additional Features Manual (Version Control Chapter) for additional
2056 information.
2057 * \li Syntax: vc-register
2058 * \li Origin: Lgb, 1 Jul 1997
2059 * \endvar
2061 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2063 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2064 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2065 * \li Notion: In RCS case this also unlocks the file.
2066 * \li Syntax: vc-check-in
2067 * \li Origin: Lgb, 1 Jul 1997
2068 * \endvar
2070 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2072 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2073 * \li Action: Checks-out the document for edit (and locks it for RCS).
2074 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2075 * \li Syntax: vc-check-out
2076 * \li Origin: Lgb, 1 Jul 1997
2077 * \endvar
2079 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2081 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2082 * \li Action: Reverts the document to the last check-in/commit in VCS.
2083 * \li Syntax: vc-revert
2084 * \li Origin: Lgb, 1 Jul 1997
2085 * \endvar
2087 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2089 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2090 * \li Action: Undo last check-in.
2091 * \li Notion: This is currently implemented only for RCS.
2092 * \li Syntax: vc-check-out
2093 * \li Origin: Lgb, 1 Jul 1997
2094 * \endvar
2096 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2098 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2099 * \li Action: Executes external command. This command is intended to support
2100 additional VCS commands.
2101 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2102 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2103 U - dUmmy - no flags \n
2104 D - Doc - need document loaded to proceed \n
2105 I - dIrty - mark document dirty \n
2106 R - Reload - ensure that the document is saved and reload it after command execution \n
2107 M - Message - ask for input string (commit message)\n
2108 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2109 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
2110 * \li Sample: vc-command DR $$p "svn up"
2111 * \li Origin: sanda, 13 Jan 2009
2112 * \endvar
2114 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2117 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2118 * \li Action: Toggles change tracking to on/off.
2119 * \li Syntax: changes-track
2120 * \li Origin: levon, 1 Oct 2002
2121 * \endvar
2123 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2125 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2126 * \li Action: Toggles showing of change tracking in typesetted output.
2127 * \li Syntax: changes-output
2128 * \li Origin: jspitzm, 21 Jan 2005
2129 * \endvar
2131 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2133 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2134 * \li Action: Moves the cursor to the position of the next change
2135 of the change tracking records.
2136 * \li Syntax: change-next
2137 * \li Origin: schmitt, 4 Oct 2006
2138 * \endvar
2140 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2142 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2143 * \li Action: Moves the cursor to the position of the previous change
2144 of the change tracking records.
2145 * \li Syntax: change-previous
2146 * \li Origin: vfr, 4 Apr 2009
2147 * \endvar
2149 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2151 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2152 * \li Action: Open change tracking dialog for merging and moves the cursor
2153 to the position of the next change.
2154 * \li Syntax: changes-merge
2155 * \li Origin: Levon, 16 Oct 2002
2156 * \endvar
2158 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2160 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2161 * \li Action: Accepts tracked change inside the selection.
2162 * \li Syntax: change-accept
2163 * \li Origin: Levon, 16 Oct 2002
2164 * \endvar
2166 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2168 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2169 * \li Action: Rejects tracked change inside the selection.
2170 * \li Syntax: change-accept
2171 * \li Origin: Levon, 16 Oct 2002
2172 * \endvar
2174 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2176 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2177 * \li Action: Accepts all tracked changes in the document.
2178 * \li Syntax: all-changes-accept
2179 * \li Origin: Levon, 16 Oct 2002
2180 * \endvar
2182 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2184 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2185 * \li Action: Rejects all tracked changes in the document.
2186 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2187 * \li Syntax: all-changes-reject
2188 * \li Origin: Levon, 16 Oct 2002
2189 * \endvar
2191 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2194 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2195 * \li Action: Apply data for an inset.
2196 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2197 be applied. This is either changed to #LFUN_INSET_MODIFY or
2198 #LFUN_INSET_INSERT depending on the context where it is called.
2199 * \li Syntax: inset-apply <ARGS>
2200 * \li Params: See #LFUN_INSET_INSERT .
2201 * \endvar
2203 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2205 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2206 * \li Action: Dissolve the current inset into text.
2207 * \li Syntax: inset-dissolve [<INSET>]
2208 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2209 is dissolved. For example "dissolve" entry in the charstyles
2210 sub-menu should only dissolve the charstyle inset, even if the
2211 cursor is inside several nested insets of different type.\n
2212 For values see #lyx::InsetLayout::lyxtype_ .
2213 * \li Origin: JSpitz, 7 Aug 2006
2214 * \endvar
2216 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2218 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2219 * \li Action: Insert new inset (type given by the parameters).
2220 * \li Syntax: inset-insert <INSET> <ARGS>
2221 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2222 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2223 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2224 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2225 where <label name> is the name of the referenced label and
2226 <Format> is one of the following: \n
2227 ref -- <reference> \n
2228 eqref -- (<reference>) \n
2229 pageref -- <page> \n
2230 vpageref -- on <page> \n
2231 vref -- <reference> on <page> \n
2232 prettyref -- Formatted reference
2233 * \endvar
2235 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2237 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2238 * \li Action: Modify existing inset.
2239 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2240 floats, graphics, include, label, listings, note,
2241 phantom, ref, space, tabular, vspace, wrap insets.
2242 * \li Syntax: inset-modify <INSET> <ARGS>
2243 * \li Params: See #LFUN_INSET_INSERT for further details.
2244 * \endvar
2246 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2248 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2249 * \li Action: Modify the inset at cursor position, if there is one.
2250 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2251 floats, graphics, include, label, listings, note,
2252 phantom, ref, space, tabular, vspace, wrap insets.
2253 * \li Syntax: next-inset-modify <INSET> <ARGS>
2254 * \li Syntax: next-inset-modify changetype <TYPE>
2255 * \li Params: See #LFUN_INSET_INSERT for further details.
2256 * \li Origin: JSpitzm, 23 Mar 2008
2257 * \endvar
2259 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", Noop, Edit },
2261 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2262 * \li Action: Updates the values inside the dialog from the inset.
2263 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2264 by #LFUN_DIALOG_UPDATE
2265 * \li Params: <DIALOG-NAME>
2266 * \li Origin: leeming, 25 Feb 2003
2267 * \endvar
2269 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2271 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2272 * \li Action: Open the inset's properties dialog.
2273 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2274 float, graphics, href, include, index, index_print, label, listings,
2275 note, phantom, ref, space, tabular, vspace, wrap insets.
2276 * \li Syntax: inset-settings <INSET>
2277 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2278 graphics|href|include|index|index_print|label|listings|
2279 note|phantom|ref|space|tabular|vspace|wrap>.
2280 * \endvar
2282 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2284 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2285 * \li Action: Toggles the collapsable inset at cursor position,
2286 or the inset we are currently in.
2287 * \li Syntax: inset-toggle [<ARG>]
2288 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2289 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2290 assign synchronize the branch-inset with activation status of the branch.
2291 Used for global toggling when changed activation.
2292 * \li Origin: lasgouttes, 19 Jul 2001
2293 * \endvar
2295 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2297 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2298 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2299 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2300 * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
2301 * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
2302 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2303 * \li Origin: leeming, 30 Mar 2004
2304 * \endvar
2306 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2308 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2309 * \li Action: Set the group for the graphics inset on the cursor position.
2310 * \li Syntax: set-graphics-group [<GROUP>]
2311 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2312 the graphics inset is removed from the current group.
2313 * \li Origin: sanda, 6 May 2008
2314 * \endvar
2316 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2319 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2320 * \li Action: Moves the cursor out of the current slice, going forward.
2321 * \li Notion: Cursor movement within an inset may be different than cursor
2322 movement in the surrounding text. This action should be called
2323 automatically by the cursor movement within the inset, when
2324 movement within the inset has ceased (reached the end of the
2325 last paragraph, for example), in order to move correctly
2326 back into the surrounding text.
2327 * \endvar
2329 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2331 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2332 * \li Action: Moves the cursor out of the current slice, going backwards.
2333 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2334 * \endvar
2336 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2338 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2339 * \li Action: Moves the cursor out of the current slice, going right.
2340 * \li Notion: See also #LFUN_FINISHED_FORWARD
2341 * \endvar
2343 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2345 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2346 * \li Action: Moves the cursor out of the current slice, going left.
2347 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2348 * \endvar
2350 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2353 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2354 * \li Action: Set language from the current cursor position.
2355 * \li Syntax: language <LANG>
2356 * \li Params: <LANG>: Requested language. Look in lib/languages for
2357 the list.
2358 * \li Origin: Dekel, 2 Mar 2000
2359 * \endvar
2361 { LFUN_LANGUAGE, "language", Noop, Edit },
2364 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2365 * \li Action: Goto a label.
2366 * \li Syntax: label-goto [<LABEL>]
2367 * \li Params: <LABEL>: Requested label. If no label is given and reference
2368 is on cursor position, Bookmark 0 is saved and
2369 cursor moves to the position of referenced label.
2370 * \li Origin: Ale, 6 Aug 1997
2371 * \endvar
2373 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2375 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2376 * \li Action: Inserts label to text or displayed formula.
2377 * \li Syntax: label-insert [<LABEL>]
2378 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2379 name will be opened.
2380 * \endvar
2382 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2384 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2385 * \li Action: Go to the next label or cross-reference.
2386 * \li Syntax: reference-next
2387 * \li Origin: Dekel, 14 Jan 2001
2388 * \endvar
2390 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2393 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2394 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2395 if necessary. Note that bookmarsk are saved per-session, not
2396 per file.
2397 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2398 1. to the paragraph you are currently editing \n
2399 2. to the paragraph from where you are jumping to the last-edited
2400 position (jump-back feature) \n
2401 3. when jumping from crossreference to the requested label by
2402 #LFUN_LABEL_GOTO.
2403 * \li Syntax: bookmark-goto <NUMBER>
2404 * \li Params: <NUMBER>: the number of the bookmark to restore.
2405 * \li Origin: Dekel, 27 January 2001
2406 * \endvar
2408 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2410 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2411 * \li Action: Save a bookmark.
2412 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2413 must be between 1 and 9, inclusive. Note that bookmarks are
2414 saved per-session, not per file.
2415 * \li Syntax: bookmark-save <NUMBER>
2416 * \li Params: <NUMBER>: the number of the bookmark to save.
2417 * \li Origin: Dekel, 27 January 2001
2418 * \endvar
2420 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2422 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2423 * \li Action: Clears the list of saved bookmarks.
2424 * \li Syntax: bookmark-clear
2425 * \li Origin: bpeng, 31 October 2006
2426 * \endvar
2428 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2431 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2432 * \li Action: Open the given help file according to the language setting.
2433 * \li Syntax: help-open <FILE>[.lyx]
2434 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2435 * \li Origin: Jug, 27 Jun 1999
2436 * \endvar
2438 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2440 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2441 * \li Action: Terminates the current LyX instance.
2442 * \li Notion: Terminates the current LyX instance, asking whether to save
2443 modified documents, etc.
2444 * \li Syntax: lyx-quit
2445 * \endvar
2447 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2449 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2450 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2451 * \li Notion: Skiping "auto" when allowauto is false.
2452 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2453 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2454 minibuffer|review|view/update|math_panels|vcs
2455 * \li Origin: Edwin, 21 May 2007
2456 * \endvar
2458 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2460 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2461 * \li Action: Opens the menu given by its name.
2462 * \li Syntax: menu-open <NAME>
2463 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2464 * \endvar
2466 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2468 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2469 * \li Action: Various UI visibility-toggling actions.
2470 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2471 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2472 menubar : Toggle visibility of the menubar.\n
2473 scrollbar : Toggle visibility of the scrollbar.\n
2474 frame : Toggle visibility of the frames around editing window.\n
2475 fullscreen : Toggle fullscreen mode. This also covers calling the
2476 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2477 custom tweaks of the toolbars should be used.
2478 * \li Origin: sanda, 9 Feb 2007
2479 * \endvar
2481 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2484 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2485 * \li Action: Creates new empty LyX window.
2486 * \li Notion: Already opened documents from the previous window can be found under View menu.
2487 * \li Syntax: window-new [<GEOMETRY>]
2488 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2489 accepted only on Windows platform.
2490 * \li Origin: Abdel, 21 Oct 2006
2491 * \endvar
2493 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2495 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2496 * \li Action: Closes the current LyX window.
2497 * \li Syntax: window-close
2498 * \li Origin: Abdel, 23 Oct 2006
2499 * \endvar
2501 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2504 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2505 * \li Action: Creates another split view of current buffer.
2506 * \li Notion: All split views act in the same way indpendently.
2507 * \li Syntax: split-view <vertical|horizontal>
2508 * \li Params: horizontal : The work areas are laid out side by side.\n
2509 vertical : The work areas laid out vertically.
2510 * \li Origin: Abdel, 20 Feb 2008
2511 * \endvar
2513 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2516 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2517 * \li Action: Close the current tab group.
2518 * \li Notion: This only closes the work areas, not the buffer themselves.
2519 The still opened buffers can be visualized in another tab group.
2520 * \li Syntax: close-tab-group
2521 * \li Origin: Abdel, 21 Feb 2008
2522 * \endvar
2524 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2526 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2527 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2528 * \li Syntax: dialog-show <NAME> [<DATA>]
2529 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2530 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|\n
2531 href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2532 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2533 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2534 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2535 <SPECIAL>: latexlog|vclog \n
2536 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2537 details.
2538 * \li Origin: leeming, 17 Jun 2003
2539 * \endvar
2541 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2543 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2544 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2545 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2546 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2547 * \li Params: See #LFUN_DIALOG_SHOW .
2548 * \li Origin: leeming, 25 Feb 2003
2549 * \endvar
2551 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2553 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2554 * \li Action: Updates the dialog values from the inset/paragraph/document.
2555 * \li Syntax: dialog-update <NAME>
2556 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2557 <INSET>: inset name
2558 * \li Origin: leeming, 25 Feb 2003
2559 * \endvar
2561 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2563 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2564 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2565 * \li Syntax: dialog-hide <NAME>
2566 * \li Params: See #LFUN_DIALOG_SHOW .
2567 * \li Origin: leeming, 25 Feb 2003
2568 * \endvar
2570 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2572 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2573 * \li Action: Toggles dialog between showed/hidden state.
2574 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2575 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2576 * \li Params: See #LFUN_DIALOG_SHOW .
2577 * \li Origin: JSpitzm, 30 Apr 2007
2578 * \endvar
2580 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2582 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2583 * \li Action: Closes opened connection to opened inset.
2584 * \li Notion: Connection is used for apply functions.
2585 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2586 * \li Origin: leeming, 25 Feb 2003
2587 * \endvar
2589 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2592 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2593 * \li Action: This function is called when mouse button is pressed (inside workarea).
2594 Action depends on the context.
2595 * \li Notion: This is internal LFUN, not to be used by users.
2596 * \li Origin: Andre, 9 Aug 2002
2597 * \endvar
2599 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2601 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2602 * \li Action: This function is called when double click on mouse button is
2603 pressed (inside workarea). Action depends on the context.
2604 * \li Notion: This is internal LFUN, not to be used by users.
2605 * \li Origin: Andre, 9 Aug 2002
2606 * \endvar
2608 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2610 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2611 * \li Action: This function is called when triple click on mouse button is
2612 pressed (inside workarea). Action depends on the context.
2613 * \li Notion: This is internal LFUN, not to be used by users.
2614 * \li Origin: Andre, 9 Aug 2002
2615 * \endvar
2617 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2619 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2620 * \li Action: This function is called when mouse cursor is moving over the text.
2621 Action depends on the context.
2622 * \li Notion: This is internal LFUN, not to be used by users.
2623 * \li Origin: Andre, 9 Aug 2002
2624 * \endvar
2626 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2628 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2629 * \li Action: This function is called when mouse button is released (inside workarea).
2630 Action depends on the context.
2631 * \li Notion: This is internal LFUN, not to be used by users.
2632 * \li Origin: Andre, 9 Aug 2002
2633 * \endvar
2635 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2638 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2639 * \li Action: Turn off the loaded keyboard map.
2640 * \li Syntax: keymap-off
2641 * \endvar
2643 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2645 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2646 * \li Action: Turn on the primary keyboard map.
2647 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2648 keyboard support. They can be still used to maintain uniform keyboard
2649 layout across the various plaforms.\n
2650 The language is to be set in the Preferences dialog.
2651 * \li Syntax: keymap-primary
2652 * \endvar
2654 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2656 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2657 * \li Action: Turn on the secondary keyboard map.
2658 * \li Syntax: keymap-secondary
2659 * \endvar
2661 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2663 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2664 * \li Action: Toggles keyboard maps (first/second/off).
2665 * \li Syntax: keymap-toggle
2666 * \li Origin: leeming, 30 Mar 2004
2667 * \endvar
2669 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2672 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2673 * \li Action: Returns the current layout (that is environment) name
2674 on the cursor position.
2675 * \li Syntax: server-get-layout
2676 * \endvar
2678 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2680 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2681 * \li Action: Returns path and file name of the currently edited document.
2682 * \li Syntax: server-get-filename
2683 * \endvar
2685 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2687 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2688 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2689 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2690 line from LaTeX compilation. Note that before this function can be used
2691 export to LaTeX output must occur (in order to map the row numbers).
2692 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2693 * \li Params: <FILE>: the filename. Environment variables are expaned in the path.
2694 In case this LFUN does not work make sure you are giving correct
2695 path to the file.\n
2696 If the file is located inside LyX temporary directory it will be
2697 mapped back into the appropriate opened buffer (e.g. for the case
2698 of generated .tex file).
2699 .ext: extensions will be automatically replaced by .lyx.
2700 * \li Origin: Edmar, 23 Dec 1998
2701 * \endvar
2703 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2705 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2706 * \li Action: Sends notify message about the last key-sequence to client.
2707 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2708 See also Debug extensions section in Additional features manual.
2709 * \li Syntax: server-notify
2710 * \endvar
2712 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2714 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2715 * \li Action: Sets the cursor position based on the editing area coordinates
2716 (similar as clicking on that point with left mouse button).
2717 * \li Syntax: server-set-xy <X> <Y>
2718 * \endvar
2720 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2722 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2723 * \li Action: Returns the coordinates of cursor position in the editing area.
2724 * \li Syntax: server-get-xy
2725 * \endvar
2727 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2730 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2731 * \li Action: Generates the code (literate programming).
2732 * \li Notion: Latex file with extension \literate_extension is generated.
2733 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2734 \build_error_filter to process the compilation error messages. \n
2735 In case you want to process your literate file with a script, or some other program,
2736 just insert in your lyxrc file an entry with:\n
2737 \build_command "my_script my_arguments" \n
2738 The \build_error_filter differs from the \literate_error_filter only in that the
2739 former will identify error messages from your compiler.
2740 * \li Syntax: build-program
2741 * \endvar
2743 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2746 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2747 * \li Action: Saves the current buffer to a temporary file.
2748 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2749 is called automatically by LyX, to "autosave" the current buffer.
2750 * \li Syntax: buffer-auto-save
2751 * \endvar
2753 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2755 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2756 * \li Action: Loads the given child document.
2757 * \li Notion: The current document is treated as a parent.
2758 * \li Syntax: buffer-child-open <FILE>
2759 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2760 * \li Origin: Ale, 28 May 1997
2761 * \endvar
2763 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2765 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2766 * \li Action: Runs chktex for the current document.
2767 * \li Syntax: buffer-chktex
2768 * \li Origin: Asger, 30 Oct 1997
2769 * \endvar
2771 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2773 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2774 * \li Action: Toggles compression of the current document on/off.
2775 * \li Syntax: buffer-toggle-compression
2776 * \li Origin: bpeng, 27 Apr 2006
2777 * \endvar
2779 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2781 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2782 * \li Action: Closes the current buffer.
2783 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2784 if the buffer has been modified.
2785 * \li Syntax: buffer-close
2786 * \endvar
2788 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2790 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2791 * \li Action: Exports the current buffer (document) to the given format.
2792 * \li Syntax: buffer-export <FORMAT>
2793 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2794 can find in Tools->Preferences->File formats->Format.
2795 Usual format you will enter is "pdf2" (pdflatex),
2796 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2797 In case of "custom" you will be asked for a format you
2798 want to start from and for the command that you want to
2799 apply to this format. Internally the control is then passed
2800 to #LFUN_BUFFER_EXPORT_CUSTOM.
2801 * \li Origin: Lgb, 29 Jul 1997
2802 * \endvar
2804 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2806 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2807 * \li Action: Exports the current buffer (document) from the given format using
2808 the given command on it.
2809 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2810 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2811 intermediate file).\n
2812 <COMMAND> this command will be launched on the file. Note that you can
2813 use "$$FName" string to qualify the intermediate file.
2814 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2815 * \li Origin: leeming, 27 Mar 2004
2816 * \endvar
2818 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2820 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2821 * \li Action: Prints the current document.
2822 * \li Notion: Many settings can be given via the preferences dialog.
2823 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2824 * \li Params: <TARGET> is either "printer" or "file".\n
2825 <TARGER-NAME> is either "default" or file name or printer name.\n
2826 <COMMAND> command ensuring the printing job.
2827 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2828 * \li Origin: leeming, 28 Mar 2004
2829 * \endvar
2831 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2833 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2834 * \li Action: Import a given file as a lyx document.
2835 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2836 defined convertors in preferences. Look into File->Import menu to get
2837 an idea of the currently active import formats.
2838 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2839 * \li Origin: Asger, 24 Jul 1998
2840 * \endvar
2842 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2844 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2845 * \li Action: Creates a new buffer (that is, document).
2846 * \li Notion: Implicit path can be set in Preferences dialog.
2847 * \li Syntax: buffer-new [<FILE>]
2848 * \li Params: <FILE>: filename of created file with absolute path.
2849 * \endvar
2851 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2853 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2854 * \li Action: Creates a new buffer (that is, document) from a template.
2855 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2856 Template will be asked for via Open-dialog.
2857 * \li Syntax: buffer-new-template [<FILE>]
2858 * \li Params: <FILE>: filename of created file with absolute path.
2859 * \endvar
2861 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2863 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2864 * \li Action: Reverts opened document.
2865 * \li Syntax: buffer-reload
2866 * \li Origin: Asger, 2 Feb 1997
2867 * \endvar
2869 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2871 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2872 * \li Action: Switch to the given buffer.
2873 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2874 document in different LyX windows.
2875 * \li Syntax: buffer-new-template <BUFFER>
2876 * \li Params: <BUFFER>: already opened document which is to be shown.
2877 * \endvar
2879 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2881 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2882 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2883 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2884 In the Readonly-> mode checkouts the data from repository. \n
2885 If these operations fail, buffer won't be toggled.
2886 * \li Syntax: buffer-toggle-read-only
2887 * \li Origin: Lgb, 27 May 1997
2888 * \endvar
2890 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2892 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2893 * \li Action: Displays current buffer in chosen format.
2894 * \li Notion: Displays the contents of the current buffer in the chosen
2895 format, for example, PDF or DVI. This runs the necessary
2896 converter, calls the defined viewer, and so forth.
2897 * \li Syntax: buffer-view [<FORMAT>]
2898 * \li Params: <FORMAT>: The format to display, where this is one of the
2899 formats defined (in the current GUI) in the
2900 Tools>Preferences>File Formats dialog.
2901 If no format is given, the default format as
2902 specified in the same dialog is used.
2903 * \endvar
2905 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2907 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2908 * \li Action: Exports the current document and put the result into the
2909 temporary directory.
2910 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2911 the output will be rewriten - updated. This is useful in case your viewer
2912 is able to detect such changes (e.g. ghostview for postscript).
2913 * \li Syntax: buffer-update [<FORMAT>]
2914 * \li Params: <FORMAT>: The format to display, where this is one of the
2915 formats defined (in the current GUI) in the
2916 Tools>Preferences>File Formats dialog.
2917 If no format is given, the default format as
2918 specified in the same dialog is used.
2919 * \li Origin: Dekel, 5 Aug 2000
2920 * \endvar
2922 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2925 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2926 * \li Action: Saves the current buffer.
2927 * \li Notion: Saves the current buffer to disk, using the filename that
2928 is already associated with the buffer, asking for one if
2929 none is yet assigned.
2930 * \li Syntax: buffer-write
2931 * \endvar
2933 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2935 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2936 * \li Action: Rename and save current buffer.
2937 * \li Syntax: buffer-write-as <FILENAME>
2938 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2939 is with respect to the original location of the buffer/file.
2940 * \endvar
2942 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2944 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2945 * \li Action: Save all changed documents.
2946 * \li Syntax: buffer-write-all
2947 * \li Origin: rgh, gpothier 6 Aug 2007
2948 * \endvar
2950 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2952 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2953 * \li Action: Switch to the next opened document.
2954 * \li Notion: Note that this does not necessarily mean next in tabbar
2955 (for full list see View menu).
2956 * \li Syntax: buffer-next
2957 * \endvar
2959 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2961 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2962 * \li Action: Switch to the previous opened document.
2963 * \li Syntax: buffer-previous
2964 * \endvar
2966 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2968 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2969 * \li Action: When run from a child document, this updates (exports) document built
2970 from the master buffer, if available.
2971 * \li Syntax: master-buffer-update [<FORMAT>]
2972 * \li Params: <FORMAT>: The format to display, where this is one of the
2973 formats defined (in the current GUI) in the
2974 Tools>Preferences>File Formats dialog.
2975 If no format is given, the default format as
2976 specified in the same dialog is used.
2977 * \li Origin: Tommaso, 20 Sep 2007
2978 * \endvar
2980 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2982 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2983 * \li Action: When run from a child document, this command shows a preview built
2984 from the master buffer, if available.
2985 * \li Syntax: master-buffer-view [<FORMAT>]
2986 * \li Params: <FORMAT>: The format to display, where this is one of the
2987 formats defined (in the current GUI) in the
2988 Tools>Preferences>File Formats dialog.
2989 If no format is given, the default format as
2990 specified in the same dialog is used.
2991 * \li Origin: Tommaso, 20 Sep 2007
2992 * \endvar
2994 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2996 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2997 * \li Action: Set language of the current document.
2998 * \li Syntax: buffer-language <LANG>
2999 * \li Params: <LANG>: language name. See lib/languages for list.
3000 * \li Origin: leeming, 30 Mar 2004
3001 * \endvar
3003 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3005 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3006 * \li Action: Save the current document settings as default.
3007 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3008 * \li Syntax: buffer-save-as-default [<ARGS>]
3009 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3010 you can find in document header of usual .lyx file.
3011 * \li Origin: leeming, 30 Mar 2004
3012 * \endvar
3014 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3016 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3017 * \li Action: Apply the given settings to the current document.
3018 * \li Syntax: buffer-params-apply [<ARGS>]
3019 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3020 you can find in document header of usual .lyx file.
3021 * \li Origin: leeming, 30 Mar 2004
3022 * \endvar
3024 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
3027 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3028 * \li Action: Inserts another LyX file.
3029 * \li Syntax: file-insert [<FILE>]
3030 * \li Params: <FILE>: Filename to be inserted.
3031 * \endvar
3033 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3035 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3036 * \li Action: Inserts plain text file.
3037 * \li Syntax: file-insert-plaintext [<FILE>]
3038 * \li Params: <FILE>: Filename to be inserted.
3039 * \li Origin: CFO-G, 19 Nov 1997
3040 * \endvar
3042 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3044 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3045 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3046 * \li Syntax: file-insert-plaintext-para [<FILE>]
3047 * \li Params: <FILE>: Filename to be inserted.
3048 * \li Origin: Levon, 14 Feb 2001
3049 * \endvar
3051 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3053 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3054 * \li Action: Open LyX document.
3055 * \li Syntax: file-open [<FILE>]
3056 * \li Params: <FILE>: Filename to be opened.
3057 * \endvar
3059 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3062 * \var lyx::FuncCode lyx::LFUN_CALL
3063 * \li Action: Executes a command defined in a .def file.
3064 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3065 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3066 where <NAME> is the name of the new command and <LFUN> is the lfun code
3067 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3068 \def_file "FileName" allows to include another .def file. \n
3069 This is particularly useful in connection with toolbar buttons:
3070 Since the name of the button image for this lfun is
3071 lib/images/commands/<NAME>.png this is the way to assign an image
3072 to a complex command-sequence.
3073 * \li Syntax: call <NAME>
3074 * \li Params: <NAME>: Name of the command that must be called.
3075 * \li Origin: broider, 2 Oct 2007
3076 * \endvar
3078 { LFUN_CALL, "call", NoBuffer, System },
3080 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3081 * \li Action: Simulate halting Meta key (Alt key on PCs).
3082 * \li Notion: Used for buffer editation not for GUI control.
3083 * \li Syntax: meta-prefix
3084 * \endvar
3086 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3088 * \var lyx::FuncCode lyx::LFUN_CANCEL
3089 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3090 * \li Syntax: cancel
3091 * \endvar
3093 { LFUN_CANCEL, "cancel", NoBuffer, System },
3096 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3097 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
3098 * \li Notion: Usually bound to M-x shortcut.
3099 * \li Syntax: command-execute
3100 * \endvar
3102 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3104 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3105 * \li Action: Return the current key sequence and available options as a string.
3106 * \li Notion: No options are added if no current map exists. \n
3107 This is probably usable only with connection to lyxserver.
3108 * \li Syntax: command-prefix
3109 * \endvar
3111 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3113 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3114 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3115 * \li Syntax: command-sequence <CMDS>
3116 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3117 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3118 * \li Origin: Andre, 11 Nov 1999
3119 * \endvar
3121 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3123 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3124 * \li Action: Runs the first listed command that is enabled.
3125 * \li Notion: This can be used to bind multiple functions to a single key,
3126 and then which one is used will depend upon the context.
3127 * \li Syntax: command-alternatives <CMDS>
3128 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3129 * \li Sample: command-alternatives completion-accept;cell-forward
3130 * \li Origin: rgh, 24 September 2008
3131 * \endvar
3133 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3135 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3136 * \li Action: Shows message in statusbar (for script purposes).
3137 * \li Syntax: message <STRING>
3138 * \li Origin: Lgb, 8 Apr 2001
3139 * \endvar
3141 { LFUN_MESSAGE, "message", NoBuffer, System },
3143 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3144 * \li Action: Save user preferences.
3145 * \li Syntax: preferences-save
3146 * \li Origin: Lgb, 27 Nov 1999
3147 * \endvar
3149 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3151 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3152 * \li Action: Reconfigure the automatic settings.
3153 * \li Syntax: reconfigure
3154 * \li Origin: Asger, 14 Feb 1997
3155 * \endvar
3157 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3159 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3160 * \li Action: Apply the given settings to user preferences.
3161 * \li Syntax: lyxrc-apply <SETTINGS>
3162 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3163 to get an idea which commands to use and their syntax.
3164 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3165 * \endvar
3167 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3169 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3170 * \li Action: Determine whether keep cursor inside the editing window regardless
3171 the scrollbar movement.
3172 * \li Syntax: toggle-cursor-follows-scrollbar
3173 * \li Origin: ARRae, 2 Dec 1997
3174 * \endvar
3176 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3178 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3179 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3180 * \li Notion: A new color entry is created if the color is unknown.
3181 Color names can be stored as a part of user settings.
3182 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3183 * \li Origin: SLior, 11 Jun 2000
3184 * \endvar
3186 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3188 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3189 * \li Action: Count the statistics (number of words and characters)
3190 in the document or in the given selection.
3191 * \li Notion: Note that this function gives the number of words/chars written,
3192 not the number of characters which will be typeset.
3193 * \li Syntax: statistics
3194 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3195 * \endvar
3197 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3199 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3200 * \li Action: Show the inline completion at the cursor position.
3201 * \li Syntax: completion-inline
3202 * \li Origin: sts, Feb 19 2008
3203 * \endvar
3205 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3207 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3208 * \li Action: Show the completion popup at the cursor position.
3209 * \li Syntax: completion-popup
3210 * \li Origin: sts, Feb 19 2008
3211 * \endvar
3213 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3215 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3216 * \li Action: Try to complete the word or command at the cursor position.
3217 * \li Syntax: complete
3218 * \li Origin: sts, Feb 19 2008
3219 * \endvar
3221 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3224 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3225 * \li Action: Try to cancel completion, either the popup or the inline completion
3226 * \li Syntax: completion-cancel
3227 * \li Origin: sts, Sep 07 2008
3228 * \endvar
3230 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3232 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3233 * \li Action: Accept suggested completion.
3234 * \li Syntax: completion-accept
3235 * \li Origin: sanda, Sep 08 2008
3236 * \endvar
3238 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3242 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3243 * \li Action: Activate the branch
3244 * \li Syntax: branch-activate <BRANCH>
3245 * \li Params: <BRANCH>: The branch to activate
3246 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3247 could be used to export a pdf with the answers branch included
3248 without one's having to open LyX and activate the branch manually.
3249 * \li Origin: rgh, 27 May 2008
3250 * \endvar
3252 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3254 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3255 * \li Action: De-activate the branch
3256 * \li Syntax: branch-deactivate <BRANCH>
3257 * \li Params: <BRANCH>: The branch to deactivate
3258 * \li Origin: rgh, 27 May 2008
3259 * \endvar
3261 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3264 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3265 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3266 * \li Syntax: copy-label-as-reference <LABEL>
3267 * \li Params: <LABEL>: The label to copy (for multi-line math)
3268 * \li Origin: sts, 16 Nov 2008
3269 * \endvar
3271 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3274 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3275 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3276 * \li Syntax: label-insert-as-reference
3277 * \li Origin: vfr, 7 Apr 2009
3278 * \endvar
3280 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3283 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3284 * \li Action: Increases the zoom of the screen fonts.
3285 * \li Syntax: buffer-zoom-in [<ZOOM>]
3286 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3287 * \li Origin: vfr, 30 Mar 2009
3288 * \endvar
3290 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3293 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3294 * \li Action: Decreases the zoom of the screen fonts.
3295 * \li Syntax: buffer-zoom-out [<ZOOM>]
3296 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3297 * \li Origin: vfr, 30 Mar 2009
3298 * \endvar
3300 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3303 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3304 * \li Action: Selects the whole section.
3305 * \li Notion: The cursor should be in a section heading
3306 before calling this lfun.
3307 * \li Syntax: section-select
3308 * \li Origin: vfr, 05 May 2009
3309 * \endvar
3311 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3313 { LFUN_NOACTION, "", Noop, Hidden }
3314 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3317 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3318 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3321 init = true;
3323 #endif
3325 LyXAction::LyXAction()
3327 init();
3331 // Returns an action tag from a string.
3332 FuncRequest LyXAction::lookupFunc(string const & func) const
3334 string const func2 = trim(func);
3336 if (func2.empty()) {
3337 return FuncRequest(LFUN_NOACTION);
3340 string cmd;
3341 string const arg = split(func2, cmd, ' ');
3343 func_map::const_iterator fit = lyx_func_map.find(cmd);
3345 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3349 string const LyXAction::getActionName(FuncCode action) const
3351 info_map::const_iterator const it = lyx_info_map.find(action);
3352 return it != lyx_info_map.end() ? it->second.name : string();
3356 LyXAction::func_type LyXAction::getActionType(FuncCode action) const
3358 info_map::const_iterator const it = lyx_info_map.find(action);
3359 return it != lyx_info_map.end() ? it->second.type : Hidden;
3363 bool LyXAction::funcHasFlag(FuncCode action,
3364 LyXAction::func_attrib flag) const
3366 info_map::const_iterator ici = lyx_info_map.find(action);
3368 if (ici == lyx_info_map.end()) {
3369 LYXERR0("action: " << action << " is not known.");
3370 LASSERT(false, /**/);
3373 return ici->second.attrib & flag;
3377 LyXAction::const_func_iterator LyXAction::func_begin() const
3379 return lyx_func_map.begin();
3383 LyXAction::const_func_iterator LyXAction::func_end() const
3385 return lyx_func_map.end();
3389 LyXErr & operator<<(LyXErr & l, FuncCode code)
3391 if (l.enabled())
3392 l.stream() << lyxaction.getActionName(code);
3393 return l;
3396 } // namespace lyx