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/assert.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                 { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
 196 /*!
 197  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
 198  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
 199                over the next two character typed.
 200  * \li Notion: the following char will finish the tie.
 201  * \li Syntax: accent-tie
 202  * \endvar
 203  */
 204                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
 205 /*!
 206  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
 207  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
 208                over the next character typed.
 209  * \li Syntax: accent-tilde
 210  * \endvar
 211  */
 212                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
 213 /*!
 214  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
 215  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
 216                over the next character typed.
 217  * \li Syntax: accent-umlaut
 218  * \endvar
 219  */
 220                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
 221 /*!
 222  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
 223  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
 224                under the next character typed.
 225  * \li Syntax: accent-underbar
 226  * \endvar
 227  */
 228                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
 229 /*!
 230  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
 231  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
 232                under the next character typed.
 233  * \li Syntax: accent-underdot
 234  * \endvar
 235  */
 236                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
 237
 238 /*!
 239  * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
 240  * \li Action: Inserts a caption inset.
 241  * \li Syntax: caption-insert
 242  * \li Origin: Lgb, 18 Jul 2000
 243  * \endvar
 244  */
 245                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
 246 /*!
 247  * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
 248  * \li Action: Inserts the current date.
 249  * \li Syntax: date-insert [<ARG>]
 250  * \li Params: <ARG>: Format of date. The default value (%x) can be set
 251                      in Preferences->Date format. For possible formats
 252                      see manual page of strftime function.
 253  * \li Origin: jdblair, 31 Jan 2000
 254  * \endvar
 255  */
 256                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
 257 /*!
 258  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
 259  * \li Action: Inserts a footnote inset.
 260  * \li Syntax: footnote-insert
 261  * \li Origin: Jug, 7 Mar 2000
 262  * \endvar
 263  */
 264                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
 265 /*!
 266  * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
 267  * \li Action: Inserts an ERT inset.
 268  * \li Syntax: ert-insert
 269  * \li Origin: Jug, 18 Feb 2000
 270  * \endvar
 271  */
 272                 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
 273                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
 274                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
 275                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
 276 /*!
 277  * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
 278  * \li Action: Inserts an optional-argument (short title) inset.
 279  * \li Syntax: optional-insert
 280  * \li Origin: Martin, 12 Aug 2002
 281  * \endvar
 282  */
 283                 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
 284 /*!
 285  * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
 286  * \li Action: Inserts a horizontal line.
 287  * \li Syntax: line-insert
 288  * \li Origin: poenitz,  Oct 27 2003
 289  * \endvar
 290  */
 291                 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
 292 /*!
 293  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
 294  * \li Action: Inserts a new page.
 295  * \li Syntax: newpage-insert<ARG>
 296  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 297  * \li Origin: uwestoehr, 24 Nov 2007
 298  * \endvar
 299  */
 300                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
 301 /*!
 302  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
 303  * \li Action: Inserts a marginal note.
 304  * \li Syntax: marginalnote-insert
 305  * \li Origin: Lgb, 26 Jun 2000
 306  * \endvar
 307  */
 308                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
 309 /*!
 310  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
 311  * \li Action: Inserts a single unicode character.
 312  * \li Syntax: unicode-insert <CHAR>
 313  * \li Params: <CHAR>: The character to insert, given as its code
 314                        point, in hexadecimal, e.g.: unicode-insert 0x0100.
 315  * \li Origin: Lgb, 22 Oct 2006
 316  * \endvar
 317  */
 318                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
 319 /*!
 320  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
 321  * \li Action: Inserts a new listings inset.
 322  * \li Syntax: listing-insert
 323  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
 324  * \endvar
 325  */
 326                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
 327                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
 328 /*!
 329  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
 330  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
 331                information in a non-editable boxed InsetText.
 332  * \li Notion: Apart from lfun arguments you can use the following method: \n
 333                1. input the type and argument of this inset, e.g. "menu paste", in
 334                the work area.\n
 335                2. select the text and run info-insert lfun.\n
 336  * \li Syntax: info-insert <TYPE> <ARG>
 337  * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
 338                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
 339                       description.
 340  * \li Origin: bpeng, 7 Oct 2007
 341  * \endvar
 342  */
 343                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
 344                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
 345                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
 346 /*!
 347  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
 348  * \li Action: Inserts CharStyle, Custom inset or XML short element.
 349  * \li Notion: Look into the Customization manual for more information about
 350                these elements.\n
 351                For dissolving the element see #LFUN_INSET_DISSOLVE.
 352  * \li Syntax: flex-insert <TYPE:Name>
 353  * \li Params: TYPE: CharStyle|Custom|Element|Standard
 354                      Identifies whether this is a Character Style, a
 355                      Custom Inset or an XML Element, and which dynamical
 356                      sub-menu this flex inset is in on the LyX menu tree.
 357                      If Standard (currently unused): none of these.
 358                Name: This name must be defined either in your layout file
 359                      or imported by some module. The definition is\n
 360                      InsetLayout <TYPE:Name>
 361  * \li Sample: flex-insert CharStyle:Code
 362  * \endvar
 363  */
 364                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
 365                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
 366 /*!
 367  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
 368  * \li Action: Inserts one of horizontal space insets.
 369  * \li Syntax: space-insert <NAME> [<LEN>]
 370  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
 371                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
 372                        hspace* \n
 373                <LEN>: length for custom spaces (hspace, hspace* for protected)
 374  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
 375  * \endvar
 376  */
 377                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
 378                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
 379 /*!
 380  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
 381  * \li Action: Inserts various characters into the document.
 382  * \li Syntax: specialchar-insert <CHAR>
 383  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
 384                        end-of-sentence, menu-separator.
 385  * \li Origin: JSpitzm, 6 Dec 2007
 386  * \endvar
 387  */
 388                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
 389                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
 390                 { LFUN_APPENDIX, "appendix", Noop, Edit },
 391
 392                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
 393                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
 394
 395                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
 396                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
 397
 398                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
 399                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
 400 /*!
 401  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
 402  * \li Action: Inserts a line break or new line.
 403  * \li Syntax: newline-insert <ARG>
 404  * \li Params: <ARG>: <newline|linebreak> default: newline
 405  * \li Origin: JSpitzm, 25 Mar 2008
 406  * \endvar
 407  */
 408                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
 409
 410
 411 #if 0
 412                 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
 413 #endif
 414
 415                 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
 416                 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
 417                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
 418                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
 419                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
 420                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
 421                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
 422                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
 423 /*!
 424  * \var lyx::FuncCode lyx::LFUN_SCROLL
 425  * \li Action: Scroll the buffer view.
 426  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
 427  * \li Syntax: scroll <TYPE> <QUANTITY>
 428  * \li Params: <TYPE>:  line|page\n
 429                <QUANTITY>: up|down|<number>
 430  * \li Origin: Abdelrazak Younes, Dec 27 2007
 431  * \endvar
 432  */
 433                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
 434 /*!
 435  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
 436  * \li Action: Recenters the screen on the current cursor position.
 437  * \li Syntax: screen-recenter
 438  * \endvar
 439  */
 440                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
 441                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
 442                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
 443
 444                 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
 445 /*!
 446  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
 447  * \li Action: Moves the cursor one position logically backwards.
 448  * \li Notion: This is not the action which should be bound to the arrow keys,
 449                because backwards may be left or right, depending on the
 450                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
 451                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 452  * \li Syntax: char-backward
 453  * \endvar
 454  */
 455                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
 456 /*!
 457  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
 458  * \li Action: Moves the cursor one position logically backwards, adding
 459                traversed position to the selection.
 460  * \li Notion: See also #LFUN_CHAR_BACKWARD.
 461  * \li Syntax: char-backward-select
 462  * \endvar
 463  */
 464                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
 465                 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
 466                 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
 467 /*!
 468  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
 469  * \li Action: Moves the cursor one position logically forward.
 470  * \li Notion: This is not the action which should be bound to the arrow keys,
 471                because forward may be left or right, depending on the language.
 472                The arrow keys should be bound to #LFUN_CHAR_LEFT or
 473                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 474  * \li Syntax: char-forward
 475  * \endvar
 476  */
 477                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
 478 /*!
 479  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
 480  * \li Action: Moves the cursor one position logically forward, adding
 481                traversed position to the selection.
 482  * \li Notion: See also #LFUN_CHAR_FORWARD.
 483  * \li Syntax: char-forward-select
 484  * \endvar
 485  */
 486                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
 487 /*!
 488  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
 489  * \li Action: Moves the cursor one position "to the left".
 490  * \li Notion: This is the action which should be taken when the "left" key
 491                is pressed. Generally, it moves the cursor one position to the
 492                left. However, in Bidi text this become slightly more
 493                complicated, and there are different modes of cursor movement.
 494                In "visual mode", this moves left, plain and simple. In "logical
 495                mode", movement is logically forward in RTL paragraphs, and
 496                logically backwards in LTR paragraphs.
 497  * \li Syntax: char-left
 498  * \endvar
 499  */
 500                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
 501 /*!
 502  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
 503  * \li Action: Moves the cursor one position "to the left", adding
 504                traversed position to the selection.
 505  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
 506  * \li Syntax: char-left-select
 507  * \endvar
 508  */
 509                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
 510 /*!
 511  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
 512  * \li Action: Moves the cursor one position "to the right".
 513  * \li Notion: This is the action which should be taken when the "right" key
 514                is pressed. Generally, it moves the cursor one position to the
 515                right. However, in Bidi text this become slightly more
 516                complicated, and there are different modes of cursor movement.
 517                In "visual mode", this moves right, plain and simple. In "logical
 518                mode", movement is logically forward in LTR paragraphs, and
 519                logically backwards in RTL paragraphs.
 520  * \li Syntax: char-right
 521  * \endvar
 522  */
 523                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
 524 /*!
 525  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
 526  * \li Action: Moves the cursor one position "to the right", adding
 527                traversed position to the selection.
 528  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
 529  * \li Syntax: char-right-select
 530  * \endvar
 531  */
 532                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
 533
 534                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
 535                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
 536                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
 537                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
 538                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
 539 /*!
 540  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
 541  * \li Action: Search for a given string in forward direction.
 542  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 543  * \li Syntax: word-find-forward [<STRING>]
 544  * \li Origin: Etienne, 16 Feb 1998
 545  * \endvar
 546  */
 547                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
 548 /*!
 549  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
 550  * \li Action: Search for a given string in backward direction.
 551  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 552  * \li Syntax: word-find-backward [<STRING>]
 553  * \li Origin: Etienne, 20 Feb 1998
 554  * \endvar
 555  */
 556                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
 557 /*!
 558  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
 559  * \li Action: Search for next occurence of a string.
 560  * \li Syntax: word-find [<DATA>]
 561  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
 562                        If no parameter is given, search with last find-dialog
 563                        data is used for search (i.e. find-next).
 564  * \li Origin: poenitz, Jan 7 2004
 565  * \endvar
 566  */
 567                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
 568                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
 569                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
 570                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
 571                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
 572                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
 573                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
 574                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
 575                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
 576                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 577                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
 578 /*!
 579  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
 580  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
 581  * \li Syntax: thesaurus-entry
 582  * \li Origin: Levon, 20 Jul 2001
 583  * \endvar
 584  */
 585                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
 586                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
 587                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
 588                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
 589                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 590
 591                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
 592                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
 593                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 594                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
 595                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
 596 /*!
 597  * \var lyx::FuncCode lyx::LFUN_COPY
 598  * \li Action: Copies to the clipboard the last edit.
 599  * \li Syntax: copy
 600  * \endvar
 601  */
 602                 { LFUN_COPY, "copy", ReadOnly, Edit },
 603 /*!
 604  * \var lyx::FuncCode lyx::LFUN_CUT
 605  * \li Action: Cuts to the clipboard.
 606  * \li Syntax: cut
 607  * \endvar
 608  */
 609                 { LFUN_CUT, "cut", Noop, Edit },
 610 /*!
 611  * \var lyx::FuncCode lyx::LFUN_PASTE
 612  * \li Action: Pastes from the active clipboard.
 613  * \li Syntax: paste
 614  * \endvar
 615  */
 616                 { LFUN_PASTE, "paste", Noop, Edit },
 617                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
 618 /*!
 619  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
 620  * \li Action: Pastes the material currently selected.
 621  * \li Syntax: primary-selection-paste
 622  * \endvar
 623  */
 624                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
 625 /*!
 626  * \var lyx::FuncCode lyx::LFUN_UNDO
 627  * \li Action: Undoes the last edit.
 628  * \li Syntax: undo
 629  * \endvar
 630  */
 631                 { LFUN_UNDO, "undo", Noop, Edit },
 632 /*!
 633  * \var lyx::FuncCode lyx::LFUN_REDO
 634  * \li Action: Redoes the last thing undone.
 635  * \li Syntax: redo
 636  * \endvar
 637  */
 638                 { LFUN_REDO, "redo", Noop, Edit },
 639 /*!
 640  * \var lyx::FuncCode lyx::LFUN_REPEAT
 641  * \li Action: Repeat the given command.
 642  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
 643  * \li Author: poenitz, 27 Oct 2003
 644  * \endvar
 645  */
 646                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
 647                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
 648
 649                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
 650                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
 651                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
 652
 653                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
 654                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
 655                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
 656                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
 657                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
 658                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
 659                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
 660                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
 661                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
 662                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
 663                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
 664                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
 665                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
 666                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
 667                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
 668
 669                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
 670                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
 671                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
 672                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
 673
 674 /*!
 675  * \var lyx::FuncCode lyx::LFUN_LAYOUT
 676  * \li Action: Sets the layout (that is, environment) for the current paragraph.
 677  * \li Syntax: layout <LAYOUT>
 678  * \li Params: <LAYOUT>: the layout to use
 679  * \endvar
 680  */
 681                 { LFUN_LAYOUT, "layout", Noop, Layout },
 682 /*!
 683  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
 684  * \li Action: Launches the paragraph settings dialog.
 685  * \li Syntax: layout-paragraph
 686  * \endvar
 687  */
 688                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
 689                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
 690 /*!
 691  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
 692  * \li Action: Displays list of layout choices.
 693  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
 694                dropbox allowing for choice of layout.
 695  * \li Syntax: drop-layouts-choice
 696  * \endvar
 697  */
 698                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
 699 /*!
 700  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
 701  * \li Action: Clears the module list.
 702  * \li Notion: Clears the list of included modules for the current buffer.
 703  * \li Syntax: layout-modules-clear
 704  * \li Origin: rgh, 25 August 2007
 705  * \endvar
 706  */
 707                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
 708 /*!
 709  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
 710  * \li Action: Adds a module.
 711  * \li Notion: Adds a module to the list of included modules for the current buffer.
 712  * \li Syntax: layout-module-add <MODULE>
 713  * \li Params: <MODULE>: the module to be added
 714  * \li Origin: rgh, 25 August 2007
 715  * \endvar
 716  */
 717                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
 718 /*!
 719  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
 720  * \li Action: Reloads layout information.
 721  * \li Notion: Reloads all layout information for the current buffer from disk, thus
 722                recognizing any changes that have been made to layout files on the fly.
 723                This is intended to be used only by layout developers and should not be
 724                used when one is trying to do actual work.
 725  * \li Syntax: layout-reload
 726  * \li Origin: rgh, 3 September 2007
 727  * \endvar
 728  */
 729                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
 730 /*!
 731  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
 732  * \li Action: Sets the text class for the current buffer.
 733  * \li Syntax: textclass-apply <TEXTCLASS>
 734  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
 735                    the filename, minus the ".layout" extension.
 736  * \endvar
 737  */
 738                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
 739 /*!
 740  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
 741  * \li Action: Loads information for a textclass from disk.
 742  * \li Syntax: textclass-load <TEXTCLASS>
 743  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
 744                    the filename, minus the ".layout" extension.
 745  * \endvar
 746  */
 747                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
 748
 749 /*!
 750  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
 751  * \li Action: Disable selecting of text-region.
 752  * \li Syntax: mark-off
 753  * \endvar
 754  */
 755                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
 756 /*!
 757  * \var lyx::FuncCode lyx::LFUN_MARK_ON
 758  * \li Action: Enable selecting of text-region.
 759  * \li Notion: After enabling you can simply move arrow keys to get selected region.
 760  * \li Syntax: mark-on
 761  * \endvar
 762  */
 763                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
 764 /*!
 765  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
 766  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
 767  * \li Syntax: mark-toggle
 768  * \li Origin: poenitz, May 5 2006
 769  * \endvar
 770  */
 771                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
 772
 773                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
 774                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
 775                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
 776                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
 777                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
 778                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
 779                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
 780                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
 781                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
 782                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
 783                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
 784                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
 785                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
 786 /*!
 787  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
 788  * \li Action: Toggles numbering of the current formula line.
 789  * \li Notion: Must be in display formula mode.
 790  * \li Syntax: math-number-line-toggle
 791  * \li Origin: Alejandro 18 Jun 1996
 792  * \endvar
 793  */
 794                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
 795 /*!
 796  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
 797  * \li Action: Toggles numbering/labeling of the current formula.
 798  * \li Notion: Must be in display formula mode.
 799  * \li Syntax: math-number-toggle
 800  * \li Origin: Alejandro 4 Jun 1996
 801  * \endvar
 802  */
 803                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
 804                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
 805                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
 806 /*!
 807  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
 808  * \li Action: Unfold a Math Macro.
 809  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
 810                display it as \foo.
 811  * \li Syntax: math-macro-unfold
 812  * \li Origin: sts, 06 January 2008
 813  * \endvar
 814  */
 815                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
 816 /*!
 817  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
 818  * \li Action: Fold a Math Macro.
 819  * \li Notion: Fold the Math Macro the cursor is in if it was
 820                unfolded, i.e. displayed as \foo before.
 821  * \li Syntax: math-macro-fold
 822  * \li Origin: sts, 06 January 2008
 823  * \endvar
 824  */
 825                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
 826 /*!
 827  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
 828  * \li Action: Add a parameter.
 829  * \li Notion: Add a parameter to a Math Macro.
 830  * \li Params: <NUM>: The number of the parameter behind which the new one
 831                will be added (1 for the first, i.e. use 0 for add a
 832                parameter at the left), defaults to the last one.
 833  * \li Syntax: math-macro-add-param <NUM>
 834  * \li Origin: sts, 06 January 2008
 835  * \endvar
 836  */
 837                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
 838 /*!
 839  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
 840  * \li Action: Remove the last parameter.
 841  * \li Notion: Remove the last parameter of a Math Macro and
 842                remove its value in all instances of the macro
 843                in the buffer.
 844  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
 845                the first), defaults to the last one.
 846  * \li Syntax: math-macro-remove-param <NUM>
 847  * \li Origin: sts, 06 January 2008
 848  * \endvar
 849  */
 850                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
 851 /*!
 852  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
 853  * \li Action: Append a greedy parameter.
 854  * \li Notion: Append a greedy parameter to a Math Macro which
 855                eats the following mathed cell in every instance of
 856                the macro in the buffer.
 857  * \li Syntax: math-macro-append-greedy-param
 858  * \li Origin: sts, 06 January 2008
 859  * \endvar
 860  */
 861                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
 862 /*!
 863  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
 864  * \li Action: Remove a greedy parameter.
 865  * \li Notion: Remove a greedy parameter of a Math Macro and spit
 866                out the values of it in every instance of the macro
 867                in the buffer. If it is an optional parameter the [valud]
 868                format is used.
 869  * \li Syntax: math-macro-remove-greedy-param
 870  * \li Origin: sts, 06 January 2008
 871  * \endvar
 872  */
 873                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
 874 /*!
 875  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
 876  * \li Action: Make a parameter optional.
 877  * \li Notion: Turn the first non-optional parameter of a Math Macro
 878                into an optional parameter with a default value.
 879  * \li Syntax: math-macro-make-optional
 880  * \li Origin: sts, 06 January 2008
 881  * \endvar
 882  */
 883                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
 884 /*!
 885  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
 886  * \li Action: Make a parameter non-optional.
 887  * \li Notion: Turn the last optional parameter of a Math Macro
 888                into a non-optional parameter. The default value is
 889                remembered to be reused later if the user changes his mind.
 890  * \li Syntax: math-macro-make-nonoptional
 891  * \li Origin: sts, 06 January 2008
 892  * \endvar
 893  */
 894                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
 895 /*!
 896  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
 897  * \li Action: Add an optional parameter.
 898  * \li Notion: Insert an optional parameter just behind the
 899                already existing optional parameters.
 900  * \li Syntax: math-macro-add-optional-param
 901  * \li Origin: sts, 06 January 2008
 902  * \endvar
 903  */
 904                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
 905 /*!
 906  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
 907  * \li Action: Remove the last optional parameter.
 908  * \li Notion: Remove the last optional parameter of a Math Macro and
 909                remove it in all the instances of the macro in the buffer.
 910  * \li Syntax: math-macro-remove-optional-param
 911  * \li Origin: sts, 06 January 2008
 912  * \endvar
 913  */
 914                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
 915 /*!
 916  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
 917  * \li Action: Add a greedy optional parameter.
 918  * \li Notion: Add a greedy optional parameter which eats the value
 919                from the following cells in mathed which are in the [value]
 920                format.
 921  * \li Syntax: math-macro-add-greedy-optional-param
 922  * \li Origin: sts, 06 January 2008
 923  * \endvar
 924  */
 925                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
 926 /*!
 927  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
 928  * \li Action: Only active in Math Macro definition.
 929  * \li Notion: Dummy function which is only active in a Math Macro definition.
 930                It's used to toggle the Math Macro toolbar if the cursor moves
 931                into a Math Macro definition.
 932  * \li Syntax: in-mathmacrotemplate
 933  * \li Origin: sts, 06 January 2008
 934  * \endvar
 935  */
 936                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
 937
 938 /*!
 939  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
 940  * \li Action: Moves the current paragraph downwards in the document.
 941  * \li Syntax: paragraph-move-down
 942  * \li Origin: Edwin, 8 Apr 2006
 943  * \endvar
 944  */
 945                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
 946 /*!
 947  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
 948  * \li Action: Moves the current paragraph upwards in the document.
 949  * \li Syntax: paragraph-move-up
 950  * \li Origin: Edwin, 8 Apr 2006
 951  * \endvar
 952  */
 953                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
 954
 955 /*!
 956  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
 957  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
 958                in upward direction.
 959  * \li Syntax: paragraph-up
 960  * \li Origin: Asger, 1 Oct 1996
 961  * \endvar
 962  */
 963                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
 964 /*!
 965  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
 966  * \li Action: Move the cursor and select the text to the next paragraph (or
 967                begining of the current one) in upward direction.
 968  * \li Syntax: paragraph-up-select
 969  * \li Origin: Asger, 1 Oct 1996
 970  * \endvar
 971  */
 972                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
 973 /*!
 974  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
 975  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
 976                in downward direction.
 977  * \li Syntax: paragraph-down
 978  * \li Origin: Asger, 1 Oct 1996
 979  * \endvar
 980  */
 981                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
 982 /*!
 983  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
 984  * \li Action: Move the cursor and select the text to the next paragraph (or
 985                begining of the current one) in downward direction.
 986  * \li Syntax: paragraph-down-select
 987  * \li Origin: Asger, 1 Oct 1996
 988  * \endvar
 989  */
 990                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
 991 /*!
 992  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
 993  * \li Action: Jump to a paragraph given by its id number.
 994  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
 995                seen on the screen. Moreover the id is unique for all opened buffers (documents).
 996  * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
 997  * \li Origin: Dekel, 26 Aug 2000
 998  * \endvar
 999  */
1000                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1001 /*!
1002  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1003  * \li Action: Breaks the current paragraph at the current location.
1004  * \li Syntax: break-paragraph
1005  * \endvar
1006  */
1007                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1008                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1009 /*!
1010  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1011  * \li Action: Breaks the current paragraph at the current location,
1012                unless used at the beginning of a line, where it sets
1013                the label width string to empty.
1014  * \li Syntax: break-paragraph-skip
1015  * \endvar
1016  */
1017                 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1018 /*!
1019  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1020  * \li Action: Change paragraph settings.
1021  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1022                This function only modifies, and does not override, existing settings.
1023                Note that the "leftindent" indent setting is deprecated.
1024  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1025  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1026                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1027                <ALIGN>:   \\align block|left|right|center|default\n
1028                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1029  * \li Origin: rgh, Aug 15 2007
1030  * \endvar
1031  */
1032                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1033 /*!
1034  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1035  * \li Action: Change paragraph settings.
1036  * \li Notion: Overwrite all nonspecified settings to the default ones.
1037                Use paragraph-params lfun if you don't want to overwrite others settings.
1038  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1039  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1040  * \li Origin: leeming, 30 Mar 2004
1041  * \endvar
1042  */
1043                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1044                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1045
1046 /*!
1047  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1048  * \li Action: Move the current group in the upward direction in the
1049                structure of the document.
1050  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1051                the whole substructure of the group.
1052  * \li Syntax: outline-up
1053  * \li Origin: Vermeer, 23 Mar 2006
1054  * \endvar
1055  */
1056                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1057 /*!
1058  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1059  * \li Action: Move the current group in the downward direction in the
1060                structure of the document.
1061  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1062                the whole substructure of the group.
1063  * \li Syntax: outline-down
1064  * \li Origin: Vermeer, 23 Mar 2006
1065  * \endvar
1066  */
1067                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1068 /*!
1069  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1070  * \li Action: Moves the current group in the downward direction in the
1071                hierarchy of the document structure.
1072  * \li Notion: Part -> Chapter -> Section -> etc.
1073  * \li Syntax: outline-in
1074  * \li Origin: Vermeer, 23 Mar 2006
1075  * \endvar
1076  */
1077                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1078 /*!
1079  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1080  * \li Action: Moves the current group in the upward direction in the
1081                hierarchy of the document structure.
1082  * \li Notion: Part <- Chapter <- Section <- etc.
1083  * \li Syntax: outline-out
1084  * \li Origin: Vermeer, 23 Mar 2006
1085  * \endvar
1086  */
1087                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1088
1089                 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
1090                 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
1091
1092                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1093                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1094                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1095                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1096                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1097
1098                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1099                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1100                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1101                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1102                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1103
1104                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1105                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1106                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1107                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1108                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1109                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1110                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1111                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1112
1113 /*!
1114  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1115  * \li Action: Apply data for an inset.
1116  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1117                be applied. This is either changed to #LFUN_INSET_MODIFY or
1118                #LFUN_INSET_INSERT depending on the context where it is called.
1119  * \li Syntax: inset-apply <ARGS>
1120  * \li Params: See #LFUN_INSET_INSERT .
1121  * \endvar
1122  */
1123                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1124 /*!
1125  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1126  * \li Action: Dissolve the current inset into text.
1127  * \li Syntax: inset-dissolve [<INSET>]
1128  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1129                         is dissolved. For example "dissolve" entry in the charstyles
1130                         sub-menu should only dissolve the charstyle inset, even if the
1131                         cursor is inside several nested insets of different type.\n
1132                         For values see #lyx::InsetLayout::lyxtype_ .
1133  * \li Author: JSpitz, 7 Aug 2006
1134  * \endvar
1135  */
1136                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1137 /*!
1138  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1139  * \li Action: Insert new inset (type given by the parameters).
1140  * \li Syntax: inset-insert <INSET> <ARGS>
1141  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1142                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1143                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1144                        explore.
1145  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1146                where <label name> is the name of the referenced label and
1147                <Format> is one of the following: \n
1148                ref -- <reference> \n
1149                eqref -- (<reference>) \n
1150                pageref -- <page> \n
1151                vpageref -- on <page> \n
1152                vref -- <reference> on <page> \n
1153                prettyref -- Formatted reference
1154  * \endvar
1155  */
1156                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1157 /*!
1158  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1159  * \li Action: Modify existing inset.
1160  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1161                bibtex, ert, command, graphics, note, space, vspace, tabular,
1162                bibitem, inlude, ref insets.
1163  * \li Syntax: inset-modify <INSET> <ARGS>
1164  * \li Params: See #LFUN_INSET_INSERT for further details.
1165  * \endvar
1166  */
1167                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1168 /*!
1169  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1170  * \li Action: Modify the inset at cursor position, if there is one.
1171  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1172                bibtex, ert, command, graphics, note, space, vspace, tabular,
1173                bibitem, inlude, ref insets.
1174  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1175  * \li Params: See #LFUN_INSET_INSERT for further details.
1176  * \li Origin: JSpitzm, 23 Mar 2008
1177  * \endvar
1178  */
1179                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1180                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1181 /*!
1182  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1183  * \li Action: Open the inset's properties dialog.
1184  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1185  * \li Syntax: inset-settings <INSET>
1186  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1187  * \endvar
1188  */
1189                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1190 /*!
1191  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1192  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1193                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1194                be entered. Also cf. #LFUN_INSET_SETTINGS.
1195  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1196                bibtex, ert, command, graphics, note, space, vspace, tabular,
1197                bibitem, inlude, ref insets.
1198  * \li Syntax: next-inset-toggle <ARG>
1199  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1200  * \li Origin: leeming, 30 Mar 2004
1201  * \endvar
1202  */
1203                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1204 /*!
1205  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1206  * \li Action: Toggles the collapsable inset we are currently in.
1207  * \li Syntax: inset-toggle [<ARG>]
1208  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1209                open/close/toggle are for collapsable insets. close can be currently used
1210                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1211                assign is for branch inset.
1212  * \li Origin: lasgouttes, 19 Jul 2001
1213  * \endvar
1214  */
1215                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1216 /*!
1217  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1218  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1219  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1220  * \li Syntax: all-insets-toggle <STATE> <INSET>
1221  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1222                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1223  * \li Origin: leeming, 30 Mar 2004
1224  * \endvar
1225  */
1226                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1227
1228 /*!
1229  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1230  * \li Action: Moves the cursor out of the current slice, going forward.
1231  * \li Notion: Cursor movement within an inset may be different than cursor
1232                movement in the surrounding text. This action should be called
1233                automatically by the cursor movement within the inset, when
1234                movement within the inset has ceased (reached the end of the
1235                last paragraph, for example), in order to move correctly
1236                back into the surrounding text.
1237  * \endvar
1238  */
1239                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1240 /*!
1241  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1242  * \li Action: Moves the cursor out of the current slice, going backwards.
1243  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1244  * \endvar
1245  */
1246                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1247 /*!
1248  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1249  * \li Action: Moves the cursor out of the current slice, going right.
1250  * \li Notion: See also #LFUN_FINISHED_FORWARD
1251  * \endvar
1252  */
1253                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1254 /*!
1255  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1256  * \li Action: Moves the cursor out of the current slice, going left.
1257  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1258  * \endvar
1259  */
1260                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1261
1262                 { LFUN_LANGUAGE, "language", Noop, Edit },
1263
1264 /*!
1265  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1266  * \li Action: Goto a label.
1267  * \li Syntax: label-goto [<LABEL>]
1268  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1269                         is on cursor position, Bookmark 0 is saved and
1270                         cursor moves to the position of referenced label.
1271  * \li Origin: Ale, 6 Aug 1997
1272  * \endvar
1273  */
1274                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1275                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1276 /*!
1277  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1278  * \li Action: Go to the next label or cross-reference.
1279  * \li Syntax: reference-next
1280  * \li Origin: Dekel, 14 Jan 2001
1281  * \endvar
1282  */
1283                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1284
1285 /*!
1286  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1287  * \li Action: Goto a bookmark.
1288  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1289                if necessary. Note that bookmarsk are saved per-session, not
1290                per file.
1291  * \li Syntax: bookmark-goto <NUMBER>
1292  * \li Params: <NUMBER>: the number of the bookmark to restore.
1293  * \li Origin: Dekel, 27 January 2001
1294  * \endvar
1295  */
1296                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1297 /*!
1298  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1299  * \li Action: Save a bookmark.
1300  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1301                must be between 1 and 9, inclusive. Note that bookmarks are
1302                saved per-session, not per file.
1303  * \li Syntax: bookmark-save <NUMBER>
1304  * \li Params: <NUMBER>: the number of the bookmark to save.
1305  * \li Origin: Dekel, 27 January 2001
1306  * \endvar
1307  */
1308                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1309 /*!
1310  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1311  * \li Action: Clears the list of saved bookmarks.
1312  * \li Syntax: bookmark-clear
1313  * \li Origin: bpeng, 31 October 2006
1314  * \endvar
1315  */
1316                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1317
1318 /*!
1319  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1320  * \li Action: Open the given help file according to the language setting.
1321  * \li Syntax: help-open <FILE>[.lyx]
1322  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1323  * \li Author: Jug, 27 Jun 1999
1324  * \endvar
1325  */
1326                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1327 /*!
1328  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1329  * \li Action: Terminates the current LyX instance.
1330  * \li Notion: Terminates the current LyX instance, asking whether to save
1331                modified documents, etc.
1332  * \li Syntax: lyx-quit
1333  * \endvar
1334  */
1335                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1336 /*!
1337  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1338  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1339  * \li Notion: Skiping "auto" when allowauto is false.
1340  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1341  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1342                        minibuffer|review|view/update|math_panels
1343  * \li Origin: Edwin, 21 May 2007
1344  * \endvar
1345  */
1346                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1347 /*!
1348  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1349  * \li Action: Opens the menu given by its name.
1350  * \li Syntax: menu-open <NAME>
1351  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1352  * \endvar
1353  */
1354                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1355 /*!
1356  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1357  * \li Action: Various UI visibility-toggling actions.
1358  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1359  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1360                menubar    : Toggle visibility of the menubar.\n
1361                scrollbar  : Toggle visibility of the scrollbar.\n
1362                frame      : Toggle visibility of the frames around editing window.\n
1363                fullscreen : Toggle fullscreen mode. This also covers calling the
1364                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1365                             custom tweaks of the toolbars should be used.
1366  * \li Origin: ps, 9 Feb 2007
1367  * \endvar
1368  */
1369                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1370
1371 /*!
1372  * \var lyx::FuncCode lyx::WINDOW_NEW
1373  * \li Action: Creates new empty LyX window.
1374  * \li Notion: Already opened documents from the previous window can be found under View menu.
1375  * \li Syntax: window-new [<GEOMETRY>]
1376  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1377                            accepted only on Windows platform.
1378  * \li Origin: Abdel, 21 Oct 2006
1379  * \endvar
1380  */
1381                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1382 /*!
1383  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1384  * \li Action: Closes the current LyX window.
1385  * \li Syntax: window-close
1386  * \li Origin: Abdel, 23 Oct 2006
1387  * \endvar
1388  */
1389                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1390
1391 /*!
1392  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1393  * \li Action: Creates another split view of current buffer.
1394  * \li Notion: All split views act in the same way indpendently.
1395  * \li Syntax: split-view <vertical|horizontal>
1396  * \li Params: horizontal : The work areas are laid out side by side.\n
1397                vertical   : The work areas laid out vertically.\n
1398  * \li Origin: abdel, 20 Feb 2008
1399  * \endvar
1400  */
1401                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1402
1403 /*!
1404  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1405  * \li Action: Close the current tab group.
1406  * \li Notion: This only closes the work areas, not the buffer themselves.
1407                The still opened buffers can be visualized in another tab group.
1408  * \li Syntax: close-tab-group
1409  * \li Origin: abdel, 21 Feb 2008
1410  * \endvar
1411  */
1412                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1413                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1414                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1415                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1416                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1417                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1418                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1419
1420                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1421                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1422                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1423                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1424                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1425
1426                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1427                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1428                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1429                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1430
1431                 { LFUN_MESSAGE, "message", NoBuffer, System },
1432                 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1433                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1434
1435                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1436                 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1437                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1438                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1439 /*!
1440  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1441  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1442  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1443  * \li Origin: Edmar, 23 Dec 1998
1444  * \endvar
1445  */
1446                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1447                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1448 /*!
1449  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1450  * \li Action: Sets the cursor position based on the editing area coordinates
1451                (similar as clicking on that point with left mouse button).
1452  * \li Syntax: server-set-xy <X> <Y>
1453  * \endvar
1454  */
1455                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1456 /*!
1457  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1458  * \li Action: Returns the coordinates of cursor position in the editing area.
1459  * \li Syntax: server-get-xy
1460  * \endvar
1461  */
1462                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1463
1464 /*!
1465  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1466  * \li Action: Generates the code (literate programming).
1467  * \li Notion: Latex file with extension \literate_extension is generated.
1468                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1469                \build_error_filter to process the compilation error messages. \n
1470                In case you want to process your literate file with a script, or some other program,
1471                just insert in your lyxrc file an entry with:\n
1472                \build_command "my_script my_arguments" \n
1473                The \build_error_filter differs from the \literate_error_filter only in that the
1474                former will identify error messages from your compiler.
1475  * \li Syntax: build-program
1476  * \endvar
1477  */
1478                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1479
1480 /*!
1481  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1482  * \li Action: Saves the current buffer to a temporary file.
1483  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1484                is called automatically by LyX, to "autosave" the current buffer.
1485  * \li Syntax: buffer-auto-save
1486  * \endvar
1487  */
1488                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1489 /*!
1490  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1491  * \li Action: Loads the given child document.
1492  * \li Notion: The current document is treated as a parent.
1493  * \li Syntax: buffer-child-open <FILE>
1494  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1495  * \li Origin: Ale, 28 May 1997
1496  * \endvar
1497  */
1498                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1499 /*!
1500  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1501  * \li Action: Runs chktex for the current document.
1502  * \li Syntax: buffer-chktex
1503  * \li Origin: Asger, 30 Oct 1997
1504  * \endvar
1505  */
1506                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1507 /*!
1508  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1509  * \li Action: Toggles compression of the current document on/off.
1510  * \li Syntax: buffer-toggle-compression
1511  * \li Origin: bpeng, 27 Apr 2006
1512  * \endvar
1513  */
1514                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1515 /*!
1516  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1517  * \li Action: Closes the current buffer.
1518  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1519                if the buffer has been modified.
1520  * \li Syntax: buffer-close
1521  * \endvar
1522  */
1523                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1524 /*!
1525  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1526  * \li Action: Exports the current buffer (document) to the given format.
1527  * \li Syntax: buffer-export <FORMAT>
1528  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1529                         can find in Tools->Preferences->File formats->Format.
1530                         Usual format you will enter is "pdf2" (pdflatex),
1531                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1532                         In case of "custom" you will be asked for a format you
1533                         want to start from and for the command that you want to
1534                         apply to this format. Internally the control is then passed
1535                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1536  * \li Origin: Lgb, 29 Jul 1997
1537  * \endvar
1538  */
1539                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1540 /*!
1541  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1542  * \li Action: Exports the current buffer (document) from the given format using
1543                the given command on it.
1544  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1545  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1546                         intermediate file).\n
1547                <COMMAND> this command will be launched on the file. Note that you can
1548                use "$$FName" string to qualify the intermediate file.
1549  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1550  * \li Origin: leeming, 27 Mar 2004
1551  * \endvar
1552  */
1553                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1554 /*!
1555  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1556  * \li Action: Prints the current document.
1557  * \li Notion: Many settings can be given via the preferences dialog.
1558  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1559  * \li Params: <TARGET> is either "printer" or "file".\n
1560                <TARGER-NAME> is either "default" or file name or printer name.\n
1561                <COMMAND> command ensuring the printing job.
1562  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1563  * \li Origin: leeming, 28 Mar 2004
1564  * \endvar
1565  */
1566                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1567 /*!
1568  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1569  * \li Action: Import a given file as a lyx document.
1570  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1571                defined convertors in preferences. Look into File->Import menu to get
1572                an idea of the currently active import formats.
1573  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1574  * \li Origin: Asger, 24 Jul 1998
1575  * \endvar
1576  */
1577                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1578 /*!
1579  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1580  * \li Action: Creates a new buffer (that is, document).
1581  * \li Notion: Implicit path can be set in Preferences dialog.
1582  * \li Syntax: buffer-new [<FILE>]
1583  * \li Params: <FILE>: filename of created file with absolute path.
1584  * \endvar
1585  */
1586                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1587 /*!
1588  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1589  * \li Action: Creates a new buffer (that is, document) from a template.
1590  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1591                Template will be asked for via Open-dialog.
1592  * \li Syntax: buffer-new-template [<FILE>]
1593  * \li Params: <FILE>: filename of created file with absolute path.
1594  * \endvar
1595  */
1596                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1597 /*!
1598  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1599  * \li Action: Reverts opened document.
1600  * \li Syntax: buffer-reload
1601  * \li Origin: Asger, 2 Feb 1997
1602  * \endvar
1603  */
1604                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1605 /*!
1606  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1607  * \li Action: Switch to the given buffer.
1608  * \li Notion: This is useful also in case you need simultaneously more views of the edited
1609                document in different LyX windows.
1610  * \li Syntax: buffer-new-template <BUFFER>
1611  * \li Params: <BUFFER>: already opened document which is to be shown.
1612  * \endvar
1613  */
1614                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1615 /*!
1616  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1617  * \li Action: Toggle editing mode of the current document between read/write and read-only.
1618  * \li Syntax: buffer-toggle-read-only
1619  * \li Origin: Lgb, 27 May 1997
1620  * \endvar
1621  */
1622                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1623 /*!
1624  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1625  * \li Action: Displays current buffer in chosen format.
1626  * \li Notion: Displays the contents of the current buffer in the chosen
1627                format, for example, PDF or DVI. This runs the necessary
1628                converter, calls the defined viewer, and so forth.
1629  * \li Syntax: buffer-view <FORMAT>
1630  * \li Params: <FORMAT>: The format to display, where this is one of the
1631                          formats defined (in the current GUI) in the
1632                          Tools>Preferences>File Formats dialog.
1633  * \endvar
1634  */
1635                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1636 /*!
1637  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1638  * \li Action: Exports the current document and put the result into the
1639                temporary directory.
1640  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1641                the output will be rewriten - updated. This is useful in case your viewer
1642                is able to detect such changes (e.g. ghostview for postscript).
1643  * \li Syntax: buffer-update <FORMAT>
1644  * \li Params: <FORMAT>: The format to display, where this is one of the
1645                          formats defined (in the current GUI) in the
1646                          Tools>Preferences>File Formats dialog.
1647  * \li Origin: Dekel, 5 Aug 2000
1648  * \endvar
1649  */
1650                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1651
1652 /*!
1653  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1654  * \li Action: Saves the current buffer.
1655  * \li Notion: Saves the current buffer to disk, using the filename that
1656                is already associated with the buffer, asking for one if
1657                none is yet assigned.
1658  * \li Syntax: buffer-write
1659  * \endvar
1660  */
1661                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1662 /*!
1663  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1664  * \li Action: Rename and save current buffer.
1665  * \li Syntax: buffer-write-as <FILENAME>
1666  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1667                is with respect to the original location of the buffer/file.
1668  * \endvar
1669  */
1670                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1671 /*!
1672  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1673  * \li Action: Save all changed documents.
1674  * \li Syntax: buffer-write-all
1675  * \li Origin: rgh, gpothier 6 Aug 2007
1676  * \endvar
1677  */
1678                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1679 /*!
1680  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1681  * \li Action: Switch to the next opened document.
1682  * \li Notion: Note that this does not necessarily mean next in tabbar
1683                (for full list see View menu).
1684  * \li Syntax: buffer-next
1685  * \endvar
1686  */
1687                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1688 /*!
1689  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1690  * \li Action: Switch to the previous opened document.
1691  * \li Syntax: buffer-previous
1692  * \endvar
1693  */
1694                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1695 /*!
1696  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1697  * \li Action: When run from a child document, this updates (exports) document built
1698                 from the master buffer. If a master is not found, it updates the
1699                 current buffer.
1700  * \li Syntax: master-buffer-update
1701  * \li Author: Tommaso, 20 Sep 2007
1702  * \endvar
1703  */
1704                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1705 /*!
1706  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1707  * \li Action: When run from a child document, this command shows a preview built
1708                from the master buffer. If a master is not found, it previews the
1709                current buffer.
1710  * \li Syntax: master-buffer-view
1711  * \li Author: Tommaso, 20 Sep 2007
1712  * \endvar
1713  */
1714                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1715 /*!
1716  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1717  * \li Action: Set language of the current document.
1718  * \li Syntax: buffer-language <LANG>
1719  * \li Params: <LANG>: language name. See lib/languages for list.
1720  * \li Author: leeming, 30 Mar 2004
1721  * \endvar
1722  */
1723                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1724 /*!
1725  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1726  * \li Action: Save the current document settings as default.
1727  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1728  * \li Syntax: buffer-save-as-default [<ARGS>]
1729  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1730                        you can find in document header of usual .lyx file.
1731  * \li Author: leeming, 30 Mar 2004
1732  * \endvar
1733  */
1734                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1735 /*!
1736  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1737  * \li Action: Apply the given settings to the current document.
1738  * \li Syntax: buffer-params-apply [<ARGS>]
1739  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1740                        you can find in document header of usual .lyx file.
1741  * \li Author: leeming, 30 Mar 2004
1742  * \endvar
1743  */
1744                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1745
1746 /*!
1747  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1748  * \li Action: Inserts another LyX file.
1749  * \li Syntax: file-insert [<FILE>]
1750  * \li Params: <FILE>: Filename to be inserted.
1751  * \endvar
1752  */
1753                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1754 /*!
1755  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1756  * \li Action: Inserts plain text file.
1757  * \li Syntax: file-insert-plaintext [<FILE>]
1758  * \li Params: <FILE>: Filename to be inserted.
1759  * \li Origin: CFO-G, 19 Nov 1997
1760  * \endvar
1761  */
1762                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1763 /*!
1764  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1765  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1766  * \li Syntax: file-insert-plaintext-para [<FILE>]
1767  * \li Params: <FILE>: Filename to be inserted.
1768  * \li Origin: Levon, 14 Feb 2001
1769  * \endvar
1770  */
1771                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1772 /*!
1773  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1774  * \li Action: Open LyX document.
1775  * \li Syntax: file-open [<FILE>]
1776  * \li Params: <FILE>: Filename to be opened.
1777  * \endvar
1778  */
1779                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1780
1781 /*!
1782  * \var lyx::FuncCode lyx::LFUN_CALL
1783  * \li Action: Executes a command defined in a .def file.
1784  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1785                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1786                where <NAME> is the name of the new command and <LFUN> is the lfun code
1787                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1788                \\def_file "FileName" allows to include another .def file. \n
1789                This is particularly useful in connection with toolbar buttons:
1790                Since the name of the button image for this lfun is
1791                lib/images/commands/<NAME>.png this is the way to assign an image
1792                to a complex command-sequence.
1793  * \li Syntax: call <NAME>
1794  * \li Params: <NAME>: Name of the command that must be called.
1795  * \li Origin: broider, 2 Oct 2007
1796  * \endvar
1797  */
1798                 { LFUN_CALL, "call", NoBuffer, System },
1799 /*!
1800  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1801  * \li Action: Simulate halting Meta key (Alt key on PCs).
1802  * \li Notion: Used for buffer editation not for GUI control.
1803  * \li Syntax: meta-prefix
1804  * \endvar
1805  */
1806                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1807 /*!
1808  * \var lyx::FuncCode lyx::LFUN_CANCEL
1809  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1810  * \li Syntax: cancel
1811  * \endvar
1812  */
1813                 { LFUN_CANCEL, "cancel", NoBuffer, System },
1814
1815 /*!
1816  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1817  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1818  * \li Notion: Usually bound to M-x shortcut.
1819  * \li Syntax: command-execute
1820  * \endvar
1821  */
1822                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1823                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1824 /*!
1825  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1826  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1827  * \li Syntax: command-sequence <CMDS>
1828  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1829  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1830  * \li Origin: Andre', 11 Nov 1999
1831  * \endvar
1832  */
1833                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1834
1835 /*!
1836  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1837  * \li Action: Save user preferences.
1838  * \li Syntax: preferences-save
1839  * \li Origin: Lgb, 27 Nov 1999
1840  * \endvar
1841  */
1842                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1843 /*!
1844  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1845  * \li Action: Reconfigure the automatic settings.
1846  * \li Syntax: reconfigure
1847  * \li Origin: Asger, 14 Feb 1997
1848  * \endvar
1849  */
1850                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1851 /*!
1852  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1853  * \li Action: Apply the given settings to user preferences.
1854  * \li Syntax: lyxrc-apply <SETTINGS>
1855  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1856                            to get an idea which commands to use and their syntax.
1857                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
1858  * \endvar
1859  */
1860                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1861 /*!
1862  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1863  * \li Action: Determine whether keep cursor inside the editing window regardless
1864                the scrollbar movement.
1865  * \li Syntax: toggle-cursor-follows-scrollbar
1866  * \li Origin: ARRae, 2 Dec 1997
1867  * \endvar
1868  */
1869                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1870 /*!
1871  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1872  * \li Action: Set the given LyX color to the color defined by the X11 name given.
1873  * \li Notion: A new color entry is created if the color is unknown.
1874                Color names can be stored as a part of user settings.
1875  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1876  * \li Origin: SLior, 11 Jun 2000
1877  * \endvar
1878  */
1879                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1880 /*!
1881  * \var lyx::FuncCode lyx::LFUN_STATISTICS
1882  * \li Action: Count the statistics (number of words and characters)
1883                in the document or in the given selection.
1884  * \li Notion: Note that this function gives the number of words/chars written,
1885                not the number of characters which will be typeset.
1886  * \li Syntax: statistics
1887  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1888  * \endvar
1889  */
1890                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1891 /*!
1892  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1893  * \li Action: Show the inline completion at the cursor position.
1894  * \li Syntax: completion-inline
1895  * \li Origin: sts, Feb 19 2008
1896  * \endvar
1897  */
1898                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1899 /*!
1900  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1901  * \li Action: Show the completion popup at the cursor position.
1902  * \li Syntax: completion-popup
1903  * \li Origin: sts, Feb 19 2008
1904  * \endvar
1905  */
1906                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1907 /*!
1908  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1909  * \li Action: Try to complete the word or command at the cursor position.
1910  * \li Syntax: completion-complete
1911  * \li Origin: sts, Feb 19 2008
1912  * \endvar
1913  */
1914                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1915
1916                 { LFUN_NOACTION, "", Noop, Hidden }
1917 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1918         };
1919
1920         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1921                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1922         }
1923
1924         init = true;
1925 }
1926 #endif
1927
1928 LyXAction::LyXAction()
1929 {
1930         init();
1931 }
1932
1933
1934 // Returns an action tag from a string.
1935 FuncRequest LyXAction::lookupFunc(string const & func) const
1936 {
1937         string const func2 = trim(func);
1938
1939         if (func2.empty()) {
1940                 return FuncRequest(LFUN_NOACTION);
1941         }
1942
1943         string cmd;
1944         string const arg = split(func2, cmd, ' ');
1945
1946         func_map::const_iterator fit = lyx_func_map.find(cmd);
1947
1948         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1949 }
1950
1951
1952 string const LyXAction::getActionName(FuncCode action) const
1953 {
1954         info_map::const_iterator const it = lyx_info_map.find(action);
1955         return it != lyx_info_map.end() ? it->second.name : string();
1956 }
1957
1958
1959 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1960 {
1961         info_map::const_iterator const it = lyx_info_map.find(action);
1962         return it != lyx_info_map.end() ? it->second.type : Hidden;
1963 }
1964
1965
1966 bool LyXAction::funcHasFlag(FuncCode action,
1967                             LyXAction::func_attrib flag) const
1968 {
1969         info_map::const_iterator ici = lyx_info_map.find(action);
1970
1971         if (ici == lyx_info_map.end()) {
1972                 LYXERR0("action: " << action << " is not known.");
1973                 LASSERT(false, /**/);
1974         }
1975
1976         return ici->second.attrib & flag;
1977 }
1978
1979
1980 LyXAction::const_func_iterator LyXAction::func_begin() const
1981 {
1982         return lyx_func_map.begin();
1983 }
1984
1985
1986 LyXAction::const_func_iterator LyXAction::func_end() const
1987 {
1988         return lyx_func_map.end();
1989 }
1990
1991
1992 } // namespace lyx