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