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