src/LyXAction.cpp

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