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                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 981 /*!
 982  * \var lyx::FuncCode lyx::LFUN_COPY
 983  * \li Action: Copies to the clipboard the last edit.
 984  * \li Syntax: copy
 985  * \endvar
 986  */
 987                 { LFUN_COPY, "copy", ReadOnly, Edit },
 988 /*!
 989  * \var lyx::FuncCode lyx::LFUN_CUT
 990  * \li Action: Cuts to the clipboard.
 991  * \li Syntax: cut
 992  * \endvar
 993  */
 994                 { LFUN_CUT, "cut", Noop, Edit },
 995 /*!
 996  * \var lyx::FuncCode lyx::LFUN_PASTE
 997  * \li Action: Pastes from the active clipboard.
 998  * \li Syntax: paste
 999  * \endvar
1000  */
1001                 { LFUN_PASTE, "paste", Noop, Edit },
1002                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1003 /*!
1004  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1005  * \li Action: Pastes the material currently selected.
1006  * \li Syntax: primary-selection-paste
1007  * \endvar
1008  */
1009                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1010 /*!
1011  * \var lyx::FuncCode lyx::LFUN_UNDO
1012  * \li Action: Undoes the last edit.
1013  * \li Syntax: undo
1014  * \endvar
1015  */
1016                 { LFUN_UNDO, "undo", Noop, Edit },
1017 /*!
1018  * \var lyx::FuncCode lyx::LFUN_REDO
1019  * \li Action: Redoes the last thing undone.
1020  * \li Syntax: redo
1021  * \endvar
1022  */
1023                 { LFUN_REDO, "redo", Noop, Edit },
1024 /*!
1025  * \var lyx::FuncCode lyx::LFUN_REPEAT
1026  * \li Action: Repeat the given command.
1027  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1028  * \li Author: poenitz, 27 Oct 2003
1029  * \endvar
1030  */
1031                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1032 /*!
1033  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1034  * \li Action: Transposes the character at the cursor with the one before it.
1035  * \li Syntax: chars-transpose
1036  * \li Author: Lgb, 25 Apr 2001
1037  * \endvar
1038  */
1039                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1040
1041                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1042                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1043                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
1044
1045 /*!
1046  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1047  * \li Action: Toggles the bold font (selection-wise).
1048  * \li Syntax: font-bold
1049  * \endvar
1050  */
1051                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1052 /*!
1053  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1054  * \li Action: Toggles the typewriter family font (selection-wise).
1055  * \li Syntax: font-typewriter
1056  * \endvar
1057  */
1058                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1059 /*!
1060  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1061  * \li Action: Toggles underline in the font (selection-wise).
1062  * \li Syntax: font-underline
1063  * \endvar
1064  */
1065                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1066 /*!
1067  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1068  * \li Action: Toggles the emphasis font style (selection-wise).
1069  * \li Syntax: font-emph
1070  * \endvar
1071  */
1072                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1073 /*!
1074  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1075  * \li Action: Toggles Noun text style font (selection-wise).
1076  * \li Syntax: font-noun
1077  * \endvar
1078  */
1079                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1080 /*!
1081  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1082  * \li Action: Toggles Roman family font (selection-wise).
1083  * \li Syntax: font-roman
1084  * \endvar
1085  */
1086                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1087 /*!
1088  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1089  * \li Action: Toggles Sans Serif family font (selection-wise).
1090  * \li Syntax: font-sans
1091  * \endvar
1092  */
1093                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1094 /*!
1095  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1096  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1097  * \li Syntax: font-frak
1098  * \li Origin: vermeer, 10 Jan 2002
1099  * \endvar
1100  */
1101                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1102 /*!
1103  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1104  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1105  * \li Syntax: font-ital
1106  * \li Origin: vermeer, 10 Jan 2002
1107  * \endvar
1108  */
1109                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1110 /*!
1111  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1112  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1113  * \li Syntax: font-default
1114  * \endvar
1115  */
1116                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1117                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
1118                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
1119                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1120                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1121 /*!
1122  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1123  * \li Action: Returns the info about the current font.
1124  * \li Syntax: font-state
1125  * \endvar
1126  */
1127                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1128
1129                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1130                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1131                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1132                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1133
1134 /*!
1135  * \var lyx::FuncCode lyx::LFUN_LAYOUT
1136  * \li Action: Sets the layout (that is, environment) for the current paragraph.
1137  * \li Syntax: layout <LAYOUT>
1138  * \li Params: <LAYOUT>: the layout to use
1139  * \endvar
1140  */
1141                 { LFUN_LAYOUT, "layout", Noop, Layout },
1142 /*!
1143  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1144  * \li Action: Launches the paragraph settings dialog.
1145  * \li Syntax: layout-paragraph
1146  * \endvar
1147  */
1148                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1149 /*!
1150  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1151  * \li Action: Launches the tabular settings dialog.
1152  * \li Syntax: layout-tabular
1153  * \li Origin: Jug, 31 Jul 2000
1154  * \endvar
1155  */
1156                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1157 /*!
1158  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1159  * \li Action: Displays list of layout choices.
1160  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1161                dropbox allowing for choice of layout.
1162  * \li Syntax: drop-layouts-choice
1163  * \endvar
1164  */
1165                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1166 /*!
1167  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1168  * \li Action: Clears the module list.
1169  * \li Notion: Clears the list of included modules for the current buffer.
1170  * \li Syntax: layout-modules-clear
1171  * \li Origin: rgh, 25 August 2007
1172  * \endvar
1173  */
1174                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1175 /*!
1176  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1177  * \li Action: Adds a module.
1178  * \li Notion: Adds a module to the list of included modules for the current buffer.
1179  * \li Syntax: layout-module-add <MODULE>
1180  * \li Params: <MODULE>: the module to be added
1181  * \li Origin: rgh, 25 August 2007
1182  * \endvar
1183  */
1184                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1185 /*!
1186  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1187  * \li Action: Reloads layout information.
1188  * \li Notion: Reloads all layout information for the current buffer from disk, thus
1189                recognizing any changes that have been made to layout files on the fly.
1190                This is intended to be used only by layout developers and should not be
1191                used when one is trying to do actual work.
1192  * \li Syntax: layout-reload
1193  * \li Origin: rgh, 3 September 2007
1194  * \endvar
1195  */
1196                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1197 /*!
1198  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1199  * \li Action: Sets the text class for the current buffer.
1200  * \li Syntax: textclass-apply <TEXTCLASS>
1201  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1202                    the filename, minus the ".layout" extension.
1203  * \endvar
1204  */
1205                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1206 /*!
1207  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1208  * \li Action: Loads information for a textclass from disk.
1209  * \li Syntax: textclass-load <TEXTCLASS>
1210  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1211                    the filename, minus the ".layout" extension.
1212  * \endvar
1213  */
1214                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1215
1216 /*!
1217  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1218  * \li Action: Disable selecting of text-region.
1219  * \li Syntax: mark-off
1220  * \endvar
1221  */
1222                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1223 /*!
1224  * \var lyx::FuncCode lyx::LFUN_MARK_ON
1225  * \li Action: Enable selecting of text-region.
1226  * \li Notion: After enabling you can simply move arrow keys to get selected region.
1227  * \li Syntax: mark-on
1228  * \endvar
1229  */
1230                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1231 /*!
1232  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1233  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1234  * \li Syntax: mark-toggle
1235  * \li Origin: poenitz, May 5 2006
1236  * \endvar
1237  */
1238                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1239
1240                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1241                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1242                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1243                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1244                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1245                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1246                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1247                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1248                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1249                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1250                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1251                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1252                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1253 /*!
1254  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1255  * \li Action: Toggles numbering of the current formula line.
1256  * \li Notion: Must be in display formula mode.
1257  * \li Syntax: math-number-line-toggle
1258  * \li Origin: Alejandro 18 Jun 1996
1259  * \endvar
1260  */
1261                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1262 /*!
1263  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1264  * \li Action: Toggles numbering/labeling of the current formula.
1265  * \li Notion: Must be in display formula mode.
1266  * \li Syntax: math-number-toggle
1267  * \li Origin: Alejandro 4 Jun 1996
1268  * \endvar
1269  */
1270                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1271                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1272                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1273 /*!
1274  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1275  * \li Action: Unfold a Math Macro.
1276  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1277                display it as \foo.
1278  * \li Syntax: math-macro-unfold
1279  * \li Origin: sts, 06 January 2008
1280  * \endvar
1281  */
1282                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1283 /*!
1284  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1285  * \li Action: Fold a Math Macro.
1286  * \li Notion: Fold the Math Macro the cursor is in if it was
1287                unfolded, i.e. displayed as \foo before.
1288  * \li Syntax: math-macro-fold
1289  * \li Origin: sts, 06 January 2008
1290  * \endvar
1291  */
1292                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1293 /*!
1294  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1295  * \li Action: Add a parameter.
1296  * \li Notion: Add a parameter to a Math Macro.
1297  * \li Params: <NUM>: The number of the parameter behind which the new one
1298                will be added (1 for the first, i.e. use 0 for add a
1299                parameter at the left), defaults to the last one.
1300  * \li Syntax: math-macro-add-param <NUM>
1301  * \li Origin: sts, 06 January 2008
1302  * \endvar
1303  */
1304                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1305 /*!
1306  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1307  * \li Action: Remove the last parameter.
1308  * \li Notion: Remove the last parameter of a Math Macro and
1309                remove its value in all instances of the macro
1310                in the buffer.
1311  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1312                the first), defaults to the last one.
1313  * \li Syntax: math-macro-remove-param <NUM>
1314  * \li Origin: sts, 06 January 2008
1315  * \endvar
1316  */
1317                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1318 /*!
1319  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1320  * \li Action: Append a greedy parameter.
1321  * \li Notion: Append a greedy parameter to a Math Macro which
1322                eats the following mathed cell in every instance of
1323                the macro in the buffer.
1324  * \li Syntax: math-macro-append-greedy-param
1325  * \li Origin: sts, 06 January 2008
1326  * \endvar
1327  */
1328                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1329 /*!
1330  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1331  * \li Action: Remove a greedy parameter.
1332  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1333                out the values of it in every instance of the macro
1334                in the buffer. If it is an optional parameter the [valud]
1335                format is used.
1336  * \li Syntax: math-macro-remove-greedy-param
1337  * \li Origin: sts, 06 January 2008
1338  * \endvar
1339  */
1340                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1341 /*!
1342  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1343  * \li Action: Make a parameter optional.
1344  * \li Notion: Turn the first non-optional parameter of a Math Macro
1345                into an optional parameter with a default value.
1346  * \li Syntax: math-macro-make-optional
1347  * \li Origin: sts, 06 January 2008
1348  * \endvar
1349  */
1350                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1351 /*!
1352  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1353  * \li Action: Make a parameter non-optional.
1354  * \li Notion: Turn the last optional parameter of a Math Macro
1355                into a non-optional parameter. The default value is
1356                remembered to be reused later if the user changes his mind.
1357  * \li Syntax: math-macro-make-nonoptional
1358  * \li Origin: sts, 06 January 2008
1359  * \endvar
1360  */
1361                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1362 /*!
1363  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1364  * \li Action: Add an optional parameter.
1365  * \li Notion: Insert an optional parameter just behind the
1366                already existing optional parameters.
1367  * \li Syntax: math-macro-add-optional-param
1368  * \li Origin: sts, 06 January 2008
1369  * \endvar
1370  */
1371                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1372 /*!
1373  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1374  * \li Action: Remove the last optional parameter.
1375  * \li Notion: Remove the last optional parameter of a Math Macro and
1376                remove it in all the instances of the macro in the buffer.
1377  * \li Syntax: math-macro-remove-optional-param
1378  * \li Origin: sts, 06 January 2008
1379  * \endvar
1380  */
1381                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1382 /*!
1383  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1384  * \li Action: Add a greedy optional parameter.
1385  * \li Notion: Add a greedy optional parameter which eats the value
1386                from the following cells in mathed which are in the [value]
1387                format.
1388  * \li Syntax: math-macro-add-greedy-optional-param
1389  * \li Origin: sts, 06 January 2008
1390  * \endvar
1391  */
1392                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1393 /*!
1394  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1395  * \li Action: Only active in Math Macro definition.
1396  * \li Notion: Dummy function which is only active in a Math Macro definition.
1397                It's used to toggle the Math Macro toolbar if the cursor moves
1398                into a Math Macro definition.
1399  * \li Syntax: in-mathmacrotemplate
1400  * \li Origin: sts, 06 January 2008
1401  * \endvar
1402  */
1403                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1404
1405 /*!
1406  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1407  * \li Action: Moves the current paragraph downwards in the document.
1408  * \li Syntax: paragraph-move-down
1409  * \li Origin: Edwin, 8 Apr 2006
1410  * \endvar
1411  */
1412                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1413 /*!
1414  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1415  * \li Action: Moves the current paragraph upwards in the document.
1416  * \li Syntax: paragraph-move-up
1417  * \li Origin: Edwin, 8 Apr 2006
1418  * \endvar
1419  */
1420                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1421
1422 /*!
1423  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1424  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1425                in upward direction.
1426  * \li Syntax: paragraph-up
1427  * \li Origin: Asger, 1 Oct 1996
1428  * \endvar
1429  */
1430                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1431 /*!
1432  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1433  * \li Action: Move the cursor and select the text to the next paragraph (or
1434                begining of the current one) in upward direction.
1435  * \li Syntax: paragraph-up-select
1436  * \li Origin: Asger, 1 Oct 1996
1437  * \endvar
1438  */
1439                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1440 /*!
1441  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1442  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1443                in downward direction.
1444  * \li Syntax: paragraph-down
1445  * \li Origin: Asger, 1 Oct 1996
1446  * \endvar
1447  */
1448                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1449 /*!
1450  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1451  * \li Action: Move the cursor and select the text to the next paragraph (or
1452                begining of the current one) in downward direction.
1453  * \li Syntax: paragraph-down-select
1454  * \li Origin: Asger, 1 Oct 1996
1455  * \endvar
1456  */
1457                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1458 /*!
1459  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1460  * \li Action: Jump to a paragraph given by its id number and optionally the
1461                desired position within the paragraph.
1462  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1463                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1464  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1465  * \li Params: <PAR_ID_NUMBER>:  paragraph id
1466                <POSITION_IN_PAR>: desired position within the paragraph
1467  * \li Origin: Dekel, 26 Aug 2000
1468  * \endvar
1469  */
1470                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1471 /*!
1472  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1473  * \li Action: Breaks the current paragraph at the current location.
1474  * \li Syntax: break-paragraph
1475  * \endvar
1476  */
1477                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1478 /*!
1479  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1480  * \li Action: Breaks the current paragraph at the current location.
1481  * \li Notion: Removes the selection.
1482  * \li Syntax: break-paragraph [<LAYOUT>]
1483  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1484                          to default layout) when the cursor is at the end of
1485                          the line.
1486  * \endvar
1487  */
1488                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1489 /*!
1490  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1491  * \li Action: Change paragraph settings.
1492  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1493                This function only modifies, and does not override, existing settings.
1494                Note that the "leftindent" indent setting is deprecated.
1495  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1496  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1497                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1498                <ALIGN>:   \\align block|left|right|center|default\n
1499                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1500  * \li Origin: rgh, Aug 15 2007
1501  * \endvar
1502  */
1503                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1504 /*!
1505  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1506  * \li Action: Change paragraph settings.
1507  * \li Notion: Overwrite all nonspecified settings to the default ones.
1508                Use paragraph-params lfun if you don't want to overwrite others settings.
1509  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1510  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1511  * \li Origin: leeming, 30 Mar 2004
1512  * \endvar
1513  */
1514                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1515                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1516
1517 /*!
1518  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1519  * \li Action: Move the current group in the upward direction in the
1520                structure of the document.
1521  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1522                the whole substructure of the group.
1523  * \li Syntax: outline-up
1524  * \li Origin: Vermeer, 23 Mar 2006
1525  * \endvar
1526  */
1527                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1528 /*!
1529  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1530  * \li Action: Move the current group in the downward direction in the
1531                structure of the document.
1532  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1533                the whole substructure of the group.
1534  * \li Syntax: outline-down
1535  * \li Origin: Vermeer, 23 Mar 2006
1536  * \endvar
1537  */
1538                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1539 /*!
1540  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1541  * \li Action: Moves the current group in the downward direction in the
1542                hierarchy of the document structure.
1543  * \li Notion: Part -> Chapter -> Section -> etc.
1544  * \li Syntax: outline-in
1545  * \li Origin: Vermeer, 23 Mar 2006
1546  * \endvar
1547  */
1548                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1549 /*!
1550  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1551  * \li Action: Moves the current group in the upward direction in the
1552                hierarchy of the document structure.
1553  * \li Notion: Part <- Chapter <- Section <- etc.
1554  * \li Syntax: outline-out
1555  * \li Origin: Vermeer, 23 Mar 2006
1556  * \endvar
1557  */
1558                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1559 /*!
1560  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1561  * \li Action: Edit the inset at cursor with an external application,
1562  *             if one is attributed.
1563  * \li Syntax: inset-edit [<INSET_PARAMS>]
1564  * \li Params: <INSET_PARAMS>: Parameters for the inset.
1565                                Currently only the filename will be considered.
1566  * \li Origin: JSpitzm, 27 Apr 2006
1567  * \endvar
1568  */
1569                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1570
1571                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1572                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1573                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1574                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1575                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1576
1577                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1578                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1579                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1580                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1581                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1582
1583                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1584                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1585                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1586                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1587                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1588                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1589                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1590                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1591
1592 /*!
1593  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1594  * \li Action: Apply data for an inset.
1595  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1596                be applied. This is either changed to #LFUN_INSET_MODIFY or
1597                #LFUN_INSET_INSERT depending on the context where it is called.
1598  * \li Syntax: inset-apply <ARGS>
1599  * \li Params: See #LFUN_INSET_INSERT .
1600  * \endvar
1601  */
1602                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1603 /*!
1604  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1605  * \li Action: Dissolve the current inset into text.
1606  * \li Syntax: inset-dissolve [<INSET>]
1607  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1608                         is dissolved. For example "dissolve" entry in the charstyles
1609                         sub-menu should only dissolve the charstyle inset, even if the
1610                         cursor is inside several nested insets of different type.\n
1611                         For values see #lyx::InsetLayout::lyxtype_ .
1612  * \li Author: JSpitz, 7 Aug 2006
1613  * \endvar
1614  */
1615                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1616 /*!
1617  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1618  * \li Action: Insert new inset (type given by the parameters).
1619  * \li Syntax: inset-insert <INSET> <ARGS>
1620  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1621                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1622                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1623                        explore.
1624  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1625                where <label name> is the name of the referenced label and
1626                <Format> is one of the following: \n
1627                ref -- <reference> \n
1628                eqref -- (<reference>) \n
1629                pageref -- <page> \n
1630                vpageref -- on <page> \n
1631                vref -- <reference> on <page> \n
1632                prettyref -- Formatted reference
1633  * \endvar
1634  */
1635                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1636 /*!
1637  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1638  * \li Action: Modify existing inset.
1639  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1640                bibtex, ert, command, graphics, note, space, vspace, tabular,
1641                bibitem, inlude, ref insets.
1642  * \li Syntax: inset-modify <INSET> <ARGS>
1643  * \li Params: See #LFUN_INSET_INSERT for further details.
1644  * \endvar
1645  */
1646                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1647 /*!
1648  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1649  * \li Action: Modify the inset at cursor position, if there is one.
1650  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1651                bibtex, ert, command, graphics, note, space, vspace, tabular,
1652                bibitem, inlude, ref insets.
1653  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1654  * \li Params: See #LFUN_INSET_INSERT for further details.
1655  * \li Origin: JSpitzm, 23 Mar 2008
1656  * \endvar
1657  */
1658                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1659                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1660 /*!
1661  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1662  * \li Action: Open the inset's properties dialog.
1663  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1664  * \li Syntax: inset-settings <INSET>
1665  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1666  * \endvar
1667  */
1668                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1669 /*!
1670  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1671  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1672                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1673                be entered. Also cf. #LFUN_INSET_SETTINGS.
1674  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1675                bibtex, ert, command, graphics, note, space, vspace, tabular,
1676                bibitem, inlude, ref insets.
1677  * \li Syntax: next-inset-toggle <ARG>
1678  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1679  * \li Origin: leeming, 30 Mar 2004
1680  * \endvar
1681  */
1682                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1683 /*!
1684  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1685  * \li Action: Toggles the collapsable inset we are currently in.
1686  * \li Syntax: inset-toggle [<ARG>]
1687  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1688                open/close/toggle are for collapsable insets. close can be currently used
1689                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1690                assign is for branch inset.
1691  * \li Origin: lasgouttes, 19 Jul 2001
1692  * \endvar
1693  */
1694                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1695 /*!
1696  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1697  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1698  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1699  * \li Syntax: all-insets-toggle <STATE> <INSET>
1700  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1701                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1702  * \li Origin: leeming, 30 Mar 2004
1703  * \endvar
1704  */
1705                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1706 /*!
1707  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1708  * \li Action: Unify all graphics insets with the one given as an parameter.
1709  * \li Notion: This is internally used for synchronize certain group of graphics insets.
1710  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1711  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1712                                   (syntax can be seen in .lyx files).
1713  * \li Origin: sanda, 6 May 2008
1714  * \endvar
1715  */
1716                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1717 /*!
1718  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1719  * \li Action: Set the group for the graphics inset on the cursor position.
1720  * \li Syntax: set-graphics-group [<GROUP>]
1721  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1722                         the graphics inset is removed from the current group.
1723  * \li Origin: sanda, 6 May 2008
1724  * \endvar
1725  */
1726                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1727
1728 /*!
1729  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1730  * \li Action: Moves the cursor out of the current slice, going forward.
1731  * \li Notion: Cursor movement within an inset may be different than cursor
1732                movement in the surrounding text. This action should be called
1733                automatically by the cursor movement within the inset, when
1734                movement within the inset has ceased (reached the end of the
1735                last paragraph, for example), in order to move correctly
1736                back into the surrounding text.
1737  * \endvar
1738  */
1739                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1740 /*!
1741  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1742  * \li Action: Moves the cursor out of the current slice, going backwards.
1743  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1744  * \endvar
1745  */
1746                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1747 /*!
1748  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1749  * \li Action: Moves the cursor out of the current slice, going right.
1750  * \li Notion: See also #LFUN_FINISHED_FORWARD
1751  * \endvar
1752  */
1753                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1754 /*!
1755  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1756  * \li Action: Moves the cursor out of the current slice, going left.
1757  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1758  * \endvar
1759  */
1760                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1761
1762                 { LFUN_LANGUAGE, "language", Noop, Edit },
1763
1764 /*!
1765  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1766  * \li Action: Goto a label.
1767  * \li Syntax: label-goto [<LABEL>]
1768  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1769                         is on cursor position, Bookmark 0 is saved and
1770                         cursor moves to the position of referenced label.
1771  * \li Origin: Ale, 6 Aug 1997
1772  * \endvar
1773  */
1774                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1775 /*!
1776  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1777  * \li Action: Inserts label to text or displayed formula.
1778  * \li Syntax: label-insert [<LABEL>]
1779  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1780                         name will be opened.
1781  * \endvar
1782  */
1783                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1784 /*!
1785  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1786  * \li Action: Go to the next label or cross-reference.
1787  * \li Syntax: reference-next
1788  * \li Origin: Dekel, 14 Jan 2001
1789  * \endvar
1790  */
1791                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1792
1793 /*!
1794  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1795  * \li Action: Goto a bookmark.
1796  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1797                if necessary. Note that bookmarsk are saved per-session, not
1798                per file.
1799  * \li Syntax: bookmark-goto <NUMBER>
1800  * \li Params: <NUMBER>: the number of the bookmark to restore.
1801  * \li Origin: Dekel, 27 January 2001
1802  * \endvar
1803  */
1804                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1805 /*!
1806  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1807  * \li Action: Save a bookmark.
1808  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1809                must be between 1 and 9, inclusive. Note that bookmarks are
1810                saved per-session, not per file.
1811  * \li Syntax: bookmark-save <NUMBER>
1812  * \li Params: <NUMBER>: the number of the bookmark to save.
1813  * \li Origin: Dekel, 27 January 2001
1814  * \endvar
1815  */
1816                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1817 /*!
1818  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1819  * \li Action: Clears the list of saved bookmarks.
1820  * \li Syntax: bookmark-clear
1821  * \li Origin: bpeng, 31 October 2006
1822  * \endvar
1823  */
1824                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1825
1826 /*!
1827  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1828  * \li Action: Open the given help file according to the language setting.
1829  * \li Syntax: help-open <FILE>[.lyx]
1830  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1831  * \li Author: Jug, 27 Jun 1999
1832  * \endvar
1833  */
1834                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1835 /*!
1836  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1837  * \li Action: Terminates the current LyX instance.
1838  * \li Notion: Terminates the current LyX instance, asking whether to save
1839                modified documents, etc.
1840  * \li Syntax: lyx-quit
1841  * \endvar
1842  */
1843                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1844 /*!
1845  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1846  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1847  * \li Notion: Skiping "auto" when allowauto is false.
1848  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1849  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1850                        minibuffer|review|view/update|math_panels
1851  * \li Origin: Edwin, 21 May 2007
1852  * \endvar
1853  */
1854                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1855 /*!
1856  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1857  * \li Action: Opens the menu given by its name.
1858  * \li Syntax: menu-open <NAME>
1859  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1860  * \endvar
1861  */
1862                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1863 /*!
1864  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1865  * \li Action: Various UI visibility-toggling actions.
1866  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1867  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1868                menubar    : Toggle visibility of the menubar.\n
1869                scrollbar  : Toggle visibility of the scrollbar.\n
1870                frame      : Toggle visibility of the frames around editing window.\n
1871                fullscreen : Toggle fullscreen mode. This also covers calling the
1872                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1873                             custom tweaks of the toolbars should be used.
1874  * \li Origin: ps, 9 Feb 2007
1875  * \endvar
1876  */
1877                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1878
1879 /*!
1880  * \var lyx::FuncCode lyx::WINDOW_NEW
1881  * \li Action: Creates new empty LyX window.
1882  * \li Notion: Already opened documents from the previous window can be found under View menu.
1883  * \li Syntax: window-new [<GEOMETRY>]
1884  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1885                            accepted only on Windows platform.
1886  * \li Origin: Abdel, 21 Oct 2006
1887  * \endvar
1888  */
1889                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1890 /*!
1891  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1892  * \li Action: Closes the current LyX window.
1893  * \li Syntax: window-close
1894  * \li Origin: Abdel, 23 Oct 2006
1895  * \endvar
1896  */
1897                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1898
1899 /*!
1900  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1901  * \li Action: Creates another split view of current buffer.
1902  * \li Notion: All split views act in the same way indpendently.
1903  * \li Syntax: split-view <vertical|horizontal>
1904  * \li Params: horizontal : The work areas are laid out side by side.\n
1905                vertical   : The work areas laid out vertically.\n
1906  * \li Origin: abdel, 20 Feb 2008
1907  * \endvar
1908  */
1909                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1910
1911 /*!
1912  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1913  * \li Action: Close the current tab group.
1914  * \li Notion: This only closes the work areas, not the buffer themselves.
1915                The still opened buffers can be visualized in another tab group.
1916  * \li Syntax: close-tab-group
1917  * \li Origin: abdel, 21 Feb 2008
1918  * \endvar
1919  */
1920                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1921                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1922                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1923                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1924                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1925                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1926                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1927
1928                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1929                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1930                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1931                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1932                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1933
1934                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1935                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1936                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1937                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1938
1939                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1940                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1941                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1942 /*!
1943  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1944  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1945  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1946  * \li Origin: Edmar, 23 Dec 1998
1947  * \endvar
1948  */
1949                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1950                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1951 /*!
1952  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1953  * \li Action: Sets the cursor position based on the editing area coordinates
1954                (similar as clicking on that point with left mouse button).
1955  * \li Syntax: server-set-xy <X> <Y>
1956  * \endvar
1957  */
1958                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1959 /*!
1960  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1961  * \li Action: Returns the coordinates of cursor position in the editing area.
1962  * \li Syntax: server-get-xy
1963  * \endvar
1964  */
1965                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1966
1967 /*!
1968  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1969  * \li Action: Generates the code (literate programming).
1970  * \li Notion: Latex file with extension \literate_extension is generated.
1971                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1972                \build_error_filter to process the compilation error messages. \n
1973                In case you want to process your literate file with a script, or some other program,
1974                just insert in your lyxrc file an entry with:\n
1975                \build_command "my_script my_arguments" \n
1976                The \build_error_filter differs from the \literate_error_filter only in that the
1977                former will identify error messages from your compiler.
1978  * \li Syntax: build-program
1979  * \endvar
1980  */
1981                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1982
1983 /*!
1984  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1985  * \li Action: Saves the current buffer to a temporary file.
1986  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1987                is called automatically by LyX, to "autosave" the current buffer.
1988  * \li Syntax: buffer-auto-save
1989  * \endvar
1990  */
1991                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1992 /*!
1993  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1994  * \li Action: Loads the given child document.
1995  * \li Notion: The current document is treated as a parent.
1996  * \li Syntax: buffer-child-open <FILE>
1997  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1998  * \li Origin: Ale, 28 May 1997
1999  * \endvar
2000  */
2001                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2002 /*!
2003  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2004  * \li Action: Runs chktex for the current document.
2005  * \li Syntax: buffer-chktex
2006  * \li Origin: Asger, 30 Oct 1997
2007  * \endvar
2008  */
2009                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2010 /*!
2011  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2012  * \li Action: Toggles compression of the current document on/off.
2013  * \li Syntax: buffer-toggle-compression
2014  * \li Origin: bpeng, 27 Apr 2006
2015  * \endvar
2016  */
2017                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2018 /*!
2019  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2020  * \li Action: Closes the current buffer.
2021  * \li Notion: Closes the current buffer, asking whether to save it, etc,
2022                if the buffer has been modified.
2023  * \li Syntax: buffer-close
2024  * \endvar
2025  */
2026                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2027 /*!
2028  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2029  * \li Action: Exports the current buffer (document) to the given format.
2030  * \li Syntax: buffer-export <FORMAT>
2031  * \li Params: <FORMAT> is either "custom" or one of the formats which you
2032                         can find in Tools->Preferences->File formats->Format.
2033                         Usual format you will enter is "pdf2" (pdflatex),
2034                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2035                         In case of "custom" you will be asked for a format you
2036                         want to start from and for the command that you want to
2037                         apply to this format. Internally the control is then passed
2038                         to #LFUN_BUFFER_EXPORT_CUSTOM.
2039  * \li Origin: Lgb, 29 Jul 1997
2040  * \endvar
2041  */
2042                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2043 /*!
2044  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2045  * \li Action: Exports the current buffer (document) from the given format using
2046                the given command on it.
2047  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2048  * \li Params: <FORMAT> format to start from (LyX will care to produce such
2049                         intermediate file).\n
2050                <COMMAND> this command will be launched on the file. Note that you can
2051                use "$$FName" string to qualify the intermediate file.
2052  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2053  * \li Origin: leeming, 27 Mar 2004
2054  * \endvar
2055  */
2056                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2057 /*!
2058  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2059  * \li Action: Prints the current document.
2060  * \li Notion: Many settings can be given via the preferences dialog.
2061  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2062  * \li Params: <TARGET> is either "printer" or "file".\n
2063                <TARGER-NAME> is either "default" or file name or printer name.\n
2064                <COMMAND> command ensuring the printing job.
2065  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2066  * \li Origin: leeming, 28 Mar 2004
2067  * \endvar
2068  */
2069                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2070 /*!
2071  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2072  * \li Action: Import a given file as a lyx document.
2073  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2074                defined convertors in preferences. Look into File->Import menu to get
2075                an idea of the currently active import formats.
2076  * \li Syntax: buffer-import <FORMAT> [<FILE>]
2077  * \li Origin: Asger, 24 Jul 1998
2078  * \endvar
2079  */
2080                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2081 /*!
2082  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2083  * \li Action: Creates a new buffer (that is, document).
2084  * \li Notion: Implicit path can be set in Preferences dialog.
2085  * \li Syntax: buffer-new [<FILE>]
2086  * \li Params: <FILE>: filename of created file with absolute path.
2087  * \endvar
2088  */
2089                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2090 /*!
2091  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2092  * \li Action: Creates a new buffer (that is, document) from a template.
2093  * \li Notion: Path for new files and templates can be set in Preferences dialog.
2094                Template will be asked for via Open-dialog.
2095  * \li Syntax: buffer-new-template [<FILE>]
2096  * \li Params: <FILE>: filename of created file with absolute path.
2097  * \endvar
2098  */
2099                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2100 /*!
2101  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2102  * \li Action: Reverts opened document.
2103  * \li Syntax: buffer-reload
2104  * \li Origin: Asger, 2 Feb 1997
2105  * \endvar
2106  */
2107                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2108 /*!
2109  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2110  * \li Action: Switch to the given buffer.
2111  * \li Notion: This is useful also in case you need simultaneously more views of the edited
2112                document in different LyX windows.
2113  * \li Syntax: buffer-new-template <BUFFER>
2114  * \li Params: <BUFFER>: already opened document which is to be shown.
2115  * \endvar
2116  */
2117                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2118 /*!
2119  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2120  * \li Action: Toggle editing mode of the current document between read/write and read-only.
2121  * \li Syntax: buffer-toggle-read-only
2122  * \li Origin: Lgb, 27 May 1997
2123  * \endvar
2124  */
2125                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2126 /*!
2127  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2128  * \li Action: Displays current buffer in chosen format.
2129  * \li Notion: Displays the contents of the current buffer in the chosen
2130                format, for example, PDF or DVI. This runs the necessary
2131                converter, calls the defined viewer, and so forth.
2132  * \li Syntax: buffer-view <FORMAT>
2133  * \li Params: <FORMAT>: The format to display, where this is one of the
2134                          formats defined (in the current GUI) in the
2135                          Tools>Preferences>File Formats dialog.
2136  * \endvar
2137  */
2138                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2139 /*!
2140  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2141  * \li Action: Exports the current document and put the result into the
2142                temporary directory.
2143  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2144                the output will be rewriten - updated. This is useful in case your viewer
2145                is able to detect such changes (e.g. ghostview for postscript).
2146  * \li Syntax: buffer-update <FORMAT>
2147  * \li Params: <FORMAT>: The format to display, where this is one of the
2148                          formats defined (in the current GUI) in the
2149                          Tools>Preferences>File Formats dialog.
2150  * \li Origin: Dekel, 5 Aug 2000
2151  * \endvar
2152  */
2153                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2154
2155 /*!
2156  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2157  * \li Action: Saves the current buffer.
2158  * \li Notion: Saves the current buffer to disk, using the filename that
2159                is already associated with the buffer, asking for one if
2160                none is yet assigned.
2161  * \li Syntax: buffer-write
2162  * \endvar
2163  */
2164                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2165 /*!
2166  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2167  * \li Action: Rename and save current buffer.
2168  * \li Syntax: buffer-write-as <FILENAME>
2169  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2170                is with respect to the original location of the buffer/file.
2171  * \endvar
2172  */
2173                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2174 /*!
2175  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2176  * \li Action: Save all changed documents.
2177  * \li Syntax: buffer-write-all
2178  * \li Origin: rgh, gpothier 6 Aug 2007
2179  * \endvar
2180  */
2181                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2182 /*!
2183  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2184  * \li Action: Switch to the next opened document.
2185  * \li Notion: Note that this does not necessarily mean next in tabbar
2186                (for full list see View menu).
2187  * \li Syntax: buffer-next
2188  * \endvar
2189  */
2190                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2191 /*!
2192  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2193  * \li Action: Switch to the previous opened document.
2194  * \li Syntax: buffer-previous
2195  * \endvar
2196  */
2197                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2198 /*!
2199  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2200  * \li Action: When run from a child document, this updates (exports) document built
2201                 from the master buffer. If a master is not found, it updates the
2202                 current buffer.
2203  * \li Syntax: master-buffer-update
2204  * \li Author: Tommaso, 20 Sep 2007
2205  * \endvar
2206  */
2207                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2208 /*!
2209  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2210  * \li Action: When run from a child document, this command shows a preview built
2211                from the master buffer. If a master is not found, it previews the
2212                current buffer.
2213  * \li Syntax: master-buffer-view
2214  * \li Author: Tommaso, 20 Sep 2007
2215  * \endvar
2216  */
2217                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2218 /*!
2219  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2220  * \li Action: Set language of the current document.
2221  * \li Syntax: buffer-language <LANG>
2222  * \li Params: <LANG>: language name. See lib/languages for list.
2223  * \li Author: leeming, 30 Mar 2004
2224  * \endvar
2225  */
2226                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2227 /*!
2228  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2229  * \li Action: Save the current document settings as default.
2230  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2231  * \li Syntax: buffer-save-as-default [<ARGS>]
2232  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2233                        you can find in document header of usual .lyx file.
2234  * \li Author: leeming, 30 Mar 2004
2235  * \endvar
2236  */
2237                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2238 /*!
2239  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2240  * \li Action: Apply the given settings to the current document.
2241  * \li Syntax: buffer-params-apply [<ARGS>]
2242  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2243                        you can find in document header of usual .lyx file.
2244  * \li Author: leeming, 30 Mar 2004
2245  * \endvar
2246  */
2247                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2248
2249 /*!
2250  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2251  * \li Action: Inserts another LyX file.
2252  * \li Syntax: file-insert [<FILE>]
2253  * \li Params: <FILE>: Filename to be inserted.
2254  * \endvar
2255  */
2256                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2257 /*!
2258  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2259  * \li Action: Inserts plain text file.
2260  * \li Syntax: file-insert-plaintext [<FILE>]
2261  * \li Params: <FILE>: Filename to be inserted.
2262  * \li Origin: CFO-G, 19 Nov 1997
2263  * \endvar
2264  */
2265                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2266 /*!
2267  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2268  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2269  * \li Syntax: file-insert-plaintext-para [<FILE>]
2270  * \li Params: <FILE>: Filename to be inserted.
2271  * \li Origin: Levon, 14 Feb 2001
2272  * \endvar
2273  */
2274                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2275 /*!
2276  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2277  * \li Action: Open LyX document.
2278  * \li Syntax: file-open [<FILE>]
2279  * \li Params: <FILE>: Filename to be opened.
2280  * \endvar
2281  */
2282                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2283
2284 /*!
2285  * \var lyx::FuncCode lyx::LFUN_CALL
2286  * \li Action: Executes a command defined in a .def file.
2287  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2288                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2289                where <NAME> is the name of the new command and <LFUN> is the lfun code
2290                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2291                \\def_file "FileName" allows to include another .def file. \n
2292                This is particularly useful in connection with toolbar buttons:
2293                Since the name of the button image for this lfun is
2294                lib/images/commands/<NAME>.png this is the way to assign an image
2295                to a complex command-sequence.
2296  * \li Syntax: call <NAME>
2297  * \li Params: <NAME>: Name of the command that must be called.
2298  * \li Origin: broider, 2 Oct 2007
2299  * \endvar
2300  */
2301                 { LFUN_CALL, "call", NoBuffer, System },
2302 /*!
2303  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2304  * \li Action: Simulate halting Meta key (Alt key on PCs).
2305  * \li Notion: Used for buffer editation not for GUI control.
2306  * \li Syntax: meta-prefix
2307  * \endvar
2308  */
2309                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2310 /*!
2311  * \var lyx::FuncCode lyx::LFUN_CANCEL
2312  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2313  * \li Syntax: cancel
2314  * \endvar
2315  */
2316                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2317
2318 /*!
2319  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2320  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2321  * \li Notion: Usually bound to M-x shortcut.
2322  * \li Syntax: command-execute
2323  * \endvar
2324  */
2325                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2326                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2327 /*!
2328  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2329  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2330  * \li Syntax: command-sequence <CMDS>
2331  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2332  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2333  * \li Origin: Andre', 11 Nov 1999
2334  * \endvar
2335  */
2336                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2337 /*!
2338  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2339  * \li Action: Shows message in statusbar (for script purposes).
2340  * \li Syntax: message <STRING>
2341  * \li Origin: Lgb, 8 Apr 2001
2342  * \endvar
2343  */
2344                 { LFUN_MESSAGE, "message", NoBuffer, System },
2345 /*!
2346  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2347  * \li Action: Save user preferences.
2348  * \li Syntax: preferences-save
2349  * \li Origin: Lgb, 27 Nov 1999
2350  * \endvar
2351  */
2352                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2353 /*!
2354  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2355  * \li Action: Reconfigure the automatic settings.
2356  * \li Syntax: reconfigure
2357  * \li Origin: Asger, 14 Feb 1997
2358  * \endvar
2359  */
2360                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2361 /*!
2362  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2363  * \li Action: Apply the given settings to user preferences.
2364  * \li Syntax: lyxrc-apply <SETTINGS>
2365  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2366                            to get an idea which commands to use and their syntax.
2367                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2368  * \endvar
2369  */
2370                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2371 /*!
2372  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2373  * \li Action: Determine whether keep cursor inside the editing window regardless
2374                the scrollbar movement.
2375  * \li Syntax: toggle-cursor-follows-scrollbar
2376  * \li Origin: ARRae, 2 Dec 1997
2377  * \endvar
2378  */
2379                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2380 /*!
2381  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2382  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2383  * \li Notion: A new color entry is created if the color is unknown.
2384                Color names can be stored as a part of user settings.
2385  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2386  * \li Origin: SLior, 11 Jun 2000
2387  * \endvar
2388  */
2389                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2390 /*!
2391  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2392  * \li Action: Count the statistics (number of words and characters)
2393                in the document or in the given selection.
2394  * \li Notion: Note that this function gives the number of words/chars written,
2395                not the number of characters which will be typeset.
2396  * \li Syntax: statistics
2397  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2398  * \endvar
2399  */
2400                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2401 /*!
2402  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2403  * \li Action: Show the inline completion at the cursor position.
2404  * \li Syntax: completion-inline
2405  * \li Origin: sts, Feb 19 2008
2406  * \endvar
2407  */
2408                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2409 /*!
2410  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2411  * \li Action: Show the completion popup at the cursor position.
2412  * \li Syntax: completion-popup
2413  * \li Origin: sts, Feb 19 2008
2414  * \endvar
2415  */
2416                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2417 /*!
2418  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2419  * \li Action: Try to complete the word or command at the cursor position.
2420  * \li Syntax: completion-complete
2421  * \li Origin: sts, Feb 19 2008
2422  * \endvar
2423  */
2424                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2425 /*!
2426  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2427  * \li Action: Activate the branch
2428  * \li Syntax: branch-activate <BRANCH>
2429  * \li Params: <BRANCH>: The branch to activate
2430  * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2431                could be used to export a pdf with the answers branch included
2432                without one's having to open LyX and activate the branch manually.
2433  * \li Origin: rgh, 27 May 2008
2434  * \endvar
2435  */
2436                 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2437 /*!
2438  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2439  * \li Action: De-activate the branch
2440  * \li Syntax: branch-deactivate <BRANCH>
2441  * \li Params: <BRANCH>: The branch to deactivate
2442  * \li Origin: rgh, 27 May 2008
2443  * \endvar
2444  */
2445                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2446
2447                 { LFUN_NOACTION, "", Noop, Hidden }
2448 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2449         };
2450
2451         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2452                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2453         }
2454
2455         init = true;
2456 }
2457 #endif
2458
2459 LyXAction::LyXAction()
2460 {
2461         init();
2462 }
2463
2464
2465 // Returns an action tag from a string.
2466 FuncRequest LyXAction::lookupFunc(string const & func) const
2467 {
2468         string const func2 = trim(func);
2469
2470         if (func2.empty()) {
2471                 return FuncRequest(LFUN_NOACTION);
2472         }
2473
2474         string cmd;
2475         string const arg = split(func2, cmd, ' ');
2476
2477         func_map::const_iterator fit = lyx_func_map.find(cmd);
2478
2479         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2480 }
2481
2482
2483 string const LyXAction::getActionName(FuncCode action) const
2484 {
2485         info_map::const_iterator const it = lyx_info_map.find(action);
2486         return it != lyx_info_map.end() ? it->second.name : string();
2487 }
2488
2489
2490 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2491 {
2492         info_map::const_iterator const it = lyx_info_map.find(action);
2493         return it != lyx_info_map.end() ? it->second.type : Hidden;
2494 }
2495
2496
2497 bool LyXAction::funcHasFlag(FuncCode action,
2498                             LyXAction::func_attrib flag) const
2499 {
2500         info_map::const_iterator ici = lyx_info_map.find(action);
2501
2502         if (ici == lyx_info_map.end()) {
2503                 LYXERR0("action: " << action << " is not known.");
2504                 LASSERT(false, /**/);
2505         }
2506
2507         return ici->second.attrib & flag;
2508 }
2509
2510
2511 LyXAction::const_func_iterator LyXAction::func_begin() const
2512 {
2513         return lyx_func_map.begin();
2514 }
2515
2516
2517 LyXAction::const_func_iterator LyXAction::func_end() const
2518 {
2519         return lyx_func_map.end();
2520 }
2521
2522
2523 } // namespace lyx