src/LyXAction.cpp

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