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<ARG>
 296  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 297  * \li Origin: uwestoehr, 24 Nov 2007
 298  * \endvar
 299  */
 300                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
 301 /*!
 302  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
 303  * \li Action: Inserts a marginal note.
 304  * \li Syntax: marginalnote-insert
 305  * \li Origin: Lgb, 26 Jun 2000
 306  * \endvar
 307  */
 308                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
 309 /*!
 310  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
 311  * \li Action: Inserts a single unicode character.
 312  * \li Syntax: unicode-insert <CHAR>
 313  * \li Params: <CHAR>: The character to insert, given as its code
 314                        point, in hexadecimal, e.g.: unicode-insert 0x0100.
 315  * \li Origin: Lgb, 22 Oct 2006
 316  * \endvar
 317  */
 318                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
 319 /*!
 320  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
 321  * \li Action: Inserts a new listings inset.
 322  * \li Syntax: listing-insert
 323  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
 324  * \endvar
 325  */
 326                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
 327                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
 328                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
 329                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
 330                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
 331 /*!
 332  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
 333  * \li Action: Inserts CharStyle, Custom inset or XML short element.
 334  * \li Notion: Look into the Customization manual for more information about
 335                these elements.\n
 336                For dissolving the element see #LFUN_INSET_DISSOLVE.
 337  * \li Syntax: flex-insert <TYPE:Name>
 338  * \li Params: TYPE: CharStyle|Custom|Element|Standard
 339                      Identifies whether this is a Character Style, a
 340                      Custom Inset or an XML Element, and which dynamical
 341                      sub-menu this flex inset is in on the LyX menu tree.
 342                      If Standard (currently unused): none of these.
 343                Name: This name must be defined either in your layout file
 344                      or imported by some module. The definition is\n
 345                      InsetLayout <TYPE:Name>
 346  * \li Sample: flex-insert CharStyle:Code
 347  * \endvar
 348  */
 349                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
 350                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
 351 /*!
 352  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
 353  * \li Action: Inserts one of horizontal space insets.
 354  * \li Syntax: space-insert <NAME> [<LEN>]
 355  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
 356                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
 357                        hspace* \n
 358                <LEN>: length for custom spaces (hspace, hspace* for protected)
 359  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
 360  * \endvar
 361  */
 362                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
 363                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
 364 /*!
 365  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
 366  * \li Action: Inserts various characters into the document.
 367  * \li Syntax: specialchar-insert <CHAR>
 368  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
 369                        end-of-sentence, menu-separator.
 370  * \li Origin: JSpitzm, 6 Dec 2007
 371  * \endvar
 372  */
 373                 { LFUN_SPECIALCHAR_INSERT, "specialchar-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, graphics, note, space, vspace, tabular,
1063                bibitem, 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 /*!
1070  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1071  * \li Action: Modify the inset at cursor position, if there is one.
1072  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1073                bibtex, ert, command, graphics, note, space, vspace, tabular,
1074                bibitem, inlude, ref insets.
1075  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1076  * \li Params: See #LFUN_INSET_INSERT for further details.
1077  * \li Origin: JSpitzm, 23 Mar 2008
1078  * \endvar
1079  */
1080                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1081                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1082 /*!
1083  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1084  * \li Action: Open the inset's properties dialog.
1085  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1086  * \li Syntax: inset-settings <INSET>
1087  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1088  * \endvar
1089  */
1090                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1091 /*!
1092  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1093  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1094                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1095                be entered. Also cf. #LFUN_INSET_SETTINGS.
1096  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1097                bibtex, ert, command, graphics, note, space, vspace, tabular,
1098                bibitem, inlude, ref insets.
1099  * \li Syntax: next-inset-toggle
1100  * \endvar
1101  */
1102                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1103                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1104 /*!
1105  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1106  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1107  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1108  * \li Syntax: all-insets-toggle <STATE> <INSET>
1109  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1110  *             <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1111  * \endvar
1112  */
1113                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1114
1115 /*!
1116  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1117  * \li Action: Moves the cursor out of the current slice, going forward.
1118  * \li Notion: Cursor movement within an inset may be different than cursor
1119                movement in the surrounding text. This action should be called
1120                automatically by the cursor movement within the inset, when
1121                movement within the inset has ceased (reached the end of the
1122                last paragraph, for example), in order to move correctly
1123                back into the surrounding text.
1124  * \endvar
1125  */
1126                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1127 /*!
1128  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1129  * \li Action: Moves the cursor out of the current slice, going backwards.
1130  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1131  * \endvar
1132  */
1133                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1134 /*!
1135  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1136  * \li Action: Moves the cursor out of the current slice, going right.
1137  * \li Notion: See also #LFUN_FINISHED_FORWARD
1138  * \endvar
1139  */
1140                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1141 /*!
1142  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1143  * \li Action: Moves the cursor out of the current slice, going left.
1144  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1145  * \endvar
1146  */
1147                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1148
1149                 { LFUN_LANGUAGE, "language", Noop, Edit },
1150
1151 /*!
1152  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1153  * \li Action: Goto a label.
1154  * \li Syntax: label-goto [<LABEL>]
1155  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1156                         is on cursor position, Bookmark 0 is saved and
1157                         cursor moves to the position of referenced label.
1158  * \li Origin: Ale, 6 Aug 1997
1159  * \endvar
1160  */
1161                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1162                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1163 /*!
1164  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1165  * \li Action: Go to the next label or cross-reference.
1166  * \li Syntax: reference-next
1167  * \li Origin: Dekel, 14 Jan 2001
1168  * \endvar
1169  */
1170                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1171
1172 /*!
1173  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1174  * \li Action: Goto a bookmark.
1175  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1176                if necessary. Note that bookmarsk are saved per-session, not
1177                per file.
1178  * \li Syntax: bookmark-goto <NUMBER>
1179  * \li Params: <NUMBER>: the number of the bookmark to restore.
1180  * \li Origin: Dekel, 27 January 2001
1181  * \endvar
1182  */
1183                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1184 /*!
1185  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1186  * \li Action: Save a bookmark.
1187  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1188                must be between 1 and 9, inclusive. Note that bookmarks are
1189                saved per-session, not per file.
1190  * \li Syntax: bookmark-save <NUMBER>
1191  * \li Params: <NUMBER>: the number of the bookmark to save.
1192  * \li Origin: Dekel, 27 January 2001
1193  * \endvar
1194  */
1195                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1196 /*!
1197  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1198  * \li Action: Clears the list of saved bookmarks.
1199  * \li Syntax: bookmark-clear
1200  * \li Origin: bpeng, 31 October 2006
1201  * \endvar
1202  */
1203                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1204
1205 /*!
1206  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1207  * \li Action: Open the given help file according to the language setting.
1208  * \li Syntax: help-open <FILE>[.lyx]
1209  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1210  * \li Author: Jug, 27 Jun 1999
1211  * \endvar
1212  */
1213                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1214 /*!
1215  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1216  * \li Action: Terminates the current LyX instance.
1217  * \li Notion: Terminates the current LyX instance, asking whether to save
1218                modified documents, etc.
1219  * \li Syntax: lyx-quit
1220  * \endvar
1221  */
1222                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1223 /*!
1224  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1225  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1226  * \li Notion: Skiping "auto" when allowauto is false.
1227  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1228  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1229                        minibuffer|review|view/update|math_panels
1230  * \li Origin: Edwin, 21 May 2007
1231  * \endvar
1232  */
1233                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1234                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1235 /*!
1236  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1237  * \li Action: Various UI visibility-toggling actions.
1238  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1239  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1240                menubar    : Toggle visibility of the menubar.\n
1241                scrollbar  : Toggle visibility of the scrollbar.\n
1242                frame      : Toggle visibility of the frames around editing window.\n
1243                fullscreen : Toggle fullscreen mode. This also covers calling the
1244                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1245                             custom tweaks of the toolbars should be used.
1246  * \li Origin: ps, 9 Feb 2007
1247  * \endvar
1248  */
1249                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1250
1251                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1252                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1253
1254 /*!
1255  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1256  * \li Action: Creates another split view of current buffer.
1257  * \li Notion: All split views act in the same way indpendently.
1258  * \li Syntax: split-view <vertical|horizontal>
1259  * \li Params: horizontal : The work areas are laid out side by side.\n
1260                vertical   : The work areas laid out vertically.\n
1261  * \li Origin: abdel, 20 Feb 2008
1262  * \endvar
1263  */
1264                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1265
1266 /*!
1267  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1268  * \li Action: Close the current tab group.
1269  * \li Notion: This only closes the work areas, not the buffer themselves.
1270                The still opened buffers can be visualized in another tab group.
1271  * \li Syntax: close-tab-group
1272  * \li Origin: abdel, 21 Feb 2008
1273  * \endvar
1274  */
1275                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1276                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1277                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1278                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1279                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1280                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1281                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1282
1283                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1284                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1285                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1286                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1287                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1288
1289                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1290                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1291                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1292                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1293
1294                 { LFUN_MESSAGE, "message", NoBuffer, System },
1295                 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1296                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1297
1298                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1299                 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1300                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1301                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1302                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1303 /*!
1304  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1305  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1306  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1307  * \li Origin: Edmar, 23 Dec 1998
1308  * \endvar
1309  */
1310                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1311                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1312                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1313
1314                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1315
1316 /*!
1317  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1318  * \li Action: Saves the current buffer to a temporary file.
1319  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1320                is called automatically by LyX, to "autosave" the current buffer.
1321  * \li Syntax: buffer-auto-save
1322  * \endvar
1323  */
1324                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1325                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1326                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1327 /*!
1328  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1329  * \li Action: Toggles compression of the current document on/off.
1330  * \li Syntax: buffer-toggle-compression
1331  * \li Origin: bpeng, 27 Apr 2006
1332  * \endvar
1333  */
1334                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1335 /*!
1336  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_EMBEDDING
1337  * \li Action: Toggles the embeddding feature on/off.
1338  * \li Syntax: buffer-toggle-embedding
1339  * \li Origin: bpeng, 21 Oct 2007
1340  * \endvar
1341  */
1342                 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1343 /*!
1344  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1345  * \li Action: Closes the current buffer.
1346  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1347                if the buffer has been modified.
1348  * \li Syntax: buffer-close
1349  * \endvar
1350  */
1351                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1352 /*!
1353  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1354  * \li Action: Exports the current buffer (document) to the given format.
1355  * \li Syntax: buffer-export <FORMAT>
1356  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1357                         can find in Tools->Preferences->File formats->Format.
1358                         Usual format you will enter is "pdf2" (pdflatex),
1359                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1360                         In case of "custom" you will be asked for a format you
1361                         want to start from and for the command that you want to
1362                         apply to this format. Internally the control is then passed
1363                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1364  * \li Origin: Lgb, 29 Jul 1997
1365  * \endvar
1366  */
1367                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1368 /*!
1369  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1370  * \li Action: Exports the current buffer (document) from the given format using
1371                the given command on it.
1372  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1373  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1374                         intermediate file).\n
1375                <COMMAND> this command will be launched on the file. Note that you can
1376                use "$$FName" string to qualify the intermediate file.
1377  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1378  * \li Origin: leeming, 27 Mar 2004
1379  * \endvar
1380  */
1381                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1382 /*!
1383  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1384  * \li Action: Prints the current document.
1385  * \li Notion: Many settings can be given via the preferences dialog.
1386  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1387  * \li Params: <TARGET> is either "printer" or "file".\n
1388                <TARGER-NAME> is either "default" or file name or printer name.\n
1389                <COMMAND> command ensuring the printing job.
1390  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1391  * \li Origin: leeming, 28 Mar 2004
1392  * \endvar
1393  */
1394                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1395 /*!
1396  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1397  * \li Action: Import a given file as a lyx document.
1398  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1399                defined convertors in preferences. Look into File->Import menu to get
1400                an idea of the currently active import formats.
1401  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1402  * \li Origin: Asger, 24 Jul 1998
1403  * \endvar
1404  */
1405                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1406 /*!
1407  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1408  * \li Action: Creates a new buffer (that is, document).
1409  * \li Notion: Implicit path can be set in Preferences dialog.
1410  * \li Syntax: buffer-new [<FILE>]
1411  * \li Params: <FILE>: filename of created file with absolute path.
1412  * \endvar
1413  */
1414                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1415 /*!
1416  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1417  * \li Action: Creates a new buffer (that is, document) from a template.
1418  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1419                Template will be asked for via Open-dialog.
1420  * \li Syntax: buffer-new-template [<FILE>]
1421  * \li Params: <FILE>: filename of created file with absolute path.
1422  * \endvar
1423  */
1424                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1425 /*!
1426  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1427  * \li Action: Reverts opened document.
1428  * \li Syntax: buffer-reload
1429  * \li Origin: Asger, 2 Feb 1997
1430  * \endvar
1431  */
1432                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1433 /*!
1434  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1435  * \li Action: Switch to the given buffer.
1436  * \li Notion: This is useful also in case you need simultaneously more views of the edited
1437                document in different LyX windows.
1438  * \li Syntax: buffer-new-template <BUFFER>
1439  * \li Params: <BUFFER>: already opened document which is to be shown.
1440  * \endvar
1441  */
1442                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1443 /*!
1444  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1445  * \li Action: Toggle editing mode of the current document between read/write and read-only.
1446  * \li Syntax: buffer-toggle-read-only
1447  * \li Origin: Lgb, 27 May 1997
1448  * \endvar
1449  */
1450                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1451 /*!
1452  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1453  * \li Action: Displays current buffer in chosen format.
1454  * \li Notion: Displays the contents of the current buffer in the chosen
1455                format, for example, PDF or DVI. This runs the necessary
1456                converter, calls the defined viewer, and so forth.
1457  * \li Syntax: buffer-view <FORMAT>
1458  * \li Params: <FORMAT>: The format to display, where this is one of the
1459                          formats defined (in the current GUI) in the
1460                          Tools>Preferences>File Formats dialog.
1461  * \endvar
1462  */
1463                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1464 /*!
1465  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1466  * \li Action: Exports the current document and put the result into the
1467                temporary directory.
1468  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1469                the output will be rewriten - updated. This is useful in case your viewer
1470                is able to detect such changes (e.g. ghostview for postscript).
1471  * \li Syntax: buffer-update <FORMAT>
1472  * \li Params: <FORMAT>: The format to display, where this is one of the
1473                          formats defined (in the current GUI) in the
1474                          Tools>Preferences>File Formats dialog.
1475  * \li Origin: Dekel, 5 Aug 2000
1476  * \endvar
1477  */
1478                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1479
1480 /*!
1481  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1482  * \li Action: Saves the current buffer.
1483  * \li Notion: Saves the current buffer to disk, using the filename that
1484                is already associated with the buffer, asking for one if
1485                none is yet assigned.
1486  * \li Syntax: buffer-write
1487  * \endvar
1488  */
1489                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1490 /*!
1491  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1492  * \li Action: Rename and save current buffer.
1493  * \li Syntax: buffer-write-as <FILENAME>
1494  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1495                is with respect to the original location of the buffer/file.
1496  * \endvar
1497  */
1498                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1499                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1500                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1501                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1502                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1503                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1504                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1505                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1506                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1507
1508 /*!
1509  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1510  * \li Action: Inserts another LyX file.
1511  * \li Syntax: file-insert [<FILE>]
1512  * \li Params: <FILE>: Filename to be inserted.
1513  * \endvar
1514  */
1515                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1516 /*!
1517  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1518  * \li Action: Inserts plain text file.
1519  * \li Syntax: file-insert-plaintext [<FILE>]
1520  * \li Params: <FILE>: Filename to be inserted.
1521  * \li Origin: CFO-G, 19 Nov 1997
1522  * \endvar
1523  */
1524                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1525 /*!
1526  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1527  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1528  * \li Syntax: file-insert-plaintext-para [<FILE>]
1529  * \li Params: <FILE>: Filename to be inserted.
1530  * \li Origin: Levon, 14 Feb 2001
1531  * \endvar
1532  */
1533                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1534 /*!
1535  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1536  * \li Action: Open LyX document.
1537  * \li Syntax: file-open [<FILE>]
1538  * \li Params: <FILE>: Filename to be opened.
1539  * \endvar
1540  */
1541                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1542
1543 /*!
1544  * \var lyx::FuncCode lyx::LFUN_CALL
1545  * \li Action: Executes a command defined in a .def file.
1546  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1547                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1548                where <NAME> is the name of the new command and <LFUN> is the lfun code
1549                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1550                \\def_file "FileName" allows to include another .def file. \n
1551                This is particularly useful in connection with toolbar buttons:
1552                Since the name of the button image for this lfun is
1553                lib/images/commands/<NAME>.png this is the way to assign an image
1554                to a complex command-sequence.
1555  * \li Syntax: call <NAME>
1556  * \li Params: <NAME>: Name of the command that must be called.
1557  * \li Origin: broider, 2 Oct 2007
1558  * \endvar
1559  */
1560                 { LFUN_CALL, "call", NoBuffer, System },
1561 /*!
1562  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1563  * \li Action: Simulate halting Meta key (Alt key on PCs).
1564  * \li Notion: Used for buffer editation not for GUI control.
1565  * \li Syntax: meta-prefix
1566  * \endvar
1567  */
1568                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1569 /*!
1570  * \var lyx::FuncCode lyx::LFUN_CANCEL
1571  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1572  * \li Syntax: cancel
1573  * \endvar
1574  */
1575                 { LFUN_CANCEL, "cancel", NoBuffer, System },
1576
1577 /*!
1578  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1579  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1580  * \li Notion: Usually bound to M-x shortcut.
1581  * \li Syntax: command-execute
1582  * \endvar
1583  */
1584                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1585                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1586 /*!
1587  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1588  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1589  * \li Syntax: command-sequence <CMDS>
1590  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1591  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1592  * \li Origin: Andre', 11 Nov 1999
1593  * \endvar
1594  */
1595                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1596
1597 /*!
1598  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1599  * \li Action: Save user preferences.
1600  * \li Syntax: preferences-save
1601  * \li Origin: Lgb, 27 Nov 1999
1602  * \endvar
1603  */
1604                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1605 /*!
1606  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1607  * \li Action: Reconfigure the automatic settings.
1608  * \li Syntax: reconfigure
1609  * \li Origin: Asger, 14 Feb 1997
1610  * \endvar
1611  */
1612                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1613 /*!
1614  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1615  * \li Action: Apply the given settings to user preferences.
1616  * \li Syntax: lyxrc-apply <SETTINGS>
1617  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1618                            to get an idea which commands to use and their syntax.
1619                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
1620  * \endvar
1621  */
1622                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1623 /*!
1624  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1625  * \li Action: Determine whether keep cursor inside the editing window regardless
1626                the scrollbar movement.
1627  * \li Syntax: toggle-cursor-follows-scrollbar
1628  * \li Origin: ARRae, 2 Dec 1997
1629  * \endvar
1630  */
1631                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1632 /*!
1633  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1634  * \li Action: Set the given LyX color to the color defined by the X11 name given.
1635  * \li Notion: A new color entry is created if the color is unknown.
1636                Color names can be stored as a part of user settings.
1637  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1638  * \li Origin: SLior, 11 Jun 2000
1639  * \endvar
1640  */
1641                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1642 /*!
1643  * \var lyx::FuncCode lyx::LFUN_STATISTICS
1644  * \li Action: Count the statistics (number of words and characters)
1645                in the document or in the given selection.
1646  * \li Notion: Note that this function gives the number of words/chars written,
1647                not the number of characters which will be typeset.
1648  * \li Syntax: statistics
1649  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1650  * \endvar
1651  */
1652                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1653 /*!
1654  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1655  * \li Action: Show the inline completion at the cursor position.
1656  * \li Syntax: completion-inline
1657  * \li Origin: sts, Feb 19 2008
1658  * \endvar
1659  */
1660                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1661 /*!
1662  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1663  * \li Action: Show the completion popup at the cursor position.
1664  * \li Syntax: completion-popup
1665  * \li Origin: sts, Feb 19 2008
1666  * \endvar
1667  */
1668                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1669 /*!
1670  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1671  * \li Action: Try to complete the word or command at the cursor position.
1672  * \li Syntax: completion-complete
1673  * \li Origin: sts, Feb 19 2008
1674  * \endvar
1675  */
1676                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1677
1678                 { LFUN_NOACTION, "", Noop, Hidden }
1679 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1680         };
1681
1682         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1683                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1684         }
1685
1686         init = true;
1687 }
1688 #endif
1689
1690 LyXAction::LyXAction()
1691 {
1692         init();
1693 }
1694
1695
1696 // Returns an action tag from a string.
1697 FuncRequest LyXAction::lookupFunc(string const & func) const
1698 {
1699         string const func2 = trim(func);
1700
1701         if (func2.empty()) {
1702                 return FuncRequest(LFUN_NOACTION);
1703         }
1704
1705         string cmd;
1706         string const arg = split(func2, cmd, ' ');
1707
1708         func_map::const_iterator fit = lyx_func_map.find(cmd);
1709
1710         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1711 }
1712
1713
1714 string const LyXAction::getActionName(FuncCode action) const
1715 {
1716         info_map::const_iterator const it = lyx_info_map.find(action);
1717         return it != lyx_info_map.end() ? it->second.name : string();
1718 }
1719
1720
1721 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1722 {
1723         info_map::const_iterator const it = lyx_info_map.find(action);
1724         return it != lyx_info_map.end() ? it->second.type : Hidden;
1725 }
1726
1727
1728 bool LyXAction::funcHasFlag(FuncCode action,
1729                             LyXAction::func_attrib flag) const
1730 {
1731         info_map::const_iterator ici = lyx_info_map.find(action);
1732
1733         if (ici == lyx_info_map.end()) {
1734                 LYXERR0("action: " << action << " is not known.");
1735                 BOOST_ASSERT(false);
1736         }
1737
1738         return ici->second.attrib & flag;
1739 }
1740
1741
1742 LyXAction::const_func_iterator LyXAction::func_begin() const
1743 {
1744         return lyx_func_map.begin();
1745 }
1746
1747
1748 LyXAction::const_func_iterator LyXAction::func_end() const
1749 {
1750         return lyx_func_map.end();
1751 }
1752
1753
1754 } // namespace lyx