Update doxy.
[lyx.git] / src / LyXAction.cpp
blob5b0745312024b6ba1fcaeb42f11de935b7473e27
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[s]|lyxrc|package|textclass|menu|buffer \n
409 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
410 description. \n
411 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
412 lyxrc: name of rc_entry (e.g. bind_file) \n
413 package: name of latex package (e.g. listings) \n
414 textclass: name of textclass (e.g. article) \n
415 menu: name of lfun used in menu \n
416 icon: name of lfun used in toolbar \n
417 buffer: "name"|"path"|"class"
418 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
419 * \li Origin: bpeng, 7 Oct 2007
420 * \endvar
422 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
424 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
425 * \li Action: Inserts branch inset.
426 * \li Syntax: branch-insert <BRANCH-NAME>
427 * \li Origin: vermeer, 17 Aug 2003
428 * \endvar
430 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
432 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
433 * \li Action: Inserts Box inset.
434 * \li Syntax: box-insert [<TYPE>]
435 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
436 Framed is the default one.
437 * \li Origin: vermeer, 7 Oct 2003
438 * \endvar
440 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
442 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
443 * \li Action: Inserts CharStyle, Custom inset or XML short element.
444 * \li Notion: Look into the Customization manual for more information about
445 these elements.\n
446 To make this command enabled the layout file for the document
447 class you're using has to load the character styles. There are
448 a few contained in the Logical Markup module. You can also of
449 course create some yourself. \n
450 For dissolving the element see #LFUN_INSET_DISSOLVE.
451 * \li Syntax: flex-insert <TYPE:Name>
452 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
453 Identifies whether this is a Character Style, a
454 Custom Inset or an XML Element, and which dynamical
455 sub-menu this flex inset is in on the LyX menu tree.
456 If Standard (currently unused): none of these.\n
457 Name: This name must be defined either in your layout file
458 or imported by some module. The definition is
459 InsetLayout <TYPE:Name>
460 * \li Sample: flex-insert CharStyle:Code
461 * \endvar
463 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
465 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
466 * \li Action: Inserts the given string (accordingly to the correct keymap).
467 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
468 settings "auto_region_delete".
469 * \li Syntax: self-insert <STRING>
470 * \endvar
472 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
474 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
475 * \li Action: Inserts one of horizontal space insets.
476 * \li Syntax: space-insert <NAME> [<LEN>]
477 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
478 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
479 hspace* \n
480 <LEN>: length for custom spaces (hspace, hspace* for protected)
481 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
482 * \endvar
484 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
486 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
487 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
488 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
489 * \li Syntax: href-insert [<TARGET>]
490 * \li Origin: CFO-G, 21 Nov 1997
491 * \endvar
493 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
495 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
496 * \li Action: Inserts various characters into the document.
497 * \li Syntax: specialchar-insert <CHAR>
498 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
499 end-of-sentence, menu-separator.
500 * \li Origin: JSpitzm, 6 Dec 2007
501 * \endvar
503 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
505 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
506 * \li Action: Inserts table of contents.
507 * \li Syntax: toc-insert
508 * \li Origin: Lgb, 27 May 97
509 * \endvar
511 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
513 * \var lyx::FuncCode lyx::LFUN_APPENDIX
514 * \li Action: Start (or remove) Appendix on the given cursor position.
515 * \li Syntax: appendix
516 * \li Origin: ettrich, 5 May 1998
517 * \endvar
519 { LFUN_APPENDIX, "appendix", Noop, Edit },
522 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
523 * \li Action: Inserts Index entry.
524 * \li Notion: It automatically takes the word on the cursor position.
525 * \li Syntax: index-insert [<TYPE:Name>]
526 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
527 with an empty argument, the default index is selected.
528 * \li Origin: leeming, 3 Aug 2000
529 * \endvar
531 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
533 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
534 * \li Action: Inserts list of Index entries on a new page.
535 * \li Syntax: index-print [<TYPE:Name>]
536 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
537 with an empty argument, the default index is selected.
538 * \li Origin: Lgb, 27 Feb 1997
539 * \endvar
541 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
544 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
545 * \li Action: Inserts Nomenclature entry.
546 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
547 * \li Syntax: nomencl-insert [<SYMBOL>]
548 * \li Origin: Ugras, 4 Nov 2006
549 * \endvar
551 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
553 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
554 * \li Action: Inserts list of Nomenclature entries.
555 * \li Syntax: nomenclature-print
556 * \li Origin: Ugras, 4 Nov 2006
557 * \endvar
559 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
562 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
563 * \li Action: Inserts Note on the current cursor postion,
564 move selection inside the inset.
565 * \li Syntax: note-insert [<TYPE>]
566 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
567 * \endvar
569 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
571 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
572 * \li Action: Moves the cursor to the begining of next Note inset.
573 * \li Syntax: note-next
574 * \endvar
576 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
578 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
579 * \li Action: Changes all Note insets of a particular type (source)
580 to a different type (target) fot the current document.
581 * \li Syntax: notes-mutate <SOURCE> <TARGET>
582 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
583 * \li Origin: sanda, 18 Jun 2008
584 * \endvar
586 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
588 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
589 * \li Action: Inserts phantom on the current cursor postion,
590 move selection inside the inset.
591 * \li Syntax: phantom-insert [<TYPE>]
592 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
593 * \li Origin: uwestoehr, 30 Jan 2009
594 * \endvar
596 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
598 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
599 * \li Action: Inserts a line break or new line.
600 * \li Syntax: newline-insert [<ARG>]
601 * \li Params: <ARG>: <newline|linebreak> default: newline
602 * \li Origin: JSpitzm, 25 Mar 2008
603 * \endvar
605 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
607 * \var lyx::FuncCode lyx::LFUN_ESCAPE
608 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
609 * \li Syntax: escape
610 * \li Origin: Lgb, 17 May 2001
611 * \endvar
613 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
615 * \var lyx::FuncCode lyx::LFUN_DOWN
616 * \li Action: Moves the cursor one line in downward direction.
617 * \li Syntax: down
618 * \endvar
620 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
622 * \var lyx::FuncCode lyx::LFUN_UP
623 * \li Action: Moves the cursor one line in upward direction.
624 * \li Syntax: up
625 * \endvar
627 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
629 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
630 * \li Action: Moves the cursor one line in downward direction adding the current
631 position to the selection.
632 * \li Syntax: down-select
633 * \endvar
635 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
637 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
638 * \li Action: Moves the cursor one line in upward direction adding the current
639 position to the selection.
640 * \li Syntax: up-select
641 * \endvar
643 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
645 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
646 * \li Action: Moves the cursor one page in downward direction.
647 * \li Syntax: screen-down
648 * \endvar
650 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
652 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
653 * \li Action: Moves the cursor one page in upward direction.
654 * \li Syntax: screen-up
655 * \endvar
657 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
659 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
660 * \li Action: Moves the cursor one screen in downward direction adding the current
661 position to the selection.
662 * \li Syntax: screen-down-select
663 * \endvar
665 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
667 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
668 * \li Action: Moves the cursor one page in upward direction adding the current
669 position to the selection.
670 * \li Syntax: screen-up-select
671 * \endvar
673 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
675 * \var lyx::FuncCode lyx::LFUN_SCROLL
676 * \li Action: Scroll the buffer view.
677 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
678 * \li Syntax: scroll <TYPE> <QUANTITY>
679 * \li Params: <TYPE>: line|page\n
680 <QUANTITY>: up|down|<number>
681 * \li Origin: Abdel, Dec 27 2007
682 * \endvar
684 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
686 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
687 * \li Action: Recenters the screen on the current cursor position.
688 * \li Syntax: screen-recenter
689 * \endvar
691 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
694 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
695 * \li Action: Repositions the screen such that the cursor is visible.
696 * \li Syntax: screen-show-cursor
697 * \li Origin: vfr, 25 Mar 2009
698 * \endvar
700 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
703 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
704 * \li Action: Moves the cursor one position logically backwards.
705 * \li Notion: This is not the action which should be bound to the arrow keys,
706 because backwards may be left or right, depending on the
707 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
708 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
709 * \li Syntax: char-backward
710 * \endvar
712 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
714 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
715 * \li Action: Moves the cursor one position logically backwards, adding
716 traversed position to the selection.
717 * \li Notion: See also #LFUN_CHAR_BACKWARD.
718 * \li Syntax: char-backward-select
719 * \endvar
721 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
723 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
724 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
725 * \li Syntax: char-delete-backward
726 * \endvar
728 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
730 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
731 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
732 * \li Syntax: char-delete-forward
733 * \endvar
735 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
737 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
738 * \li Action: Moves the cursor one position logically forward.
739 * \li Notion: This is not the action which should be bound to the arrow keys,
740 because forward may be left or right, depending on the language.
741 The arrow keys should be bound to #LFUN_CHAR_LEFT or
742 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
743 * \li Syntax: char-forward
744 * \endvar
746 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
748 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
749 * \li Action: Moves the cursor one position logically forward, adding
750 traversed position to the selection.
751 * \li Notion: See also #LFUN_CHAR_FORWARD.
752 * \li Syntax: char-forward-select
753 * \endvar
755 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
757 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
758 * \li Action: Moves the cursor one position "to the left".
759 * \li Notion: This is the action which should be taken when the "left" key
760 is pressed. Generally, it moves the cursor one position to the
761 left. However, in Bidi text this become slightly more
762 complicated, and there are different modes of cursor movement.
763 In "visual mode", this moves left, plain and simple. In "logical
764 mode", movement is logically forward in RTL paragraphs, and
765 logically backwards in LTR paragraphs.
766 * \li Syntax: char-left
767 * \endvar
769 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
771 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
772 * \li Action: Moves the cursor one position "to the left", adding
773 traversed position to the selection.
774 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
775 * \li Syntax: char-left-select
776 * \endvar
778 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
780 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
781 * \li Action: Moves the cursor one position "to the right".
782 * \li Notion: This is the action which should be taken when the "right" key
783 is pressed. Generally, it moves the cursor one position to the
784 right. However, in Bidi text this become slightly more
785 complicated, and there are different modes of cursor movement.
786 In "visual mode", this moves right, plain and simple. In "logical
787 mode", movement is logically forward in LTR paragraphs, and
788 logically backwards in RTL paragraphs.
789 * \li Syntax: char-right
790 * \endvar
792 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
794 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
795 * \li Action: Moves the cursor one position "to the right", adding
796 traversed position to the selection.
797 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
798 * \li Syntax: char-right-select
799 * \endvar
801 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
804 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
805 * \li Action: Moves the cursor to the logically previous beginning of a word.
806 * \li Notion: This is not the action which should be bound to the arrow keys,
807 because backwards may be left or right, depending on the
808 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
809 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
810 * \li Syntax: word-backward
811 * \endvar
813 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
815 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
816 * \li Action: Moves the cursor to the logically previous beginning of a word,
817 adding the logically traversed text to the selection.
818 * \li Notion: See also #LFUN_WORD_BACKWARD.
819 * \li Syntax: word-backward-select
820 * \endvar
822 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
824 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
825 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
826 * \li Syntax: word-delete-backward
827 * \endvar
829 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
831 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
832 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
833 * \li Syntax: word-delete-forward
834 * \endvar
836 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
838 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
839 * \li Action: Search for a given string in forward direction.
840 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
841 * \li Syntax: word-find-forward [<STRING>]
842 * \li Origin: Etienne, 16 Feb 1998
843 * \endvar
845 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
847 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
848 * \li Action: Search for a given string in backward direction.
849 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
850 * \li Syntax: word-find-backward [<STRING>]
851 * \li Origin: Etienne, 20 Feb 1998
852 * \endvar
854 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
856 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
857 * \li Action: Search for next occurence of a string.
858 * \li Syntax: word-find [<DATA>]
859 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
860 If no parameter is given, search with last find-dialog
861 data is used for search (i.e. find-next).
862 * \li Origin: Andre, Jan 7 2004
863 * \endvar
865 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
867 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
868 * \li Action: Replace a string in the document.
869 * \li Syntax: word-replace [<DATA>]
870 * \li Params: <DATA>: data is of the form
871 "<replace> \n
872 <search> \n
873 <casesensitive> <matchword> <all> <forward>"
874 * \li Origin: Andre, Jan 7 2004
875 * \endvar
877 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
879 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
880 * \li Action: Search for next occurence of a pattern.
881 * \li Syntax: word-findadv [<DATA>]
882 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
883 If no parameter is given, search with last find-dialog
884 data is used for search (i.e. find-next).
885 * \li Origin: Tommaso, Nov 15 2007
886 * \endvar
888 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly, Edit },
890 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
891 * \li Action: Moves the cursor to the logically next beginning of a word.
892 * \li Notion: This is not the action which should be bound to the arrow keys,
893 because forward may be left or right, depending on the language.
894 The arrow keys should be bound to #LFUN_WORD_LEFT or
895 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
896 * \li Syntax: word-forward
897 * \endvar
899 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
901 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
902 * \li Action: Moves the cursor to the logically next beginning of a word,
903 adding the logically traversed text to the selection.
904 * \li Notion: See also #LFUN_WORD_FORWARD.
905 * \li Syntax: word-forward-select
906 * \endvar
908 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
910 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
911 * \li Action: Moves the cursor to the next beginning of a word "on the left".
912 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
913 "left" key is pressed. Generally, it moves the cursor to the
914 next beginning of a word on the left. However, in Bidi text this
915 become slightly more complicated, and there are different modes
916 of cursor movement. In "visual mode", this moves left, plain and
917 simple. In "logical mode", movement is logically forward in RTL
918 paragraphs, and logically backwards in LTR paragraphs.
919 * \li Syntax: word-left
920 * \li Origin: dov, 28 Oct 2007
921 * \endvar
923 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
925 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
926 * \li Action: Moves the cursor to the next beginning of a word "on the left",
927 adding *logically* traversed text to the selection.
928 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
929 * \li Syntax: word-left-select
930 * \li Origin: dov, 28 Oct 2007
931 * \endvar
933 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
935 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
936 * \li Action: Moves the cursor to the next beginning of a word "on the right".
937 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
938 "right" key is pressed. Generally, it moves the cursor to the
939 next beginning of a word on the right. However, in Bidi text
940 this become slightly more complicated, and there are different
941 modes of cursor movement. In "visual mode", this moves right,
942 plain and simple. In "logical mode", movement is logically
943 forward in LTR paragraphs, and logically backwards in RTL
944 paragraphs.
945 * \li Syntax: word-right
946 * \li Origin: dov, 28 Oct 2007
947 * \endvar
949 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
951 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
952 * \li Action: Moves the cursor to the next beginning of a word "on the right",
953 adding *logically* traversed text to the selection.
954 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
955 * \li Syntax: word-right-select
956 * \li Origin: dov, 28 Oct 2007
957 * \endvar
959 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
961 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
962 * \li Action: Puts the word where the cursor stands into the selection.
963 * \li Syntax: word-select
964 * \li Origin: Andre, 11 Sep 2002
965 * \endvar
967 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
969 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
970 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
971 or the letter on the cursor position.
972 * \li Syntax: word-capitalize
973 * \endvar
975 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
977 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
978 * \li Action: Change the words in the selection or from the cursor position
979 to the end of word to the upper case.
980 * \li Syntax: word-upcase
981 * \endvar
983 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
985 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
986 * \li Action: Change the words in the selection or from the cursor position
987 to the end of word to the lower case.
988 * \li Syntax: word-lowcase
989 * \endvar
991 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
993 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
994 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
995 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
996 * \li Params: <STRING>: word to look up
997 <LANG>: language (see file languages)
998 * \li Origin: Levon, 20 Jul 2001
999 * \endvar
1001 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1003 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1004 * \li Action: Move the cursor to the beginning of the document.
1005 * \li Syntax: buffer-begin
1006 * \endvar
1008 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1010 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1011 * \li Action: Move the cursor to the beginning of the document adding the
1012 traversed text to the selection.
1013 * \li Syntax: buffer-begin-select
1014 * \endvar
1016 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1018 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1019 * \li Action: Move the cursor to the end of the document.
1020 * \li Syntax: buffer-end
1021 * \endvar
1023 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1025 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1026 * \li Action: Move the cursor to the end of the document adding the
1027 traversed text to the selection.
1028 * \li Syntax: buffer-end-select
1029 * \endvar
1031 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1034 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1035 * \li Action: Move the cursor to the beginning of the current inset
1036 if it is not already there, or at the beginning of the
1037 enclosing inset otherwise
1038 * \li Syntax: inset-begin
1039 * \li Origin: lasgouttes, 16 Mar 2009
1040 * \endvar
1042 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1044 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1045 * \li Action: Move the cursor to the beginning of the current inset
1046 if it is not already there, or at the beginning of the
1047 enclosing inset otherwise (adding the
1048 traversed text to the selection).
1049 * \li Syntax: inset-begin-select
1050 * \li Origin: lasgouttes, 16 Mar 2009
1051 * \endvar
1053 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1055 * \var lyx::FuncCode lyx::LFUN_INSET_END
1056 * \li Action: Move the cursor to the end of the current inset
1057 if it is not already there, or at the end of the
1058 enclosing inset otherwise
1059 * \li Syntax: inset-end
1060 * \li Origin: lasgouttes, 16 Mar 2009
1061 * \endvar
1063 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1066 * \li Action: Move the cursor to the end of the current inset
1067 if it is not already there, or at the end of the
1068 enclosing inset otherwise (adding the
1069 traversed text to the selection).
1070 * \li Syntax: inset-end-select
1071 * \li Origin: lasgouttes, 16 Mar 2009
1072 * \endvar
1074 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1077 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1078 * \li Action: Move the cursor to the begining of the (screen) line.
1079 * \li Syntax: line-begin
1080 * \endvar
1082 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1084 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1085 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1086 traversed text to the selection.
1087 * \li Syntax: line-begin-select
1088 * \endvar
1090 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1092 * \var lyx::FuncCode lyx::LFUN_LINE_END
1093 * \li Action: Move the cursor to the end of the (screen) line.
1094 * \li Syntax: line-end
1095 * \endvar
1097 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1099 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1100 * \li Action: Move the cursor to the end of the (screen) line adding the
1101 traversed text to the selection.
1102 * \li Syntax: line-end-select
1103 * \endvar
1105 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1107 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1108 * \li Action: Deletes the letters to the end of the (screen) line or
1109 deletes the selection.
1110 * \li Syntax: line-delete-forward
1111 * \endvar
1113 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1115 * \var lyx::FuncCode lyx::LFUN_COPY
1116 * \li Action: Copies to the clipboard the last edit.
1117 * \li Syntax: copy
1118 * \endvar
1120 { LFUN_COPY, "copy", ReadOnly, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_CUT
1123 * \li Action: Cuts to the clipboard.
1124 * \li Syntax: cut
1125 * \endvar
1127 { LFUN_CUT, "cut", Noop, Edit },
1129 * \var lyx::FuncCode lyx::LFUN_PASTE
1130 * \li Action: Pastes material (text or picture) from the active clipboard.
1131 * \li Syntax: paste [<TYPE>|<NUM>]
1132 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1133 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1134 * \endvar
1136 { LFUN_PASTE, "paste", Noop, Edit },
1138 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1139 * \li Action: Pastes text from the active clipboard.
1140 * \li Syntax: clipboard-paste [<ARG>]
1141 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1142 * \li Origin: baum, 10 Jul 2006
1143 * \endvar
1145 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1147 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1148 * \li Action: Pastes the currently text selected text.
1149 * \li Notion: Primary selection mechanism is linux-only thing.
1150 * \li Syntax: primary-selection-paste [<ARG>]
1151 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1152 * \endvar
1154 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1156 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1157 * \li Action: Pastes the text in permanent selection.
1158 * \li Syntax: selection-paste
1159 * \endvar
1161 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1163 * \var lyx::FuncCode lyx::LFUN_UNDO
1164 * \li Action: Undoes the last edit.
1165 * \li Syntax: undo
1166 * \endvar
1168 { LFUN_UNDO, "undo", Noop, Edit },
1170 * \var lyx::FuncCode lyx::LFUN_REDO
1171 * \li Action: Redoes the last thing undone.
1172 * \li Syntax: redo
1173 * \endvar
1175 { LFUN_REDO, "redo", Noop, Edit },
1177 * \var lyx::FuncCode lyx::LFUN_REPEAT
1178 * \li Action: Repeat the given command.
1179 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1180 * \li Origin: Andre, 27 Oct 2003
1181 * \endvar
1183 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1185 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1186 * \li Action: Transposes the character at the cursor with the one before it.
1187 * \li Syntax: chars-transpose
1188 * \li Origin: Lgb, 25 Apr 2001
1189 * \endvar
1191 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1194 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1195 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1196 inside lists.
1197 * \li Syntax: depth-decrement
1198 * \endvar
1200 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1202 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1203 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1204 inside lists.
1205 * \li Syntax: depth-increment
1206 * \endvar
1208 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1211 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1212 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1213 * \li Syntax: font-bold
1214 * \endvar
1216 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1219 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1220 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1221 * \li Syntax: font-boldsymbol
1222 * \endvar
1224 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1226 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1227 * \li Action: Toggles the typewriter family font (selection-wise).
1228 * \li Syntax: font-typewriter
1229 * \endvar
1231 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1233 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1234 * \li Action: Toggles underline in the font (selection-wise).
1235 * \li Syntax: font-underline
1236 * \endvar
1238 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1240 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1241 * \li Action: Toggles double underline in the font (selection-wise).
1242 * \li Syntax: font-underunderline
1243 * \li Origin: sanda, 5 May 2009
1244 * \endvar
1246 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1248 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1249 * \li Action: Toggles wavy underline in the font (selection-wise).
1250 * \li Syntax: font-underwave
1251 * \li Origin: sanda, 5 May 2009
1252 * \endvar
1254 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1256 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1257 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1258 * \li Syntax: font-strikeout
1259 * \li Origin: sanda, 3 May 2009
1260 * \endvar
1262 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1264 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1265 * \li Action: Toggles the emphasis font style (selection-wise).
1266 * \li Syntax: font-emph
1267 * \endvar
1269 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1271 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1272 * \li Action: Toggles Noun text style font (selection-wise).
1273 * \li Syntax: font-noun
1274 * \endvar
1276 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1278 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1279 * \li Action: Toggles Roman family font (selection-wise).
1280 * \li Syntax: font-roman
1281 * \endvar
1283 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1285 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1286 * \li Action: Toggles Sans Serif family font (selection-wise).
1287 * \li Syntax: font-sans
1288 * \endvar
1290 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1292 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1293 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1294 * \li Syntax: font-frak
1295 * \li Origin: vermeer, 10 Jan 2002
1296 * \endvar
1298 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1300 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1301 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1302 * \li Syntax: font-ital
1303 * \li Origin: vermeer, 10 Jan 2002
1304 * \endvar
1306 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1308 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1309 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1310 * \li Syntax: font-default
1311 * \endvar
1313 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1315 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1316 * \li Action: Sets font size according to lyx format string.
1317 * \li Syntax: font-size <SIZE>
1318 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1319 largest|huge|giant|increase|decrease|default
1320 * \endvar
1322 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1324 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1325 * \li Action: Toggle user-defined (=last-time used) text style.
1326 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1327 automatically trigerred when using Text Style dialog.
1328 * \li Syntax: textstyle-apply
1329 * \li Origin: leeming, 12 Mar 2003
1330 * \endvar
1332 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1334 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1335 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1336 * \li Syntax: textstyle-update <FONT_INFO>
1337 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1338 size, emph, noun, underbar, number, color, language,
1339 toggleall.\n
1340 Use lyx -dbg action for exact syntax of text-style
1341 dialog parameters.
1342 * \li Origin: leeming, 12 Mar 2003
1343 * \endvar
1345 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1347 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1348 * \li Action: Update fonts and its metrics.
1349 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1350 * \li Syntax: screen-font-update
1351 * \li Origin: ARRae, 13 Aug 2000
1352 * \endvar
1354 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1356 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1357 * \li Action: Returns the info about the current font.
1358 * \li Syntax: font-state
1359 * \endvar
1361 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1364 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1365 * \li Action: Inserts citation from loaded citation database.
1366 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1367 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1368 <TEXT_BEFORE>: text which should appear before citation.
1369 * \li Origin: AAS, 97-02-23
1370 * \endvar
1372 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1374 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1375 * \li Action: Adds database, which will be used for bibtex citations.
1376 * \li Notion: Databases are added to the first BibTeX inset
1377 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1378 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1379 * \li Origin: Ale, 30 May 1997
1380 * \endvar
1382 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1384 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1385 * \li Action: Adds database, which will be used for bibtex citations.
1386 * \li Notion: Databases are deleted from the first BibTeX inset
1387 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1388 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1389 * \li Origin: Ale, 30 May 1997
1390 * \endvar
1392 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1395 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1396 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1397 * \li Syntax: layout <LAYOUT>
1398 * \li Params: <LAYOUT>: the layout to use
1399 * \endvar
1401 { LFUN_LAYOUT, "layout", Noop, Layout },
1403 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1404 * \li Action: Launches the paragraph settings dialog.
1405 * \li Syntax: layout-paragraph
1406 * \endvar
1408 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1410 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1411 * \li Action: Launches the tabular settings dialog.
1412 * \li Syntax: layout-tabular
1413 * \li Origin: Jug, 31 Jul 2000
1414 * \endvar
1416 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1418 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1419 * \li Action: Displays list of layout choices.
1420 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1421 dropbox allowing for choice of layout.
1422 * \li Syntax: drop-layouts-choice
1423 * \endvar
1425 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1427 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1428 * \li Action: Clears the module list.
1429 * \li Notion: Clears the list of included modules for the current buffer.
1430 * \li Syntax: layout-modules-clear
1431 * \li Origin: rgh, 25 August 2007
1432 * \endvar
1434 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1436 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1437 * \li Action: Adds a module.
1438 * \li Notion: Adds a module to the list of included modules for the current buffer.
1439 * \li Syntax: layout-module-add <MODULE>
1440 * \li Params: <MODULE>: the module to be added
1441 * \li Origin: rgh, 25 August 2007
1442 * \endvar
1444 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1446 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1447 * \li Action: Reloads layout information.
1448 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1449 recognizing any changes that have been made to layout files on the fly.
1450 This is intended to be used only by layout developers and should not be
1451 used when one is trying to do actual work.
1452 * \li Syntax: layout-reload
1453 * \li Origin: rgh, 3 September 2007
1454 * \endvar
1456 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1458 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1459 * \li Action: Sets the text class for the current buffer.
1460 * \li Syntax: textclass-apply <TEXTCLASS>
1461 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1462 the filename, minus the ".layout" extension.
1463 * \endvar
1465 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1467 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1468 * \li Action: Loads information for a textclass from disk.
1469 * \li Syntax: textclass-load <TEXTCLASS>
1470 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1471 the filename, minus the ".layout" extension.
1472 * \endvar
1474 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1477 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1478 * \li Action: Disable selecting of text-region.
1479 * \li Syntax: mark-off
1480 * \endvar
1482 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1484 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1485 * \li Action: Enable selecting of text-region.
1486 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1487 * \li Syntax: mark-on
1488 * \endvar
1490 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1492 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1493 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1494 * \li Syntax: mark-toggle
1495 * \li Origin: Andre, May 5 2006
1496 * \endvar
1498 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1501 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1502 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1503 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1504 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1505 either a LaTeX name or a valid character.
1506 ( is the default letter.
1507 * \li Sample: math-delim { rangle
1508 * \li Origin: Alejandro, 18 Jun 1996
1509 * \endvar
1511 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1513 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1514 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1515 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1516 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1517 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1518 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1519 * \li Origin: Enrico & Georg, 7 May 2006
1520 * \endvar
1522 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1524 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1525 * \li Action: Creates a new displayed equation in text mode.
1526 Toggles inlined/display formula in math mode.
1527 * \li Syntax: math-display [<ARG>]
1528 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1529 new equation from the text mode.
1530 * \li Origin: Alejandro, 18 Jun 1996
1531 * \endvar
1533 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1535 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1536 * \li Action: Inserts math objects and symbols.
1537 * \li Syntax: math-insert <ARG>
1538 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1539 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1540 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1541 replaced by the current selection (only works if the selection
1542 is in mathed). As an example, if "abc" is selected in mathed,
1543 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1544 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1545 If nothing is selected (or the selection is not in mathed),
1546 math-insert works as expected.
1547 * \endvar
1549 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1551 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1552 * \li Action: Enters subscript expression in math expression.
1553 * \li Syntax: math-subscript
1554 * \li Origin: vermeer, 12 Dec 2001
1555 * \endvar
1557 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1559 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1560 * \li Action: Enters subscript expression in math expression.
1561 * \li Syntax: math-superscript
1562 * \li Origin: vermeer, 12 Dec 2001
1563 * \endvar
1565 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1567 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1568 * \li Action: Toggles the position of the limits from above/below to the right
1569 side an vice versa in integral symbol, a limit, a summation, etc.
1570 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1571 math-limits.
1572 * \li Syntax: math-limits [<STATE>]
1573 * \li Params: <STATE>: limits|nolimits
1574 * \endvar
1576 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1578 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1579 * \li Action: Inserts a math macro definition at the cursor position in the text.
1580 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1581 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1582 <NARGS>: The number of parameters of the macro. Default is 0.
1583 "def": Has no effect anymore, just for compatibility with former LyX versions.
1584 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1585 * \endvar
1587 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1589 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1590 * \li Action: Mutates the type of math inset to the newly selected one.
1591 * \li Syntax: math-mutate <TYPE>
1592 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1593 multline|gather|flalign
1594 * \li Origin: Andre, 23 May 2001
1595 * \endvar
1597 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1599 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1600 * \li Action: Inserts space into math expression.
1601 * \li Notion: Use spacebar after entering this space to change type of space.
1602 * \li Syntax: math-space [<TYPE>] [<LEN>]
1603 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1604 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1605 custom space: hspace \n
1606 "," used by default.\n
1607 Note that ! is equivalent to negthinspace, , = thinspace,
1608 : = medspace, and ; = thickspace.\n
1609 <LEN>: length for custom spaces (hspace)
1610 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1611 * \endvar
1613 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1615 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1616 * \li Action: Inserts a matrix.
1617 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1618 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1619 (b, c or t) (i.e. 1 char) and the horizontal alignments
1620 (l, c or r) (i.e. <COL> chars).
1621 * \li Sample: math-matrix 3 3 bccc
1622 * \endvar
1624 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1626 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1627 * \li Action: Inserts a matrix.
1628 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1629 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1630 that should be created.
1631 * \li Sample: math-ams-matrix 3 3 bmatrix
1632 * \endvar
1634 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1636 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1637 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1638 cursor position), in math mode enters text mode inside math expression.
1639 * \li Notion: If there is some selected text, it puts the text inside created math box.
1640 * \li Syntax: math-mode [on|<ARG>]
1641 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1642 "on": allow only entering of math mode from text mode.
1643 * \li Origin: Alejandro, 4 Jun 1996
1644 * \endvar
1646 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1648 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1649 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1650 cursor position). Used by the advanced search dialog.
1651 * \li Notion: If there is any selected text, then it is moved inside the created
1652 regexp inset.
1653 * \li Syntax: regexp-mode [<ARG>]
1654 * \li Params: <ARG>: eventual argument (regular expression).
1655 * \li Origin: Tommaso, 4 Oct 2008
1656 * \endvar
1658 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1660 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1661 * \li Action: Toggles numbering of the current formula line.
1662 * \li Notion: Must be in display formula mode.
1663 * \li Syntax: math-number-line-toggle
1664 * \li Origin: Alejandro, 18 Jun 1996
1665 * \endvar
1667 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1669 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1670 * \li Action: Toggles numbering/labeling of the current formula.
1671 * \li Notion: Must be in display formula mode.
1672 * \li Syntax: math-number-toggle
1673 * \li Origin: Alejandro, 4 Jun 1996
1674 * \endvar
1676 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1678 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1679 * \li Action: Calls external program and passes the current expression/equation
1680 as an argument for the calculation in the format appropriate to the
1681 given language.
1682 * \li Notion: Selection can be used to determine the input for the external program.
1683 * \li Syntax: math-extern <LANG> [<COMMAND>]
1684 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1685 where "script" stands fot the external script (normalized
1686 expression will be passed)
1687 * \li Origin: Andre, 24 Apr 2001
1688 * \li Sample: math-extern maple simplify
1689 * \endvar
1691 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1693 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1694 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1695 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1696 * \li Syntax: math-size <STYLE>
1697 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1698 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1699 * \endvar
1701 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1703 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1704 * \li Action: Changes the text style used in math.
1705 * \li Syntax: math-font-style <STYLE>
1706 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1707 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1708 |textsc|textsl|textup
1709 * \li Origin: vfr, 9 jan 2009
1710 * \endvar
1712 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1714 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1715 * \li Action: Unfold a Math Macro.
1716 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1717 display it as \foo.
1718 * \li Syntax: math-macro-unfold
1719 * \li Origin: sts, 06 January 2008
1720 * \endvar
1722 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1724 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1725 * \li Action: Fold a Math Macro.
1726 * \li Notion: Fold the Math Macro the cursor is in if it was
1727 unfolded, i.e. displayed as \foo before.
1728 * \li Syntax: math-macro-fold
1729 * \li Origin: sts, 06 January 2008
1730 * \endvar
1732 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1734 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1735 * \li Action: Add a parameter.
1736 * \li Notion: Add a parameter to a Math Macro.
1737 * \li Params: <NUM>: The number of the parameter behind which the new one
1738 will be added (1 for the first, i.e. use 0 for add a
1739 parameter at the left), defaults to the last one.
1740 * \li Syntax: math-macro-add-param <NUM>
1741 * \li Origin: sts, 06 January 2008
1742 * \endvar
1744 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1746 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1747 * \li Action: Remove the last parameter.
1748 * \li Notion: Remove the last parameter of a Math Macro and
1749 remove its value in all instances of the macro
1750 in the buffer.
1751 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1752 the first), defaults to the last one.
1753 * \li Syntax: math-macro-remove-param <NUM>
1754 * \li Origin: sts, 06 January 2008
1755 * \endvar
1757 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1759 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1760 * \li Action: Append a greedy parameter.
1761 * \li Notion: Append a greedy parameter to a Math Macro which
1762 eats the following mathed cell in every instance of
1763 the macro in the buffer.
1764 * \li Syntax: math-macro-append-greedy-param
1765 * \li Origin: sts, 06 January 2008
1766 * \endvar
1768 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1770 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1771 * \li Action: Remove a greedy parameter.
1772 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1773 out the values of it in every instance of the macro
1774 in the buffer. If it is an optional parameter the [valud]
1775 format is used.
1776 * \li Syntax: math-macro-remove-greedy-param
1777 * \li Origin: sts, 06 January 2008
1778 * \endvar
1780 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1782 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1783 * \li Action: Make a parameter optional.
1784 * \li Notion: Turn the first non-optional parameter of a Math Macro
1785 into an optional parameter with a default value.
1786 * \li Syntax: math-macro-make-optional
1787 * \li Origin: sts, 06 January 2008
1788 * \endvar
1790 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1792 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1793 * \li Action: Make a parameter non-optional.
1794 * \li Notion: Turn the last optional parameter of a Math Macro
1795 into a non-optional parameter. The default value is
1796 remembered to be reused later if the user changes his mind.
1797 * \li Syntax: math-macro-make-nonoptional
1798 * \li Origin: sts, 06 January 2008
1799 * \endvar
1801 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1803 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1804 * \li Action: Add an optional parameter.
1805 * \li Notion: Insert an optional parameter just behind the
1806 already existing optional parameters.
1807 * \li Syntax: math-macro-add-optional-param
1808 * \li Origin: sts, 06 January 2008
1809 * \endvar
1811 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1813 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1814 * \li Action: Remove the last optional parameter.
1815 * \li Notion: Remove the last optional parameter of a Math Macro and
1816 remove it in all the instances of the macro in the buffer.
1817 * \li Syntax: math-macro-remove-optional-param
1818 * \li Origin: sts, 06 January 2008
1819 * \endvar
1821 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1823 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1824 * \li Action: Add a greedy optional parameter.
1825 * \li Notion: Add a greedy optional parameter which eats the value
1826 from the following cells in mathed which are in the [value]
1827 format.
1828 * \li Syntax: math-macro-add-greedy-optional-param
1829 * \li Origin: sts, 06 January 2008
1830 * \endvar
1832 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1834 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1835 * \li Action: Only active in Math Macro definition.
1836 * \li Notion: Dummy function which is only active in a Math Macro definition.
1837 It's used to toggle the Math Macro toolbar if the cursor moves
1838 into a Math Macro definition.
1839 * \li Syntax: in-mathmacrotemplate
1840 * \li Origin: sts, 06 January 2008
1841 * \endvar
1843 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1846 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1847 * \li Action: Moves the current paragraph downwards in the document.
1848 * \li Syntax: paragraph-move-down
1849 * \li Origin: Edwin, 8 Apr 2006
1850 * \endvar
1852 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1854 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1855 * \li Action: Moves the current paragraph upwards in the document.
1856 * \li Syntax: paragraph-move-up
1857 * \li Origin: Edwin, 8 Apr 2006
1858 * \endvar
1860 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1863 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1864 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1865 in upward direction.
1866 * \li Syntax: paragraph-up
1867 * \li Origin: Asger, 1 Oct 1996
1868 * \endvar
1870 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1872 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1873 * \li Action: Move the cursor and select the text to the next paragraph (or
1874 begining of the current one) in upward direction.
1875 * \li Syntax: paragraph-up-select
1876 * \li Origin: Asger, 1 Oct 1996
1877 * \endvar
1879 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1881 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1882 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1883 in downward direction.
1884 * \li Syntax: paragraph-down
1885 * \li Origin: Asger, 1 Oct 1996
1886 * \endvar
1888 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1890 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1891 * \li Action: Move the cursor and select the text to the next paragraph (or
1892 begining of the current one) in downward direction.
1893 * \li Syntax: paragraph-down-select
1894 * \li Origin: Asger, 1 Oct 1996
1895 * \endvar
1897 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1899 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1900 * \li Action: Jump to a paragraph given by its id number and optionally the
1901 desired position within the paragraph.
1902 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1903 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1904 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1905 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1906 <POSITION_IN_PAR>: desired position within the paragraph
1907 * \li Origin: Dekel, 26 Aug 2000
1908 * \endvar
1910 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1912 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1913 * \li Action: Breaks the current paragraph at the current location.
1914 * \li Syntax: break-paragraph
1915 * \endvar
1917 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1919 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1920 * \li Action: Breaks the current paragraph at the current location.
1921 * \li Notion: Removes the selection.
1922 * \li Syntax: break-paragraph [<LAYOUT>]
1923 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1924 to default layout) when the cursor is at the end of
1925 the line.
1926 * \endvar
1928 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1930 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1931 * \li Action: Change paragraph settings.
1932 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1933 This function only modifies, and does not override, existing settings.
1934 Note that the "leftindent" indent setting is deprecated.
1935 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1936 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1937 <SPACING>: \paragraph_spacing default|single|onehalf|double|other\n
1938 <ALIGN>: \align block|left|right|center|default\n
1939 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1940 * \li Origin: rgh, Aug 15 2007
1941 * \endvar
1943 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1945 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1946 * \li Action: Change paragraph settings.
1947 * \li Notion: Overwrite all nonspecified settings to the default ones.
1948 Use paragraph-params lfun if you don't want to overwrite others settings.
1949 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1950 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1951 * \li Origin: leeming, 30 Mar 2004
1952 * \endvar
1954 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1956 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1957 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1958 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1959 by #LFUN_DIALOG_UPDATE.
1960 * \li Origin: leeming, 13 Mar 2003
1961 * \endvar
1963 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1966 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1967 * \li Action: Move the current group in the upward direction in the
1968 structure of the document.
1969 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1970 the whole substructure of the group.
1971 * \li Syntax: outline-up
1972 * \li Origin: Vermeer, 23 Mar 2006
1973 * \endvar
1975 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1977 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1978 * \li Action: Move the current group in the downward direction in the
1979 structure of the document.
1980 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1981 the whole substructure of the group.
1982 * \li Syntax: outline-down
1983 * \li Origin: Vermeer, 23 Mar 2006
1984 * \endvar
1986 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1988 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1989 * \li Action: Moves the current group in the downward direction in the
1990 hierarchy of the document structure.
1991 * \li Notion: Part -> Chapter -> Section -> etc.
1992 * \li Syntax: outline-in
1993 * \li Origin: Vermeer, 23 Mar 2006
1994 * \endvar
1996 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1998 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1999 * \li Action: Moves the current group in the upward direction in the
2000 hierarchy of the document structure.
2001 * \li Notion: Part <- Chapter <- Section <- etc.
2002 * \li Syntax: outline-out
2003 * \li Origin: Vermeer, 23 Mar 2006
2004 * \endvar
2006 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2009 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DRAGMOVE
2010 * \li Action: Moves the document section associated with the specified
2011 heading to a specified location. Both the heading and the
2012 target paragraph are specified by the paragraph ID numbers.
2013 * \li Notion: The heading is a paragraph with style Part/Chapter/Section/
2014 etc. Id number of the paragraph is not the sequential number
2015 seen on the screen, but an internal number that is unique
2016 for all opened buffers (documents).
2017 * \li Syntax: outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
2018 * \li Params: <PAR_ID_SECTION>: paragraph id of the section heading which
2019 is to be moved. \n
2020 <PAR_ID_DROP_POSITION>: the paragraph id where the section
2021 will be moved to.
2022 * \li Origin: Rob Oakes, 22 June 2009
2023 * \endvar
2025 { LFUN_OUTLINE_DRAGMOVE, "outline-dragmove", Noop, Edit },
2028 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2029 * \li Action: Edit the inset at cursor with an external application,
2030 if one is attributed.
2031 * \li Syntax: inset-edit [<INSET_PARAMS>]
2032 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2033 Currently only the filename will be considered.
2034 * \li Origin: JSpitzm, 27 Apr 2006
2035 * \endvar
2038 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
2041 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2042 * \li Action: Inserts table into the document.
2043 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2044 * \li Params: In case no arguments are given show insert dialog.
2045 * \li Origin: Jug, 12 Apr 2000
2046 * \endvar
2048 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2050 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
2051 * \li Action: Sets various features to the table/cell on the current cursor position.
2052 * \li Notion: Various math-environment features are handled here as well, e.g.
2053 add-vline-left/right for the Grid/Array environment
2054 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
2055 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2056 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2057 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
2058 valign-middle|longtabular-align-left|longtabular-align-center|
2059 longtabular-align-right|m-align-left|m-align-right|m-align-center|
2060 m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|
2061 unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
2062 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2063 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2064 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2065 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2066 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
2067 set-top-space|set-bottom-space|set-interline-space|set-border-lines|
2068 tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n
2069 <ARG>: additional argument for some commands, use debug mode to explore its values.
2070 * \li Origin: Jug, 28 Jul 2000
2071 * \endvar
2073 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
2075 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2076 * \li Action: Moves the cursor to the previous cell inside the table.
2077 * \li Syntax: cell-backward
2078 * \li Origin: Jug, 22 May 2000
2079 * \endvar
2081 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2083 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2084 * \li Action: Moves the cursor to the next cell inside the table.
2085 * \li Syntax: cell-forward
2086 * \endvar
2088 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2090 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2091 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2092 * \li Syntax: cell-split
2093 * \li Origin: Ale, 15 May 1997
2094 * \endvar
2096 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2099 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2100 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2101 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2102 of cvs/svn/rcs entries in the document's directory. \n
2103 See LyX Additional Features Manual (Version Control Chapter) for additional
2104 information.
2105 * \li Syntax: vc-register
2106 * \li Origin: Lgb, 1 Jul 1997
2107 * \endvar
2109 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2111 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2112 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2113 * \li Notion: In RCS case this also unlocks the file.
2114 * \li Syntax: vc-check-in
2115 * \li Origin: Lgb, 1 Jul 1997
2116 * \endvar
2118 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2120 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2121 * \li Action: Checks-out the document for edit (and locks it for RCS).
2122 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2123 * \li Syntax: vc-check-out
2124 * \li Origin: Lgb, 1 Jul 1997
2125 * \endvar
2127 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2129 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2130 * \li Action: Reverts the document to the last check-in/commit in VCS.
2131 * \li Syntax: vc-revert
2132 * \li Origin: Lgb, 1 Jul 1997
2133 * \endvar
2135 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2137 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2138 * \li Action: Undo last check-in.
2139 * \li Notion: This is currently implemented only for RCS.
2140 * \li Syntax: vc-check-out
2141 * \li Origin: Lgb, 1 Jul 1997
2142 * \endvar
2144 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2146 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2147 * \li Action: Executes external command. This command is intended to support
2148 additional VCS commands.
2149 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2150 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2151 U - dUmmy - no flags \n
2152 D - Doc - need document loaded to proceed \n
2153 I - dIrty - mark document dirty \n
2154 R - Reload - ensure that the document is saved and reload it after command execution \n
2155 M - Message - ask for input string (commit message)\n
2156 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2157 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
2158 * \li Sample: vc-command DR $$p "svn up"
2159 * \li Origin: sanda, 13 Jan 2009
2160 * \endvar
2162 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2164 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2165 * \li Action: Toggles the locking property of the edited file.
2166 * \li Notion: This is currently implemented only for SVN.
2167 * \li Syntax: vc-locking-toggle
2168 * \li Origin: sanda, 25 Jun 2009
2169 * \endvar
2171 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2174 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2175 * \li Action: Toggles change tracking to on/off.
2176 * \li Syntax: changes-track
2177 * \li Origin: levon, 1 Oct 2002
2178 * \endvar
2180 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2182 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2183 * \li Action: Toggles showing of change tracking in typesetted output.
2184 * \li Syntax: changes-output
2185 * \li Origin: jspitzm, 21 Jan 2005
2186 * \endvar
2188 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2190 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2191 * \li Action: Moves the cursor to the position of the next change
2192 of the change tracking records.
2193 * \li Syntax: change-next
2194 * \li Origin: schmitt, 4 Oct 2006
2195 * \endvar
2197 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2199 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2200 * \li Action: Moves the cursor to the position of the previous change
2201 of the change tracking records.
2202 * \li Syntax: change-previous
2203 * \li Origin: vfr, 4 Apr 2009
2204 * \endvar
2206 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2208 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2209 * \li Action: Open change tracking dialog for merging and moves the cursor
2210 to the position of the next change.
2211 * \li Syntax: changes-merge
2212 * \li Origin: Levon, 16 Oct 2002
2213 * \endvar
2215 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2217 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2218 * \li Action: Accepts tracked change inside the selection.
2219 * \li Syntax: change-accept
2220 * \li Origin: Levon, 16 Oct 2002
2221 * \endvar
2223 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2225 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2226 * \li Action: Rejects tracked change inside the selection.
2227 * \li Syntax: change-accept
2228 * \li Origin: Levon, 16 Oct 2002
2229 * \endvar
2231 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2233 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2234 * \li Action: Accepts all tracked changes in the document.
2235 * \li Syntax: all-changes-accept
2236 * \li Origin: Levon, 16 Oct 2002
2237 * \endvar
2239 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2241 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2242 * \li Action: Rejects all tracked changes in the document.
2243 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2244 * \li Syntax: all-changes-reject
2245 * \li Origin: Levon, 16 Oct 2002
2246 * \endvar
2248 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2251 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2252 * \li Action: Apply data for an inset.
2253 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2254 be applied. This is either changed to #LFUN_INSET_MODIFY or
2255 #LFUN_INSET_INSERT depending on the context where it is called.
2256 * \li Syntax: inset-apply <ARGS>
2257 * \li Params: See #LFUN_INSET_INSERT .
2258 * \endvar
2260 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2262 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2263 * \li Action: Dissolve the current inset into text.
2264 * \li Syntax: inset-dissolve [<INSET>]
2265 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2266 is dissolved. For example "dissolve" entry in the charstyles
2267 sub-menu should only dissolve the charstyle inset, even if the
2268 cursor is inside several nested insets of different type.\n
2269 For values see #lyx::InsetLayout::lyxtype_ .
2270 * \li Origin: JSpitz, 7 Aug 2006
2271 * \endvar
2273 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2275 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2276 * \li Action: Insert new inset (type given by the parameters).
2277 * \li Syntax: inset-insert <INSET> <ARGS>
2278 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2279 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2280 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2281 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2282 where <label name> is the name of the referenced label and
2283 <Format> is one of the following: \n
2284 ref -- <reference> \n
2285 eqref -- (<reference>) \n
2286 pageref -- <page> \n
2287 vpageref -- on <page> \n
2288 vref -- <reference> on <page> \n
2289 prettyref -- Formatted reference
2290 * \endvar
2292 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2294 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2295 * \li Action: Modify existing inset.
2296 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2297 floats, graphics, include, label, listings, note,
2298 phantom, ref, space, tabular, vspace, wrap insets.
2299 * \li Syntax: inset-modify <INSET> <ARGS>
2300 * \li Params: See #LFUN_INSET_INSERT for further details.
2301 * \endvar
2303 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2305 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2306 * \li Action: Modify the inset at cursor position, if there is one.
2307 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2308 floats, graphics, include, label, listings, note,
2309 phantom, ref, space, tabular, vspace, wrap insets.
2310 * \li Syntax: next-inset-modify <INSET> <ARGS>
2311 * \li Syntax: next-inset-modify changetype <TYPE>
2312 * \li Params: See #LFUN_INSET_INSERT for further details.
2313 * \li Origin: JSpitzm, 23 Mar 2008
2314 * \endvar
2316 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", Noop, Edit },
2318 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2319 * \li Action: Updates the values inside the dialog from the inset.
2320 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2321 by #LFUN_DIALOG_UPDATE
2322 * \li Params: <DIALOG-NAME>
2323 * \li Origin: leeming, 25 Feb 2003
2324 * \endvar
2326 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2328 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2329 * \li Action: Open the inset's properties dialog.
2330 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2331 float, graphics, href, include, index, index_print, label, listings,
2332 note, phantom, ref, space, tabular, vspace, wrap insets.
2333 * \li Syntax: inset-settings <INSET>
2334 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2335 graphics|href|include|index|index_print|label|listings|
2336 note|phantom|ref|space|tabular|vspace|wrap>.
2337 * \endvar
2339 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2341 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2342 * \li Action: Toggles the collapsable inset at cursor position,
2343 or the inset we are currently in.
2344 * \li Syntax: inset-toggle [<ARG>]
2345 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2346 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2347 assign synchronize the branch-inset with activation status of the branch.
2348 Used for global toggling when changed activation.
2349 * \li Origin: lasgouttes, 19 Jul 2001
2350 * \endvar
2352 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2354 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2355 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2356 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2357 * \li Syntax: all-insets-toggle [<STATE>] [<INSET>]
2358 * \li Params: <STATE>: <toggle|open|close|assign> default: toggle \n
2359 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2360 * \li Origin: leeming, 30 Mar 2004
2361 * \endvar
2363 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2365 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2366 * \li Action: Set the group for the graphics inset on the cursor position.
2367 * \li Syntax: set-graphics-group [<GROUP>]
2368 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2369 the graphics inset is removed from the current group.
2370 * \li Origin: sanda, 6 May 2008
2371 * \endvar
2373 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2376 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2377 * \li Action: Moves the cursor out of the current slice, going forward.
2378 * \li Notion: Cursor movement within an inset may be different than cursor
2379 movement in the surrounding text. This action should be called
2380 automatically by the cursor movement within the inset, when
2381 movement within the inset has ceased (reached the end of the
2382 last paragraph, for example), in order to move correctly
2383 back into the surrounding text.
2384 * \endvar
2386 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2388 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2389 * \li Action: Moves the cursor out of the current slice, going backwards.
2390 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2391 * \endvar
2393 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2395 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2396 * \li Action: Moves the cursor out of the current slice, going right.
2397 * \li Notion: See also #LFUN_FINISHED_FORWARD
2398 * \endvar
2400 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2402 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2403 * \li Action: Moves the cursor out of the current slice, going left.
2404 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2405 * \endvar
2407 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2410 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2411 * \li Action: Set language from the current cursor position.
2412 * \li Syntax: language <LANG>
2413 * \li Params: <LANG>: Requested language. Look in lib/languages for
2414 the list.
2415 * \li Origin: Dekel, 2 Mar 2000
2416 * \endvar
2418 { LFUN_LANGUAGE, "language", Noop, Edit },
2421 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2422 * \li Action: Goto a label.
2423 * \li Syntax: label-goto [<LABEL>]
2424 * \li Params: <LABEL>: Requested label. If no label is given and reference
2425 is on cursor position, Bookmark 0 is saved and
2426 cursor moves to the position of referenced label.
2427 * \li Origin: Ale, 6 Aug 1997
2428 * \endvar
2430 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2432 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2433 * \li Action: Inserts label to text or displayed formula.
2434 * \li Syntax: label-insert [<LABEL>]
2435 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2436 name will be opened.
2437 * \endvar
2439 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2441 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2442 * \li Action: Go to the next label or cross-reference.
2443 * \li Syntax: reference-next
2444 * \li Origin: Dekel, 14 Jan 2001
2445 * \endvar
2447 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2450 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2451 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2452 if necessary. Note that bookmarsk are saved per-session, not
2453 per file.
2454 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2455 1. to the paragraph you are currently editing \n
2456 2. to the paragraph from where you are jumping to the last-edited
2457 position (jump-back feature) \n
2458 3. when jumping from crossreference to the requested label by
2459 #LFUN_LABEL_GOTO.
2460 * \li Syntax: bookmark-goto <NUMBER>
2461 * \li Params: <NUMBER>: the number of the bookmark to restore.
2462 * \li Origin: Dekel, 27 January 2001
2463 * \endvar
2465 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2467 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2468 * \li Action: Save a bookmark.
2469 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2470 must be between 1 and 9, inclusive. Note that bookmarks are
2471 saved per-session, not per file.
2472 * \li Syntax: bookmark-save <NUMBER>
2473 * \li Params: <NUMBER>: the number of the bookmark to save.
2474 * \li Origin: Dekel, 27 January 2001
2475 * \endvar
2477 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2479 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2480 * \li Action: Clears the list of saved bookmarks.
2481 * \li Syntax: bookmark-clear
2482 * \li Origin: bpeng, 31 October 2006
2483 * \endvar
2485 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2488 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2489 * \li Action: Open the given help file according to the language setting.
2490 * \li Syntax: help-open <FILE>[.lyx]
2491 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2492 * \li Origin: Jug, 27 Jun 1999
2493 * \endvar
2495 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2497 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2498 * \li Action: Terminates the current LyX instance.
2499 * \li Notion: Terminates the current LyX instance, asking whether to save
2500 modified documents, etc.
2501 * \li Syntax: lyx-quit
2502 * \endvar
2504 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2506 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2507 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2508 * \li Notion: Skiping "auto" when allowauto is false.
2509 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2510 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2511 minibuffer|review|view/update|math_panels|vcs
2512 * \li Origin: Edwin, 21 May 2007
2513 * \endvar
2515 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2517 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2518 * \li Action: Opens the menu given by its name.
2519 * \li Syntax: menu-open <NAME>
2520 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2521 * \endvar
2523 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2525 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2526 * \li Action: Various UI visibility-toggling actions.
2527 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2528 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2529 menubar : Toggle visibility of the menubar.\n
2530 scrollbar : Toggle visibility of the scrollbar.\n
2531 frame : Toggle visibility of the frames around editing window.\n
2532 fullscreen : Toggle fullscreen mode. This also covers calling the
2533 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2534 custom tweaks of the toolbars should be used.
2535 * \li Origin: sanda, 9 Feb 2007
2536 * \endvar
2538 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2541 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2542 * \li Action: Creates new empty LyX window.
2543 * \li Notion: Already opened documents from the previous window can be found under View menu.
2544 * \li Syntax: window-new [<GEOMETRY>]
2545 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2546 accepted only on Windows platform.
2547 * \li Origin: Abdel, 21 Oct 2006
2548 * \endvar
2550 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2552 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2553 * \li Action: Closes the current LyX window.
2554 * \li Syntax: window-close
2555 * \li Origin: Abdel, 23 Oct 2006
2556 * \endvar
2558 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2561 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2562 * \li Action: Creates another split view of current buffer.
2563 * \li Notion: All split views act in the same way indpendently.
2564 * \li Syntax: split-view <vertical|horizontal>
2565 * \li Params: horizontal : The work areas are laid out side by side.\n
2566 vertical : The work areas laid out vertically.
2567 * \li Origin: Abdel, 20 Feb 2008
2568 * \endvar
2570 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2573 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2574 * \li Action: Close the current tab group.
2575 * \li Notion: This only closes the work areas, not the buffer themselves.
2576 The still opened buffers can be visualized in another tab group.
2577 * \li Syntax: close-tab-group
2578 * \li Origin: Abdel, 21 Feb 2008
2579 * \endvar
2581 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2583 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2584 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2585 * \li Syntax: dialog-show <NAME> [<DATA>]
2586 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2587 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|\n
2588 href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2589 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2590 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2591 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2592 <SPECIAL>: latexlog|vclog \n
2593 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2594 details.
2595 * \li Origin: leeming, 17 Jun 2003
2596 * \endvar
2598 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2600 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2601 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2602 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2603 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2604 * \li Params: See #LFUN_DIALOG_SHOW .
2605 * \li Origin: leeming, 25 Feb 2003
2606 * \endvar
2608 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2610 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2611 * \li Action: Updates the dialog values from the inset/paragraph/document.
2612 * \li Syntax: dialog-update <NAME>
2613 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2614 <INSET>: inset name
2615 * \li Origin: leeming, 25 Feb 2003
2616 * \endvar
2618 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2620 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2621 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2622 * \li Syntax: dialog-hide <NAME>
2623 * \li Params: See #LFUN_DIALOG_SHOW .
2624 * \li Origin: leeming, 25 Feb 2003
2625 * \endvar
2627 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2629 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2630 * \li Action: Toggles dialog between showed/hidden state.
2631 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2632 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2633 * \li Params: See #LFUN_DIALOG_SHOW .
2634 * \li Origin: JSpitzm, 30 Apr 2007
2635 * \endvar
2637 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2639 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2640 * \li Action: Closes opened connection to opened inset.
2641 * \li Notion: Connection is used for apply functions.
2642 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2643 * \li Origin: leeming, 25 Feb 2003
2644 * \endvar
2646 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2649 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2650 * \li Action: This function is called when mouse button is pressed (inside workarea).
2651 Action depends on the context.
2652 * \li Notion: This is internal LFUN, not to be used by users.
2653 * \li Origin: Andre, 9 Aug 2002
2654 * \endvar
2656 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2658 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2659 * \li Action: This function is called when double click on mouse button is
2660 pressed (inside workarea). Action depends on the context.
2661 * \li Notion: This is internal LFUN, not to be used by users.
2662 * \li Origin: Andre, 9 Aug 2002
2663 * \endvar
2665 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2667 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2668 * \li Action: This function is called when triple click on mouse button is
2669 pressed (inside workarea). Action depends on the context.
2670 * \li Notion: This is internal LFUN, not to be used by users.
2671 * \li Origin: Andre, 9 Aug 2002
2672 * \endvar
2674 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2676 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2677 * \li Action: This function is called when mouse cursor is moving over the text.
2678 Action depends on the context.
2679 * \li Notion: This is internal LFUN, not to be used by users.
2680 * \li Origin: Andre, 9 Aug 2002
2681 * \endvar
2683 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2685 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2686 * \li Action: This function is called when mouse button is released (inside workarea).
2687 Action depends on the context.
2688 * \li Notion: This is internal LFUN, not to be used by users.
2689 * \li Origin: Andre, 9 Aug 2002
2690 * \endvar
2692 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2695 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2696 * \li Action: Turn off the loaded keyboard map.
2697 * \li Syntax: keymap-off
2698 * \endvar
2700 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2702 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2703 * \li Action: Turn on the primary keyboard map.
2704 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2705 keyboard support. They can be still used to maintain uniform keyboard
2706 layout across the various plaforms.\n
2707 The language is to be set in the Preferences dialog.
2708 * \li Syntax: keymap-primary
2709 * \endvar
2711 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2713 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2714 * \li Action: Turn on the secondary keyboard map.
2715 * \li Syntax: keymap-secondary
2716 * \endvar
2718 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2720 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2721 * \li Action: Toggles keyboard maps (first/second/off).
2722 * \li Syntax: keymap-toggle
2723 * \li Origin: leeming, 30 Mar 2004
2724 * \endvar
2726 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2729 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2730 * \li Action: Returns the current layout (that is environment) name
2731 on the cursor position.
2732 * \li Syntax: server-get-layout
2733 * \endvar
2735 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2737 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2738 * \li Action: Returns path and file name of the currently edited document.
2739 * \li Syntax: server-get-filename
2740 * \endvar
2742 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2744 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2745 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2746 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2747 line from LaTeX compilation. Note that before this function can be used
2748 export to LaTeX output must occur (in order to map the row numbers).
2749 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2750 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2751 In case this LFUN does not work make sure you are giving correct
2752 path to the file.\n
2753 If the file is located inside LyX temporary directory it will be
2754 mapped back into the appropriate opened buffer (e.g. for the case
2755 of generated .tex file).
2756 .ext: extensions will be automatically replaced by .lyx.
2757 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2758 * \li Origin: Edmar, 23 Dec 1998
2759 * \endvar
2761 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2763 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2764 * \li Action: Sends notify message about the last key-sequence to client.
2765 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2766 See also Debug extensions section in Additional features manual.
2767 * \li Syntax: server-notify
2768 * \endvar
2770 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2772 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2773 * \li Action: Sets the cursor position based on the editing area coordinates
2774 (similar as clicking on that point with left mouse button).
2775 * \li Syntax: server-set-xy <X> <Y>
2776 * \endvar
2778 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2780 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2781 * \li Action: Returns the coordinates of cursor position in the editing area.
2782 * \li Syntax: server-get-xy
2783 * \endvar
2785 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2788 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2789 * \li Action: Generates the code (literate programming).
2790 * \li Notion: Latex file with extension \literate_extension is generated.
2791 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2792 \build_error_filter to process the compilation error messages. \n
2793 In case you want to process your literate file with a script, or some other program,
2794 just insert in your lyxrc file an entry with:\n
2795 \build_command "my_script my_arguments" \n
2796 The \build_error_filter differs from the \literate_error_filter only in that the
2797 former will identify error messages from your compiler.
2798 * \li Syntax: build-program
2799 * \endvar
2801 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2804 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2805 * \li Action: Saves the current buffer to a temporary file.
2806 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2807 is called automatically by LyX, to "autosave" the current buffer.
2808 * \li Syntax: buffer-auto-save
2809 * \endvar
2811 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2813 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2814 * \li Action: Loads the given child document.
2815 * \li Notion: The current document is treated as a parent.
2816 * \li Syntax: buffer-child-open <FILE>
2817 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2818 * \li Origin: Ale, 28 May 1997
2819 * \endvar
2821 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2823 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2824 * \li Action: Runs chktex for the current document.
2825 * \li Syntax: buffer-chktex
2826 * \li Origin: Asger, 30 Oct 1997
2827 * \endvar
2829 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2831 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2832 * \li Action: Toggles compression of the current document on/off.
2833 * \li Syntax: buffer-toggle-compression
2834 * \li Origin: bpeng, 27 Apr 2006
2835 * \endvar
2837 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2839 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2840 * \li Action: Closes the current buffer.
2841 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2842 if the buffer has been modified.
2843 * \li Syntax: buffer-close
2844 * \endvar
2846 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2848 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2849 * \li Action: Exports the current buffer (document) to the given format.
2850 * \li Syntax: buffer-export <FORMAT>
2851 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2852 can find in Tools->Preferences->File formats->Format.
2853 Usual format you will enter is "pdf2" (pdflatex),
2854 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2855 In case of "custom" you will be asked for a format you
2856 want to start from and for the command that you want to
2857 apply to this format. Internally the control is then passed
2858 to #LFUN_BUFFER_EXPORT_CUSTOM.
2859 * \li Origin: Lgb, 29 Jul 1997
2860 * \endvar
2862 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2864 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2865 * \li Action: Exports the current buffer (document) from the given format using
2866 the given command on it.
2867 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2868 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2869 intermediate file).\n
2870 <COMMAND> this command will be launched on the file. Note that you can
2871 use "$$FName" string to qualify the intermediate file.
2872 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2873 * \li Origin: leeming, 27 Mar 2004
2874 * \endvar
2876 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2878 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2879 * \li Action: Prints the current document.
2880 * \li Notion: Many settings can be given via the preferences dialog.
2881 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2882 * \li Params: <TARGET> is either "printer" or "file".\n
2883 <TARGER-NAME> is either "default" or file name or printer name.\n
2884 <COMMAND> command ensuring the printing job.
2885 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2886 * \li Origin: leeming, 28 Mar 2004
2887 * \endvar
2889 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2891 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2892 * \li Action: Import a given file as a lyx document.
2893 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2894 defined convertors in preferences. Look into File->Import menu to get
2895 an idea of the currently active import formats.
2896 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2897 * \li Origin: Asger, 24 Jul 1998
2898 * \endvar
2900 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2902 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2903 * \li Action: Creates a new buffer (that is, document).
2904 * \li Notion: Implicit path can be set in Preferences dialog.
2905 * \li Syntax: buffer-new [<FILE>]
2906 * \li Params: <FILE>: filename of created file with absolute path.
2907 * \endvar
2909 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2911 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2912 * \li Action: Creates a new buffer (that is, document) from a template.
2913 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2914 Template will be asked for via Open-dialog.
2915 * \li Syntax: buffer-new-template [<FILE>]
2916 * \li Params: <FILE>: filename of created file with absolute path.
2917 * \endvar
2919 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2921 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2922 * \li Action: Reverts opened document.
2923 * \li Syntax: buffer-reload
2924 * \li Origin: Asger, 2 Feb 1997
2925 * \endvar
2927 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2929 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2930 * \li Action: Switch to the given buffer.
2931 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2932 document in different LyX windows.
2933 * \li Syntax: buffer-new-template <BUFFER>
2934 * \li Params: <BUFFER>: already opened document which is to be shown.
2935 * \endvar
2937 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2939 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2940 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2941 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2942 In the Readonly-> mode checkouts the data from repository. \n
2943 If these operations fail, buffer won't be toggled.
2944 * \li Syntax: buffer-toggle-read-only
2945 * \li Origin: Lgb, 27 May 1997
2946 * \endvar
2948 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2950 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2951 * \li Action: Displays current buffer in chosen format.
2952 * \li Notion: Displays the contents of the current buffer in the chosen
2953 format, for example, PDF or DVI. This runs the necessary
2954 converter, calls the defined viewer, and so forth.
2955 * \li Syntax: buffer-view [<FORMAT>]
2956 * \li Params: <FORMAT>: The format to display, where this is one of the
2957 formats defined (in the current GUI) in the
2958 Tools>Preferences>File Formats dialog.
2959 If no format is given, the default format as
2960 specified in the same dialog is used.
2961 * \endvar
2963 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2965 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2966 * \li Action: Exports the current document and put the result into the
2967 temporary directory.
2968 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2969 the output will be rewriten - updated. This is useful in case your viewer
2970 is able to detect such changes (e.g. ghostview for postscript).
2971 * \li Syntax: 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: Dekel, 5 Aug 2000
2978 * \endvar
2980 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2983 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2984 * \li Action: Saves the current buffer.
2985 * \li Notion: Saves the current buffer to disk, using the filename that
2986 is already associated with the buffer, asking for one if
2987 none is yet assigned.
2988 * \li Syntax: buffer-write
2989 * \endvar
2991 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2993 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2994 * \li Action: Rename and save current buffer.
2995 * \li Syntax: buffer-write-as <FILENAME>
2996 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2997 is with respect to the original location of the buffer/file.
2998 * \endvar
3000 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3002 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3003 * \li Action: Save all changed documents.
3004 * \li Syntax: buffer-write-all
3005 * \li Origin: rgh, gpothier 6 Aug 2007
3006 * \endvar
3008 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3010 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3011 * \li Action: Switch to the next opened document.
3012 * \li Notion: Note that this does not necessarily mean next in tabbar
3013 (for full list see View menu).
3014 * \li Syntax: buffer-next
3015 * \endvar
3017 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3019 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3020 * \li Action: Switch to the previous opened document.
3021 * \li Syntax: buffer-previous
3022 * \endvar
3024 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3026 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3027 * \li Action: When run from a child document, this updates (exports) document built
3028 from the master buffer, if available.
3029 * \li Syntax: master-buffer-update [<FORMAT>]
3030 * \li Params: <FORMAT>: The format to display, where this is one of the
3031 formats defined (in the current GUI) in the
3032 Tools>Preferences>File Formats dialog.
3033 If no format is given, the default format as
3034 specified in the same dialog is used.
3035 * \li Origin: Tommaso, 20 Sep 2007
3036 * \endvar
3038 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3040 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3041 * \li Action: When run from a child document, this command shows a preview built
3042 from the master buffer, if available.
3043 * \li Syntax: master-buffer-view [<FORMAT>]
3044 * \li Params: <FORMAT>: The format to display, where this is one of the
3045 formats defined (in the current GUI) in the
3046 Tools>Preferences>File Formats dialog.
3047 If no format is given, the default format as
3048 specified in the same dialog is used.
3049 * \li Origin: Tommaso, 20 Sep 2007
3050 * \endvar
3052 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3054 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3055 * \li Action: Set language of the current document.
3056 * \li Syntax: buffer-language <LANG>
3057 * \li Params: <LANG>: language name. See lib/languages for list.
3058 * \li Origin: leeming, 30 Mar 2004
3059 * \endvar
3061 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3063 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3064 * \li Action: Save the current document settings as default.
3065 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3066 * \li Syntax: buffer-save-as-default [<ARGS>]
3067 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3068 you can find in document header of usual .lyx file.
3069 * \li Origin: leeming, 30 Mar 2004
3070 * \endvar
3072 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3074 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3075 * \li Action: Apply the given settings to the current document.
3076 * \li Syntax: buffer-params-apply [<ARGS>]
3077 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3078 you can find in document header of usual .lyx file.
3079 * \li Origin: leeming, 30 Mar 2004
3080 * \endvar
3082 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
3085 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3086 * \li Action: Inserts another LyX file.
3087 * \li Syntax: file-insert [<FILE>]
3088 * \li Params: <FILE>: Filename to be inserted.
3089 * \endvar
3091 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3093 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3094 * \li Action: Inserts plain text file.
3095 * \li Syntax: file-insert-plaintext [<FILE>]
3096 * \li Params: <FILE>: Filename to be inserted.
3097 * \li Origin: CFO-G, 19 Nov 1997
3098 * \endvar
3100 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3102 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3103 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3104 * \li Syntax: file-insert-plaintext-para [<FILE>]
3105 * \li Params: <FILE>: Filename to be inserted.
3106 * \li Origin: Levon, 14 Feb 2001
3107 * \endvar
3109 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3111 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3112 * \li Action: Open LyX document.
3113 * \li Syntax: file-open [<FILE>]
3114 * \li Params: <FILE>: Filename to be opened.
3115 * \endvar
3117 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3120 * \var lyx::FuncCode lyx::LFUN_CALL
3121 * \li Action: Executes a command defined in a .def file.
3122 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3123 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3124 where <NAME> is the name of the new command and <LFUN> is the lfun code
3125 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3126 \def_file "FileName" allows to include another .def file. \n
3127 This is particularly useful in connection with toolbar buttons:
3128 Since the name of the button image for this lfun is
3129 lib/images/commands/<NAME>.png this is the way to assign an image
3130 to a complex command-sequence.
3131 * \li Syntax: call <NAME>
3132 * \li Params: <NAME>: Name of the command that must be called.
3133 * \li Origin: broider, 2 Oct 2007
3134 * \endvar
3136 { LFUN_CALL, "call", NoBuffer, System },
3138 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3139 * \li Action: Simulate halting Meta key (Alt key on PCs).
3140 * \li Notion: Used for buffer editation not for GUI control.
3141 * \li Syntax: meta-prefix
3142 * \endvar
3144 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3146 * \var lyx::FuncCode lyx::LFUN_CANCEL
3147 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3148 * \li Syntax: cancel
3149 * \endvar
3151 { LFUN_CANCEL, "cancel", NoBuffer, System },
3154 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3155 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
3156 * \li Notion: Usually bound to M-x shortcut.
3157 * \li Syntax: command-execute
3158 * \endvar
3160 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3162 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3163 * \li Action: Return the current key sequence and available options as a string.
3164 * \li Notion: No options are added if no current map exists. \n
3165 This is probably usable only with connection to lyxserver.
3166 * \li Syntax: command-prefix
3167 * \endvar
3169 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3171 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3172 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3173 * \li Syntax: command-sequence <CMDS>
3174 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3175 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3176 * \li Origin: Andre, 11 Nov 1999
3177 * \endvar
3179 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3181 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3182 * \li Action: Runs the first listed command that is enabled.
3183 * \li Notion: This can be used to bind multiple functions to a single key,
3184 and then which one is used will depend upon the context.
3185 * \li Syntax: command-alternatives <CMDS>
3186 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3187 * \li Sample: command-alternatives completion-accept;cell-forward
3188 * \li Origin: rgh, 24 September 2008
3189 * \endvar
3191 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3193 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3194 * \li Action: Shows message in statusbar (for script purposes).
3195 * \li Syntax: message <STRING>
3196 * \li Origin: Lgb, 8 Apr 2001
3197 * \endvar
3199 { LFUN_MESSAGE, "message", NoBuffer, System },
3201 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3202 * \li Action: Save user preferences.
3203 * \li Syntax: preferences-save
3204 * \li Origin: Lgb, 27 Nov 1999
3205 * \endvar
3207 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3209 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3210 * \li Action: Reconfigure the automatic settings.
3211 * \li Syntax: reconfigure
3212 * \li Origin: Asger, 14 Feb 1997
3213 * \endvar
3215 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3217 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3218 * \li Action: Apply the given settings to user preferences.
3219 * \li Syntax: lyxrc-apply <SETTINGS>
3220 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3221 to get an idea which commands to use and their syntax.
3222 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3223 * \endvar
3225 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3227 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3228 * \li Action: Determine whether keep cursor inside the editing window regardless
3229 the scrollbar movement.
3230 * \li Syntax: toggle-cursor-follows-scrollbar
3231 * \li Origin: ARRae, 2 Dec 1997
3232 * \endvar
3234 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3236 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3237 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3238 * \li Notion: A new color entry is created if the color is unknown.
3239 Color names can be stored as a part of user settings.
3240 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3241 * \li Origin: SLior, 11 Jun 2000
3242 * \endvar
3244 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3246 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3247 * \li Action: Count the statistics (number of words and characters)
3248 in the document or in the given selection.
3249 * \li Notion: Note that this function gives the number of words/chars written,
3250 not the number of characters which will be typeset.
3251 * \li Syntax: statistics
3252 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3253 * \endvar
3255 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3257 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3258 * \li Action: Show the inline completion at the cursor position.
3259 * \li Syntax: completion-inline
3260 * \li Origin: sts, Feb 19 2008
3261 * \endvar
3263 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3265 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3266 * \li Action: Show the completion popup at the cursor position.
3267 * \li Syntax: completion-popup
3268 * \li Origin: sts, Feb 19 2008
3269 * \endvar
3271 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3273 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3274 * \li Action: Try to complete the word or command at the cursor position.
3275 * \li Syntax: complete
3276 * \li Origin: sts, Feb 19 2008
3277 * \endvar
3279 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3282 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3283 * \li Action: Try to cancel completion, either the popup or the inline completion.
3284 * \li Syntax: completion-cancel
3285 * \li Origin: sts, Sep 07 2008
3286 * \endvar
3288 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3290 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3291 * \li Action: Accept suggested completion.
3292 * \li Syntax: completion-accept
3293 * \li Origin: sanda, Sep 08 2008
3294 * \endvar
3296 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3300 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3301 * \li Action: Add a branch to the buffer's BranchList.
3302 * \li Syntax: branch-add <BRANCH>
3303 * \li Params: <BRANCH>: Name of the branch to add
3304 * \li Origin: spitz, 7 Jul 2009
3305 * \endvar
3307 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3311 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3312 * \li Action: Activate the branch.
3313 * \li Syntax: branch-activate <BRANCH>
3314 * \li Params: <BRANCH>: The branch to activate
3315 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3316 could be used to export a pdf with the answers branch included
3317 without one's having to open LyX and activate the branch manually.
3318 * \li Origin: rgh, 27 May 2008
3319 * \endvar
3321 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3323 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3324 * \li Action: De-activate the branch.
3325 * \li Syntax: branch-deactivate <BRANCH>
3326 * \li Params: <BRANCH>: The branch to deactivate
3327 * \li Origin: rgh, 27 May 2008
3328 * \endvar
3330 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3333 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3334 * \li Action: Rename all branches of a given name in a document.
3335 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3336 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3337 * <NEWNAME>: New name of the branch
3338 * \li Origin: spitz, 9 Jul 2009
3339 * \endvar
3341 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3343 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3344 * \li Action: Create new branch and directly put the branch inset into
3345 the document.
3346 * \li Syntax: branch-add-insert [<NAME>]
3347 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3348 * \li Origin: sanda, 10 Jul 2009
3349 * \endvar
3351 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3355 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3356 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3357 * \li Syntax: copy-label-as-reference <LABEL>
3358 * \li Params: <LABEL>: The label to copy (for multi-line math)
3359 * \li Origin: sts, 16 Nov 2008
3360 * \endvar
3362 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3365 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3366 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3367 * \li Syntax: label-insert-as-reference
3368 * \li Origin: vfr, 7 Apr 2009
3369 * \endvar
3371 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3374 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3375 * \li Action: Increases the zoom of the screen fonts.
3376 * \li Syntax: buffer-zoom-in [<ZOOM>]
3377 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3378 * \li Origin: vfr, 30 Mar 2009
3379 * \endvar
3381 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3384 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3385 * \li Action: Decreases the zoom of the screen fonts.
3386 * \li Syntax: buffer-zoom-out [<ZOOM>]
3387 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3388 * \li Origin: vfr, 30 Mar 2009
3389 * \endvar
3391 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3394 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
3395 * \li Action: Selects the whole section.
3396 * \li Notion: The cursor should be in a section heading
3397 before calling this lfun.
3398 * \li Syntax: section-select
3399 * \li Origin: vfr, 05 May 2009
3400 * \endvar
3402 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
3404 { LFUN_NOACTION, "", Noop, Hidden }
3405 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3408 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3409 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3412 init = true;
3414 #endif
3416 LyXAction::LyXAction()
3418 init();
3422 // Returns an action tag from a string.
3423 FuncRequest LyXAction::lookupFunc(string const & func) const
3425 string const func2 = trim(func);
3427 if (func2.empty()) {
3428 return FuncRequest(LFUN_NOACTION);
3431 string cmd;
3432 string const arg = split(func2, cmd, ' ');
3434 func_map::const_iterator fit = lyx_func_map.find(cmd);
3436 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3440 string const LyXAction::getActionName(FuncCode action) const
3442 info_map::const_iterator const it = lyx_info_map.find(action);
3443 return it != lyx_info_map.end() ? it->second.name : string();
3447 LyXAction::func_type LyXAction::getActionType(FuncCode action) const
3449 info_map::const_iterator const it = lyx_info_map.find(action);
3450 return it != lyx_info_map.end() ? it->second.type : Hidden;
3454 bool LyXAction::funcHasFlag(FuncCode action,
3455 LyXAction::func_attrib flag) const
3457 info_map::const_iterator ici = lyx_info_map.find(action);
3459 if (ici == lyx_info_map.end()) {
3460 LYXERR0("action: " << action << " is not known.");
3461 LASSERT(false, /**/);
3464 return ici->second.attrib & flag;
3468 LyXAction::const_func_iterator LyXAction::func_begin() const
3470 return lyx_func_map.begin();
3474 LyXAction::const_func_iterator LyXAction::func_end() const
3476 return lyx_func_map.end();
3480 LyXErr & operator<<(LyXErr & l, FuncCode code)
3482 if (l.enabled())
3483 l.stream() << lyxaction.getActionName(code);
3484 return l;
3487 } // namespace lyx