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  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "LyXAction.h"
  17
  18 #include "FuncRequest.h"
  19
  20 #include "support/debug.h"
  21 #include "support/lstrings.h"
  22
  23 #include "support/lassert.h"
  24
  25 using namespace std;
  26 using namespace lyx::support;
  27
  28 namespace lyx {
  29
  30 /*
  31      NAMING RULES FOR USER-COMMANDS
  32      Here's the set of rules to apply when a new command name is introduced:
  33
  34      1) Use the object.event order. That is, use `word-forward'
  35         instead of `forward-word'.
  36      2) Don't introduce an alias for an already named object. Same for events.
  37      3) Forward movement or focus is called `forward' (not `right').
  38      4) Backward movement or focus is called `backward' (not `left').
  39      5) Upward movement of focus is called `up'.
  40      6) Downward movement is called `down'.
  41      7) The begin of an object is called `begin' (not `start').
  42      8) The end of an object is called `end'.
  43
  44      (May 19 1996, 12:04, RvdK)
  45 */
  46
  47 /* LFUN documentation (a start at least, Chr 2007-08-12)
  48  *
  49  * The documentation below is primarily notes about restrictions and
  50  * oddities relating to the different LFUNs.
  51  *
  52  * Try to find an appropriate (thematical) place when adding the new LFUN.
  53  *
  54  * Doxygen template below. Some notes: Parameters should be set in uppercase
  55  * and put in <BRACKETS>, as so.
  56  */
  57
  58 /*!
  59  * \var lyx::FuncCode lyx::LFUN_
  60  * \li Action:
  61  * \li Notion:
  62  * \li Syntax:
  63  * \li Params:
  64  * \li Sample:
  65  * \li Origin:
  66  * \endvar
  67  */
  68
  69 LyXAction lyxaction;
  70
  71
  72 void LyXAction::newFunc(FuncCode action, string const & name,
  73                         unsigned int attrib, LyXAction::func_type type)
  74 {
  75         lyx_func_map[name] = action;
  76         FuncInfo tmpinfo;
  77         tmpinfo.name = name;
  78         tmpinfo.attrib = attrib;
  79         tmpinfo.type = type;
  80         lyx_info_map[action] = tmpinfo;
  81 }
  82
  83
  84 // Needed for LFUNs documentation to be accepted, since doxygen won't take
  85 // \var inside functions.
  86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  87 void LyXAction::init()
  88 {
  89         // This function was changed to use the array below in initalization
  90         // instead of calling newFunc numerous times because of compilation
  91         // times. Since the array is not static we get back the memory it
  92         // occupies after the init is completed. It compiles several
  93         // magnitudes faster.
  94
  95         static bool init;
  96         if (init) return;
  97
  98         struct ev_item {
  99                 FuncCode action;
 100                 char const * name;
 101                 unsigned int attrib;
 102                 func_type type;
 103         };
 104
 105         ev_item const items[] = {
 106 #endif
 107 /*!
 108  * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
 109  * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
 110                to the next character typed.
 111  * \li Syntax: accent-acute
 112  * \endvar
 113  */
 114                 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
 115 /*!
 116  * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
 117  * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
 118                to the next character typed.
 119  * \li Syntax: accent-breve
 120  * \endvar
 121  */
 122                 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
 123 /*!
 124  * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
 125  * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
 126                to the next character typed.
 127  * \li Syntax: accent-caron
 128  * \endvar
 129  */
 130                 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
 131 /*!
 132  * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
 133  * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
 134                to the next character typed.
 135  * \li Syntax: accent-cedilla
 136  * \endvar
 137  */
 138                 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
 139 /*!
 140  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
 141  * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
 142                to the next character typed.
 143  * \li Syntax: accent-circle
 144  * \endvar
 145  */
 146                 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
 147 /*!
 148  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
 149  * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
 150                to the next character typed.
 151  * \li Syntax: accent-circumflex
 152  * \endvar
 153  */
 154                 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
 155 /*!
 156  * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
 157  * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
 158                to the next character typed.
 159  * \li Syntax: accent-dot
 160  * \endvar
 161  */
 162                 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
 163 /*!
 164  * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
 165  * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
 166                to the next character typed.
 167  * \li Syntax: accent-grave
 168  * \endvar
 169  */
 170                 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
 171 /*!
 172  * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
 173  * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
 174                to the next character typed.
 175  * \li Syntax: accent-grave
 176  * \endvar
 177  */
 178                 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
 179 /*!
 180  * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
 181  * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
 182                to the next character typed.
 183  * \li Syntax: accent-macron
 184  * \endvar
 185  */
 186                 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
 187 /*!
 188  * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
 189  * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
 190                to the next character typed.
 191  * \li Syntax: accent-ogonek
 192  * \endvar
 193  */
 194                 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
 195 /*!
 196  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
 197  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
 198                over the next two character typed.
 199  * \li Notion: the following char will finish the tie.
 200  * \li Syntax: accent-tie
 201  * \endvar
 202  */
 203                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
 204 /*!
 205  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
 206  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
 207                over the next character typed.
 208  * \li Syntax: accent-tilde
 209  * \endvar
 210  */
 211                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
 212 /*!
 213  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
 214  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
 215                over the next character typed.
 216  * \li Syntax: accent-umlaut
 217  * \endvar
 218  */
 219                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
 220 /*!
 221  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
 222  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
 223                under the next character typed.
 224  * \li Syntax: accent-underbar
 225  * \endvar
 226  */
 227                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
 228 /*!
 229  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
 230  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
 231                under the next character typed.
 232  * \li Syntax: accent-underdot
 233  * \endvar
 234  */
 235                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
 236
 237 /*!
 238  * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
 239  * \li Action: Inserts a caption inset.
 240  * \li Syntax: caption-insert
 241  * \li Origin: Lgb, 18 Jul 2000
 242  * \endvar
 243  */
 244                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
 245 /*!
 246  * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
 247  * \li Action: Inserts the current date.
 248  * \li Syntax: date-insert [<ARG>]
 249  * \li Params: <ARG>: Format of date. The default value (%x) can be set
 250                      in Preferences->Date format. For possible formats
 251                      see manual page of strftime function.
 252  * \li Origin: jdblair, 31 Jan 2000
 253  * \endvar
 254  */
 255                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
 256 /*!
 257  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
 258  * \li Action: Inserts a footnote inset.
 259  * \li Syntax: footnote-insert
 260  * \li Origin: Jug, 7 Mar 2000
 261  * \endvar
 262  */
 263                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
 264 /*!
 265  * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
 266  * \li Action: Inserts an ERT inset.
 267  * \li Syntax: ert-insert
 268  * \li Origin: Jug, 18 Feb 2000
 269  * \endvar
 270  */
 271                 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
 272 /*!
 273  * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
 274  * \li Action: Inserts a float inset.
 275  * \li Syntax: float-insert <TYPE>
 276  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
 277                        "algorithm", "table", "figure" parameters can be given.
 278  * \li Origin: Lgb, 27 Jun 2000
 279  * \endvar
 280  */
 281                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
 282 /*!
 283  * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
 284  * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
 285  * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
 286  * \li Syntax: float-wide-insert <TYPE>
 287  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
 288                        "algorithm", "table", "figure" parameters can be given.
 289  * \li Origin: Lgb, 31 Oct 2001
 290  * \endvar
 291  */
 292                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
 293 /*!
 294  * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
 295  * \li Action: Inserts the list of floats in the document.
 296  * \li Syntax: float-list-insert <TYPE>
 297  * \li Params: <TYPE>: type of float depends on the used textclass. Usually
 298                        "algorithm", "table", "figure" parameters can be given.
 299  * \li Origin: Lgb, 3 May 2001
 300  * \endvar
 301  */
 302                 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
 303 /*!
 304  * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
 305  * \li Action: Inserts floats wrapped by the text around.
 306  * \li Syntax: wrap-insert <TYPE>
 307  * \li Params: <TYPE>: table|figure
 308  * \li Origin: Dekel, 7 Apr 2002
 309  * \endvar
 310  */
 311                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
 312 /*!
 313  * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
 314  * \li Action: Inserts an optional-argument (short title) inset.
 315  * \li Syntax: optional-insert
 316  * \li Origin: Martin, 12 Aug 2002
 317  * \endvar
 318  */
 319                 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
 320 /*!
 321  * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
 322  * \li Action: Inserts a horizontal line.
 323  * \li Syntax: line-insert
 324  * \li Origin: poenitz,  Oct 27 2003
 325  * \endvar
 326  */
 327                 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
 328 /*!
 329  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
 330  * \li Action: Inserts a new page.
 331  * \li Syntax: newpage-insert<ARG>
 332  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 333  * \li Origin: uwestoehr, 24 Nov 2007
 334  * \endvar
 335  */
 336                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
 337 /*!
 338  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
 339  * \li Action: Inserts a marginal note.
 340  * \li Syntax: marginalnote-insert
 341  * \li Origin: Lgb, 26 Jun 2000
 342  * \endvar
 343  */
 344                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
 345 /*!
 346  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
 347  * \li Action: Inserts a single unicode character.
 348  * \li Syntax: unicode-insert <CHAR>
 349  * \li Params: <CHAR>: The character to insert, given as its code
 350                        point, in hexadecimal, e.g.: 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_QUOTE_INSERT
 365  * \li Action: Inserts quotes according to the type and quote-language preference.
 366  * \li Action: Currently  English, Swedish, German, Polish, French, Danish quotes
 367                are distinguished.
 368  * \li Syntax: quote-insert [<TYPE>]
 369  * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
 370  * \endvar
 371  */
 372                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
 373 /*!
 374  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
 375  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
 376                information in a non-editable boxed InsetText.
 377  * \li Notion: Apart from lfun arguments you can use the following method: \n
 378                1. input the type and argument of this inset, e.g. "menu paste", in
 379                the work area.\n
 380                2. select the text and run info-insert lfun.\n
 381  * \li Syntax: info-insert <TYPE> <ARG>
 382  * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
 383                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
 384                       description.
 385  * \li Origin: bpeng, 7 Oct 2007
 386  * \endvar
 387  */
 388                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
 389 /*!
 390  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
 391  * \li Action: Inserts branch inset.
 392  * \li Syntax: branch-insert <BRANCH-NAME>
 393  * \li Origin: vermeer, 17 Aug 2003
 394  * \endvar
 395  */
 396                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
 397 /*!
 398  * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
 399  * \li Action: Inserts Box inset.
 400  * \li Syntax: box-insert [<TYPE>]
 401  * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
 402                        Framed is the default one.
 403  * \li Origin: vermeer, 7 Oct 2003
 404  * \endvar
 405  */
 406                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
 407 /*!
 408  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
 409  * \li Action: Inserts CharStyle, Custom inset or XML short element.
 410  * \li Notion: Look into the Customization manual for more information about
 411                these elements.\n
 412                For dissolving the element see #LFUN_INSET_DISSOLVE.
 413  * \li Syntax: flex-insert <TYPE:Name>
 414  * \li Params: TYPE: CharStyle|Custom|Element|Standard
 415                      Identifies whether this is a Character Style, a
 416                      Custom Inset or an XML Element, and which dynamical
 417                      sub-menu this flex inset is in on the LyX menu tree.
 418                      If Standard (currently unused): none of these.
 419                Name: This name must be defined either in your layout file
 420                      or imported by some module. The definition is\n
 421                      InsetLayout <TYPE:Name>
 422  * \li Sample: flex-insert CharStyle:Code
 423  * \endvar
 424  */
 425                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
 426 /*!
 427  * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
 428  * \li Action: Inserts the given string (accordingly to the correct keymap).
 429  * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
 430                settings "auto_region_delete".
 431  * \li Syntax: self-insert <STRING>
 432  * \endvar
 433  */
 434                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
 435 /*!
 436  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
 437  * \li Action: Inserts one of horizontal space insets.
 438  * \li Syntax: space-insert <NAME> [<LEN>]
 439  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
 440                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
 441                        hspace* \n
 442                <LEN>: length for custom spaces (hspace, hspace* for protected)
 443  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
 444  * \endvar
 445  */
 446                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
 447 /*!
 448  * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
 449  * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
 450  * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
 451  * \li Syntax: href-insert [<TARGET>]
 452  * \li Origin: CFO-G, 21 Nov 1997
 453  * \endvar
 454  */
 455                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
 456 /*!
 457  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
 458  * \li Action: Inserts various characters into the document.
 459  * \li Syntax: specialchar-insert <CHAR>
 460  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
 461                        end-of-sentence, menu-separator.
 462  * \li Origin: JSpitzm, 6 Dec 2007
 463  * \endvar
 464  */
 465                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
 466 /*!
 467  * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
 468  * \li Action: Inserts table of contents.
 469  * \li Syntax: toc-insert
 470  * \li Origin: Lgb, 27 May 97
 471  * \endvar
 472  */
 473                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
 474 /*!
 475  * \var lyx::FuncCode lyx::LFUN_APPENDIX
 476  * \li Action: Start (or remove) Appendix on the given cursor position.
 477  * \li Syntax: appendix
 478  * \li Origin: ettrich, 5 May 1998
 479  * \endvar
 480  */
 481                 { LFUN_APPENDIX, "appendix", Noop, Edit },
 482
 483 /*!
 484  * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
 485  * \li Action: Inserts Index entry.
 486  * \li Notion: It automatically takes the word on the cursor position.
 487  * \li Syntax: index-insert
 488  * \li Origin: Angus, 3 Aug 2000
 489  * \endvar
 490  */
 491                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
 492 /*!
 493  * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
 494  * \li Action: Inserts list of Index entries on a new page.
 495  * \li Syntax: index-print
 496  * \li Origin: Lgb, 27 Feb 1997
 497  * \endvar
 498  */
 499                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
 500
 501 /*!
 502  * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
 503  * \li Action: Inserts Nomenclature entry.
 504  * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
 505  * \li Syntax: nomencl-insert [<SYMBOL>]
 506  * \li Origin: Ugras, 4 Nov 2006
 507  * \endvar
 508  */
 509                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
 510 /*!
 511  * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
 512  * \li Action: Inserts list of Nomenclature entries.
 513  * \li Syntax: nomenclature-print
 514  * \li Origin: Ugras, 4 Nov 2006
 515  * \endvar
 516  */
 517                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
 518
 519 /*!
 520  * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
 521  * \li Action: Inserts Note on the current cursor postion,
 522                move selection inside the inset.
 523  * \li Syntax: note-insert [<TYPE>]
 524  * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
 525  * \endvar
 526  */
 527                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
 528 /*!
 529  * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
 530  * \li Action: Moves the cursor to the begining of next Note inset.
 531  * \li Syntax: note-next
 532  * \endvar
 533  */
 534                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
 535 /*!
 536  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
 537  * \li Action: Inserts a line break or new line.
 538  * \li Syntax: newline-insert [<ARG>]
 539  * \li Params: <ARG>: <newline|linebreak> default: newline
 540  * \li Origin: JSpitzm, 25 Mar 2008
 541  * \endvar
 542  */
 543                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
 544
 545 /*!
 546  * \var lyx::FuncCode lyx::LFUN_ESCAPE
 547  * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
 548  * \li Syntax: escape
 549  * \li Origin: Lgb, 17 May 2001
 550  * \endvar
 551  */
 552                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
 553 /*!
 554  * \var lyx::FuncCode lyx::LFUN_DOWN
 555  * \li Action: Moves the cursor one line in downward direction.
 556  * \li Syntax: down
 557  * \endvar
 558  */
 559                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
 560 /*!
 561  * \var lyx::FuncCode lyx::LFUN_UP
 562  * \li Action: Moves the cursor one line in upward direction.
 563  * \li Syntax: up
 564  * \endvar
 565  */
 566                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
 567 /*!
 568  * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
 569  * \li Action: Moves the cursor one line in downward direction adding the current
 570                position to the selection.
 571  * \li Syntax: down-select
 572  * \endvar
 573  */
 574                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
 575 /*!
 576  * \var lyx::FuncCode lyx::LFUN_UP_SELECT
 577  * \li Action: Moves the cursor one line in upward direction adding the current
 578                position to the selection.
 579  * \li Syntax: up-select
 580  * \endvar
 581  */
 582                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
 583 /*!
 584  * \var lyx::FuncCode lyx::SCREEN_DOWN
 585  * \li Action: Moves the cursor one page in downward direction.
 586  * \li Syntax: screen-down
 587  * \endvar
 588  */
 589                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
 590 /*!
 591  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
 592  * \li Action: Moves the cursor one page in upward direction.
 593  * \li Syntax: screen-up
 594  * \endvar
 595  */
 596                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
 597 /*!
 598  * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
 599  * \li Action: Moves the cursor one screen in downward direction adding the current
 600                position to the selection.
 601  * \li Syntax: screen-down-select
 602  * \endvar
 603  */
 604                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
 605 /*!
 606  * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
 607  * \li Action: Moves the cursor one page in upward direction adding the current
 608                position to the selection.
 609  * \li Syntax: screen-up-select
 610  * \endvar
 611  */
 612                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
 613 /*!
 614  * \var lyx::FuncCode lyx::LFUN_SCROLL
 615  * \li Action: Scroll the buffer view.
 616  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
 617  * \li Syntax: scroll <TYPE> <QUANTITY>
 618  * \li Params: <TYPE>:  line|page\n
 619                <QUANTITY>: up|down|<number>
 620  * \li Origin: Abdelrazak Younes, Dec 27 2007
 621  * \endvar
 622  */
 623                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
 624 /*!
 625  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
 626  * \li Action: Recenters the screen on the current cursor position.
 627  * \li Syntax: screen-recenter
 628  * \endvar
 629  */
 630                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
 631
 632 /*!
 633  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
 634  * \li Action: Moves the cursor one position logically backwards.
 635  * \li Notion: This is not the action which should be bound to the arrow keys,
 636                because backwards may be left or right, depending on the
 637                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
 638                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 639  * \li Syntax: char-backward
 640  * \endvar
 641  */
 642                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
 643 /*!
 644  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
 645  * \li Action: Moves the cursor one position logically backwards, adding
 646                traversed position to the selection.
 647  * \li Notion: See also #LFUN_CHAR_BACKWARD.
 648  * \li Syntax: char-backward-select
 649  * \endvar
 650  */
 651                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
 652 /*!
 653  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
 654  * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
 655  * \li Syntax: char-delete-backward
 656  * \endvar
 657  */
 658                 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
 659 /*!
 660  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
 661  * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
 662  * \li Syntax: char-delete-forward
 663  * \endvar
 664  */
 665                 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
 666 /*!
 667  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
 668  * \li Action: Moves the cursor one position logically forward.
 669  * \li Notion: This is not the action which should be bound to the arrow keys,
 670                because forward may be left or right, depending on the language.
 671                The arrow keys should be bound to #LFUN_CHAR_LEFT or
 672                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 673  * \li Syntax: char-forward
 674  * \endvar
 675  */
 676                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
 677 /*!
 678  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
 679  * \li Action: Moves the cursor one position logically forward, adding
 680                traversed position to the selection.
 681  * \li Notion: See also #LFUN_CHAR_FORWARD.
 682  * \li Syntax: char-forward-select
 683  * \endvar
 684  */
 685                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
 686 /*!
 687  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
 688  * \li Action: Moves the cursor one position "to the left".
 689  * \li Notion: This is the action which should be taken when the "left" key
 690                is pressed. Generally, it moves the cursor one position to the
 691                left. However, in Bidi text this become slightly more
 692                complicated, and there are different modes of cursor movement.
 693                In "visual mode", this moves left, plain and simple. In "logical
 694                mode", movement is logically forward in RTL paragraphs, and
 695                logically backwards in LTR paragraphs.
 696  * \li Syntax: char-left
 697  * \endvar
 698  */
 699                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
 700 /*!
 701  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
 702  * \li Action: Moves the cursor one position "to the left", adding
 703                traversed position to the selection.
 704  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
 705  * \li Syntax: char-left-select
 706  * \endvar
 707  */
 708                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
 709 /*!
 710  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
 711  * \li Action: Moves the cursor one position "to the right".
 712  * \li Notion: This is the action which should be taken when the "right" key
 713                is pressed. Generally, it moves the cursor one position to the
 714                right. However, in Bidi text this become slightly more
 715                complicated, and there are different modes of cursor movement.
 716                In "visual mode", this moves right, plain and simple. In "logical
 717                mode", movement is logically forward in LTR paragraphs, and
 718                logically backwards in RTL paragraphs.
 719  * \li Syntax: char-right
 720  * \endvar
 721  */
 722                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
 723 /*!
 724  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
 725  * \li Action: Moves the cursor one position "to the right", adding
 726                traversed position to the selection.
 727  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
 728  * \li Syntax: char-right-select
 729  * \endvar
 730  */
 731                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
 732
 733 /*!
 734  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
 735  * \li Action: Moves the cursor to the logically previous beginning of a word.
 736  * \li Notion: This is not the action which should be bound to the arrow keys,
 737                because backwards may be left or right, depending on the
 738                language. The arrow keys should be bound to #LFUN_WORD_LEFT or
 739                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
 740  * \li Syntax: word-backward
 741  * \endvar
 742  */
 743                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
 744 /*!
 745  * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
 746  * \li Action: Moves the cursor to the logically previous beginning of a word,
 747                            adding the logically traversed text to the selection.
 748  * \li Notion: See also #LFUN_WORD_BACKWARD.
 749  * \li Syntax: word-backward-select
 750  * \endvar
 751  */
 752                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
 753 /*!
 754  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
 755  * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
 756  * \li Syntax: word-delete-backward
 757  * \endvar
 758  */
 759                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
 760 /*!
 761  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
 762  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
 763  * \li Syntax: word-delete-forward
 764  * \endvar
 765  */
 766                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
 767 /*!
 768  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
 769  * \li Action: Search for a given string in forward direction.
 770  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 771  * \li Syntax: word-find-forward [<STRING>]
 772  * \li Origin: Etienne, 16 Feb 1998
 773  * \endvar
 774  */
 775                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
 776 /*!
 777  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
 778  * \li Action: Search for a given string in backward direction.
 779  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 780  * \li Syntax: word-find-backward [<STRING>]
 781  * \li Origin: Etienne, 20 Feb 1998
 782  * \endvar
 783  */
 784                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
 785 /*!
 786  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
 787  * \li Action: Search for next occurence of a string.
 788  * \li Syntax: word-find [<DATA>]
 789  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
 790                        If no parameter is given, search with last find-dialog
 791                        data is used for search (i.e. find-next).
 792  * \li Origin: poenitz, Jan 7 2004
 793  * \endvar
 794  */
 795                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
 796 /*!
 797  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
 798  * \li Action: Replace a string in the document.
 799  * \li Syntax: word-replace [<DATA>]
 800  * \li Params: <DATA>: data is of the form
 801                        "<search> \n
 802                         <replace> \n
 803                         <casesensitive> <matchword> <all> <forward>"
 804  * \li Origin: poenitz, Jan 7 2004
 805  * \endvar
 806  */
 807                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
 808 /*!
 809  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
 810  * \li Action: Moves the cursor to the logically next beginning of a word.
 811  * \li Notion: This is not the action which should be bound to the arrow keys,
 812                because forward may be left or right, depending on the language.
 813                The arrow keys should be bound to #LFUN_WORD_LEFT or
 814                #LFUN_WORD_RIGHT actions, which in turn may employ this one.
 815  * \li Syntax: word-forward
 816  * \endvar
 817  */
 818                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
 819 /*!
 820  * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
 821  * \li Action: Moves the cursor to the logically next beginning of a word,
 822                            adding the logically traversed text to the selection.
 823  * \li Notion: See also #LFUN_WORD_FORWARD.
 824  * \li Syntax: word-forward-select
 825  * \endvar
 826  */
 827                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
 828 /*!
 829  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
 830  * \li Action: Moves the cursor to the next beginning of a word "on the left".
 831  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
 832                            "left" key is pressed. Generally, it moves the cursor to the
 833                            next beginning of a word on the left. However, in Bidi text this
 834                            become slightly more complicated, and there are different modes
 835                            of cursor movement. In "visual mode", this moves left, plain and
 836                            simple. In "logical mode", movement is logically forward in RTL
 837                            paragraphs, and logically backwards in LTR paragraphs.
 838  * \li Syntax: word-left
 839  * \li Origin: dov, 28 Oct 2007
 840  * \endvar
 841  */
 842                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
 843 /*!
 844  * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
 845  * \li Action: Moves the cursor to the next beginning of a word "on the left",
 846                            adding *logically* traversed text to the selection.
 847  * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
 848  * \li Syntax: word-left-select
 849  * \li Origin: dov, 28 Oct 2007
 850  * \endvar
 851  */
 852                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
 853 /*!
 854  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
 855  * \li Action: Moves the cursor to the next beginning of a word "on the right".
 856  * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
 857                            "right" key is pressed. Generally, it moves the cursor to the
 858                            next beginning of a word on the right. However, in Bidi text
 859                            this become slightly more complicated, and there are different
 860                            modes of cursor movement. In "visual mode", this moves right,
 861                            plain and simple. In "logical mode", movement is logically
 862                            forward in LTR paragraphs, and logically backwards in RTL
 863                            paragraphs.
 864  * \li Syntax: word-right
 865  * \li Origin: dov, 28 Oct 2007
 866  * \endvar
 867  */
 868                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
 869 /*!
 870  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
 871  * \li Action: Moves the cursor to the next beginning of a word "on the right",
 872                            adding *logically* traversed text to the selection.
 873  * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
 874  * \li Syntax: word-right-select
 875  * \li Origin: dov, 28 Oct 2007
 876  * \endvar
 877  */
 878                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
 879 /*!
 880  * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
 881  * \li Action: Puts the word where the cursor stands into the selection.
 882  * \li Syntax: word-select
 883  * \li Author: Andre, 11 Sep 2002
 884  * \endvar
 885  */
 886                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 887 /*!
 888  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
 889  * \li Action: Capitalizes the words in the selection (i.e. the first letters)
 890                or the letter on the cursor position.
 891  * \li Syntax: word-capitalize
 892  * \endvar
 893  */
 894                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
 895 /*!
 896  * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
 897  * \li Action: Change the words in the selection or from the cursor position
 898                to the end of word to the upper case.
 899  * \li Syntax: word-upcase
 900  * \endvar
 901  */
 902                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
 903 /*!
 904  * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
 905  * \li Action: Change the words in the selection or from the cursor position
 906                to the end of word to the lower case.
 907  * \li Syntax: word-lowcase
 908  * \endvar
 909  */
 910                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
 911 /*!
 912  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
 913  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
 914  * \li Syntax: thesaurus-entry
 915  * \li Origin: Levon, 20 Jul 2001
 916  * \endvar
 917  */
 918                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
 919 /*!
 920  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
 921  * \li Action: Move the cursor to the beginning of the document.
 922  * \li Syntax: buffer-begin
 923  * \endvar
 924  */
 925                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
 926 /*!
 927  * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
 928  * \li Action: Move the cursor to the beginning of the document adding the
 929                traversed text to the selection.
 930  * \li Syntax: buffer-begin-select
 931  * \endvar
 932  */
 933                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
 934 /*!
 935  * \var lyx::FuncCode lyx::LFUN_BUFFER_END
 936  * \li Action: Move the cursor to the end of the document.
 937  * \li Syntax: buffer-end
 938  * \endvar
 939  */
 940                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
 941 /*!
 942  * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
 943  * \li Action: Move the cursor to the end of the document adding the
 944                traversed text to the selection.
 945  * \li Syntax: buffer-end-select
 946  * \endvar
 947  */
 948                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 949
 950 /*!
 951  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
 952  * \li Action: Move the cursor to the begining of the (screen) line.
 953  * \li Syntax: line-begin
 954  * \endvar
 955  */
 956                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
 957 /*!
 958  * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
 959  * \li Action: Move the cursor to the beginning of the (screen) line adding the
 960                traversed text to the selection.
 961  * \li Syntax: line-begin-select
 962  * \endvar
 963  */
 964                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
 965 /*!
 966  * \var lyx::FuncCode lyx::LFUN_LINE_END
 967  * \li Action: Move the cursor to the end of the (screen) line.
 968  * \li Syntax: line-end
 969  * \endvar
 970  */
 971                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
 972 /*!
 973  * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
 974  * \li Action: Move the cursor to the end of the (screen) line adding the
 975                traversed text to the selection.
 976  * \li Syntax: line-end-select
 977  * \endvar
 978  */
 979                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
 980 /*!
 981  * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
 982  * \li Action: Deletes the letters to the end of the (screen) line or
 983                deletes the selection.
 984  * \li Syntax: line-delete-forward
 985  * \endvar
 986  */
 987                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 988 /*!
 989  * \var lyx::FuncCode lyx::LFUN_COPY
 990  * \li Action: Copies to the clipboard the last edit.
 991  * \li Syntax: copy
 992  * \endvar
 993  */
 994                 { LFUN_COPY, "copy", ReadOnly, Edit },
 995 /*!
 996  * \var lyx::FuncCode lyx::LFUN_CUT
 997  * \li Action: Cuts to the clipboard.
 998  * \li Syntax: cut
 999  * \endvar
1000  */
1001                 { LFUN_CUT, "cut", Noop, Edit },
1002 /*!
1003  * \var lyx::FuncCode lyx::LFUN_PASTE
1004  * \li Action: Pastes from the active clipboard.
1005  * \li Syntax: paste
1006  * \endvar
1007  */
1008                 { LFUN_PASTE, "paste", Noop, Edit },
1009                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1010 /*!
1011  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1012  * \li Action: Pastes the material currently selected.
1013  * \li Syntax: primary-selection-paste
1014  * \endvar
1015  */
1016                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1017 /*!
1018  * \var lyx::FuncCode lyx::LFUN_UNDO
1019  * \li Action: Undoes the last edit.
1020  * \li Syntax: undo
1021  * \endvar
1022  */
1023                 { LFUN_UNDO, "undo", Noop, Edit },
1024 /*!
1025  * \var lyx::FuncCode lyx::LFUN_REDO
1026  * \li Action: Redoes the last thing undone.
1027  * \li Syntax: redo
1028  * \endvar
1029  */
1030                 { LFUN_REDO, "redo", Noop, Edit },
1031 /*!
1032  * \var lyx::FuncCode lyx::LFUN_REPEAT
1033  * \li Action: Repeat the given command.
1034  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1035  * \li Author: poenitz, 27 Oct 2003
1036  * \endvar
1037  */
1038                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1039 /*!
1040  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1041  * \li Action: Transposes the character at the cursor with the one before it.
1042  * \li Syntax: chars-transpose
1043  * \li Author: Lgb, 25 Apr 2001
1044  * \endvar
1045  */
1046                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1047
1048 /*!
1049  * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1050  * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1051                inside lists.
1052  * \li Syntax: depth-decrement
1053  * \endvar
1054  */
1055                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1056 /*!
1057  * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1058  * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1059                inside lists.
1060  * \li Syntax: depth-increment
1061  * \endvar
1062  */
1063                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1064                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
1065
1066 /*!
1067  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1068  * \li Action: Toggles the bold font (selection-wise).
1069  * \li Syntax: font-bold
1070  * \endvar
1071  */
1072                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1073 /*!
1074  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1075  * \li Action: Toggles the typewriter family font (selection-wise).
1076  * \li Syntax: font-typewriter
1077  * \endvar
1078  */
1079                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1080 /*!
1081  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1082  * \li Action: Toggles underline in the font (selection-wise).
1083  * \li Syntax: font-underline
1084  * \endvar
1085  */
1086                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1087 /*!
1088  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1089  * \li Action: Toggles the emphasis font style (selection-wise).
1090  * \li Syntax: font-emph
1091  * \endvar
1092  */
1093                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1094 /*!
1095  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1096  * \li Action: Toggles Noun text style font (selection-wise).
1097  * \li Syntax: font-noun
1098  * \endvar
1099  */
1100                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1101 /*!
1102  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1103  * \li Action: Toggles Roman family font (selection-wise).
1104  * \li Syntax: font-roman
1105  * \endvar
1106  */
1107                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1108 /*!
1109  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1110  * \li Action: Toggles Sans Serif family font (selection-wise).
1111  * \li Syntax: font-sans
1112  * \endvar
1113  */
1114                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1115 /*!
1116  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1117  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1118  * \li Syntax: font-frak
1119  * \li Origin: vermeer, 10 Jan 2002
1120  * \endvar
1121  */
1122                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1123 /*!
1124  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1125  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1126  * \li Syntax: font-ital
1127  * \li Origin: vermeer, 10 Jan 2002
1128  * \endvar
1129  */
1130                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1131 /*!
1132  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1133  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1134  * \li Syntax: font-default
1135  * \endvar
1136  */
1137                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1138 /*!
1139  * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1140  * \li Action: Sets font size according to lyx format string.
1141  * \li Syntax: font-size <SIZE>
1142  * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1143                        largest|huge|giant|increase|decrease|default
1144  * \endvar
1145  */
1146                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1147 /*!
1148  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1149  * \li Action: Toggle user-defined (=last-time used) text style.
1150  * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1151                automatically trigerred when using Text Style dialog.
1152  * \li Syntax: textstyle-apply
1153  * \li Origin: leeming, 12 Mar 2003
1154  * \endvar
1155  */
1156                 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1157 /*!
1158  * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1159  * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1160  * \li Syntax: textstyle-update <FONT_INFO>
1161  * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1162                             size, emph, noun, underbar, number, color, language,
1163                             toggleall.\n
1164                             Use lyx -dbg action for exact syntax of text-style
1165                             dialog parameters.
1166  * \li Origin: leeming, 12 Mar 2003
1167  * \endvar
1168  */
1169                 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1170 /*!
1171  * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1172  * \li Action: Update fonts and its metrics.
1173  * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1174  * \li Syntax: screen-font-update
1175  * \li Origin: ARRae, 13 Aug 2000
1176  * \endvar
1177  */
1178                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1179 /*!
1180  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1181  * \li Action: Returns the info about the current font.
1182  * \li Syntax: font-state
1183  * \endvar
1184  */
1185                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1186
1187                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1188                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1189                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1190                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1191
1192 /*!
1193  * \var lyx::FuncCode lyx::LFUN_LAYOUT
1194  * \li Action: Sets the layout (that is, environment) for the current paragraph.
1195  * \li Syntax: layout <LAYOUT>
1196  * \li Params: <LAYOUT>: the layout to use
1197  * \endvar
1198  */
1199                 { LFUN_LAYOUT, "layout", Noop, Layout },
1200 /*!
1201  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1202  * \li Action: Launches the paragraph settings dialog.
1203  * \li Syntax: layout-paragraph
1204  * \endvar
1205  */
1206                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1207 /*!
1208  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1209  * \li Action: Launches the tabular settings dialog.
1210  * \li Syntax: layout-tabular
1211  * \li Origin: Jug, 31 Jul 2000
1212  * \endvar
1213  */
1214                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1215 /*!
1216  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1217  * \li Action: Displays list of layout choices.
1218  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1219                dropbox allowing for choice of layout.
1220  * \li Syntax: drop-layouts-choice
1221  * \endvar
1222  */
1223                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1224 /*!
1225  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1226  * \li Action: Clears the module list.
1227  * \li Notion: Clears the list of included modules for the current buffer.
1228  * \li Syntax: layout-modules-clear
1229  * \li Origin: rgh, 25 August 2007
1230  * \endvar
1231  */
1232                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1233 /*!
1234  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1235  * \li Action: Adds a module.
1236  * \li Notion: Adds a module to the list of included modules for the current buffer.
1237  * \li Syntax: layout-module-add <MODULE>
1238  * \li Params: <MODULE>: the module to be added
1239  * \li Origin: rgh, 25 August 2007
1240  * \endvar
1241  */
1242                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1243 /*!
1244  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1245  * \li Action: Reloads layout information.
1246  * \li Notion: Reloads all layout information for the current buffer from disk, thus
1247                recognizing any changes that have been made to layout files on the fly.
1248                This is intended to be used only by layout developers and should not be
1249                used when one is trying to do actual work.
1250  * \li Syntax: layout-reload
1251  * \li Origin: rgh, 3 September 2007
1252  * \endvar
1253  */
1254                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1255 /*!
1256  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1257  * \li Action: Sets the text class for the current buffer.
1258  * \li Syntax: textclass-apply <TEXTCLASS>
1259  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1260                    the filename, minus the ".layout" extension.
1261  * \endvar
1262  */
1263                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1264 /*!
1265  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1266  * \li Action: Loads information for a textclass from disk.
1267  * \li Syntax: textclass-load <TEXTCLASS>
1268  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1269                    the filename, minus the ".layout" extension.
1270  * \endvar
1271  */
1272                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1273
1274 /*!
1275  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1276  * \li Action: Disable selecting of text-region.
1277  * \li Syntax: mark-off
1278  * \endvar
1279  */
1280                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1281 /*!
1282  * \var lyx::FuncCode lyx::LFUN_MARK_ON
1283  * \li Action: Enable selecting of text-region.
1284  * \li Notion: After enabling you can simply move arrow keys to get selected region.
1285  * \li Syntax: mark-on
1286  * \endvar
1287  */
1288                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1289 /*!
1290  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1291  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1292  * \li Syntax: mark-toggle
1293  * \li Origin: poenitz, May 5 2006
1294  * \endvar
1295  */
1296                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1297
1298 /*!
1299  * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1300  * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1301  * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1302  * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1303                              either a LaTeX name or a valid character.
1304                              ( is the default letter.
1305  * \li Sample: math-delim { rangle
1306  * \li Origin: Alejandro, 18 Jun 1996
1307  * \endvar
1308  */
1309                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1310 /*!
1311  * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1312  * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1313  * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1314  * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1315                <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1316  * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1317  * \li Origin: Enrico & Georg, 7 May 2006
1318  * \endvar
1319  */
1320                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1321 /*!
1322  * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1323  * \li Action: Creates a new displayed equation in text mode.
1324                Toggles inlined/display formula in math mode.
1325  * \li Syntax: math-display [<ARG>]
1326  * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1327                       new equation from the text mode.
1328  * \li Origin: Alejandro, 18 Jun 1996
1329  * \endvar
1330  */
1331                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1332 /*!
1333  * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1334  * \li Action: Inserts math objects and symbols.
1335  * \li Syntax: math-insert <ARG>
1336  * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1337  * \endvar
1338  */
1339                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1340 /*!
1341  * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1342  * \li Action: Enters subscript expression in math expression.
1343  * \li Syntax: math-subscript
1344  * \li Origin: vermeer, 12 Dec 2001
1345  * \endvar
1346  */
1347                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1348 /*!
1349  * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1350  * \li Action: Enters subscript expression in math expression.
1351  * \li Syntax: math-superscript
1352  * \li Origin: vermeer, 12 Dec 2001
1353  * \endvar
1354  */
1355                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1356 /*!
1357  * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1358  * \li Action: Toggles the position of the limits from above/below to the right
1359                side an vice versa in integral symbol, a limit, a summation, etc.
1360  * \li Notion: Put the cursor before the symbol with the limits and then invoke
1361                math-limits.
1362  * \li Syntax: math-limits [<STATE>]
1363  * \li Params: <STATE>: limits|nolimits
1364  * \endvar
1365  */
1366                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1367 /*!
1368  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1369  * \li Action: Inserts a math macro definition at the cursor position in the text.
1370  * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1371  * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1372                <NARGS>: The number of parameters of the macro. Default is 0.
1373                "def": Has no effect anymore, just for compatibility with former LyX versions.
1374  * \li Origin: ale, 10 May 1997;  sts, 21 Dec 2007
1375  * \endvar
1376  */
1377                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1378 /*!
1379  * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1380  * \li Action: Mutates the type of math inset to the newly selected one.
1381  * \li Syntax: math-mutate <TYPE>
1382  * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1383                        multline|gather|flalign
1384  * \li Origin: Andre', 23 May 2001
1385  * \endvar
1386  */
1387                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1388 /*!
1389  * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1390  * \li Action: Inserts space into math expression.
1391  * \li Notion: Use spacebar after entering this space to change type of space.
1392  * \li Syntax: math-space [<TYPE>]
1393  * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
1394                        positive spaces: ,|:|;|quad|qquad \n
1395                        "," used by default.
1396  * \li Origin: Andre', 25 Jul 2001; ps, 16 Jun 2008
1397  * \endvar
1398  */
1399                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1400                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1401 /*!
1402  * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1403  * \li Action: Inserts a matrix.
1404  * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1405  * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1406                         (b, c or t) (i.e. 1 char) and the horizontal alignments
1407                         (l, c or r) (i.e. <COL> chars).
1408  * \li Sample: math-matrix 3 3 bccc
1409  * \endvar
1410  */
1411                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1412 /*!
1413  * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1414  * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1415                cursor position), in math mode enters text mode inside math expression.
1416  * \li Notion: If there is some selected text, it puts the text inside created math box.
1417  * \li Syntax: math-mode
1418  * \li Origin: Alejandro, 4 Jun 1996
1419  * \endvar
1420  */
1421                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1422 /*!
1423  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1424  * \li Action: Toggles numbering of the current formula line.
1425  * \li Notion: Must be in display formula mode.
1426  * \li Syntax: math-number-line-toggle
1427  * \li Origin: Alejandro, 18 Jun 1996
1428  * \endvar
1429  */
1430                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1431 /*!
1432  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1433  * \li Action: Toggles numbering/labeling of the current formula.
1434  * \li Notion: Must be in display formula mode.
1435  * \li Syntax: math-number-toggle
1436  * \li Origin: Alejandro, 4 Jun 1996
1437  * \endvar
1438  */
1439                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1440 /*!
1441  * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1442  * \li Action: Calls external program and passes the current expression/equation
1443                as an argument for the calculation in the format appropriate to the
1444                given language.
1445  * \li Notion: Selection can be used to determine the input for the external program.
1446  * \li Syntax: math-extern <LANG> [<COMMAND>]
1447  * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1448                        where "script" stands fot the external script (normalized
1449                        expression will be passed)
1450  * \li Origin: Andre', 24 Apr 2001
1451  * \li Sample: math-extern maple simplify
1452  * \endvar
1453  */
1454                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1455 /*!
1456  * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1457  * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1458  * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1459  * \li Syntax: math-size <STYLE>
1460  *\ li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1461  * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1462  * \endvar
1463  */
1464                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1465 /*!
1466  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1467  * \li Action: Unfold a Math Macro.
1468  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1469                display it as \foo.
1470  * \li Syntax: math-macro-unfold
1471  * \li Origin: sts, 06 January 2008
1472  * \endvar
1473  */
1474                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1475 /*!
1476  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1477  * \li Action: Fold a Math Macro.
1478  * \li Notion: Fold the Math Macro the cursor is in if it was
1479                unfolded, i.e. displayed as \foo before.
1480  * \li Syntax: math-macro-fold
1481  * \li Origin: sts, 06 January 2008
1482  * \endvar
1483  */
1484                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1485 /*!
1486  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1487  * \li Action: Add a parameter.
1488  * \li Notion: Add a parameter to a Math Macro.
1489  * \li Params: <NUM>: The number of the parameter behind which the new one
1490                will be added (1 for the first, i.e. use 0 for add a
1491                parameter at the left), defaults to the last one.
1492  * \li Syntax: math-macro-add-param <NUM>
1493  * \li Origin: sts, 06 January 2008
1494  * \endvar
1495  */
1496                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1497 /*!
1498  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1499  * \li Action: Remove the last parameter.
1500  * \li Notion: Remove the last parameter of a Math Macro and
1501                remove its value in all instances of the macro
1502                in the buffer.
1503  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1504                the first), defaults to the last one.
1505  * \li Syntax: math-macro-remove-param <NUM>
1506  * \li Origin: sts, 06 January 2008
1507  * \endvar
1508  */
1509                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1510 /*!
1511  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1512  * \li Action: Append a greedy parameter.
1513  * \li Notion: Append a greedy parameter to a Math Macro which
1514                eats the following mathed cell in every instance of
1515                the macro in the buffer.
1516  * \li Syntax: math-macro-append-greedy-param
1517  * \li Origin: sts, 06 January 2008
1518  * \endvar
1519  */
1520                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1521 /*!
1522  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1523  * \li Action: Remove a greedy parameter.
1524  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1525                out the values of it in every instance of the macro
1526                in the buffer. If it is an optional parameter the [valud]
1527                format is used.
1528  * \li Syntax: math-macro-remove-greedy-param
1529  * \li Origin: sts, 06 January 2008
1530  * \endvar
1531  */
1532                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1533 /*!
1534  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1535  * \li Action: Make a parameter optional.
1536  * \li Notion: Turn the first non-optional parameter of a Math Macro
1537                into an optional parameter with a default value.
1538  * \li Syntax: math-macro-make-optional
1539  * \li Origin: sts, 06 January 2008
1540  * \endvar
1541  */
1542                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1543 /*!
1544  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1545  * \li Action: Make a parameter non-optional.
1546  * \li Notion: Turn the last optional parameter of a Math Macro
1547                into a non-optional parameter. The default value is
1548                remembered to be reused later if the user changes his mind.
1549  * \li Syntax: math-macro-make-nonoptional
1550  * \li Origin: sts, 06 January 2008
1551  * \endvar
1552  */
1553                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1554 /*!
1555  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1556  * \li Action: Add an optional parameter.
1557  * \li Notion: Insert an optional parameter just behind the
1558                already existing optional parameters.
1559  * \li Syntax: math-macro-add-optional-param
1560  * \li Origin: sts, 06 January 2008
1561  * \endvar
1562  */
1563                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1564 /*!
1565  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1566  * \li Action: Remove the last optional parameter.
1567  * \li Notion: Remove the last optional parameter of a Math Macro and
1568                remove it in all the instances of the macro in the buffer.
1569  * \li Syntax: math-macro-remove-optional-param
1570  * \li Origin: sts, 06 January 2008
1571  * \endvar
1572  */
1573                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1574 /*!
1575  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1576  * \li Action: Add a greedy optional parameter.
1577  * \li Notion: Add a greedy optional parameter which eats the value
1578                from the following cells in mathed which are in the [value]
1579                format.
1580  * \li Syntax: math-macro-add-greedy-optional-param
1581  * \li Origin: sts, 06 January 2008
1582  * \endvar
1583  */
1584                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1585 /*!
1586  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1587  * \li Action: Only active in Math Macro definition.
1588  * \li Notion: Dummy function which is only active in a Math Macro definition.
1589                It's used to toggle the Math Macro toolbar if the cursor moves
1590                into a Math Macro definition.
1591  * \li Syntax: in-mathmacrotemplate
1592  * \li Origin: sts, 06 January 2008
1593  * \endvar
1594  */
1595                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1596
1597 /*!
1598  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1599  * \li Action: Moves the current paragraph downwards in the document.
1600  * \li Syntax: paragraph-move-down
1601  * \li Origin: Edwin, 8 Apr 2006
1602  * \endvar
1603  */
1604                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1605 /*!
1606  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1607  * \li Action: Moves the current paragraph upwards in the document.
1608  * \li Syntax: paragraph-move-up
1609  * \li Origin: Edwin, 8 Apr 2006
1610  * \endvar
1611  */
1612                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1613
1614 /*!
1615  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1616  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1617                in upward direction.
1618  * \li Syntax: paragraph-up
1619  * \li Origin: Asger, 1 Oct 1996
1620  * \endvar
1621  */
1622                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1623 /*!
1624  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1625  * \li Action: Move the cursor and select the text to the next paragraph (or
1626                begining of the current one) in upward direction.
1627  * \li Syntax: paragraph-up-select
1628  * \li Origin: Asger, 1 Oct 1996
1629  * \endvar
1630  */
1631                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1632 /*!
1633  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1634  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1635                in downward direction.
1636  * \li Syntax: paragraph-down
1637  * \li Origin: Asger, 1 Oct 1996
1638  * \endvar
1639  */
1640                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1641 /*!
1642  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1643  * \li Action: Move the cursor and select the text to the next paragraph (or
1644                begining of the current one) in downward direction.
1645  * \li Syntax: paragraph-down-select
1646  * \li Origin: Asger, 1 Oct 1996
1647  * \endvar
1648  */
1649                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1650 /*!
1651  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1652  * \li Action: Jump to a paragraph given by its id number and optionally the
1653                desired position within the paragraph.
1654  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1655                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1656  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1657  * \li Params: <PAR_ID_NUMBER>:  paragraph id
1658                <POSITION_IN_PAR>: desired position within the paragraph
1659  * \li Origin: Dekel, 26 Aug 2000
1660  * \endvar
1661  */
1662                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1663 /*!
1664  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1665  * \li Action: Breaks the current paragraph at the current location.
1666  * \li Syntax: break-paragraph
1667  * \endvar
1668  */
1669                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1670 /*!
1671  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1672  * \li Action: Breaks the current paragraph at the current location.
1673  * \li Notion: Removes the selection.
1674  * \li Syntax: break-paragraph [<LAYOUT>]
1675  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1676                          to default layout) when the cursor is at the end of
1677                          the line.
1678  * \endvar
1679  */
1680                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1681 /*!
1682  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1683  * \li Action: Change paragraph settings.
1684  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1685                This function only modifies, and does not override, existing settings.
1686                Note that the "leftindent" indent setting is deprecated.
1687  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1688  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1689                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1690                <ALIGN>:   \\align block|left|right|center|default\n
1691                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1692  * \li Origin: rgh, Aug 15 2007
1693  * \endvar
1694  */
1695                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1696 /*!
1697  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1698  * \li Action: Change paragraph settings.
1699  * \li Notion: Overwrite all nonspecified settings to the default ones.
1700                Use paragraph-params lfun if you don't want to overwrite others settings.
1701  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1702  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1703  * \li Origin: leeming, 30 Mar 2004
1704  * \endvar
1705  */
1706                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1707                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1708
1709 /*!
1710  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1711  * \li Action: Move the current group in the upward direction in the
1712                structure of the document.
1713  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1714                the whole substructure of the group.
1715  * \li Syntax: outline-up
1716  * \li Origin: Vermeer, 23 Mar 2006
1717  * \endvar
1718  */
1719                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1720 /*!
1721  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1722  * \li Action: Move the current group in the downward direction in the
1723                structure of the document.
1724  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1725                the whole substructure of the group.
1726  * \li Syntax: outline-down
1727  * \li Origin: Vermeer, 23 Mar 2006
1728  * \endvar
1729  */
1730                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1731 /*!
1732  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1733  * \li Action: Moves the current group in the downward direction in the
1734                hierarchy of the document structure.
1735  * \li Notion: Part -> Chapter -> Section -> etc.
1736  * \li Syntax: outline-in
1737  * \li Origin: Vermeer, 23 Mar 2006
1738  * \endvar
1739  */
1740                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1741 /*!
1742  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1743  * \li Action: Moves the current group in the upward direction in the
1744                hierarchy of the document structure.
1745  * \li Notion: Part <- Chapter <- Section <- etc.
1746  * \li Syntax: outline-out
1747  * \li Origin: Vermeer, 23 Mar 2006
1748  * \endvar
1749  */
1750                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1751 /*!
1752  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1753  * \li Action: Edit the inset at cursor with an external application,
1754  *             if one is attributed.
1755  * \li Syntax: inset-edit [<INSET_PARAMS>]
1756  * \li Params: <INSET_PARAMS>: Parameters for the inset.
1757                                Currently only the filename will be considered.
1758  * \li Origin: JSpitzm, 27 Apr 2006
1759  * \endvar
1760  */
1761                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1762
1763                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1764                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1765                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1766                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1767                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1768
1769                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1770                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1771                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1772                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1773                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1774
1775                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1776                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1777                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1778                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1779                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1780                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1781                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1782                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1783
1784 /*!
1785  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1786  * \li Action: Apply data for an inset.
1787  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1788                be applied. This is either changed to #LFUN_INSET_MODIFY or
1789                #LFUN_INSET_INSERT depending on the context where it is called.
1790  * \li Syntax: inset-apply <ARGS>
1791  * \li Params: See #LFUN_INSET_INSERT .
1792  * \endvar
1793  */
1794                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1795 /*!
1796  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1797  * \li Action: Dissolve the current inset into text.
1798  * \li Syntax: inset-dissolve [<INSET>]
1799  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1800                         is dissolved. For example "dissolve" entry in the charstyles
1801                         sub-menu should only dissolve the charstyle inset, even if the
1802                         cursor is inside several nested insets of different type.\n
1803                         For values see #lyx::InsetLayout::lyxtype_ .
1804  * \li Author: JSpitz, 7 Aug 2006
1805  * \endvar
1806  */
1807                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1808 /*!
1809  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1810  * \li Action: Insert new inset (type given by the parameters).
1811  * \li Syntax: inset-insert <INSET> <ARGS>
1812  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1813                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1814                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1815                        explore.
1816  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1817                where <label name> is the name of the referenced label and
1818                <Format> is one of the following: \n
1819                ref -- <reference> \n
1820                eqref -- (<reference>) \n
1821                pageref -- <page> \n
1822                vpageref -- on <page> \n
1823                vref -- <reference> on <page> \n
1824                prettyref -- Formatted reference
1825  * \endvar
1826  */
1827                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1828 /*!
1829  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1830  * \li Action: Modify existing inset.
1831  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1832                bibtex, ert, command, graphics, note, space, vspace, tabular,
1833                bibitem, inlude, ref insets.
1834  * \li Syntax: inset-modify <INSET> <ARGS>
1835  * \li Params: See #LFUN_INSET_INSERT for further details.
1836  * \endvar
1837  */
1838                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1839 /*!
1840  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1841  * \li Action: Modify the inset at cursor position, if there is one.
1842  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1843                bibtex, ert, command, graphics, note, space, vspace, tabular,
1844                bibitem, inlude, ref insets.
1845  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1846  * \li Params: See #LFUN_INSET_INSERT for further details.
1847  * \li Origin: JSpitzm, 23 Mar 2008
1848  * \endvar
1849  */
1850                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1851                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1852 /*!
1853  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1854  * \li Action: Open the inset's properties dialog.
1855  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1856  * \li Syntax: inset-settings <INSET>
1857  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1858  * \endvar
1859  */
1860                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1861 /*!
1862  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1863  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1864                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1865                be entered. Also cf. #LFUN_INSET_SETTINGS.
1866  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1867                bibtex, ert, command, graphics, note, space, vspace, tabular,
1868                bibitem, inlude, ref insets.
1869  * \li Syntax: next-inset-toggle <ARG>
1870  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1871  * \li Origin: leeming, 30 Mar 2004
1872  * \endvar
1873  */
1874                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1875 /*!
1876  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1877  * \li Action: Toggles the collapsable inset we are currently in.
1878  * \li Syntax: inset-toggle [<ARG>]
1879  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1880                open/close/toggle are for collapsable insets. close can be currently used
1881                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1882                assign is for branch inset.
1883  * \li Origin: lasgouttes, 19 Jul 2001
1884  * \endvar
1885  */
1886                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1887 /*!
1888  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1889  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1890  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1891  * \li Syntax: all-insets-toggle <STATE> <INSET>
1892  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1893                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1894  * \li Origin: leeming, 30 Mar 2004
1895  * \endvar
1896  */
1897                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1898 /*!
1899  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1900  * \li Action: Unify all graphics insets with the one given as an parameter.
1901  * \li Notion: This is internally used for synchronize certain group of graphics insets.
1902  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1903  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1904                                   (syntax can be seen in .lyx files).
1905  * \li Origin: sanda, 6 May 2008
1906  * \endvar
1907  */
1908                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1909 /*!
1910  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1911  * \li Action: Set the group for the graphics inset on the cursor position.
1912  * \li Syntax: set-graphics-group [<GROUP>]
1913  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1914                         the graphics inset is removed from the current group.
1915  * \li Origin: sanda, 6 May 2008
1916  * \endvar
1917  */
1918                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1919
1920 /*!
1921  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1922  * \li Action: Moves the cursor out of the current slice, going forward.
1923  * \li Notion: Cursor movement within an inset may be different than cursor
1924                movement in the surrounding text. This action should be called
1925                automatically by the cursor movement within the inset, when
1926                movement within the inset has ceased (reached the end of the
1927                last paragraph, for example), in order to move correctly
1928                back into the surrounding text.
1929  * \endvar
1930  */
1931                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1932 /*!
1933  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1934  * \li Action: Moves the cursor out of the current slice, going backwards.
1935  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1936  * \endvar
1937  */
1938                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1939 /*!
1940  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1941  * \li Action: Moves the cursor out of the current slice, going right.
1942  * \li Notion: See also #LFUN_FINISHED_FORWARD
1943  * \endvar
1944  */
1945                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1946 /*!
1947  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1948  * \li Action: Moves the cursor out of the current slice, going left.
1949  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1950  * \endvar
1951  */
1952                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1953
1954                 { LFUN_LANGUAGE, "language", Noop, Edit },
1955
1956 /*!
1957  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1958  * \li Action: Goto a label.
1959  * \li Syntax: label-goto [<LABEL>]
1960  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1961                         is on cursor position, Bookmark 0 is saved and
1962                         cursor moves to the position of referenced label.
1963  * \li Origin: Ale, 6 Aug 1997
1964  * \endvar
1965  */
1966                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1967 /*!
1968  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1969  * \li Action: Inserts label to text or displayed formula.
1970  * \li Syntax: label-insert [<LABEL>]
1971  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1972                         name will be opened.
1973  * \endvar
1974  */
1975                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1976 /*!
1977  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1978  * \li Action: Go to the next label or cross-reference.
1979  * \li Syntax: reference-next
1980  * \li Origin: Dekel, 14 Jan 2001
1981  * \endvar
1982  */
1983                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1984
1985 /*!
1986  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1987  * \li Action: Goto a bookmark.
1988  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1989                if necessary. Note that bookmarsk are saved per-session, not
1990                per file.
1991  * \li Syntax: bookmark-goto <NUMBER>
1992  * \li Params: <NUMBER>: the number of the bookmark to restore.
1993  * \li Origin: Dekel, 27 January 2001
1994  * \endvar
1995  */
1996                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1997 /*!
1998  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1999  * \li Action: Save a bookmark.
2000  * \li Notion: Saves a numbered bookmark to the sessions file. The number
2001                must be between 1 and 9, inclusive. Note that bookmarks are
2002                saved per-session, not per file.
2003  * \li Syntax: bookmark-save <NUMBER>
2004  * \li Params: <NUMBER>: the number of the bookmark to save.
2005  * \li Origin: Dekel, 27 January 2001
2006  * \endvar
2007  */
2008                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2009 /*!
2010  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2011  * \li Action: Clears the list of saved bookmarks.
2012  * \li Syntax: bookmark-clear
2013  * \li Origin: bpeng, 31 October 2006
2014  * \endvar
2015  */
2016                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2017
2018 /*!
2019  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2020  * \li Action: Open the given help file according to the language setting.
2021  * \li Syntax: help-open <FILE>[.lyx]
2022  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2023  * \li Author: Jug, 27 Jun 1999
2024  * \endvar
2025  */
2026                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2027 /*!
2028  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2029  * \li Action: Terminates the current LyX instance.
2030  * \li Notion: Terminates the current LyX instance, asking whether to save
2031                modified documents, etc.
2032  * \li Syntax: lyx-quit
2033  * \endvar
2034  */
2035                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2036 /*!
2037  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2038  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2039  * \li Notion: Skiping "auto" when allowauto is false.
2040  * \li Syntax: toolbar-toggle <NAME> [allowauto]
2041  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2042                        minibuffer|review|view/update|math_panels
2043  * \li Origin: Edwin, 21 May 2007
2044  * \endvar
2045  */
2046                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2047 /*!
2048  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2049  * \li Action: Opens the menu given by its name.
2050  * \li Syntax: menu-open <NAME>
2051  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2052  * \endvar
2053  */
2054                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2055 /*!
2056  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2057  * \li Action: Various UI visibility-toggling actions.
2058  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
2059  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
2060                menubar    : Toggle visibility of the menubar.\n
2061                scrollbar  : Toggle visibility of the scrollbar.\n
2062                frame      : Toggle visibility of the frames around editing window.\n
2063                fullscreen : Toggle fullscreen mode. This also covers calling the
2064                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2065                             custom tweaks of the toolbars should be used.
2066  * \li Origin: ps, 9 Feb 2007
2067  * \endvar
2068  */
2069                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2070
2071 /*!
2072  * \var lyx::FuncCode lyx::WINDOW_NEW
2073  * \li Action: Creates new empty LyX window.
2074  * \li Notion: Already opened documents from the previous window can be found under View menu.
2075  * \li Syntax: window-new [<GEOMETRY>]
2076  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2077                            accepted only on Windows platform.
2078  * \li Origin: Abdel, 21 Oct 2006
2079  * \endvar
2080  */
2081                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2082 /*!
2083  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2084  * \li Action: Closes the current LyX window.
2085  * \li Syntax: window-close
2086  * \li Origin: Abdel, 23 Oct 2006
2087  * \endvar
2088  */
2089                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2090
2091 /*!
2092  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2093  * \li Action: Creates another split view of current buffer.
2094  * \li Notion: All split views act in the same way indpendently.
2095  * \li Syntax: split-view <vertical|horizontal>
2096  * \li Params: horizontal : The work areas are laid out side by side.\n
2097                vertical   : The work areas laid out vertically.\n
2098  * \li Origin: abdel, 20 Feb 2008
2099  * \endvar
2100  */
2101                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2102
2103 /*!
2104  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2105  * \li Action: Close the current tab group.
2106  * \li Notion: This only closes the work areas, not the buffer themselves.
2107                The still opened buffers can be visualized in another tab group.
2108  * \li Syntax: close-tab-group
2109  * \li Origin: abdel, 21 Feb 2008
2110  * \endvar
2111  */
2112                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2113                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2114                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2115                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2116                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2117                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2118                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2119
2120                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2121                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2122                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2123                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2124                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2125
2126                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2127                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2128                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2129                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2130
2131                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
2132                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2133                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
2134 /*!
2135  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2136  * \li Action: Sets the cursor position based on the row number of generated TeX file.
2137  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2138  * \li Origin: Edmar, 23 Dec 1998
2139  * \endvar
2140  */
2141                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2142                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2143 /*!
2144  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2145  * \li Action: Sets the cursor position based on the editing area coordinates
2146                (similar as clicking on that point with left mouse button).
2147  * \li Syntax: server-set-xy <X> <Y>
2148  * \endvar
2149  */
2150                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2151 /*!
2152  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2153  * \li Action: Returns the coordinates of cursor position in the editing area.
2154  * \li Syntax: server-get-xy
2155  * \endvar
2156  */
2157                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2158
2159 /*!
2160  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2161  * \li Action: Generates the code (literate programming).
2162  * \li Notion: Latex file with extension \literate_extension is generated.
2163                Then LyX invokes \build_command (with a default of``make'') to generate the code and
2164                \build_error_filter to process the compilation error messages. \n
2165                In case you want to process your literate file with a script, or some other program,
2166                just insert in your lyxrc file an entry with:\n
2167                \build_command "my_script my_arguments" \n
2168                The \build_error_filter differs from the \literate_error_filter only in that the
2169                former will identify error messages from your compiler.
2170  * \li Syntax: build-program
2171  * \endvar
2172  */
2173                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2174
2175 /*!
2176  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2177  * \li Action: Saves the current buffer to a temporary file.
2178  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2179                is called automatically by LyX, to "autosave" the current buffer.
2180  * \li Syntax: buffer-auto-save
2181  * \endvar
2182  */
2183                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2184 /*!
2185  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2186  * \li Action: Loads the given child document.
2187  * \li Notion: The current document is treated as a parent.
2188  * \li Syntax: buffer-child-open <FILE>
2189  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2190  * \li Origin: Ale, 28 May 1997
2191  * \endvar
2192  */
2193                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2194 /*!
2195  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2196  * \li Action: Runs chktex for the current document.
2197  * \li Syntax: buffer-chktex
2198  * \li Origin: Asger, 30 Oct 1997
2199  * \endvar
2200  */
2201                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2202 /*!
2203  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2204  * \li Action: Toggles compression of the current document on/off.
2205  * \li Syntax: buffer-toggle-compression
2206  * \li Origin: bpeng, 27 Apr 2006
2207  * \endvar
2208  */
2209                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2210 /*!
2211  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2212  * \li Action: Closes the current buffer.
2213  * \li Notion: Closes the current buffer, asking whether to save it, etc,
2214                if the buffer has been modified.
2215  * \li Syntax: buffer-close
2216  * \endvar
2217  */
2218                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2219 /*!
2220  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2221  * \li Action: Exports the current buffer (document) to the given format.
2222  * \li Syntax: buffer-export <FORMAT>
2223  * \li Params: <FORMAT> is either "custom" or one of the formats which you
2224                         can find in Tools->Preferences->File formats->Format.
2225                         Usual format you will enter is "pdf2" (pdflatex),
2226                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2227                         In case of "custom" you will be asked for a format you
2228                         want to start from and for the command that you want to
2229                         apply to this format. Internally the control is then passed
2230                         to #LFUN_BUFFER_EXPORT_CUSTOM.
2231  * \li Origin: Lgb, 29 Jul 1997
2232  * \endvar
2233  */
2234                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2235 /*!
2236  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2237  * \li Action: Exports the current buffer (document) from the given format using
2238                the given command on it.
2239  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2240  * \li Params: <FORMAT> format to start from (LyX will care to produce such
2241                         intermediate file).\n
2242                <COMMAND> this command will be launched on the file. Note that you can
2243                use "$$FName" string to qualify the intermediate file.
2244  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2245  * \li Origin: leeming, 27 Mar 2004
2246  * \endvar
2247  */
2248                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2249 /*!
2250  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2251  * \li Action: Prints the current document.
2252  * \li Notion: Many settings can be given via the preferences dialog.
2253  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2254  * \li Params: <TARGET> is either "printer" or "file".\n
2255                <TARGER-NAME> is either "default" or file name or printer name.\n
2256                <COMMAND> command ensuring the printing job.
2257  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2258  * \li Origin: leeming, 28 Mar 2004
2259  * \endvar
2260  */
2261                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2262 /*!
2263  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2264  * \li Action: Import a given file as a lyx document.
2265  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2266                defined convertors in preferences. Look into File->Import menu to get
2267                an idea of the currently active import formats.
2268  * \li Syntax: buffer-import <FORMAT> [<FILE>]
2269  * \li Origin: Asger, 24 Jul 1998
2270  * \endvar
2271  */
2272                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2273 /*!
2274  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2275  * \li Action: Creates a new buffer (that is, document).
2276  * \li Notion: Implicit path can be set in Preferences dialog.
2277  * \li Syntax: buffer-new [<FILE>]
2278  * \li Params: <FILE>: filename of created file with absolute path.
2279  * \endvar
2280  */
2281                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2282 /*!
2283  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2284  * \li Action: Creates a new buffer (that is, document) from a template.
2285  * \li Notion: Path for new files and templates can be set in Preferences dialog.
2286                Template will be asked for via Open-dialog.
2287  * \li Syntax: buffer-new-template [<FILE>]
2288  * \li Params: <FILE>: filename of created file with absolute path.
2289  * \endvar
2290  */
2291                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2292 /*!
2293  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2294  * \li Action: Reverts opened document.
2295  * \li Syntax: buffer-reload
2296  * \li Origin: Asger, 2 Feb 1997
2297  * \endvar
2298  */
2299                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2300 /*!
2301  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2302  * \li Action: Switch to the given buffer.
2303  * \li Notion: This is useful also in case you need simultaneously more views of the edited
2304                document in different LyX windows.
2305  * \li Syntax: buffer-new-template <BUFFER>
2306  * \li Params: <BUFFER>: already opened document which is to be shown.
2307  * \endvar
2308  */
2309                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2310 /*!
2311  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2312  * \li Action: Toggle editing mode of the current document between read/write and read-only.
2313  * \li Syntax: buffer-toggle-read-only
2314  * \li Origin: Lgb, 27 May 1997
2315  * \endvar
2316  */
2317                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2318 /*!
2319  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2320  * \li Action: Displays current buffer in chosen format.
2321  * \li Notion: Displays the contents of the current buffer in the chosen
2322                format, for example, PDF or DVI. This runs the necessary
2323                converter, calls the defined viewer, and so forth.
2324  * \li Syntax: buffer-view <FORMAT>
2325  * \li Params: <FORMAT>: The format to display, where this is one of the
2326                          formats defined (in the current GUI) in the
2327                          Tools>Preferences>File Formats dialog.
2328  * \endvar
2329  */
2330                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2331 /*!
2332  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2333  * \li Action: Exports the current document and put the result into the
2334                temporary directory.
2335  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2336                the output will be rewriten - updated. This is useful in case your viewer
2337                is able to detect such changes (e.g. ghostview for postscript).
2338  * \li Syntax: buffer-update <FORMAT>
2339  * \li Params: <FORMAT>: The format to display, where this is one of the
2340                          formats defined (in the current GUI) in the
2341                          Tools>Preferences>File Formats dialog.
2342  * \li Origin: Dekel, 5 Aug 2000
2343  * \endvar
2344  */
2345                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2346
2347 /*!
2348  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2349  * \li Action: Saves the current buffer.
2350  * \li Notion: Saves the current buffer to disk, using the filename that
2351                is already associated with the buffer, asking for one if
2352                none is yet assigned.
2353  * \li Syntax: buffer-write
2354  * \endvar
2355  */
2356                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2357 /*!
2358  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2359  * \li Action: Rename and save current buffer.
2360  * \li Syntax: buffer-write-as <FILENAME>
2361  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2362                is with respect to the original location of the buffer/file.
2363  * \endvar
2364  */
2365                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2366 /*!
2367  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2368  * \li Action: Save all changed documents.
2369  * \li Syntax: buffer-write-all
2370  * \li Origin: rgh, gpothier 6 Aug 2007
2371  * \endvar
2372  */
2373                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2374 /*!
2375  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2376  * \li Action: Switch to the next opened document.
2377  * \li Notion: Note that this does not necessarily mean next in tabbar
2378                (for full list see View menu).
2379  * \li Syntax: buffer-next
2380  * \endvar
2381  */
2382                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2383 /*!
2384  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2385  * \li Action: Switch to the previous opened document.
2386  * \li Syntax: buffer-previous
2387  * \endvar
2388  */
2389                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2390 /*!
2391  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2392  * \li Action: When run from a child document, this updates (exports) document built
2393                 from the master buffer. If a master is not found, it updates the
2394                 current buffer.
2395  * \li Syntax: master-buffer-update
2396  * \li Author: Tommaso, 20 Sep 2007
2397  * \endvar
2398  */
2399                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2400 /*!
2401  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2402  * \li Action: When run from a child document, this command shows a preview built
2403                from the master buffer. If a master is not found, it previews the
2404                current buffer.
2405  * \li Syntax: master-buffer-view
2406  * \li Author: Tommaso, 20 Sep 2007
2407  * \endvar
2408  */
2409                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2410 /*!
2411  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2412  * \li Action: Set language of the current document.
2413  * \li Syntax: buffer-language <LANG>
2414  * \li Params: <LANG>: language name. See lib/languages for list.
2415  * \li Author: leeming, 30 Mar 2004
2416  * \endvar
2417  */
2418                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2419 /*!
2420  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2421  * \li Action: Save the current document settings as default.
2422  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2423  * \li Syntax: buffer-save-as-default [<ARGS>]
2424  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2425                        you can find in document header of usual .lyx file.
2426  * \li Author: leeming, 30 Mar 2004
2427  * \endvar
2428  */
2429                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2430 /*!
2431  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2432  * \li Action: Apply the given settings to the current document.
2433  * \li Syntax: buffer-params-apply [<ARGS>]
2434  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2435                        you can find in document header of usual .lyx file.
2436  * \li Author: leeming, 30 Mar 2004
2437  * \endvar
2438  */
2439                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2440
2441 /*!
2442  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2443  * \li Action: Inserts another LyX file.
2444  * \li Syntax: file-insert [<FILE>]
2445  * \li Params: <FILE>: Filename to be inserted.
2446  * \endvar
2447  */
2448                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2449 /*!
2450  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2451  * \li Action: Inserts plain text file.
2452  * \li Syntax: file-insert-plaintext [<FILE>]
2453  * \li Params: <FILE>: Filename to be inserted.
2454  * \li Origin: CFO-G, 19 Nov 1997
2455  * \endvar
2456  */
2457                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2458 /*!
2459  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2460  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2461  * \li Syntax: file-insert-plaintext-para [<FILE>]
2462  * \li Params: <FILE>: Filename to be inserted.
2463  * \li Origin: Levon, 14 Feb 2001
2464  * \endvar
2465  */
2466                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2467 /*!
2468  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2469  * \li Action: Open LyX document.
2470  * \li Syntax: file-open [<FILE>]
2471  * \li Params: <FILE>: Filename to be opened.
2472  * \endvar
2473  */
2474                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2475
2476 /*!
2477  * \var lyx::FuncCode lyx::LFUN_CALL
2478  * \li Action: Executes a command defined in a .def file.
2479  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2480                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2481                where <NAME> is the name of the new command and <LFUN> is the lfun code
2482                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2483                \\def_file "FileName" allows to include another .def file. \n
2484                This is particularly useful in connection with toolbar buttons:
2485                Since the name of the button image for this lfun is
2486                lib/images/commands/<NAME>.png this is the way to assign an image
2487                to a complex command-sequence.
2488  * \li Syntax: call <NAME>
2489  * \li Params: <NAME>: Name of the command that must be called.
2490  * \li Origin: broider, 2 Oct 2007
2491  * \endvar
2492  */
2493                 { LFUN_CALL, "call", NoBuffer, System },
2494 /*!
2495  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2496  * \li Action: Simulate halting Meta key (Alt key on PCs).
2497  * \li Notion: Used for buffer editation not for GUI control.
2498  * \li Syntax: meta-prefix
2499  * \endvar
2500  */
2501                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2502 /*!
2503  * \var lyx::FuncCode lyx::LFUN_CANCEL
2504  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2505  * \li Syntax: cancel
2506  * \endvar
2507  */
2508                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2509
2510 /*!
2511  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2512  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2513  * \li Notion: Usually bound to M-x shortcut.
2514  * \li Syntax: command-execute
2515  * \endvar
2516  */
2517                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2518                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2519 /*!
2520  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2521  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2522  * \li Syntax: command-sequence <CMDS>
2523  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2524  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2525  * \li Origin: Andre', 11 Nov 1999
2526  * \endvar
2527  */
2528                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2529 /*!
2530  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2531  * \li Action: Shows message in statusbar (for script purposes).
2532  * \li Syntax: message <STRING>
2533  * \li Origin: Lgb, 8 Apr 2001
2534  * \endvar
2535  */
2536                 { LFUN_MESSAGE, "message", NoBuffer, System },
2537 /*!
2538  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2539  * \li Action: Save user preferences.
2540  * \li Syntax: preferences-save
2541  * \li Origin: Lgb, 27 Nov 1999
2542  * \endvar
2543  */
2544                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2545 /*!
2546  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2547  * \li Action: Reconfigure the automatic settings.
2548  * \li Syntax: reconfigure
2549  * \li Origin: Asger, 14 Feb 1997
2550  * \endvar
2551  */
2552                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2553 /*!
2554  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2555  * \li Action: Apply the given settings to user preferences.
2556  * \li Syntax: lyxrc-apply <SETTINGS>
2557  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2558                            to get an idea which commands to use and their syntax.
2559                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2560  * \endvar
2561  */
2562                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2563 /*!
2564  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2565  * \li Action: Determine whether keep cursor inside the editing window regardless
2566                the scrollbar movement.
2567  * \li Syntax: toggle-cursor-follows-scrollbar
2568  * \li Origin: ARRae, 2 Dec 1997
2569  * \endvar
2570  */
2571                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2572 /*!
2573  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2574  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2575  * \li Notion: A new color entry is created if the color is unknown.
2576                Color names can be stored as a part of user settings.
2577  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2578  * \li Origin: SLior, 11 Jun 2000
2579  * \endvar
2580  */
2581                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2582 /*!
2583  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2584  * \li Action: Count the statistics (number of words and characters)
2585                in the document or in the given selection.
2586  * \li Notion: Note that this function gives the number of words/chars written,
2587                not the number of characters which will be typeset.
2588  * \li Syntax: statistics
2589  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2590  * \endvar
2591  */
2592                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2593 /*!
2594  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2595  * \li Action: Show the inline completion at the cursor position.
2596  * \li Syntax: completion-inline
2597  * \li Origin: sts, Feb 19 2008
2598  * \endvar
2599  */
2600                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2601 /*!
2602  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2603  * \li Action: Show the completion popup at the cursor position.
2604  * \li Syntax: completion-popup
2605  * \li Origin: sts, Feb 19 2008
2606  * \endvar
2607  */
2608                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2609 /*!
2610  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2611  * \li Action: Try to complete the word or command at the cursor position.
2612  * \li Syntax: completion-complete
2613  * \li Origin: sts, Feb 19 2008
2614  * \endvar
2615  */
2616                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2617 /*!
2618  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2619  * \li Action: Activate the branch
2620  * \li Syntax: branch-activate <BRANCH>
2621  * \li Params: <BRANCH>: The branch to activate
2622  * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2623                could be used to export a pdf with the answers branch included
2624                without one's having to open LyX and activate the branch manually.
2625  * \li Origin: rgh, 27 May 2008
2626  * \endvar
2627  */
2628                 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2629 /*!
2630  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2631  * \li Action: De-activate the branch
2632  * \li Syntax: branch-deactivate <BRANCH>
2633  * \li Params: <BRANCH>: The branch to deactivate
2634  * \li Origin: rgh, 27 May 2008
2635  * \endvar
2636  */
2637                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2638
2639                 { LFUN_NOACTION, "", Noop, Hidden }
2640 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2641         };
2642
2643         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2644                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2645         }
2646
2647         init = true;
2648 }
2649 #endif
2650
2651 LyXAction::LyXAction()
2652 {
2653         init();
2654 }
2655
2656
2657 // Returns an action tag from a string.
2658 FuncRequest LyXAction::lookupFunc(string const & func) const
2659 {
2660         string const func2 = trim(func);
2661
2662         if (func2.empty()) {
2663                 return FuncRequest(LFUN_NOACTION);
2664         }
2665
2666         string cmd;
2667         string const arg = split(func2, cmd, ' ');
2668
2669         func_map::const_iterator fit = lyx_func_map.find(cmd);
2670
2671         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2672 }
2673
2674
2675 string const LyXAction::getActionName(FuncCode action) const
2676 {
2677         info_map::const_iterator const it = lyx_info_map.find(action);
2678         return it != lyx_info_map.end() ? it->second.name : string();
2679 }
2680
2681
2682 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2683 {
2684         info_map::const_iterator const it = lyx_info_map.find(action);
2685         return it != lyx_info_map.end() ? it->second.type : Hidden;
2686 }
2687
2688
2689 bool LyXAction::funcHasFlag(FuncCode action,
2690                             LyXAction::func_attrib flag) const
2691 {
2692         info_map::const_iterator ici = lyx_info_map.find(action);
2693
2694         if (ici == lyx_info_map.end()) {
2695                 LYXERR0("action: " << action << " is not known.");
2696                 LASSERT(false, /**/);
2697         }
2698
2699         return ici->second.attrib & flag;
2700 }
2701
2702
2703 LyXAction::const_func_iterator LyXAction::func_begin() const
2704 {
2705         return lyx_func_map.begin();
2706 }
2707
2708
2709 LyXAction::const_func_iterator LyXAction::func_end() const
2710 {
2711         return lyx_func_map.end();
2712 }
2713
2714
2715 } // namespace lyx