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