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