src/LyXAction.cpp

   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.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  * \author John Levon
   9  * \author André Pönitz
  10  * \author Pavel Sanda
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "LyXAction.h"
  18
  19 #include "FuncRequest.h"
  20
  21 #include "support/debug.h"
  22 #include "support/lstrings.h"
  23
  24 #include "support/lassert.h"
  25
  26 #include <iostream>
  27
  28 using namespace std;
  29 using namespace lyx::support;
  30
  31 namespace lyx {
  32
  33 /*
  34      NAMING RULES FOR USER-COMMANDS
  35      Here's the set of rules to apply when a new command name is introduced:
  36
  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'.
  46
  47      (May 19 1996, 12:04, RvdK)
  48 */
  49
  50 /* LFUN documentation
  51  *
  52  * The documentation below is primarily description of purpose and syntax
  53  * relating to the different LFUNs.
  54  *
  55  * Try to find an appropriate (thematical) place when adding the new LFUN
  56  * and don't forget to add doxygen commentary.
  57  *
  58  * Doxygen template below. Some notes: Parameters should be set in uppercase
  59  * and put in <BRACKETS>, [<PARAM>] means optional one.
  60  *
  61  * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
  62  */
  63
  64 /*!
  65  * \var lyx::FuncCode lyx::LFUN_
  66  * \li Action:
  67  * \li Notion:
  68  * \li Syntax:
  69  * \li Params:
  70  * \li Sample:
  71  * \li Origin:
  72  * \endvar
  73  */
  74
  75 LyXAction lyxaction;
  76
  77
  78 void LyXAction::newFunc(FuncCode action, string const & name,
  79                         unsigned int attrib, LyXAction::FuncType type)
  80 {
  81         lyx_func_map[name] = action;
  82         FuncInfo tmpinfo;
  83         tmpinfo.name = name;
  84         tmpinfo.attrib = attrib;
  85         tmpinfo.type = type;
  86         lyx_info_map[action] = tmpinfo;
  87 }
  88
  89
  90 // Needed for LFUNs documentation to be accepted, since doxygen won't take
  91 // \var inside functions.
  92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  93 void LyXAction::init()
  94 {
  95         // This function was changed to use the array below in initalization
  96         // instead of calling newFunc numerous times because of compilation
  97         // times. Since the array is not static we get back the memory it
  98         // occupies after the init is completed. It compiles several
  99         // magnitudes faster.
 100
 101         static bool init;
 102         if (init)
 103                 return;
 104
 105         struct ev_item {
 106                 FuncCode action;
 107                 char const * name;
 108                 unsigned int attrib;
 109                 FuncType type;
 110         };
 111
 112         ev_item const items[] = {
 113 #endif
 114 /*!
 115  * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
 116  * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
 117                to the next character typed.
 118  * \li Syntax: accent-acute
 119  * \endvar
 120  */
 121                 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
 122 /*!
 123  * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
 124  * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
 125                to the next character typed.
 126  * \li Syntax: accent-breve
 127  * \endvar
 128  */
 129                 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
 130 /*!
 131  * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
 132  * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
 133                to the next character typed.
 134  * \li Syntax: accent-caron
 135  * \endvar
 136  */
 137                 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
 138 /*!
 139  * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
 140  * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
 141                to the next character typed.
 142  * \li Syntax: accent-cedilla
 143  * \endvar
 144  */
 145                 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
 146 /*!
 147  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
 148  * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
 149                to the next character typed.
 150  * \li Syntax: accent-circle
 151  * \endvar
 152  */
 153                 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
 154 /*!
 155  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
 156  * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
 157                to the next character typed.
 158  * \li Syntax: accent-circumflex
 159  * \endvar
 160  */
 161                 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
 162 /*!
 163  * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
 164  * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
 165                to the next character typed.
 166  * \li Syntax: accent-dot
 167  * \endvar
 168  */
 169                 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
 170 /*!
 171  * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
 172  * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
 173                to the next character typed.
 174  * \li Syntax: accent-grave
 175  * \endvar
 176  */
 177                 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
 178 /*!
 179  * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
 180  * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
 181                to the next character typed.
 182  * \li Syntax: accent-grave
 183  * \endvar
 184  */
 185                 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
 186 /*!
 187  * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
 188  * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
 189                to the next character typed.
 190  * \li Syntax: accent-macron
 191  * \endvar
 192  */
 193                 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
 194 /*!
 195  * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
 196  * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
 197                to the next character typed.
 198  * \li Syntax: accent-ogonek
 199  * \endvar
 200  */
 201                 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
 202 /*!
 203  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
 204  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
 205                over the next two character typed.
 206  * \li Notion: The following char will finish the tie.
 207  * \li Syntax: accent-tie
 208  * \endvar
 209  */
 210                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
 211 /*!
 212  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
 213  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
 214                over the next character typed.
 215  * \li Syntax: accent-tilde
 216  * \endvar
 217  */
 218                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
 219 /*!
 220  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
 221  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
 222                over the next character typed.
 223  * \li Syntax: accent-umlaut
 224  * \endvar
 225  */
 226                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
 227 /*!
 228  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
 229  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
 230                under the next character typed.
 231  * \li Syntax: accent-underbar
 232  * \endvar
 233  */
 234                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
 235 /*!
 236  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
 237  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
 238                under the next character typed.
 239  * \li Syntax: accent-underdot
 240  * \endvar
 241  */
 242                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
 243
 244 /*!
 245  * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
 246  * \li Action: Inserts a caption inset.
 247  * \li Syntax: caption-insert
 248  * \li Origin: Lgb, 18 Jul 2000
 249  * \endvar
 250  */
 251                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
 252 /*!
 253  * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
 254  * \li Action: Inserts the current date.
 255  * \li Syntax: date-insert [<ARG>]
 256  * \li Params: <ARG>: Format of date. The default value (%x) can be set
 257                      in Preferences->Date format. For possible formats
 258                      see manual page of strftime function.
 259  * \li Origin: jdblair, 31 Jan 2000
 260  * \endvar
 261  */
 262                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
 263 /*!
 264  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
 265  * \li Action: Inserts a footnote inset.
 266  * \li Syntax: footnote-insert
 267  * \li Origin: Jug, 7 Mar 2000
 268  * \endvar
 269  */
 270                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
 271 /*!
 272  * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
 273  * \li Action: Inserts an ERT inset.
 274  * \li Syntax: ert-insert
 275  * \li Origin: Jug, 18 Feb 2000
 276  * \endvar
 277  */
 278                 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
 279 /*!
 280  * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
 281  * \li Action: Inserts a float inset.
 282  * \li Syntax: float-insert <TYPE>
 283  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
 284                        "algorithm", "table", "figure" parameters can be given.
 285  * \li Origin: Lgb, 27 Jun 2000
 286  * \endvar
 287  */
 288                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
 289 /*!
 290  * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
 291  * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
 292  * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
 293  * \li Syntax: float-wide-insert <TYPE>
 294  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
 295                        "algorithm", "table", "figure" parameters can be given.
 296  * \li Origin: Lgb, 31 Oct 2001
 297  * \endvar
 298  */
 299                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
 300 /*!
 301  * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
 302  * \li Action: Inserts the list of floats in the document.
 303  * \li Syntax: float-list-insert <TYPE>
 304  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
 305                        "algorithm", "table", "figure" parameters can be given.
 306  * \li Origin: Lgb, 3 May 2001
 307  * \endvar
 308  */
 309                 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
 310 /*!
 311  * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
 312  * \li Action: Inserts floats wrapped by the text around.
 313  * \li Syntax: wrap-insert <TYPE>
 314  * \li Params: <TYPE>: table|figure
 315  * \li Origin: Dekel, 7 Apr 2002
 316  * \endvar
 317  */
 318                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
 319 /*!
 320  * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
 321  * \li Action: Inserts an argument (short title) inset.
 322  * \li Syntax: argument-insert
 323  * \li Origin: vermeer, 12 Aug 2002
 324  * \endvar
 325  */
 326                 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
 327 /*!
 328  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
 329  * \li Action: Inserts a new page.
 330  * \li Syntax: newpage-insert <ARG>
 331  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 332  * \li Origin: uwestoehr, 24 Nov 2007
 333  * \endvar
 334  */
 335                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
 336 /*!
 337  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
 338  * \li Action: Inserts a marginal note.
 339  * \li Syntax: marginalnote-insert
 340  * \li Origin: Lgb, 26 Jun 2000
 341  * \endvar
 342  */
 343                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
 344 /*!
 345  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
 346  * \li Action: Inserts a single unicode character.
 347  * \li Syntax: unicode-insert <CHAR>
 348  * \li Params: <CHAR>: The character to insert, given as its code
 349                        point, in hexadecimal.
 350  * \li Sample: unicode-insert 0x0100
 351  * \li Origin: Lgb, 22 Oct 2006
 352  * \endvar
 353  */
 354                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
 355 /*!
 356  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
 357  * \li Action: Inserts a new listings inset.
 358  * \li Syntax: listing-insert
 359  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
 360  * \endvar
 361  */
 362                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
 363 /*!
 364  * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
 365  * \li Action: Inserts a new preview inset.
 366  * \li Syntax: preview-insert
 367  * \li Origin: vfr, 28 Mar 2010
 368  * \endvar
 369  */
 370                 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
 371 /*!
 372  * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
 373  * \li Action: Insert a tab into a listings inset.
 374  * \li Notion: It also works on a selection.
 375  * \li Syntax: tab-insert
 376  * \li Origin: vfr, Sep 30 2008
 377  * \endvar
 378  */
 379                 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
 380 /*!
 381  * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
 382  * \li Action: Delete a tab or up to an equivalent amount of spaces from
 383                a listings inset.
 384  * \li Notion: It also works on a selection - it removes a tab or spaces from the
 385                beginning of each line spanned by the selection. This is useful if
 386                you want to indent/unindent multiple lines in one action.
 387  * \li Syntax: tab-delete
 388  * \li Origin: vfr, Sep 30 2008
 389  * \endvar
 390  */
 391                 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
 392 /*!
 393  * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
 394  * \li Action: Inserts quotes according to the type and quote-language preference.
 395  * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
 396                are distinguished.
 397  * \li Syntax: quote-insert [<TYPE>]
 398  * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
 399  * \endvar
 400  */
 401                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
 402 /*!
 403  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
 404  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
 405                information in a non-editable boxed InsetText.
 406  * \li Notion: Apart from lfun arguments you can use the following method: \n
 407                1. input the type and argument of this inset, e.g. "menu paste", in
 408                the work area.\n
 409                2. select the text and run info-insert lfun.
 410  * \li Syntax: info-insert <TYPE> <ARG>
 411  * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
 412                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
 413                       description. \n
 414                       shortcut[s]: name of lfun (e.g math-insert \alpha) \n
 415                       lyxrc: name of rc_entry (e.g. bind_file) \n
 416                       lyxinfo: "version" - used version of LyX \n
 417                       package: name of latex package (e.g. listings) \n
 418                       textclass: name of textclass (e.g. article) \n
 419                       menu: name of lfun used in menu  \n
 420                       icon: icon of lfun used in toolbar \n
 421                       buffer: "name"|"path"|"class"|"vcs-tree-revision"|
 422                               "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
 423  * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
 424  * \li Origin: bpeng, 7 Oct 2007
 425  * \endvar
 426  */
 427                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
 428 /*!
 429  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
 430  * \li Action: Inserts branch inset.
 431  * \li Syntax: branch-insert <BRANCH-NAME>
 432  * \li Origin: vermeer, 17 Aug 2003
 433  * \endvar
 434  */
 435                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
 436 /*!
 437  * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
 438  * \li Action: Inserts Box inset.
 439  * \li Syntax: box-insert [<TYPE>]
 440  * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
 441                        Framed is the default one.
 442  * \li Origin: vermeer, 7 Oct 2003
 443  * \endvar
 444  */
 445                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
 446 /*!
 447  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
 448  * \li Action: Inserts CharStyle, Custom inset or XML short element.
 449  * \li Notion: Look into the Customization manual for more information about
 450                these elements.\n
 451                To make this command enabled the layout file for the document
 452                class you're using has to load the character styles. There are
 453                a few contained in the Logical Markup module. You can also of
 454                course create some yourself. \n
 455                For dissolving the element see #LFUN_INSET_DISSOLVE.
 456  * \li Syntax: flex-insert Name
 457  * \li Params: Name: This name must be defined either in your layout file
 458                      or imported by some module. The definition is
 459                      InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
 460                      prefix is optional.
 461  * \li Sample: flex-insert Code
 462  * \endvar
 463  */
 464                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
 465 /*!
 466  * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
 467  * \li Action: Inserts the given string (accordingly to the correct keymap).
 468  * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
 469                settings "auto_region_delete".
 470  * \li Syntax: self-insert <STRING>
 471  * \endvar
 472  */
 473                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
 474 /*!
 475  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
 476  * \li Action: Inserts one of horizontal space insets.
 477  * \li Syntax: space-insert <NAME> [<LEN>]
 478  * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
 479                        enskip, negthinspace, negmedspace, negthickspace, hfill,
 480                        hfill*, dotfill, hrulefill, hspace, hspace* \n
 481                        Only in math mode: med and thick.\n
 482                <LEN>: length for custom spaces (hspace, hspace* for protected)
 483  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
 484  * \endvar
 485  */
 486                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
 487 /*!
 488  * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
 489  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
 490  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
 491  * \li Syntax: href-insert [<TARGET>]
 492  * \li Origin: CFO-G, 21 Nov 1997
 493  * \endvar
 494  */
 495                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
 496 /*!
 497  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
 498  * \li Action: Inserts various characters into the document.
 499  * \li Syntax: specialchar-insert <CHAR>
 500  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
 501                        end-of-sentence, menu-separator.
 502  * \li Origin: JSpitzm, 6 Dec 2007
 503  * \endvar
 504  */
 505                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
 506 /*!
 507  * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
 508  * \li Action: Inserts a subscript or superscript inset.
 509  * \li Syntax: script-insert <TYPE>
 510  * \li Params: <TYPE>: subscript|superscript
 511  * \li Origin: Georg, 23 Nov 2010
 512  * \endvar
 513  */
 514                 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
 515 /*!
 516  * \var lyx::FuncCode lyx::LFUN_APPENDIX
 517  * \li Action: Start (or remove) Appendix on the given cursor position.
 518  * \li Syntax: appendix
 519  * \li Origin: ettrich, 5 May 1998
 520  * \endvar
 521  */
 522                 { LFUN_APPENDIX, "appendix", Noop, Edit },
 523
 524 /*!
 525  * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
 526  * \li Action: Inserts Index entry.
 527  * \li Notion: It automatically takes the word on the cursor position.
 528  * \li Syntax: index-insert [<TYPE:Name>]
 529  * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
 530                with an empty argument, the default index is selected.
 531  * \li Origin: leeming, 3 Aug 2000
 532  * \endvar
 533  */
 534                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
 535 /*!
 536  * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
 537  * \li Action: Inserts list of Index entries on a new page.
 538  * \li Syntax: index-print [<TYPE:Name>]
 539  * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
 540                with an empty argument, the default index is selected.
 541  * \li Origin: Lgb, 27 Feb 1997
 542  * \endvar
 543  */
 544                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
 545 /*!
 546  * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
 547  * \li Action: Inserts an IPA inset.
 548  * \li Syntax: ipa-insert
 549  * \li Origin: spitz, 05 Mar 2012
 550  * \endvar
 551  */
 552         { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
 553 /*!
 554  * \var lyx::FuncCode lyx::LFUN_IN_IPA
 555  * \li Action: Only active in IPA inset.
 556  * \li Notion: Dummy function which is only active in a IPA inset.
 557                It's used to toggle the IPA toolbar if the cursor moves
 558                into an IPA inset.
 559  * \li Syntax: in-ipa
 560  * \li Origin: spitz, 20 May 2012
 561  * \endvar
 562  */
 563                 { LFUN_IN_IPA, "in-ipa", Noop, Edit },
 564
 565 /*!
 566  * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
 567  * \li Action: Inserts Nomenclature entry.
 568  * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
 569  * \li Syntax: nomencl-insert [<SYMBOL>]
 570  * \li Origin: Ugras, 4 Nov 2006
 571  * \endvar
 572  */
 573                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
 574 /*!
 575  * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
 576  * \li Action: Inserts list of Nomenclature entries.
 577  * \li Syntax: nomenclature-print
 578  * \li Origin: Ugras, 4 Nov 2006
 579  * \endvar
 580  */
 581                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
 582
 583 /*!
 584  * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
 585  * \li Action: Inserts Note on the current cursor postion,
 586                move selection inside the inset.
 587  * \li Syntax: note-insert [<TYPE>]
 588  * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
 589  * \endvar
 590  */
 591                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
 592 /*!
 593  * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
 594  * \li Action: Moves the cursor to the begining of next Note inset.
 595  * \li Syntax: note-next
 596  * \endvar
 597  */
 598                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
 599 /*!
 600  * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
 601  * \li Action: Inserts phantom on the current cursor postion,
 602                move selection inside the inset.
 603  * \li Syntax: phantom-insert [<TYPE>]
 604  * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
 605  * \li Origin: uwestoehr, 30 Jan 2009
 606  * \endvar
 607  */
 608                 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
 609 /*!
 610  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
 611  * \li Action: Inserts a line break or new line.
 612  * \li Syntax: newline-insert [<ARG>]
 613  * \li Params: <ARG>: <newline|linebreak> default: newline
 614  * \li Origin: JSpitzm, 25 Mar 2008
 615  * \endvar
 616  */
 617                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
 618 /*!
 619  * \var lyx::FuncCode lyx::LFUN_ESCAPE
 620  * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
 621                Inside math mode jumps out of the math inset.
 622  * \li Syntax: escape
 623  * \li Origin: Lgb, 17 May 2001
 624  * \endvar
 625  */
 626                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
 627 /*!
 628  * \var lyx::FuncCode lyx::LFUN_DOWN
 629  * \li Action: Moves the cursor one line in downward direction.
 630  * \li Syntax: down
 631  * \endvar
 632  */
 633                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
 634 /*!
 635  * \var lyx::FuncCode lyx::LFUN_UP
 636  * \li Action: Moves the cursor one line in upward direction.
 637  * \li Syntax: up
 638  * \endvar
 639  */
 640                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
 641 /*!
 642  * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
 643  * \li Action: Moves the cursor one line in downward direction adding the current
 644                position to the selection.
 645  * \li Syntax: down-select
 646  * \endvar
 647  */
 648                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
 649 /*!
 650  * \var lyx::FuncCode lyx::LFUN_UP_SELECT
 651  * \li Action: Moves the cursor one line in upward direction adding the current
 652                position to the selection.
 653  * \li Syntax: up-select
 654  * \endvar
 655  */
 656                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
 657 /*!
 658  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
 659  * \li Action: Moves the cursor one page in downward direction.
 660  * \li Syntax: screen-down
 661  * \endvar
 662  */
 663                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
 664 /*!
 665  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
 666  * \li Action: Moves the cursor one page in upward direction.
 667  * \li Syntax: screen-up
 668  * \endvar
 669  */
 670                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
 671 /*!
 672  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
 673  * \li Action: Moves the cursor one screen in downward direction adding the current
 674                position to the selection.
 675  * \li Syntax: screen-down-select
 676  * \endvar
 677  */
 678                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
 679 /*!
 680  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
 681  * \li Action: Moves the cursor one page in upward direction adding the current
 682                position to the selection.
 683  * \li Syntax: screen-up-select
 684  * \endvar
 685  */
 686                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
 687 /*!
 688  * \var lyx::FuncCode lyx::LFUN_SCROLL
 689  * \li Action: Scroll the buffer view.
 690  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
 691  * \li Syntax: scroll <TYPE> <QUANTITY>
 692  * \li Params: <TYPE>:  line|page\n
 693                <QUANTITY>: up|down|<number>
 694  * \li Origin: Abdel, Dec 27 2007
 695  * \endvar
 696  */
 697                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
 698 /*!
 699  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
 700  * \li Action: Recenters the screen on the current cursor position.
 701  * \li Syntax: screen-recenter
 702  * \endvar
 703  */
 704                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
 705
 706 /*!
 707  * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
 708  * \li Action: Repositions the screen such that the cursor is visible.
 709  * \li Syntax: screen-show-cursor
 710  * \li Origin: vfr, 25 Mar 2009
 711  * \endvar
 712  */
 713                 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
 714
 715 /*!
 716  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
 717  * \li Action: Moves the cursor one position logically backwards.
 718  * \li Notion: This is not the action which should be bound to the arrow keys,
 719                because backwards may be left or right, depending on the
 720                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
 721                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 722  * \li Syntax: char-backward
 723  * \endvar
 724  */
 725                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
 726 /*!
 727  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
 728  * \li Action: Moves the cursor one position logically backwards, adding
 729                traversed position to the selection.
 730  * \li Notion: See also #LFUN_CHAR_BACKWARD.
 731  * \li Syntax: char-backward-select
 732  * \endvar
 733  */
 734                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
 735 /*!
 736  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
 737  * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
 738  * \li Syntax: char-delete-backward
 739  * \endvar
 740  */
 741                 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
 742 /*!
 743  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
 744  * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
 745  * \li Syntax: char-delete-forward
 746  * \endvar
 747  */
 748                 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
 749 /*!
 750  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
 751  * \li Action: Moves the cursor one position logically forward.
 752  * \li Notion: This is not the action which should be bound to the arrow keys,
 753                because forward may be left or right, depending on the language.
 754                The arrow keys should be bound to #LFUN_CHAR_LEFT or
 755                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 756  * \li Syntax: char-forward
 757  * \endvar
 758  */
 759                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
 760 /*!
 761  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
 762  * \li Action: Moves the cursor one position logically forward, adding
 763                traversed position to the selection.
 764  * \li Notion: See also #LFUN_CHAR_FORWARD.
 765  * \li Syntax: char-forward-select
 766  * \endvar
 767  */
 768                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
 769 /*!
 770  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
 771  * \li Action: Moves the cursor one position "to the left".
 772  * \li Notion: This is the action which should be taken when the "left" key
 773                is pressed. Generally, it moves the cursor one position to the
 774                left. However, in Bidi text this become slightly more
 775                complicated, and there are different modes of cursor movement.
 776                In "visual mode", this moves left, plain and simple. In "logical
 777                mode", movement is logically forward in RTL paragraphs, and
 778                logically backwards in LTR paragraphs.
 779  * \li Syntax: char-left
 780  * \endvar
 781  */
 782                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
 783 /*!
 784  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
 785  * \li Action: Moves the cursor one position "to the left", adding
 786                traversed position to the selection.
 787  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
 788  * \li Syntax: char-left-select
 789  * \endvar
 790  */
 791                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
 792 /*!
 793  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
 794  * \li Action: Moves the cursor one position "to the right".
 795  * \li Notion: This is the action which should be taken when the "right" key
 796                is pressed. Generally, it moves the cursor one position to the
 797                right. However, in Bidi text this become slightly more
 798                complicated, and there are different modes of cursor movement.
 799                In "visual mode", this moves right, plain and simple. In "logical
 800                mode", movement is logically forward in LTR paragraphs, and
 801                logically backwards in RTL paragraphs.
 802  * \li Syntax: char-right
 803  * \endvar
 804  */
 805                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
 806 /*!
 807  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
 808  * \li Action: Moves the cursor one position "to the right", adding
 809                traversed position to the selection.
 810  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
 811  * \li Syntax: char-right-select
 812  * \endvar
 813  */
 814                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
 815
 816 /*!
 817  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
 818  * \li Action: Moves the cursor to the logically previous beginning of a word.
 819  * \li Notion: This is not the action which should be bound to the arrow keys,
 820                because backwards may be left or right, depending on the
 821                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
 822                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
 823  * \li Syntax: word-backward
 824  * \endvar
 825  */
 826                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
 827 /*!
 828  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
 829  * \li Action: Moves the cursor to the logically previous beginning of a word,
 830                adding the logically traversed text to the selection.
 831  * \li Notion: See also #LFUN_WORD_BACKWARD.
 832  * \li Syntax: word-backward-select
 833  * \endvar
 834  */
 835                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
 836 /*!
 837  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
 838  * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
 839  * \li Syntax: word-delete-backward
 840  * \endvar
 841  */
 842                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
 843 /*!
 844  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
 845  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
 846  * \li Syntax: word-delete-forward
 847  * \endvar
 848  */
 849                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
 850 /*!
 851  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
 852  * \li Action: Search for a given string in forward direction.
 853  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 854  * \li Syntax: word-find-forward [<STRING>]
 855  * \li Origin: Etienne, 16 Feb 1998
 856  * \endvar
 857  */
 858                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
 859 /*!
 860  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
 861  * \li Action: Search for a given string in backward direction.
 862  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 863  * \li Syntax: word-find-backward [<STRING>]
 864  * \li Origin: Etienne, 20 Feb 1998
 865  * \endvar
 866  */
 867                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
 868 /*!
 869  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
 870  * \li Action: Search for next occurence of a string.
 871  * \li Syntax: word-find [<DATA>]
 872  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
 873                        If no parameter is given, search with last find-dialog
 874                        data is used for search (i.e. find-next).
 875  * \li Origin: Andre, Jan 7 2004
 876  * \endvar
 877  */
 878                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
 879 /*!
 880  * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
 881  * \li Action: Replace a string in the document.
 882  * \li Syntax: word-replace [<DATA>]
 883  * \li Params: <DATA>: data is of the form
 884                        "<replace> \n
 885                         <search> \n
 886                         <casesensitive> <matchword> <all> <forward> <findnext>"
 887  * \li Origin: Andre, Jan 7 2004
 888  * \endvar
 889  */
 890                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
 891 /*!
 892  * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
 893  * \li Action: Search for next occurence of a pattern.
 894  * \li Syntax: word-findadv [<DATA>]
 895  * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
 896                        If no parameter is given, search with last find-dialog
 897                        data is used for search (i.e. find-next).
 898  * \li Origin: Tommaso, Nov 15 2007
 899  * \endvar
 900  */
 901                 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
 902 /*!
 903  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
 904  * \li Action: Moves the cursor to the logically next beginning of a word.
 905  * \li Notion: This is not the action which should be bound to the arrow keys,
 906                because forward may be left or right, depending on the language.
 907                The arrow keys should be bound to #LFUN_WORD_LEFT or
 908                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
 909  * \li Syntax: word-forward
 910  * \endvar
 911  */
 912                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
 913 /*!
 914  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
 915  * \li Action: Moves the cursor to the logically next beginning of a word,
 916                adding the logically traversed text to the selection.
 917  * \li Notion: See also #LFUN_WORD_FORWARD.
 918  * \li Syntax: word-forward-select
 919  * \endvar
 920  */
 921                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
 922 /*!
 923  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
 924  * \li Action: Moves the cursor to the next beginning of a word "on the left".
 925  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
 926                "left" key is pressed. Generally, it moves the cursor to the
 927                next beginning of a word on the left. However, in Bidi text this
 928                become slightly more complicated, and there are different modes
 929                of cursor movement. In "visual mode", this moves left, plain and
 930                simple. In "logical mode", movement is logically forward in RTL
 931                paragraphs, and logically backwards in LTR paragraphs.
 932  * \li Syntax: word-left
 933  * \li Origin: dov, 28 Oct 2007
 934  * \endvar
 935  */
 936                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
 937 /*!
 938  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
 939  * \li Action: Moves the cursor to the next beginning of a word "on the left",
 940                adding *logically* traversed text to the selection.
 941  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
 942  * \li Syntax: word-left-select
 943  * \li Origin: dov, 28 Oct 2007
 944  * \endvar
 945  */
 946                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
 947 /*!
 948  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
 949  * \li Action: Moves the cursor to the next beginning of a word "on the right".
 950  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
 951                "right" key is pressed. Generally, it moves the cursor to the
 952                next beginning of a word on the right. However, in Bidi text
 953                this become slightly more complicated, and there are different
 954                modes of cursor movement. In "visual mode", this moves right,
 955                plain and simple. In "logical mode", movement is logically
 956                forward in LTR paragraphs, and logically backwards in RTL
 957                paragraphs.
 958  * \li Syntax: word-right
 959  * \li Origin: dov, 28 Oct 2007
 960  * \endvar
 961  */
 962                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
 963 /*!
 964  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
 965  * \li Action: Moves the cursor to the next beginning of a word "on the right",
 966                adding *logically* traversed text to the selection.
 967  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
 968  * \li Syntax: word-right-select
 969  * \li Origin: dov, 28 Oct 2007
 970  * \endvar
 971  */
 972                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
 973 /*!
 974  * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
 975  * \li Action: Puts the word where the cursor stands into the selection.
 976  * \li Syntax: word-select
 977  * \li Origin: Andre, 11 Sep 2002
 978  * \endvar
 979  */
 980                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 981 /*!
 982  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
 983  * \li Action: Capitalizes the words in the selection (i.e. the first letters)
 984                or the letter on the cursor position.
 985  * \li Syntax: word-capitalize
 986  * \endvar
 987  */
 988                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
 989 /*!
 990  * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
 991  * \li Action: Change the words in the selection or from the cursor position
 992                to the end of word to the upper case.
 993  * \li Syntax: word-upcase
 994  * \endvar
 995  */
 996                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
 997 /*!
 998  * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
 999  * \li Action: Change the words in the selection or from the cursor position
1000                to the end of word to the lower case.
1001  * \li Syntax: word-lowcase
1002  * \endvar
1003  */
1004                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
1005 /*!
1006  * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
1007  * \li Action: Add the word under the cursor to the respective
1008  *             spell checker dictionary.
1009  * \li Syntax: spelling-add [<STRING>] [<LANG>]
1010  * \li Params: <WORD>: word to add
1011                <LANG>: language name (see file languages)
1012  * \li Origin: JSpitzm, 18 Jan 2010
1013  * \endvar
1014  */
1015                 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1016 /*!
1017  * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1018  * \li Action: Let the spell checker ignore the word under the cursor
1019  *             in the current session for the given language.
1020  * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1021  * \li Params: <WORD>: word to ignore
1022                <LANG>: language name (see file languages)
1023  * \li Origin: JSpitzm, 18 Jan 2010
1024  * \endvar
1025  */
1026                 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1027 /*!
1028  * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1029  * \li Action: Remove the word under the cursor from the respective
1030  *             spell checker dictionary.
1031  * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1032  * \li Params: <WORD>: word to remove
1033                <LANG>: language name (see file languages)
1034  * \li Origin: SWitt, 28 July 2010
1035  * \endvar
1036  */
1037                 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1038 /*!
1039  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1040  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1041  * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1042  * \li Params: <STRING>: word to look up
1043                <LANG>: language (see file languages)
1044  * \li Origin: Levon, 20 Jul 2001
1045  * \endvar
1046  */
1047                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1048 /*!
1049  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1050  * \li Action: Move the cursor to the beginning of the document.
1051  * \li Syntax: buffer-begin
1052  * \endvar
1053  */
1054                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1055 /*!
1056  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1057  * \li Action: Move the cursor to the beginning of the document adding the
1058                traversed text to the selection.
1059  * \li Syntax: buffer-begin-select
1060  * \endvar
1061  */
1062                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1063 /*!
1064  * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1065  * \li Action: Move the cursor to the end of the document.
1066  * \li Syntax: buffer-end
1067  * \endvar
1068  */
1069                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1070 /*!
1071  * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1072  * \li Action: Move the cursor to the end of the document adding the
1073                traversed text to the selection.
1074  * \li Syntax: buffer-end-select
1075  * \endvar
1076  */
1077                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1078
1079 /*!
1080  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1081  * \li Action: Move the cursor to the beginning of the current inset
1082                if it is not already there, or at the beginning of the
1083                enclosing inset otherwise
1084  * \li Syntax: inset-begin
1085  * \li Origin: lasgouttes, 16 Mar 2009
1086  * \endvar
1087  */
1088                 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1089 /*!
1090  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1091  * \li Action: Move the cursor to the beginning of the current inset
1092                if it is not already there, or at the beginning of the
1093                enclosing inset otherwise (adding the
1094                traversed text to the selection).
1095  * \li Syntax: inset-begin-select
1096  * \li Origin: lasgouttes, 16 Mar 2009
1097  * \endvar
1098  */
1099                 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1100 /*!
1101  * \var lyx::FuncCode lyx::LFUN_INSET_END
1102  * \li Action: Move the cursor to the end of the current inset
1103                if it is not already there, or at the end of the
1104                enclosing inset otherwise
1105  * \li Syntax: inset-end
1106  * \li Origin: lasgouttes, 16 Mar 2009
1107  * \endvar
1108  */
1109                 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1110 /*!
1111  * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1112  * \li Action: Move the cursor to the end of the current inset
1113                if it is not already there, or at the end of the
1114                enclosing inset otherwise (adding the
1115                traversed text to the selection).
1116  * \li Syntax: inset-end-select
1117  * \li Origin: lasgouttes, 16 Mar 2009
1118  * \endvar
1119  */
1120                 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1121
1122 /*!
1123  * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1124  * \li Action: Selects all contents of an inset.
1125  * \li Syntax: inset-select-all
1126  * \li Origin: vfr, 22 Aug 2009
1127  * \endvar
1128  */
1129                 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1130
1131 /*!
1132  * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1133  * \li Action: Selects the whole section.
1134  * \li Notion: The cursor should be in a section heading
1135                before calling this lfun.
1136  * \li Syntax: section-select
1137  * \li Origin: vfr, 05 May 2009
1138  * \endvar
1139  */
1140                 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1141
1142 /*!
1143  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1144  * \li Action: Move the cursor to the begining of the (screen) line.
1145  * \li Syntax: line-begin
1146  * \endvar
1147  */
1148                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1149 /*!
1150  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1151  * \li Action: Move the cursor to the beginning of the (screen) line adding the
1152                traversed text to the selection.
1153  * \li Syntax: line-begin-select
1154  * \endvar
1155  */
1156                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1157 /*!
1158  * \var lyx::FuncCode lyx::LFUN_LINE_END
1159  * \li Action: Move the cursor to the end of the (screen) line.
1160  * \li Syntax: line-end
1161  * \endvar
1162  */
1163                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1164 /*!
1165  * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1166  * \li Action: Move the cursor to the end of the (screen) line adding the
1167                traversed text to the selection.
1168  * \li Syntax: line-end-select
1169  * \endvar
1170  */
1171                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1172 /*!
1173  * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1174  * \li Action: Deletes the letters to the end of the (screen) line or
1175                deletes the selection.
1176  * \li Syntax: line-delete-forward
1177  * \endvar
1178  */
1179                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1180 /*!
1181  * \var lyx::FuncCode lyx::LFUN_COPY
1182  * \li Action: Copies to the clipboard the last edit.
1183  * \li Syntax: copy
1184  * \endvar
1185  */
1186                 { LFUN_COPY, "copy", ReadOnly, Edit },
1187 /*!
1188  * \var lyx::FuncCode lyx::LFUN_CUT
1189  * \li Action: Cuts to the clipboard.
1190  * \li Syntax: cut
1191  * \endvar
1192  */
1193                 { LFUN_CUT, "cut", Noop, Edit },
1194 /*!
1195  * \var lyx::FuncCode lyx::LFUN_PASTE
1196  * \li Action: Pastes material (text or picture) from the active clipboard.
1197  * \li Syntax: paste [<TYPE>|<NUM>]
1198  * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1199                <NUM>: number of the selection in the internal clipboard stack to be pasted.
1200  * \endvar
1201  */
1202                 { LFUN_PASTE, "paste", Noop, Edit },
1203 /*!
1204  * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1205  * \li Action: Pastes text from the active clipboard.
1206  * \li Syntax: clipboard-paste [<ARG>]
1207  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1208  * \li Origin: Georg, 10 Jul 2006
1209  * \endvar
1210  */
1211                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1212 /*!
1213  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1214  * \li Action: Pastes the currently selected text.
1215  * \li Notion: Primary selection mechanism is linux-only thing.
1216  * \li Syntax: primary-selection-paste [<ARG>]
1217  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1218  * \endvar
1219  */
1220                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1221 /*!
1222  * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1223  * \li Action: Pastes the internal selection text in permanent selection.
1224  * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1225                command-alternatives selection-paste ; primary-selection-paste paragraph).
1226  * \li Syntax: selection-paste
1227  * \li Origin: lasgouttes, 14 Jan 2009
1228  * \endvar
1229  */
1230                 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1231 /*!
1232  * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1233  * \li Action: Pastes simple unformatted text from the active clipboard.
1234  * \li Syntax: clipboard-paste-simple [<ARG>]
1235  * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1236  * \endvar
1237  */
1238                 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1239 /*!
1240  * \var lyx::FuncCode lyx::LFUN_UNDO
1241  * \li Action: Undoes the last edit.
1242  * \li Syntax: undo
1243  * \endvar
1244  */
1245                 { LFUN_UNDO, "undo", ReadOnly, Edit },
1246 /*!
1247  * \var lyx::FuncCode lyx::LFUN_REDO
1248  * \li Action: Redoes the last thing undone.
1249  * \li Syntax: redo
1250  * \endvar
1251  */
1252                 { LFUN_REDO, "redo", ReadOnly, Edit },
1253 /*!
1254  * \var lyx::FuncCode lyx::LFUN_REPEAT
1255  * \li Action: Repeat the given command.
1256  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1257  * \li Origin: Andre, 27 Oct 2003
1258  * \endvar
1259  */
1260                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1261 /*!
1262  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1263  * \li Action: Transposes the character at the cursor with the one before it.
1264  * \li Syntax: chars-transpose
1265  * \li Origin: Lgb, 25 Apr 2001
1266  * \endvar
1267  */
1268                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1269
1270 /*!
1271  * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1272  * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1273                inside lists.
1274  * \li Syntax: depth-decrement
1275  * \endvar
1276  */
1277                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1278 /*!
1279  * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1280  * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1281                inside lists.
1282  * \li Syntax: depth-increment
1283  * \endvar
1284  */
1285                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1286
1287 /*!
1288  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1289  * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1290  * \li Syntax: font-bold
1291  * \endvar
1292  */
1293                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1294
1295 /*!
1296  * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1297  * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1298  * \li Syntax: font-boldsymbol
1299  * \endvar
1300  */
1301                 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1302 /*!
1303  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1304  * \li Action: Toggles the typewriter family font (selection-wise).
1305  * \li Syntax: font-typewriter
1306  * \endvar
1307  */
1308                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1309 /*!
1310  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1311  * \li Action: Toggles underline in the font (selection-wise).
1312  * \li Syntax: font-underline
1313  * \endvar
1314  */
1315                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1316 /*!
1317  * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1318  * \li Action: Toggles double underline in the font (selection-wise).
1319  * \li Syntax: font-underunderline
1320  * \li Origin: sanda, 5 May 2009
1321  * \endvar
1322  */
1323                 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1324 /*!
1325  * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1326  * \li Action: Toggles wavy underline in the font (selection-wise).
1327  * \li Syntax: font-underwave
1328  * \li Origin: sanda, 5 May 2009
1329  * \endvar
1330  */
1331                 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1332 /*!
1333  * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1334  * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1335  * \li Syntax: font-strikeout
1336  * \li Origin: sanda, 3 May 2009
1337  * \endvar
1338  */
1339                 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1340 /*!
1341  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1342  * \li Action: Toggles the emphasis font style (selection-wise).
1343  * \li Syntax: font-emph
1344  * \endvar
1345  */
1346                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1347 /*!
1348  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1349  * \li Action: Toggles Noun text style font (selection-wise).
1350  * \li Syntax: font-noun
1351  * \endvar
1352  */
1353                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1354 /*!
1355  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1356  * \li Action: Toggles Roman family font (selection-wise).
1357  * \li Syntax: font-roman
1358  * \endvar
1359  */
1360                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1361 /*!
1362  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1363  * \li Action: Toggles Sans Serif family font (selection-wise).
1364  * \li Syntax: font-sans
1365  * \endvar
1366  */
1367                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1368 /*!
1369  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1370  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1371  * \li Syntax: font-frak
1372  * \li Origin: vermeer, 10 Jan 2002
1373  * \endvar
1374  */
1375                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1376 /*!
1377  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1378  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1379  * \li Syntax: font-ital
1380  * \li Origin: vermeer, 10 Jan 2002
1381  * \endvar
1382  */
1383                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1384 /*!
1385  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1386  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1387  * \li Syntax: font-default
1388  * \endvar
1389  */
1390                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1391 /*!
1392  * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1393  * \li Action: Sets font size according to lyx format string.
1394  * \li Syntax: font-size <SIZE>
1395  * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1396                        largest|huge|giant|increase|decrease|default
1397  * \endvar
1398  */
1399                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1400 /*!
1401  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1402  * \li Action: Toggle user-defined (=last-time used) text style.
1403  * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1404                automatically trigerred when using Text Style dialog.
1405  * \li Syntax: textstyle-apply
1406  * \li Origin: leeming, 12 Mar 2003
1407  * \endvar
1408  */
1409                 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1410 /*!
1411  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1412  * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1413  * \li Syntax: textstyle-update <FONT_INFO>
1414  * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1415                             size, emph, noun, underbar, number, color, language,
1416                             toggleall.\n
1417                             Use lyx -dbg action for exact syntax of text-style
1418                             dialog parameters.
1419  * \li Origin: leeming, 12 Mar 2003
1420  * \endvar
1421  */
1422                 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1423 /*!
1424  * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1425  * \li Action: Update fonts and its metrics.
1426  * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1427  * \li Syntax: screen-font-update
1428  * \li Origin: ARRae, 13 Aug 2000
1429  * \endvar
1430  */
1431                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1432 /*!
1433  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1434  * \li Action: Returns the info about the current font.
1435  * \li Syntax: font-state
1436  * \endvar
1437  */
1438                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1439
1440 /*!
1441  * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1442  * \li Action: Inserts citation from loaded citation database.
1443  * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1444  * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1445                <TEXT_BEFORE>: text which should appear before citation.
1446  * \li Origin: AAS, 97-02-23
1447  * \endvar
1448  */
1449                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1450 /*!
1451  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1452  * \li Action: Adds database, which will be used for bibtex citations.
1453  * \li Notion: Databases are added to the first BibTeX inset
1454                (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1455  * \li Syntax: bibtex-database-add <DATABASE-NAME>
1456  * \li Origin: Ale, 30 May 1997
1457  * \endvar
1458  */
1459                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1460 /*!
1461  * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1462  * \li Action: Adds database, which will be used for bibtex citations.
1463  * \li Notion: Databases are deleted from the first BibTeX inset
1464                (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1465  * \li Syntax: bibtex-database-del <DATABASE-NAME>
1466  * \li Origin: Ale, 30 May 1997
1467  * \endvar
1468  */
1469                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1470
1471 /*!
1472  * \var lyx::FuncCode lyx::LFUN_LAYOUT
1473  * \li Action: Sets the layout (that is, environment) for the current paragraph.
1474  * \li Syntax: layout <LAYOUT>
1475  * \li Params: <LAYOUT>: the layout to use
1476  * \endvar
1477  */
1478                 { LFUN_LAYOUT, "layout", Noop, Layout },
1479 /*!
1480  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1481  * \li Action: Launches the paragraph settings dialog.
1482  * \li Syntax: layout-paragraph
1483  * \endvar
1484  */
1485                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1486 /*!
1487  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1488  * \li Action: Launches the tabular settings dialog.
1489  * \li Syntax: layout-tabular
1490  * \li Origin: Jug, 31 Jul 2000
1491  * \endvar
1492  */
1493                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1494 /*!
1495  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1496  * \li Action: Displays list of layout choices.
1497  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1498                dropbox allowing for choice of layout.
1499  * \li Syntax: drop-layouts-choice
1500  * \endvar
1501  */
1502                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1503 /*!
1504  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1505  * \li Action: Clears the module list.
1506  * \li Notion: Clears the list of included modules for the current buffer.
1507  * \li Syntax: layout-modules-clear
1508  * \li Origin: rgh, 25 August 2007
1509  * \endvar
1510  */
1511                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1512 /*!
1513  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1514  * \li Action: Adds a module.
1515  * \li Notion: Adds a module to the list of included modules for the current buffer.
1516  * \li Syntax: layout-module-add <MODULE>
1517  * \li Params: <MODULE>: the module to be added
1518  * \li Origin: rgh, 25 August 2007
1519  * \endvar
1520  */
1521                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1522 /*!
1523  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1524  * \li Action: Reloads layout information.
1525  * \li Notion: Reloads all layout information for the current buffer from disk, thus
1526                recognizing any changes that have been made to layout files on the fly.
1527                This is intended to be used only by layout developers and should not be
1528                used when one is trying to do actual work.
1529  * \li Syntax: layout-reload
1530  * \li Origin: rgh, 3 September 2007
1531  * \endvar
1532  */
1533                 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1534 /*!
1535  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1536  * \li Action: Sets the text class for the current buffer.
1537  * \li Syntax: textclass-apply <TEXTCLASS>
1538  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1539                    the filename, minus the ".layout" extension.
1540  * \endvar
1541  */
1542                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1543 /*!
1544  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1545  * \li Action: Loads information for a textclass from disk.
1546  * \li Syntax: textclass-load <TEXTCLASS>
1547  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1548                    the filename, minus the ".layout" extension.
1549  * \endvar
1550  */
1551                 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1552
1553 /*!
1554  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1555  * \li Action: Disable selecting of text-region.
1556  * \li Syntax: mark-off
1557  * \endvar
1558  */
1559                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1560 /*!
1561  * \var lyx::FuncCode lyx::LFUN_MARK_ON
1562  * \li Action: Enable selecting of text-region.
1563  * \li Notion: After enabling you can simply move arrow keys to get selected region.
1564  * \li Syntax: mark-on
1565  * \endvar
1566  */
1567                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1568 /*!
1569  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1570  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1571  * \li Syntax: mark-toggle
1572  * \li Origin: Andre, May 5 2006
1573  * \endvar
1574  */
1575                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1576
1577 /*!
1578  * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1579  * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1580  * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1581  * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1582                              either a LaTeX name or a valid character.
1583                              ( is the default letter.
1584  * \li Sample: math-delim { rangle
1585  * \li Origin: Alejandro, 18 Jun 1996
1586  * \endvar
1587  */
1588                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1589 /*!
1590  * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1591  * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1592  * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1593  * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1594                <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1595  * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1596  * \li Origin: Enrico & Georg, 7 May 2006
1597  * \endvar
1598  */
1599                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1600 /*!
1601  * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1602  * \li Action: Creates a new displayed equation in text mode.
1603                Toggles inlined/display formula in math mode.
1604  * \li Syntax: math-display [<ARG>]
1605  * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1606                       new equation from the text mode.
1607  * \li Origin: Alejandro, 18 Jun 1996
1608  * \endvar
1609  */
1610                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1611 /*!
1612  * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1613  * \li Action: Inserts math objects and symbols.
1614  * \li Syntax: math-insert <ARG>
1615  * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1616  * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1617                (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1618                replaced by the current selection (only works if the selection
1619                is in mathed). As an example, if "abc" is selected in mathed,
1620                "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1621                and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1622                If nothing is selected (or the selection is not in mathed),
1623                math-insert works as expected.
1624  * \endvar
1625  */
1626                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1627 /*!
1628  * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1629  * \li Action: Enters subscript expression in math expression.
1630  * \li Syntax: math-subscript
1631  * \li Origin: vermeer, 12 Dec 2001
1632  * \endvar
1633  */
1634                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1635 /*!
1636  * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1637  * \li Action: Enters superscript expression in math expression.
1638  * \li Syntax: math-superscript
1639  * \li Origin: vermeer, 12 Dec 2001
1640  * \endvar
1641  */
1642                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1643 /*!
1644  * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1645  * \li Action: Toggles the position of the limits from above/below to the right
1646                side an vice versa in integral symbol, a limit, a summation, etc.
1647  * \li Notion: Put the cursor before the symbol with the limits and then invoke
1648                math-limits.
1649  * \li Syntax: math-limits [<STATE>]
1650  * \li Params: <STATE>: limits|nolimits
1651  * \endvar
1652  */
1653                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1654 /*!
1655  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1656  * \li Action: Inserts a math macro definition at the cursor position in the text.
1657  * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1658  * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1659                <NARGS>: The number of parameters of the macro. Default is 0.
1660                "def": Has no effect anymore, just for compatibility with former LyX versions.
1661  * \li Origin: ale, 10 May 1997;  sts, 21 Dec 2007
1662  * \endvar
1663  */
1664                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1665 /*!
1666  * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1667  * \li Action: Mutates the type of math inset to the newly selected one.
1668  * \li Syntax: math-mutate <TYPE>
1669  * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1670                        multline|gather|flalign
1671  * \li Origin: Andre, 23 May 2001
1672  * \endvar
1673  */
1674                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1675 /*!
1676  * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1677  * \li Action: Inserts space into math expression.
1678  * \li Notion: Use spacebar after entering this space to change type of space.
1679  * \li Syntax: math-space [<TYPE>] [<LEN>]
1680  * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1681                        positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1682                        custom space: hspace \n
1683                        "," used by default.\n
1684                        Note that ! is equivalent to negthinspace, , = thinspace,
1685                        : = medspace, and ; = thickspace.\n
1686                <LEN>: length for custom spaces (hspace)
1687  * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1688  * \endvar
1689  */
1690                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1691 /*!
1692  * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1693  * \li Action: Inserts a matrix.
1694  * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1695  * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1696                         (b, c or t) (i.e. 1 char) and the horizontal alignments
1697                         (l, c or r) (i.e. <COL> chars).
1698  * \li Sample: math-matrix 3 3 bccc
1699  * \endvar
1700  */
1701                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1702 /*!
1703  * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1704  * \li Action: Inserts a matrix.
1705  * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1706  * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1707                              that should be created.
1708  * \li Sample: math-ams-matrix 3 3 bmatrix
1709  * \endvar
1710  */
1711                 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1712 /*!
1713  * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1714  * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1715                cursor position), in math mode enters text mode inside math expression.
1716  * \li Notion: If there is some selected text, it puts the text inside created math box.
1717  * \li Syntax: math-mode [on|<ARG>]
1718  * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1719                 "on": allow only entering of math mode from text mode.
1720  * \li Origin: Alejandro, 4 Jun 1996
1721  * \endvar
1722  */
1723                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1724 /*!
1725  * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1726  * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1727                cursor position). Used by the advanced search dialog.
1728  * \li Notion: If there is any selected text, then it is moved inside the created
1729                regexp inset.
1730  * \li Syntax: regexp-mode [<ARG>]
1731  * \li Params: <ARG>: eventual argument (regular expression).
1732  * \li Origin: Tommaso, 4 Oct 2008
1733  * \endvar
1734  */
1735                 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1736 /*!
1737  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1738  * \li Action: Toggles numbering of the current formula line.
1739  * \li Notion: Must be in display formula mode.
1740  * \li Syntax: math-number-line-toggle
1741  * \li Origin: Alejandro, 18 Jun 1996
1742  * \endvar
1743  */
1744                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1745 /*!
1746  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1747  * \li Action: Toggles numbering/labeling of the current formula.
1748  * \li Notion: Must be in display formula mode.
1749  * \li Syntax: math-number-toggle
1750  * \li Origin: Alejandro, 4 Jun 1996
1751  * \endvar
1752  */
1753                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1754 /*!
1755  * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1756  * \li Action: Calls external program and passes the current expression/equation
1757                as an argument for the calculation in the format appropriate to the
1758                given language.
1759  * \li Notion: Selection can be used to determine the input for the external program.
1760  * \li Syntax: math-extern <LANG> [<COMMAND>]
1761  * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1762                        where "script" stands fot the external script (normalized
1763                        expression will be passed)
1764  * \li Origin: Andre, 24 Apr 2001
1765  * \li Sample: math-extern maple simplify
1766  * \endvar
1767  */
1768                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1769 /*!
1770  * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1771  * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1772  * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1773  * \li Syntax: math-size <STYLE>
1774  * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1775  * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1776  * \endvar
1777  */
1778                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1779 /*!
1780  * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1781  * \li Action: Changes the text style used in math.
1782  * \li Syntax: math-font-style <STYLE>
1783  * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1784                |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1785  * \li Origin: vfr, 9 jan 2009
1786  * \endvar
1787  */
1788                 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1789 /*!
1790  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1791  * \li Action: Unfold a Math Macro.
1792  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1793                display it as \foo.
1794  * \li Syntax: math-macro-unfold
1795  * \li Origin: sts, 06 January 2008
1796  * \endvar
1797  */
1798                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1799 /*!
1800  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1801  * \li Action: Fold a Math Macro.
1802  * \li Notion: Fold the Math Macro the cursor is in if it was
1803                unfolded, i.e. displayed as \foo before.
1804  * \li Syntax: math-macro-fold
1805  * \li Origin: sts, 06 January 2008
1806  * \endvar
1807  */
1808                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1809 /*!
1810  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1811  * \li Action: Add a parameter.
1812  * \li Notion: Add a parameter to a Math Macro.
1813  * \li Params: <NUM>: The number of the parameter behind which the new one
1814                will be added (1 for the first, i.e. use 0 for add a
1815                parameter at the left), defaults to the last one.
1816  * \li Syntax: math-macro-add-param <NUM>
1817  * \li Origin: sts, 06 January 2008
1818  * \endvar
1819  */
1820                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1821 /*!
1822  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1823  * \li Action: Remove the last parameter.
1824  * \li Notion: Remove the last parameter of a Math Macro and
1825                remove its value in all instances of the macro
1826                in the buffer.
1827  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1828                the first), defaults to the last one.
1829  * \li Syntax: math-macro-remove-param <NUM>
1830  * \li Origin: sts, 06 January 2008
1831  * \endvar
1832  */
1833                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1834 /*!
1835  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1836  * \li Action: Append a greedy parameter.
1837  * \li Notion: Append a greedy parameter to a Math Macro which
1838                eats the following mathed cell in every instance of
1839                the macro in the buffer.
1840  * \li Syntax: math-macro-append-greedy-param
1841  * \li Origin: sts, 06 January 2008
1842  * \endvar
1843  */
1844                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1845 /*!
1846  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1847  * \li Action: Remove a greedy parameter.
1848  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1849                out the values of it in every instance of the macro
1850                in the buffer. If it is an optional parameter the [valud]
1851                format is used.
1852  * \li Syntax: math-macro-remove-greedy-param
1853  * \li Origin: sts, 06 January 2008
1854  * \endvar
1855  */
1856                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1857 /*!
1858  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1859  * \li Action: Make a parameter optional.
1860  * \li Notion: Turn the first non-optional parameter of a Math Macro
1861                into an optional parameter with a default value.
1862  * \li Syntax: math-macro-make-optional
1863  * \li Origin: sts, 06 January 2008
1864  * \endvar
1865  */
1866                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1867 /*!
1868  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1869  * \li Action: Make a parameter non-optional.
1870  * \li Notion: Turn the last optional parameter of a Math Macro
1871                into a non-optional parameter. The default value is
1872                remembered to be reused later if the user changes his mind.
1873  * \li Syntax: math-macro-make-nonoptional
1874  * \li Origin: sts, 06 January 2008
1875  * \endvar
1876  */
1877                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1878 /*!
1879  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1880  * \li Action: Add an optional parameter.
1881  * \li Notion: Insert an optional parameter just behind the
1882                already existing optional parameters.
1883  * \li Syntax: math-macro-add-optional-param
1884  * \li Origin: sts, 06 January 2008
1885  * \endvar
1886  */
1887                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1888 /*!
1889  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1890  * \li Action: Remove the last optional parameter.
1891  * \li Notion: Remove the last optional parameter of a Math Macro and
1892                remove it in all the instances of the macro in the buffer.
1893  * \li Syntax: math-macro-remove-optional-param
1894  * \li Origin: sts, 06 January 2008
1895  * \endvar
1896  */
1897                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1898 /*!
1899  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1900  * \li Action: Add a greedy optional parameter.
1901  * \li Notion: Add a greedy optional parameter which eats the value
1902                from the following cells in mathed which are in the [value]
1903                format.
1904  * \li Syntax: math-macro-add-greedy-optional-param
1905  * \li Origin: sts, 06 January 2008
1906  * \endvar
1907  */
1908                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1909 /*!
1910  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1911  * \li Action: Only active in Math Macro definition.
1912  * \li Notion: Dummy function which is only active in a Math Macro definition.
1913                It's used to toggle the Math Macro toolbar if the cursor moves
1914                into a Math Macro definition.
1915  * \li Syntax: in-mathmacrotemplate
1916  * \li Origin: sts, 06 January 2008
1917  * \endvar
1918  */
1919                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1920
1921 /*!
1922  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1923  * \li Action: Moves the current paragraph downwards in the document.
1924  * \li Syntax: paragraph-move-down
1925  * \li Origin: Edwin, 8 Apr 2006
1926  * \endvar
1927  */
1928                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1929 /*!
1930  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1931  * \li Action: Moves the current paragraph upwards in the document.
1932  * \li Notion: Movement through the document will possibly break the paragraph-depth
1933                (e.g. itemize structure).
1934  * \li Syntax: paragraph-move-up
1935  * \li Origin: Edwin, 8 Apr 2006
1936  * \endvar
1937  */
1938                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1939
1940 /*!
1941  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1942  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1943                in upward direction.
1944  * \li Syntax: paragraph-up
1945  * \li Origin: Asger, 1 Oct 1996
1946  * \endvar
1947  */
1948                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1949 /*!
1950  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1951  * \li Action: Move the cursor and select the text to the next paragraph (or
1952                begining of the current one) in upward direction.
1953  * \li Syntax: paragraph-up-select
1954  * \li Origin: Asger, 1 Oct 1996
1955  * \endvar
1956  */
1957                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1958 /*!
1959  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1960  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1961                in downward direction.
1962  * \li Syntax: paragraph-down
1963  * \li Origin: Asger, 1 Oct 1996
1964  * \endvar
1965  */
1966                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1967 /*!
1968  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1969  * \li Action: Move the cursor and select the text to the next paragraph (or
1970                begining of the current one) in downward direction.
1971  * \li Syntax: paragraph-down-select
1972  * \li Origin: Asger, 1 Oct 1996
1973  * \endvar
1974  */
1975                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1976 /*!
1977  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1978  * \li Action: Jump to a paragraph given by its id number and optionally the
1979                desired position within the paragraph.
1980  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1981                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1982  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1983  * \li Params: <PAR_ID_NUMBER>:  paragraph id \n
1984                <POSITION_IN_PAR>: desired position within the paragraph
1985  * \li Origin: Dekel, 26 Aug 2000
1986  * \endvar
1987  */
1988                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1989 /*!
1990  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1991  * \li Action: Breaks the current paragraph at the current location.
1992  * \li Notion: Removes the selection.
1993  * \li Syntax: break-paragraph [<LAYOUT>]
1994  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1995                          to default layout) when the cursor is at the end of
1996                          the line.
1997  * \endvar
1998  */
1999                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
2000 /*!
2001  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
2002  * \li Action: Change paragraph settings.
2003  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
2004                This function only modifies, and does not override, existing settings.
2005                Note that the "leftindent" indent setting is deprecated.
2006  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2007  * \li Params: <INDENT>:  \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
2008                <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
2009                <ALIGN>:   \align block|left|right|center|default\n
2010                <OTHERS>:  \labelwidthstring WIDTH|\start_of_appendix
2011  * \li Origin: rgh, Aug 15 2007
2012  * \endvar
2013  */
2014                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2015 /*!
2016  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2017  * \li Action: Change paragraph settings.
2018  * \li Notion: Overwrite all nonspecified settings to the default ones.
2019                Use paragraph-params lfun if you don't want to overwrite others settings.
2020  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2021  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2022  * \li Origin: leeming, 30 Mar 2004
2023  * \endvar
2024  */
2025                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2026 /*!
2027  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2028  * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2029  * \li Notion: This is internal LFUN, not to be used by users. Called internally
2030                by #LFUN_DIALOG_UPDATE.
2031  * \li Origin: leeming, 13 Mar 2003
2032  * \endvar
2033  */
2034                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2035
2036 /*!
2037  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2038  * \li Action: Move the current group in the upward direction in the
2039                structure of the document.
2040  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2041                the whole substructure of the group.
2042  * \li Syntax: outline-up
2043  * \li Origin: Vermeer, 23 Mar 2006
2044  * \endvar
2045  */
2046                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2047 /*!
2048  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2049  * \li Action: Move the current group in the downward direction in the
2050                structure of the document.
2051  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2052                the whole substructure of the group.
2053  * \li Syntax: outline-down
2054  * \li Origin: Vermeer, 23 Mar 2006
2055  * \endvar
2056  */
2057                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2058 /*!
2059  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2060  * \li Action: Moves the current group in the downward direction in the
2061                hierarchy of the document structure.
2062  * \li Notion: Part -> Chapter -> Section -> etc.
2063  * \li Syntax: outline-in
2064  * \li Origin: Vermeer, 23 Mar 2006
2065  * \endvar
2066  */
2067                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2068 /*!
2069  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2070  * \li Action: Moves the current group in the upward direction in the
2071                hierarchy of the document structure.
2072  * \li Notion: Part <- Chapter <- Section <- etc.
2073  * \li Syntax: outline-out
2074  * \li Origin: Vermeer, 23 Mar 2006
2075  * \endvar
2076  */
2077                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2078
2079 /*!
2080  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2081  * \li Action: Edit the inset at cursor with an external application,
2082                if one is attributed.
2083  * \li Syntax: inset-edit [<INSET_PARAMS>]
2084  * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2085                                Currently only the filename will be considered.
2086  * \li Origin: JSpitzm, 27 Apr 2006
2087  * \endvar
2088  */
2089                 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2090
2091 /*!
2092  * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2093  * \li Action: Inserts table into the document.
2094  * \li Notion: See #LFUN_INSET_MODIFY for some more details
2095                about tabular modifications.
2096  * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2097  * \li Params: In case no arguments are given show insert dialog.
2098  * \li Origin: Jug, 12 Apr 2000
2099  * \endvar
2100  */
2101                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2102
2103 /*!
2104  * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2105  * \li Action: Moves the cursor to the previous cell inside the table.
2106  * \li Syntax: cell-backward
2107  * \li Origin: Jug, 22 May 2000
2108  * \endvar
2109  */
2110                 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2111 /*!
2112  * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2113  * \li Action: Moves the cursor to the next cell inside the table.
2114  * \li Syntax: cell-forward
2115  * \endvar
2116  */
2117                 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2118 /*!
2119  * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2120  * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2121  * \li Syntax: cell-split
2122  * \li Origin: Ale, 15 May 1997
2123  * \endvar
2124  */
2125                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2126
2127 /*!
2128  * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2129  * \li Action: Register the document as an file inside version control system.
2130  * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2131                of cvs/svn/rcs entries in the document's directory. \n
2132                See LyX Additional Features Manual (Version Control Chapter) for additional
2133                information.
2134  * \li Syntax: vc-register
2135  * \li Origin: Lgb, 1 Jul 1997
2136  * \endvar
2137  */
2138                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2139 /*!
2140  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2141  * \li Action: Checks-in/commits the changes of the registered file to the repository.
2142  * \li Notion: In RCS case this also unlocks the file.
2143  * \li Syntax: vc-check-in
2144  * \li Origin: Lgb, 1 Jul 1997
2145  * \endvar
2146  */
2147                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2148 /*!
2149  * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2150  * \li Action: Checks-out the document for edit (and locks it in some cases).
2151  * \li Syntax: vc-check-out
2152  * \li Origin: Lgb, 1 Jul 1997
2153  * \endvar
2154  */
2155                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2156 /*!
2157  * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2158  * \li Action: Reverts the document to the last check-in/commit in VCS.
2159  * \li Syntax: vc-revert
2160  * \li Origin: Lgb, 1 Jul 1997
2161  * \endvar
2162  */
2163                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2164 /*!
2165  * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2166  * \li Action: Undo last check-in.
2167  * \li Notion: This is currently implemented only for RCS.
2168  * \li Syntax: vc-check-out
2169  * \li Origin: Lgb, 1 Jul 1997
2170  * \endvar
2171  */
2172                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2173 /*!
2174  * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2175  * \li Action: Executes external command. This command is intended to support
2176                additional VCS commands.
2177  * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2178  * \li Params:  <FLAG>: Flags for the command can be combined together.\n
2179                         U - dUmmy - no flags \n
2180                         D - Doc - need document loaded to proceed \n
2181                         I - dIrty - mark document dirty \n
2182                         R - Reload - ensure that the document is saved and reload it after command execution \n
2183                         M - Message - ask for input string (commit message)\n
2184                 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2185                 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2186                            document(with absolute path)/path/message.
2187  * \li Sample: vc-command DR $$p "svn up"
2188  * \li Origin: sanda, 13 Jan 2009
2189  * \endvar
2190  */
2191                 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2192 /*!
2193  * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2194  * \li Action: Toggles the locking property of the edited file.
2195  * \li Notion: This is currently implemented only for SVN.
2196  * \li Syntax: vc-locking-toggle
2197  * \li Origin: sanda, 25 Jun 2009
2198  * \endvar
2199  */
2200                 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2201 /*!
2202  * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2203  * \li Action: Update the local archive directory in which resides
2204                the current document with the remote repository.
2205  * \li Syntax: vc-repo-update
2206  * \li Origin: sanda, 16 Oct 2009
2207  * \endvar
2208  */
2209                 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2210 /*!
2211  * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2212  * \li Action: Compares two revisions of the same file under version control.
2213  * \li Syntax: vc-compare [<REV1>] [<REV2>]
2214  * \li Params: Revision number either points directly to commit in history
2215                or if negative number -x it points to (last commit - x).\n
2216                In RCS we subtract only in the last number of revision specification.
2217                Special case "0" is reserved for the last committed revision.\n
2218                <REV1>: Older file.\n
2219                <REV2>: Newer file. Used only if REV1 > 0.\n
2220                If no parameter is given, interactive dialog will be shown.
2221  * \li Sample: Compare current document against last commit\n
2222                vc-compare 0\n
2223                Compare current document against current revision - 5 commits\n
2224                vc-compare -5\n
2225                Compare revisions 120 and 155\n
2226                vc-compare 120 155
2227  * \li Origin: sanda, 12 Feb 2010
2228  * \endvar
2229  */
2230                 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2231
2232 /*!
2233  * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2234  * \li Action: Toggles change tracking to on/off.
2235  * \li Syntax: changes-track
2236  * \li Origin: levon, 1 Oct 2002
2237  * \endvar
2238  */
2239                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2240 /*!
2241  * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2242  * \li Action: Toggles showing of change tracking in typesetted output.
2243  * \li Syntax: changes-output
2244  * \li Origin: jspitzm, 21 Jan 2005
2245  * \endvar
2246  */
2247                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2248 /*!
2249  * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2250  * \li Action: Moves the cursor to the position of the next change
2251                of the change tracking records.
2252  * \li Syntax: change-next
2253  * \li Origin: schmitt, 4 Oct 2006
2254  * \endvar
2255  */
2256                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2257 /*!
2258  * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2259  * \li Action: Moves the cursor to the position of the previous change
2260                of the change tracking records.
2261  * \li Syntax: change-previous
2262  * \li Origin: vfr, 4 Apr 2009
2263  * \endvar
2264  */
2265                 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2266 /*!
2267  * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2268  * \li Action: Open change tracking dialog for merging and moves the cursor
2269                to the position of the next change.
2270  * \li Syntax: changes-merge
2271  * \li Origin: Levon, 16 Oct 2002
2272  * \endvar
2273  */
2274                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2275 /*!
2276  * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2277  * \li Action: Accepts tracked change inside the selection.
2278  * \li Syntax: change-accept
2279  * \li Origin: Levon, 16 Oct 2002
2280  * \endvar
2281  */
2282                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2283 /*!
2284  * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2285  * \li Action: Rejects tracked change inside the selection.
2286  * \li Syntax: change-reject
2287  * \li Origin: Levon, 16 Oct 2002
2288  * \endvar
2289  */
2290                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2291 /*!
2292  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2293  * \li Action: Accepts all tracked changes in the document.
2294  * \li Syntax: all-changes-accept
2295  * \li Origin: Levon, 16 Oct 2002
2296  * \endvar
2297  */
2298                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2299 /*!
2300  * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2301  * \li Action: Rejects all tracked changes in the document.
2302  * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2303  * \li Syntax: all-changes-reject
2304  * \li Origin: Levon, 16 Oct 2002
2305  * \endvar
2306  */
2307                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2308
2309 /*!
2310  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2311  * \li Action: Apply data for an inset.
2312  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2313                be applied. This is either changed to #LFUN_INSET_MODIFY or
2314                #LFUN_INSET_INSERT depending on the context where it is called.
2315  * \li Syntax: inset-apply <ARGS>
2316  * \li Params: See #LFUN_INSET_INSERT .
2317  * \endvar
2318  */
2319                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2320 /*!
2321  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2322  * \li Action: Dissolve the current inset into text.
2323  * \li Syntax: inset-dissolve [<INSET>]
2324  * \li Params: <INSET>: this can be used to make sure the right kind of inset
2325                         is dissolved. For example "dissolve" entry in the charstyles
2326                         sub-menu should only dissolve the charstyle inset, even if the
2327                         cursor is inside several nested insets of different type.\n
2328                         For values see #lyx::InsetLayout::lyxtype_ .
2329  * \li Origin: JSpitz, 7 Aug 2006
2330  * \endvar
2331  */
2332                 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2333 /*!
2334  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2335  * \li Action: Insert new inset (type given by the parameters).
2336  * \li Syntax: inset-insert <INSET> <ARGS>
2337  * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2338                          hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2339                <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2340  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2341                where <label name> is the name of the referenced label and
2342                <Format> is one of the following: \n
2343                ref -- <reference> \n
2344                eqref -- (<reference>) \n
2345                pageref -- <page> \n
2346                vpageref -- on <page> \n
2347                vref -- <reference> on <page> \n
2348                formatted -- Formatted reference
2349  * \endvar
2350  */
2351                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2352 /*!
2353  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2354  * \li Action: Modify some properties of an inset.
2355  * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2356                         floats, graphics, include, index, info, label,
2357                         listings, newline, newpage, nomencl, note, phantom,
2358                         ref, space, tabular, vspace, wrap insets.
2359  * \li Syntax: inset-modify <INSET> <ARGS>
2360  * \li Syntax: inset-modify changetype <TYPE>
2361  * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2362  * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2363                In case that <INSET> is "tabular" various math-environment features
2364                are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2365                <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2366                        toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2367                        align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2368                        valign-top|valign-bottom|valign-middle|longtabular-align-left|
2369                        longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2370                        m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2371                        set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2372                        set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2373                        set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2374                        unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2375                        set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2376                        set-special-column|set-special-multicolumn|set-special-multirow|
2377                        set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2378                        set-interline-space|set-border-lines|tabular-valign-top|
2379                        tabular-valign-middle|tabular-valign-bottom|set-tabular-width \n
2380                <ARG>: additional argument for some commands, use debug mode to explore its values.
2381  * \li Sample: inset-modify note Note Comment \n
2382                inset-modify changetype Ovalbox
2383  * \endvar
2384  */
2385                 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2386 /*!
2387  * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2388  * \li Action: Updates the values inside the dialog from the inset.
2389  * \li Notion: This is internal LFUN, not to be used by users. Called internally
2390                by #LFUN_DIALOG_UPDATE
2391  * \li Params: <DIALOG-NAME>
2392  * \li Origin: leeming, 25 Feb 2003
2393  * \endvar
2394  */
2395                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2396 /*!
2397  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2398  * \li Action: Open the inset's properties dialog.
2399  * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2400                float, graphics, href, include, index, index_print, label, line,
2401                listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2402  * \li Syntax: inset-settings <INSET>
2403  * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2404                          graphics|href|include|index|index_print|label|line|
2405                          listings|note|phantom|ref|space|tabular|vspace|wrap>.
2406  * \endvar
2407  */
2408                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2409 /*!
2410  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2411  * \li Action: Toggles the collapsable inset at cursor position,
2412                or the inset we are currently in.
2413  * \li Syntax: inset-toggle [<ARG>]
2414  * \li Params: <ARG>: <open|close|toggle|assign>. \n
2415                open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2416                assign synchronize the branch-inset with activation status of the branch.
2417                Used for global toggling when changed activation.
2418  * \li Origin: lasgouttes, 19 Jul 2001
2419  * \endvar
2420  */
2421                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2422 /*!
2423  * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2424  * \li Action: Apply the given commands on insets of a given name.
2425  * \li Notion: WARNING: use at your own risks; this function gives
2426                you too many ways of shooting yourself in the foot.
2427                A typical example is
2428                    inset-forall Note note-insert
2429                which starts an infinite loop. This is mitigated by the fact
2430                that the number of actions is arbitrarily limited to 100000.
2431                Note also that inset-forall does not update metrics between
2432                iterations, which can lead to bugs. This has to be eventually
2433                fixed.
2434  * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2435                <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2436                The name is used like for InsetLayout in layout files: "Note"
2437                matches all note insets, while "Note:Note" only matches LyX
2438                yellow note insets.
2439  * \li Sample: Remove all index insets: \n
2440                    inset-forall Index delete-char-forward \n
2441                Close all Notes (also works for a particular branch, for example): \n
2442                    inset-forall Note inset-toggle close \n
2443                Transform all yellow notes to comments \n
2444                    inset-forall Note:Note inset-modify note Note Comment \n
2445                Try to put LyX in an infinite loop if there is at least a Note: \n
2446                    inset-forall Note char-backward
2447  * \li Origin: lasgouttes, 27 Nov 2009
2448  * \endvar
2449  */
2450                 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2451
2452 /*!
2453  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2454  * \li Action: Reloads the image if necessary.
2455  * \li Syntax: graphics-reload
2456  * \li Origin: vfr, 10 Aug 2009
2457  * \endvar
2458  */
2459                 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2460 /*!
2461  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2462  * \li Action: Set the group for the graphics inset on the cursor position.
2463  * \li Syntax: set-graphics-group [<GROUP>]
2464  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2465                         the graphics inset is removed from the current group.
2466  * \li Origin: sanda, 6 May 2008
2467  * \endvar
2468  */
2469                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2470
2471 /*!
2472  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2473  * \li Action: Moves the cursor out of the current slice, going forward.
2474  * \li Notion: Cursor movement within an inset may be different than cursor
2475                movement in the surrounding text. This action should be called
2476                automatically by the cursor movement within the inset, when
2477                movement within the inset has ceased (reached the end of the
2478                last paragraph, for example), in order to move correctly
2479                back into the surrounding text.
2480  * \endvar
2481  */
2482                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2483 /*!
2484  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2485  * \li Action: Moves the cursor out of the current slice, going backwards.
2486  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2487  * \endvar
2488  */
2489                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2490 /*!
2491  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2492  * \li Action: Moves the cursor out of the current slice, going right.
2493  * \li Notion: See also #LFUN_FINISHED_FORWARD
2494  * \endvar
2495  */
2496                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2497 /*!
2498  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2499  * \li Action: Moves the cursor out of the current slice, going left.
2500  * \li Notion: See also #LFUN_FINISHED_FORWARD.
2501  * \endvar
2502  */
2503                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2504
2505 /*!
2506  * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2507  * \li Action: Set language from the current cursor position.
2508  * \li Syntax: language <LANG>
2509  * \li Params: <LANG>: Requested language. Look in lib/languages for
2510                        the list.
2511  * \li Origin: Dekel, 2 Mar 2000
2512  * \endvar
2513  */
2514                 { LFUN_LANGUAGE, "language", Noop, Edit },
2515
2516 /*!
2517  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2518  * \li Action: Goto a label.
2519  * \li Syntax: label-goto [<LABEL>]
2520  * \li Params: <LABEL>: Requested label. If no label is given and reference
2521                         is on cursor position, Bookmark 0 is saved and
2522                         cursor moves to the position of referenced label.
2523  * \li Origin: Ale, 6 Aug 1997
2524  * \endvar
2525  */
2526                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2527 /*!
2528  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2529  * \li Action: Inserts label to text or displayed formula.
2530  * \li Syntax: label-insert [<LABEL>]
2531  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2532                         name will be opened.
2533  * \endvar
2534  */
2535                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2536 /*!
2537  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2538  * \li Action: Go to the next label or cross-reference.
2539  * \li Syntax: reference-next
2540  * \li Origin: Dekel, 14 Jan 2001
2541  * \endvar
2542  */
2543                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2544
2545 /*!
2546  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2547  * \li Action: Moves the cursor to the numbered bookmark, opening the file
2548                if necessary. Note that bookmarsk are saved per-session, not
2549                per file.
2550  * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2551                1. to the paragraph you are currently editing \n
2552                2. to the paragraph from where you are jumping to the last-edited
2553                   position (jump-back feature) \n
2554                3. when jumping from crossreference to the requested label by
2555                   #LFUN_LABEL_GOTO.
2556  * \li Syntax: bookmark-goto <NUMBER>
2557  * \li Params: <NUMBER>: the number of the bookmark to restore.
2558  * \li Origin: Dekel, 27 January 2001
2559  * \endvar
2560  */
2561                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2562 /*!
2563  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2564  * \li Action: Save a bookmark.
2565  * \li Notion: Saves a numbered bookmark to the sessions file. The number
2566                must be between 1 and 9, inclusive. Note that bookmarks are
2567                saved per-session, not per file.
2568  * \li Syntax: bookmark-save <NUMBER>
2569  * \li Params: <NUMBER>: the number of the bookmark to save.
2570  * \li Origin: Dekel, 27 January 2001
2571  * \endvar
2572  */
2573                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2574 /*!
2575  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2576  * \li Action: Clears the list of saved bookmarks.
2577  * \li Syntax: bookmark-clear
2578  * \li Origin: bpeng, 31 October 2006
2579  * \endvar
2580  */
2581                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2582
2583 /*!
2584  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2585  * \li Action: Open the given help file according to the language setting.
2586  * \li Syntax: help-open <FILE>[.lyx]
2587  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2588  * \li Origin: Jug, 27 Jun 1999
2589  * \endvar
2590  */
2591                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2592 /*!
2593  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2594  * \li Action: Terminates the current LyX instance.
2595  * \li Notion: Terminates the current LyX instance, asking whether to save
2596                modified documents, etc.
2597  * \li Syntax: lyx-quit
2598  * \endvar
2599  */
2600                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2601 /*!
2602  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2603  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2604  * \li Notion: Skipping "auto" when allowauto is false.
2605  * \li Syntax: toolbar-toggle <NAME> [allowauto]
2606  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2607                        minibuffer|review|view/update|math_panels|vcs|
2608                        view-others|update-others
2609  * \li Origin: Edwin, 21 May 2007
2610  * \endvar
2611  */
2612                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2613 /*!
2614  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2615  * \li Action: Opens the menu given by its name.
2616  * \li Syntax: menu-open <NAME>
2617  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2618  * \endvar
2619  */
2620                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2621 /*!
2622  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2623  * \li Action: Various UI visibility-toggling actions.
2624  * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2625  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
2626                menubar    : Toggle visibility of the menubar.\n
2627                scrollbar  : Toggle visibility of the scrollbar.\n
2628                frame      : Toggle visibility of the frames around editing window.\n
2629                fullscreen : Toggle fullscreen mode. This also covers calling the
2630                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2631                             custom tweaks of the toolbars should be used.
2632  * \li Origin: sanda, 9 Feb 2007
2633  * \endvar
2634  */
2635                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2636
2637 /*!
2638  * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2639  * \li Action: Creates new empty LyX window.
2640  * \li Notion: Already opened documents from the previous window can be found under View menu.
2641  * \li Syntax: window-new [<GEOMETRY>]
2642  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2643                            accepted only on Windows platform.
2644  * \li Origin: Abdel, 21 Oct 2006
2645  * \endvar
2646  */
2647                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2648 /*!
2649  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2650  * \li Action: Closes the current LyX window.
2651  * \li Syntax: window-close
2652  * \li Origin: Abdel, 23 Oct 2006
2653  * \endvar
2654  */
2655                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2656
2657 /*!
2658  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2659  * \li Action: Creates another split view of current buffer.
2660  * \li Notion: All split views act in the same way indpendently.
2661  * \li Syntax: split-view <vertical|horizontal>
2662  * \li Params: horizontal : The work areas are laid out side by side.\n
2663                vertical   : The work areas laid out vertically.
2664  * \li Origin: Abdel, 20 Feb 2008
2665  * \endvar
2666  */
2667                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2668
2669 /*!
2670  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2671  * \li Action: Close the current tab group.
2672  * \li Notion: This only closes the work areas, not the buffer themselves.
2673                The still opened buffers can be visualized in another tab group.
2674  * \li Syntax: close-tab-group
2675  * \li Origin: Abdel, 21 Feb 2008
2676  * \endvar
2677  */
2678                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2679 /*!
2680  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2681  * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2682  * \li Syntax: dialog-show <NAME> [<DATA>]
2683  * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2684                compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2685                graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2686                mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2687                print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2688                thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2689                <SPECIAL>: latexlog|vclog \n
2690                <DATA>: data, usually settings for the given dialog. Use debug mode for the
2691                        details.
2692  * \li Origin: leeming, 17 Jun 2003
2693  * \endvar
2694  */
2695                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2696 /*!
2697  * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2698  * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2699  * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2700  * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2701  * \li Params: See #LFUN_DIALOG_SHOW .
2702  * \li Origin: leeming, 25 Feb 2003
2703  * \endvar
2704  */
2705                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2706 /*!
2707  * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2708  * \li Action: Updates the dialog values from the inset/paragraph/document.
2709  * \li Syntax: dialog-update <NAME>
2710  * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2711                <INSET>: inset name
2712  * \li Origin: leeming, 25 Feb 2003
2713  * \endvar
2714  */
2715                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2716 /*!
2717  * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2718  * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2719  * \li Syntax: dialog-hide <NAME>
2720  * \li Params: See #LFUN_DIALOG_SHOW .
2721  * \li Origin: leeming, 25 Feb 2003
2722  * \endvar
2723  */
2724                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2725 /*!
2726  * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2727  * \li Action: Toggles dialog between showed/hidden state.
2728  * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2729  * \li Syntax: dialog-toggle <NAME> [<DATA>]
2730  * \li Params: See #LFUN_DIALOG_SHOW .
2731  * \li Origin: JSpitzm, 30 Apr 2007
2732  * \endvar
2733  */
2734                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2735 /*!
2736  * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2737  * \li Action: Closes opened connection to opened inset.
2738  * \li Notion: Connection is used for apply functions.
2739  * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2740  * \li Origin: leeming, 25 Feb 2003
2741  * \endvar
2742  */
2743                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2744
2745 /*!
2746  * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2747  * \li Action: This function is called when mouse button is pressed (inside workarea).
2748                Action depends on the context.
2749  * \li Notion: This is internal LFUN, not to be used by users.
2750  * \li Origin: Andre, 9 Aug 2002
2751  * \endvar
2752  */
2753                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2754 /*!
2755  * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2756  * \li Action: This function is called when double click on mouse button is
2757                pressed (inside workarea). Action depends on the context.
2758  * \li Notion: This is internal LFUN, not to be used by users.
2759  * \li Origin: Andre, 9 Aug 2002
2760  * \endvar
2761  */
2762                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2763 /*!
2764  * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2765  * \li Action: This function is called when triple click on mouse button is
2766                pressed (inside workarea). Action depends on the context.
2767  * \li Notion: This is internal LFUN, not to be used by users.
2768  * \li Origin: Andre, 9 Aug 2002
2769  * \endvar
2770  */
2771                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2772 /*!
2773  * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2774  * \li Action: This function is called when mouse cursor is moving over the text.
2775                Action depends on the context.
2776  * \li Notion: This is internal LFUN, not to be used by users.
2777  * \li Origin: Andre, 9 Aug 2002
2778  * \endvar
2779  */
2780                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2781 /*!
2782  * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2783  * \li Action: This function is called when mouse button is released (inside workarea).
2784                Action depends on the context.
2785  * \li Notion: This is internal LFUN, not to be used by users.
2786  * \li Origin: Andre, 9 Aug 2002
2787  * \endvar
2788  */
2789                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2790
2791 /*!
2792  * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2793  * \li Action: Turn off the loaded keyboard map.
2794  * \li Syntax: keymap-off
2795  * \endvar
2796  */
2797                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2798 /*!
2799  * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2800  * \li Action: Turn on the primary keyboard map.
2801  * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2802                keyboard support. They can be still used to maintain uniform keyboard
2803                layout across the various plaforms.\n
2804                The language is to be set in the Preferences dialog.
2805  * \li Syntax: keymap-primary
2806  * \endvar
2807  */
2808                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2809 /*!
2810  * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2811  * \li Action: Turn on the secondary keyboard map.
2812  * \li Syntax: keymap-secondary
2813  * \endvar
2814  */
2815                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2816 /*!
2817  * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2818  * \li Action: Toggles keyboard maps (first/second/off).
2819  * \li Syntax: keymap-toggle
2820  * \li Origin: leeming, 30 Mar 2004
2821  * \endvar
2822  */
2823                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2824
2825 /*!
2826  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2827  * \li Action: Returns the current layout (that is environment) name
2828                on the cursor position.
2829  * \li Syntax: server-get-layout
2830  * \endvar
2831  */
2832                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2833 /*!
2834  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2835  * \li Action: Returns path and file name of the currently edited document.
2836  * \li Syntax: server-get-filename
2837  * \endvar
2838  */
2839                 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2840 /*!
2841  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2842  * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2843  * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2844                line from LaTeX compilation. Note that before this function can be used
2845                export to LaTeX output must occur (in order to map the row numbers).
2846  * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2847  * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2848                        In case this LFUN does not work make sure you are giving correct
2849                        path to the file.\n
2850                        If the file is located inside LyX temporary directory it will be
2851                        mapped back into the appropriate opened buffer (e.g. for the case
2852                        of generated .tex file).\n
2853                  .ext: extensions will be automatically replaced by .lyx.\n
2854                  <ROW_NUMBER> The row number of the LaTeX file to which to go.
2855  * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
2856                server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
2857  * \li Origin: Edmar, 23 Dec 1998
2858  * \endvar
2859  */
2860                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2861 /*!
2862  * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2863  * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
2864                number in LyX window.
2865  * \li Notion: The external program used for forward search call can be specified in
2866                LyX Output preferences. See Additional manual for details of these
2867                settings.
2868  * \li Syntax: forward-search
2869  * \li Origin: sanda, 14 Apr 2010
2870  * \endvar
2871  */
2872                 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2873 /*!
2874  * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2875  * \li Action: Sends notify message about the last key-sequence to client.
2876  * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2877                See also Debug extensions section in Additional features manual.
2878  * \li Syntax: server-notify
2879  * \endvar
2880  */
2881                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2882 /*!
2883  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2884  * \li Action: Sets the cursor position based on the editing area coordinates
2885                (similar as clicking on that point with left mouse button).
2886  * \li Syntax: server-set-xy <X> <Y>
2887  * \endvar
2888  */
2889                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2890 /*!
2891  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2892  * \li Action: Returns the coordinates of cursor position in the editing area.
2893  * \li Syntax: server-get-xy
2894  * \endvar
2895  */
2896                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2897
2898 /*!
2899  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2900  * \li Action: Generates the code (literate programming).
2901  * \li Notion: Latex file with extension \literate_extension is generated.
2902                Then LyX invokes \build_command (with a default of``make'') to generate the code and
2903                \build_error_filter to process the compilation error messages. \n
2904                In case you want to process your literate file with a script, or some other program,
2905                just insert in your lyxrc file an entry with:\n
2906                \build_command "my_script my_arguments" \n
2907                The \build_error_filter differs from the \literate_error_filter only in that the
2908                former will identify error messages from your compiler.
2909  * \li Syntax: build-program
2910  * \endvar
2911  */
2912                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2913
2914 /*!
2915  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2916  * \li Action: Saves the current buffer to a temporary file.
2917  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2918                is called automatically by LyX, to "autosave" the current buffer.
2919  * \li Syntax: buffer-auto-save
2920  * \endvar
2921  */
2922                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2923 /*!
2924  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2925  * \li Action: Loads the given child document.
2926  * \li Notion: The current document is treated as a parent.
2927  * \li Syntax: buffer-child-open <FILE>
2928  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2929  * \li Origin: Ale, 28 May 1997
2930  * \endvar
2931  */
2932                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2933 /*!
2934  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2935  * \li Action: Runs chktex for the current document.
2936  * \li Syntax: buffer-chktex
2937  * \li Origin: Asger, 30 Oct 1997
2938  * \endvar
2939  */
2940                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2941 /*!
2942  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2943  * \li Action: Toggles compression of the current document on/off.
2944  * \li Syntax: buffer-toggle-compression
2945  * \li Origin: bpeng, 27 Apr 2006
2946  * \endvar
2947  */
2948                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2949 /*!
2950  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2951  * \li Action: Toggles including of resources for forward/reverse search of the given document.
2952  * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2953                is used for DVI. Custom LaTeX macro can be defined in preferences.
2954  * \li Syntax: buffer-toggle-output-sync
2955  * \li Origin: sanda, 25 May 2010
2956  * \endvar
2957  */
2958                 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2959 /*!
2960  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2961  * \li Action: Closes the current buffer.
2962  * \li Notion: Closes the current buffer, asking whether to save it, etc,
2963                if the buffer has been modified.
2964  * \li Syntax: buffer-close
2965  * \endvar
2966  */
2967                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2968 /*!
2969  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2970  * \li Action: Closes all buffers.
2971  * \li Notion: Closes all buffers, asking whether to save it, etc,
2972                if a buffer has been modified.
2973  * \li Syntax: buffer-close-all
2974  * \endvar
2975  */
2976                 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2977 /*!
2978  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2979  * \li Action: Exports the current buffer (document) to the given format.
2980  * \li Syntax: buffer-export <FORMAT> [<DEST>]
2981  * \li Params: <FORMAT> is either "custom" or one of the formats which you
2982                         can find in Tools->Preferences->File formats->Format.
2983                         Usual format you will enter is "pdf2" (pdflatex),
2984                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2985                         In case of "custom" you will be asked for a format you
2986                         want to start from and for the command that you want to
2987                         apply to this format. Internally the control is then passed
2988                         to #LFUN_BUFFER_EXPORT_CUSTOM.
2989                 <DEST>  If present, this argument provides the export destination
2990                         filename. Its containing folder will also be the destination
2991                         folder, where all the needed external files will be copied.
2992  * \li Origin: Lgb, 29 Jul 1997
2993  * \endvar
2994  */
2995                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2996 /*!
2997  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2998  * \li Action: Exports the current buffer (document) from the given format using
2999                the given command on it.
3000  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
3001  * \li Params: <FORMAT> format to start from (LyX will care to produce such
3002                         intermediate file).\n
3003                <COMMAND> this command will be launched on the file. Note that you can
3004                          use "$$FName" string to qualify the intermediate file.
3005  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
3006  * \li Origin: leeming, 27 Mar 2004
3007  * \endvar
3008  */
3009                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3010 /*!
3011  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3012  * \li Action: Pops up a dialog for exporting the current buffer.
3013  * \li Syntax: buffer-export-as
3014  * \li Origin: tommaso, 6 Oct 2011
3015  * \endvar
3016  */
3017                 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3018 /*!
3019  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
3020  * \li Action: Prints the current document.
3021  * \li Notion: Many settings can be given via the preferences dialog.
3022  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
3023  * \li Params: <TARGET> is either "printer" or "file".\n
3024                <TARGER-NAME> is either "default" or file name or printer name.\n
3025                <COMMAND> command ensuring the printing job.
3026  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3027  * \li Origin: leeming, 28 Mar 2004
3028  * \endvar
3029  */
3030                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3031 /*!
3032  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3033  * \li Action: Import a given file as a lyx document.
3034  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3035                defined convertors in preferences. Look into File->Import menu to get
3036                an idea of the currently active import formats.
3037  * \li Syntax: buffer-import <FORMAT> [<FILE>]
3038  * \li Origin: Asger, 24 Jul 1998
3039  * \endvar
3040  */
3041                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3042 /*!
3043  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3044  * \li Action: Creates a new buffer (that is, document).
3045  * \li Notion: Implicit path can be set in Preferences dialog.
3046  * \li Syntax: buffer-new [<FILE>]
3047  * \li Params: <FILE>: filename of created file with absolute path.
3048  * \endvar
3049  */
3050                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3051 /*!
3052  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3053  * \li Action: Creates a new buffer (that is, document) from a template.
3054  * \li Notion: Path for new files and templates can be set in Preferences dialog.
3055                Template will be asked for via Open-dialog.
3056  * \li Syntax: buffer-new-template [<FILE>]
3057  * \li Params: <FILE>: filename of created file with absolute path.
3058  * \endvar
3059  */
3060                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3061 /*!
3062  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3063  * \li Action: Reverts opened document.
3064  * \li Syntax: buffer-reload
3065  * \li Origin: Asger, 2 Feb 1997
3066  * \endvar
3067  */
3068                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3069 /*!
3070  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3071  * \li Action: Display/switch to the given buffer.
3072  * \li Syntax: buffer-switch <BUFFER>
3073  * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3074                          document which is to be shown.
3075  * \endvar
3076  */
3077                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3078 /*!
3079  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3080  * \li Action: Toggle editing mode of the current document between read/write and read-only.
3081  * \li Notion: This function is not allowed if the file is under version control, since
3082                read-only flag is often used in version control file locking.
3083  * \li Syntax: buffer-toggle-read-only
3084  * \li Origin: Lgb, 27 May 1997
3085  * \endvar
3086  */
3087                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3088 /*!
3089  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3090  * \li Action: Displays current buffer in chosen format.
3091  * \li Notion: Displays the contents of the current buffer in the chosen
3092                format, for example, PDF or DVI. This runs the necessary
3093                converter, calls the defined viewer, and so forth.
3094  * \li Syntax: buffer-view [<FORMAT>]
3095  * \li Params: <FORMAT>: The format to display, where this is one of the
3096                          formats defined (in the current GUI) in the
3097                          Tools>Preferences>File Formats dialog.
3098                          If no format is given, the default format as
3099                          specified in the same dialog is used.
3100  * \endvar
3101  */
3102                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3103 /*!
3104  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3105  * \li Action: Exports the current document and put the result into the
3106                temporary directory.
3107  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3108                the output will be rewriten - updated. This is useful in case your viewer
3109                is able to detect such changes (e.g. ghostview for postscript).
3110  * \li Syntax: buffer-update [<FORMAT>]
3111  * \li Params: <FORMAT>: The format to display, where this is one of the
3112                          formats defined (in the current GUI) in the
3113                          Tools>Preferences>File Formats dialog.
3114                          If no format is given, the default format as
3115                          specified in the same dialog is used.
3116  * \li Origin: Dekel, 5 Aug 2000
3117  * \endvar
3118  */
3119                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3120
3121 /*!
3122  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3123  * \li Action: Saves the current buffer.
3124  * \li Notion: Saves the current buffer to disk, using the filename that
3125                is already associated with the buffer, asking for one if
3126                none is yet assigned.
3127  * \li Syntax: buffer-write
3128  * \endvar
3129  */
3130                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3131 /*!
3132  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3133  * \li Action: Rename and save current buffer.
3134  * \li Syntax: buffer-write-as <FILENAME>
3135  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3136                is with respect to the original location of the buffer/file.
3137  * \endvar
3138  */
3139                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3140 /*!
3141  * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
3142  * \li Action: Applies a command to all visible, hidden, or both types of buffers in the active window.
3143  * \li Syntax: buffer-forall [<BUFFER-TYPE>] <LFUN-COMMAND>
3144  * \li Params: <BUFFER-TYPE>: <visible|hidden|both default:> default: visible
3145                <LFUN-COMMAND>: The command that is to be applied to the buffers.
3146  * \li Sample: Close all Notes in all visible documents: \n
3147                    buffer-forall inset-forall Note inset-toggle close \n
3148                Toggle change tracking on all documents: \n
3149                    buffer-forall both changes-track \n
3150                Toggle read-only for all visible documents: \n
3151                    buffer-forall buffer-toggle-read-only \n
3152                Show statistics for each document: \n
3153                    buffer-forall both statistics \n
3154                Activate the branch named "Solutions" in all visible documents: \n
3155                    buffer-forall branch-activate Solutions \n
3156                Export all visible documents to PDF (pdflatex): \n
3157                    buffer-forall buffer-export pdf2 \n
3158  * \li Origin: scottkostyshak, 20 Jul 2012
3159  * \endvar
3160  */
3161                 { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
3162 /*!
3163  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3164  * \li Action: Save all changed documents.
3165  * \li Syntax: buffer-write-all
3166  * \li Origin: rgh, gpothier 6 Aug 2007
3167  * \endvar
3168  */
3169                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3170 /*!
3171  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3172  * \li Action: Switch to the next opened document.
3173  * \li Notion: Note that this does not necessarily mean next in tabbar
3174                (for full list see View menu).
3175  * \li Syntax: buffer-next
3176  * \endvar
3177  */
3178                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3179 /*!
3180  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3181  * \li Action: Switch to the previous opened document.
3182  * \li Syntax: buffer-previous
3183  * \endvar
3184  */
3185                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3186 /*!
3187  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3188  * \li Action: When run from a child document, this updates (exports) document built
3189                from the master buffer, if available.
3190  * \li Syntax: master-buffer-update [<FORMAT>]
3191  * \li Params: <FORMAT>: The format to display, where this is one of the
3192                          formats defined (in the current GUI) in the
3193                          Tools>Preferences>File Formats dialog.
3194                          If no format is given, the default format as
3195                          specified in the same dialog is used.
3196  * \li Origin: Tommaso, 20 Sep 2007
3197  * \endvar
3198  */
3199                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3200 /*!
3201  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3202  * \li Action: When run from a child document, this command shows a preview built
3203                from the master buffer, if available.
3204  * \li Syntax: master-buffer-view [<FORMAT>]
3205  * \li Params: <FORMAT>: The format to display, where this is one of the
3206                          formats defined (in the current GUI) in the
3207                          Tools>Preferences>File Formats dialog.
3208                          If no format is given, the default format as
3209                          specified in the same dialog is used.
3210  * \li Origin: Tommaso, 20 Sep 2007
3211  * \endvar
3212  */
3213                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3214 /*!
3215  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3216  * \li Action: Set language of the current document.
3217  * \li Syntax: buffer-language <LANG>
3218  * \li Params: <LANG>: language name. See lib/languages for list.
3219  * \li Origin: leeming, 30 Mar 2004
3220  * \endvar
3221  */
3222                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3223 /*!
3224  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3225  * \li Action: Save the current document settings as default.
3226  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3227  * \li Syntax: buffer-save-as-default [<ARGS>]
3228  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3229                        you can find in document header of usual .lyx file.
3230  * \li Origin: leeming, 30 Mar 2004
3231  * \endvar
3232  */
3233                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3234 /*!
3235  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3236  * \li Action: Apply the given settings to the current document.
3237  * \li Syntax: buffer-params-apply [<ARGS>]
3238  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3239                        you can find in document header of usual .lyx file.
3240  * \li Origin: leeming, 30 Mar 2004
3241  * \endvar
3242  */
3243                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3244
3245 /*!
3246  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3247  * \li Action: Inserts another LyX file.
3248  * \li Syntax: file-insert [<FILE>]
3249  * \li Params: <FILE>: Filename to be inserted.
3250  * \endvar
3251  */
3252                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3253 /*!
3254  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3255  * \li Action: Inserts plain text file.
3256  * \li Syntax: file-insert-plaintext [<FILE>]
3257  * \li Params: <FILE>: Filename to be inserted.
3258  * \li Origin: CFO-G, 19 Nov 1997
3259  * \endvar
3260  */
3261                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3262 /*!
3263  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3264  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3265  * \li Syntax: file-insert-plaintext-para [<FILE>]
3266  * \li Params: <FILE>: Filename to be inserted.
3267  * \li Origin: Levon, 14 Feb 2001
3268  * \endvar
3269  */
3270                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3271 /*!
3272  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3273  * \li Action: Open LyX document.
3274  * \li Syntax: file-open [<FILE>]
3275  * \li Params: <FILE>: Filename to be opened.
3276  * \endvar
3277  */
3278                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3279
3280 /*!
3281  * \var lyx::FuncCode lyx::LFUN_CALL
3282  * \li Action: Executes a command defined in a .def file.
3283  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3284                A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3285                where <NAME> is the name of the new command and <LFUN> is the lfun code
3286                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3287                \def_file "FileName" allows to include another .def file. \n
3288                This is particularly useful in connection with toolbar buttons:
3289                Since the name of the button image for this lfun is
3290                lib/images/commands/<NAME>.png this is the way to assign an image
3291                to a complex command-sequence.
3292  * \li Syntax: call <NAME>
3293  * \li Params: <NAME>: Name of the command that must be called.
3294  * \li Origin: broider, 2 Oct 2007
3295  * \endvar
3296  */
3297                 { LFUN_CALL, "call", NoBuffer, System },
3298 /*!
3299  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3300  * \li Action: Simulate halting Meta key (Alt key on PCs).
3301  * \li Notion: Used for buffer editation not for GUI control.
3302  * \li Syntax: meta-prefix
3303  * \endvar
3304  */
3305                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3306 /*!
3307  * \var lyx::FuncCode lyx::LFUN_CANCEL
3308  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3309  * \li Syntax: cancel
3310  * \endvar
3311  */
3312                 { LFUN_CANCEL, "cancel", NoBuffer, System },
3313
3314 /*!
3315  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3316  * \li Action: Switches the focus to the minibuffer so that the user can type
3317                in there. If necessary, it opens the minibuffer toolbar.
3318  * \li Notion: Usually bound to M-x shortcut.
3319  * \li Syntax: command-execute
3320  * \endvar
3321  */
3322                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3323
3324 /*!
3325  * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3326  * \li Action: Return the current key sequence and available options as a string.
3327  * \li Notion: No options are added if no current map exists. \n
3328                This is probably usable only with connection to lyxserver.
3329  * \li Syntax: command-prefix
3330  * \endvar
3331  */
3332                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3333 /*!
3334  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3335  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3336  * \li Syntax: command-sequence <CMDS>
3337  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3338  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3339  * \li Origin: Andre, 11 Nov 1999
3340  * \endvar
3341  */
3342                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3343 /*!
3344  * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3345  * \li Action: Runs the first listed command that is enabled.
3346  * \li Notion: This can be used to bind multiple functions to a single key,
3347                and then which one is used will depend upon the context.
3348  * \li Syntax: command-alternatives <CMDS>
3349  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3350  * \li Sample: command-alternatives completion-accept;cell-forward
3351  * \li Origin: rgh, 24 September 2008
3352  * \endvar
3353  */
3354                 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3355 /*!
3356  * \var lyx::FuncCode lyx::LFUN_MESSAGE
3357  * \li Action: Shows message in statusbar (for script purposes).
3358  * \li Syntax: message <STRING>
3359  * \li Origin: Lgb, 8 Apr 2001
3360  * \endvar
3361  */
3362                 { LFUN_MESSAGE, "message", NoBuffer, System },
3363 /*!
3364  * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3365  * \li Action: Set debug output level.
3366  * \li Syntax: debug-level-set <LEVEL>
3367  * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3368                         of their combination. 0 is equivalent to disabling all debug
3369                         events. See lyx -dbg for the current list of debug levels
3370                         and their numbers.
3371  * \li Origin: sanda, 28 Dec 2009
3372  * \endvar
3373  */
3374                 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3375
3376 /*!
3377  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3378  * \li Action: Save user preferences.
3379  * \li Syntax: preferences-save
3380  * \li Origin: Lgb, 27 Nov 1999
3381  * \endvar
3382  */
3383                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3384 /*!
3385  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3386  * \li Action: Reconfigure the automatic settings.
3387  * \li Syntax: reconfigure
3388  * \li Origin: Asger, 14 Feb 1997
3389  * \endvar
3390  */
3391                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3392 /*!
3393  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3394  * \li Action: Apply the given settings to user preferences.
3395  * \li Syntax: lyxrc-apply <SETTINGS>
3396  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3397                            to get an idea which commands to use and their syntax.
3398                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
3399  * \endvar
3400  */
3401                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3402 /*!
3403  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3404  * \li Action: Determine whether keep cursor inside the editing window regardless
3405                the scrollbar movement.
3406  * \li Syntax: toggle-cursor-follows-scrollbar
3407  * \li Origin: ARRae, 2 Dec 1997
3408  * \endvar
3409  */
3410                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3411 /*!
3412  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3413  * \li Action: Set the given LyX color to the color defined by the X11 name given.
3414  * \li Notion: A new color entry is created if the color is unknown.
3415                Color names can be stored as a part of user settings.
3416  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3417  * \li Origin: SLior, 11 Jun 2000
3418  * \endvar
3419  */
3420                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3421 /*!
3422  * \var lyx::FuncCode lyx::LFUN_STATISTICS
3423  * \li Action: Count the statistics (number of words and characters)
3424                in the document or in the given selection.
3425  * \li Notion: Note that this function gives the number of words/chars written,
3426                not the number of characters which will be typeset.
3427  * \li Syntax: statistics
3428  * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3429  * \endvar
3430  */
3431                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3432 /*!
3433  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3434  * \li Action: Show the inline completion at the cursor position.
3435  * \li Syntax: completion-inline
3436  * \li Origin: sts, Feb 19 2008
3437  * \endvar
3438  */
3439                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3440 /*!
3441  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3442  * \li Action: Show the completion popup at the cursor position.
3443  * \li Syntax: completion-popup
3444  * \li Origin: sts, Feb 19 2008
3445  * \endvar
3446  */
3447                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3448 /*!
3449  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3450  * \li Action: Try to complete the word or command at the cursor position.
3451  * \li Syntax: complete
3452  * \li Origin: sts, Feb 19 2008
3453  * \endvar
3454  */
3455                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3456
3457 /*!
3458  * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3459  * \li Action: Try to cancel completion, either the popup or the inline completion.
3460  * \li Syntax: completion-cancel
3461  * \li Origin: sts, Sep 07 2008
3462  * \endvar
3463  */
3464                 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3465 /*!
3466  * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3467  * \li Action: Accept suggested completion.
3468  * \li Syntax: completion-accept
3469  * \li Origin: sanda, Sep 08 2008
3470  * \endvar
3471  */
3472                 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3473
3474
3475 /*!
3476  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3477  * \li Action: Add a branch to the buffer's BranchList.
3478  * \li Syntax: branch-add <BRANCH>
3479  * \li Params: <BRANCH>: Name of the branch to add
3480  * \li Origin: spitz, 7 Jul 2009
3481  * \endvar
3482  */
3483                 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3484
3485
3486 /*!
3487  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3488  * \li Action: Activate the branch.
3489  * \li Syntax: branch-activate <BRANCH>
3490  * \li Params: <BRANCH>: The branch to activate
3491  * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3492                could be used to export a pdf with the answers branch included
3493                without one's having to open LyX and activate the branch manually.
3494  * \li Origin: rgh, 27 May 2008
3495  * \endvar
3496  */
3497                 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3498 /*!
3499  * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3500  * \li Action: De-activate the branch.
3501  * \li Syntax: branch-deactivate <BRANCH>
3502  * \li Params: <BRANCH>: The branch to deactivate
3503  * \li Origin: rgh, 27 May 2008
3504  * \endvar
3505  */
3506                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3507
3508 /*!
3509  * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3510  * \li Action: Rename all branches of a given name in a document.
3511  * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3512  * \li Params: <OLDNAME>: Current name of the branch to be renamed
3513  *             <NEWNAME>: New name of the branch
3514  * \li Origin: spitz, 9 Jul 2009
3515  * \endvar
3516  */
3517                 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3518 /*!
3519  * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3520  * \li Action: Create new branch and directly put the branch inset into
3521                the document.
3522  * \li Syntax: branch-add-insert [<NAME>]
3523  * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3524  * \li Origin: sanda, 10 Jul 2009
3525  * \endvar
3526  */
3527                 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3528
3529
3530 /*!
3531  * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3532  * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3533  * \li Syntax: copy-label-as-reference <LABEL>
3534  * \li Params: <LABEL>: The label to copy (for multi-line math)
3535  * \li Origin: sts, 16 Nov 2008
3536  * \endvar
3537  */
3538                 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3539                         ReadOnly | NoUpdate | AtPoint, Edit },
3540
3541 /*!
3542  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3543  * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3544  * \li Syntax: label-insert-as-reference
3545  * \li Origin: vfr, 7 Apr 2009
3546  * \endvar
3547  */
3548                 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3549
3550 /*!
3551  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3552  * \li Action: Increases the zoom of the screen fonts.
3553  * \li Syntax: buffer-zoom-in [<ZOOM>]
3554  * \li Params: <ZOOM>: The zoom in %, the default is 20.
3555  * \li Origin: vfr, 30 Mar 2009
3556  * \endvar
3557  */
3558                 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3559
3560 /*!
3561  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3562  * \li Action: Decreases the zoom of the screen fonts.
3563  * \li Syntax: buffer-zoom-out [<ZOOM>]
3564  * \li Params: <ZOOM>: The zoom in %, the default is 20.
3565  * \li Origin: vfr, 30 Mar 2009
3566  * \endvar
3567  */
3568                 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3569
3570 /*!
3571  * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3572  * \li Action: Copies the inset to the clipboard as a certain type.
3573  * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3574  * \li Syntax: inset-copy-as
3575  * \li Origin: vfr, 18 Apr 2010
3576  * \endvar
3577  */
3578                 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3579
3580                 { LFUN_NOACTION, "", Noop, Hidden }
3581 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3582         };
3583
3584         for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3585                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3586
3587         init = true;
3588 }
3589 #endif
3590
3591 LyXAction::LyXAction()
3592 {
3593         init();
3594 }
3595
3596
3597 FuncRequest LyXAction::lookupFunc(string const & func) const
3598 {
3599         string const func2 = trim(func);
3600
3601         if (func2.empty())
3602                 return FuncRequest(LFUN_NOACTION);
3603
3604         string cmd;
3605         string const arg = split(func2, cmd, ' ');
3606
3607         FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3608
3609         return fit != lyx_func_map.end()
3610                         ? FuncRequest(fit->second, arg)
3611                         : FuncRequest(LFUN_UNKNOWN_ACTION);
3612 }
3613
3614
3615 string const LyXAction::getActionName(FuncCode action) const
3616 {
3617         InfoMap::const_iterator const it = lyx_info_map.find(action);
3618         return it != lyx_info_map.end() ? it->second.name : string();
3619 }
3620
3621
3622 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3623 {
3624         InfoMap::const_iterator const it = lyx_info_map.find(action);
3625         return it != lyx_info_map.end() ? it->second.type : Hidden;
3626 }
3627
3628
3629 bool LyXAction::funcHasFlag(FuncCode action,
3630                             LyXAction::FuncAttribs flag) const
3631 {
3632         InfoMap::const_iterator ici = lyx_info_map.find(action);
3633
3634         if (ici == lyx_info_map.end()) {
3635                 LYXERR0("action: " << action << " is not known.");
3636                 LASSERT(false, /**/);
3637         }
3638
3639         return ici->second.attrib & flag;
3640 }
3641
3642
3643 LyXAction::const_iterator LyXAction::func_begin() const
3644 {
3645         return lyx_func_map.begin();
3646 }
3647
3648
3649 LyXAction::const_iterator LyXAction::func_end() const
3650 {
3651         return lyx_func_map.end();
3652 }
3653
3654
3655 LyXErr & operator<<(LyXErr & l, FuncCode code)
3656 {
3657         if (l.enabled())
3658                 l.stream() << lyxaction.getActionName(code);
3659         return l;
3660 }
3661
3662 } // namespace lyx