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