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