lib/doc/LFUNs.lyx

   1 #LyX 1.5.6svn created this file. For more info see http://www.lyx.org/
   2 \lyxformat 276
   3 \begin_document
   4 \begin_header
   5 \textclass amsart
   6 \language english
   7 \inputencoding auto
   8 \font_roman default
   9 \font_sans default
  10 \font_typewriter default
  11 \font_default_family default
  12 \font_sc false
  13 \font_osf false
  14 \font_sf_scale 100
  15 \font_tt_scale 100
  16 \graphics default
  17 \paperfontsize default
  18 \spacing single
  19 \papersize default
  20 \use_geometry true
  21 \use_amsmath 1
  22 \use_esint 1
  23 \cite_engine basic
  24 \use_bibtopic false
  25 \paperorientation portrait
  26 \leftmargin 2.5cm
  27 \topmargin 2cm
  28 \rightmargin 3cm
  29 \bottommargin 2cm
  30 \secnumdepth 3
  31 \tocdepth 3
  32 \paragraph_separation indent
  33 \defskip medskip
  34 \quotes_language english
  35 \papercolumns 1
  36 \papersides 1
  37 \paperpagestyle default
  38 \tracking_changes false
  39 \output_changes false
  40 \author ""
  41 \end_header
  42
  43 \begin_body
  44
  45 \begin_layout Section*
  46 LFUNs documentation automatically generated 23.7.2008.
  47 \end_layout
  48
  49 \begin_layout Standard
  50 \begin_inset ERT
  51 status open
  52
  53 \begin_layout Standard
  54
  55
  56 \backslash
  57 thispagestyle{empty}
  58 \end_layout
  59
  60 \end_inset
  61
  62
  63 \begin_inset VSpace 1cm
  64 \end_inset
  65
  66
  67 \end_layout
  68
  69 \begin_layout Subsection*
  70 LFUN_ACCENT_ACUTE
  71 \end_layout
  72
  73 \begin_layout Description
  74 Action Adds an acute accent to the next character typed.
  75
  76 \end_layout
  77
  78 \begin_layout Description
  79 Syntax accent-acute
  80 \end_layout
  81
  82 \begin_layout Subsection*
  83 LFUN_ACCENT_BREVE
  84 \end_layout
  85
  86 \begin_layout Description
  87 Action Adds a breve accent to the next character typed.
  88
  89 \end_layout
  90
  91 \begin_layout Description
  92 Syntax accent-breve
  93 \end_layout
  94
  95 \begin_layout Subsection*
  96 LFUN_ACCENT_CARON
  97 \end_layout
  98
  99 \begin_layout Description
 100 Action Adds a caron to the next character typed.
 101
 102 \end_layout
 103
 104 \begin_layout Description
 105 Syntax accent-caron
 106 \end_layout
 107
 108 \begin_layout Subsection*
 109 LFUN_ACCENT_CEDILLA
 110 \end_layout
 111
 112 \begin_layout Description
 113 Action Adds a cedilla to the next character typed.
 114
 115 \end_layout
 116
 117 \begin_layout Description
 118 Syntax accent-cedilla
 119 \end_layout
 120
 121 \begin_layout Subsection*
 122 LFUN_ACCENT_CIRCLE
 123 \end_layout
 124
 125 \begin_layout Description
 126 Action Adds a circle accent to the next character typed.
 127
 128 \end_layout
 129
 130 \begin_layout Description
 131 Syntax accent-circle
 132 \end_layout
 133
 134 \begin_layout Subsection*
 135 LFUN_ACCENT_CIRCUMFLEX
 136 \end_layout
 137
 138 \begin_layout Description
 139 Action Adds a circumflex to the next character typed.
 140
 141 \end_layout
 142
 143 \begin_layout Description
 144 Syntax accent-circumflex
 145 \end_layout
 146
 147 \begin_layout Subsection*
 148 LFUN_ACCENT_DOT
 149 \end_layout
 150
 151 \begin_layout Description
 152 Action Adds a dot accent to the next character typed.
 153
 154 \end_layout
 155
 156 \begin_layout Description
 157 Syntax accent-dot
 158 \end_layout
 159
 160 \begin_layout Subsection*
 161 LFUN_ACCENT_GRAVE
 162 \end_layout
 163
 164 \begin_layout Description
 165 Action Adds a grave accent to the next character typed.
 166
 167 \end_layout
 168
 169 \begin_layout Description
 170 Syntax accent-grave
 171 \end_layout
 172
 173 \begin_layout Subsection*
 174 LFUN_ACCENT_HUNGARIAN_UMLAUT
 175 \end_layout
 176
 177 \begin_layout Description
 178 Action Adds a Hungarian umlaut to the next character typed.
 179
 180 \end_layout
 181
 182 \begin_layout Description
 183 Syntax accent-grave
 184 \end_layout
 185
 186 \begin_layout Subsection*
 187 LFUN_ACCENT_MACRON
 188 \end_layout
 189
 190 \begin_layout Description
 191 Action Adds a macron to the next character typed.
 192
 193 \end_layout
 194
 195 \begin_layout Description
 196 Syntax accent-macron
 197 \end_layout
 198
 199 \begin_layout Subsection*
 200 LFUN_ACCENT_OGONEK
 201 \end_layout
 202
 203 \begin_layout Description
 204 Action Adds an ogonek accent to the next character typed.
 205
 206 \end_layout
 207
 208 \begin_layout Description
 209 Syntax accent-ogonek
 210 \end_layout
 211
 212 \begin_layout Subsection*
 213 LFUN_ACCENT_TIE
 214 \end_layout
 215
 216 \begin_layout Description
 217 Action Adds a tie over the next two character typed.
 218
 219 \end_layout
 220
 221 \begin_layout Description
 222 Notion The following char will finish the tie.
 223
 224 \end_layout
 225
 226 \begin_layout Description
 227 Syntax accent-tie
 228 \end_layout
 229
 230 \begin_layout Subsection*
 231 LFUN_ACCENT_TILDE
 232 \end_layout
 233
 234 \begin_layout Description
 235 Action Adds a tilde over the next character typed.
 236
 237 \end_layout
 238
 239 \begin_layout Description
 240 Syntax accent-tilde
 241 \end_layout
 242
 243 \begin_layout Subsection*
 244 LFUN_ACCENT_UMLAUT
 245 \end_layout
 246
 247 \begin_layout Description
 248 Action Adds an umlaut over the next character typed.
 249
 250 \end_layout
 251
 252 \begin_layout Description
 253 Syntax accent-umlaut
 254 \end_layout
 255
 256 \begin_layout Subsection*
 257 LFUN_ACCENT_UNDERBAR
 258 \end_layout
 259
 260 \begin_layout Description
 261 Action Adds a bar under the next character typed.
 262
 263 \end_layout
 264
 265 \begin_layout Description
 266 Syntax accent-underbar
 267 \end_layout
 268
 269 \begin_layout Subsection*
 270 LFUN_ACCENT_UNDERDOT
 271 \end_layout
 272
 273 \begin_layout Description
 274 Action Adds a dot under the next character typed.
 275
 276 \end_layout
 277
 278 \begin_layout Description
 279 Syntax accent-underdot
 280 \end_layout
 281
 282 \begin_layout Subsection*
 283 LFUN_CAPTION_INSERT
 284 \end_layout
 285
 286 \begin_layout Description
 287 Action Inserts a caption inset.
 288
 289 \end_layout
 290
 291 \begin_layout Description
 292 Syntax caption-insert
 293 \end_layout
 294
 295 \begin_layout Description
 296 Origin Lgb, 18 Jul 2000
 297 \end_layout
 298
 299 \begin_layout Subsection*
 300 LFUN_DATE_INSERT
 301 \end_layout
 302
 303 \begin_layout Description
 304 Action Inserts the current date.
 305
 306 \end_layout
 307
 308 \begin_layout Description
 309 Syntax date-insert [<ARG>]
 310 \end_layout
 311
 312 \begin_layout Description
 313 Params <ARG>: Format of date.
 314  The default value (%x) can be set in Preferences->Date format.
 315  For possible formats see manual page of strftime function.
 316
 317 \end_layout
 318
 319 \begin_layout Description
 320 Origin jdblair, 31 Jan 2000
 321 \end_layout
 322
 323 \begin_layout Subsection*
 324 LFUN_FOOTNOTE_INSERT
 325 \end_layout
 326
 327 \begin_layout Description
 328 Action Inserts a footnote inset.
 329
 330 \end_layout
 331
 332 \begin_layout Description
 333 Syntax footnote-insert
 334 \end_layout
 335
 336 \begin_layout Description
 337 Origin Jug, 7 Mar 2000
 338 \end_layout
 339
 340 \begin_layout Subsection*
 341 LFUN_ERT_INSERT
 342 \end_layout
 343
 344 \begin_layout Description
 345 Action Inserts an ERT inset.
 346
 347 \end_layout
 348
 349 \begin_layout Description
 350 Syntax ert-insert
 351 \end_layout
 352
 353 \begin_layout Description
 354 Origin Jug, 18 Feb 2000
 355 \end_layout
 356
 357 \begin_layout Subsection*
 358 LFUN_FLOAT_INSERT
 359 \end_layout
 360
 361 \begin_layout Description
 362 Action Inserts a float inset.
 363
 364 \end_layout
 365
 366 \begin_layout Description
 367 Syntax float-insert <TYPE>
 368 \end_layout
 369
 370 \begin_layout Description
 371 Params <TYPE>: type of float depends on the used textclass.
 372  Usually "algorithm", "table", "figure" parameters can be given.
 373
 374 \end_layout
 375
 376 \begin_layout Description
 377 Origin Lgb, 27 Jun 2000
 378 \end_layout
 379
 380 \begin_layout Subsection*
 381 LFUN_FLOAT_WIDE_INSERT
 382 \end_layout
 383
 384 \begin_layout Description
 385 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
 386
 387 \end_layout
 388
 389 \begin_layout Description
 390 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
 391
 392 \end_layout
 393
 394 \begin_layout Description
 395 Syntax float-wide-insert <TYPE>
 396 \end_layout
 397
 398 \begin_layout Description
 399 Params <TYPE>: type of float depends on the used textclass.
 400  Usually "algorithm", "table", "figure" parameters can be given.
 401
 402 \end_layout
 403
 404 \begin_layout Description
 405 Origin Lgb, 31 Oct 2001
 406 \end_layout
 407
 408 \begin_layout Subsection*
 409 LFUN_FLOAT_LIST_INSERT
 410 \end_layout
 411
 412 \begin_layout Description
 413 Action Inserts the list of floats in the document.
 414
 415 \end_layout
 416
 417 \begin_layout Description
 418 Syntax float-list-insert <TYPE>
 419 \end_layout
 420
 421 \begin_layout Description
 422 Params <TYPE>: type of float depends on the used textclass.
 423  Usually "algorithm", "table", "figure" parameters can be given.
 424
 425 \end_layout
 426
 427 \begin_layout Description
 428 Origin Lgb, 3 May 2001
 429 \end_layout
 430
 431 \begin_layout Subsection*
 432 LFUN_WRAP_INSERT
 433 \end_layout
 434
 435 \begin_layout Description
 436 Action Inserts floats wrapped by the text around.
 437
 438 \end_layout
 439
 440 \begin_layout Description
 441 Syntax wrap-insert <TYPE>
 442 \end_layout
 443
 444 \begin_layout Description
 445 Params <TYPE>: table|figure
 446 \end_layout
 447
 448 \begin_layout Description
 449 Origin Dekel, 7 Apr 2002
 450 \end_layout
 451
 452 \begin_layout Subsection*
 453 LFUN_OPTIONAL_INSERT
 454 \end_layout
 455
 456 \begin_layout Description
 457 Action Inserts an optional-argument (short title) inset.
 458
 459 \end_layout
 460
 461 \begin_layout Description
 462 Syntax optional-insert
 463 \end_layout
 464
 465 \begin_layout Description
 466 Origin vermeer, 12 Aug 2002
 467 \end_layout
 468
 469 \begin_layout Subsection*
 470 LFUN_LINE_INSERT
 471 \end_layout
 472
 473 \begin_layout Description
 474 Action Inserts a horizontal line.
 475
 476 \end_layout
 477
 478 \begin_layout Description
 479 Syntax line-insert
 480 \end_layout
 481
 482 \begin_layout Description
 483 Origin Andre, Oct 27 2003
 484 \end_layout
 485
 486 \begin_layout Subsection*
 487 LFUN_NEWPAGE_INSERT
 488 \end_layout
 489
 490 \begin_layout Description
 491 Action Inserts a new page.
 492
 493 \end_layout
 494
 495 \begin_layout Description
 496 Syntax newpage-insert <ARG>
 497 \end_layout
 498
 499 \begin_layout Description
 500 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 501
 502 \end_layout
 503
 504 \begin_layout Description
 505 Origin uwestoehr, 24 Nov 2007
 506 \end_layout
 507
 508 \begin_layout Subsection*
 509 LFUN_MARGINALNOTE_INSERT
 510 \end_layout
 511
 512 \begin_layout Description
 513 Action Inserts a marginal note.
 514
 515 \end_layout
 516
 517 \begin_layout Description
 518 Syntax marginalnote-insert
 519 \end_layout
 520
 521 \begin_layout Description
 522 Origin Lgb, 26 Jun 2000
 523 \end_layout
 524
 525 \begin_layout Subsection*
 526 LFUN_UNICODE_INSERT
 527 \end_layout
 528
 529 \begin_layout Description
 530 Action Inserts a single unicode character.
 531
 532 \end_layout
 533
 534 \begin_layout Description
 535 Syntax unicode-insert <CHAR>
 536 \end_layout
 537
 538 \begin_layout Description
 539 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
 540
 541 \end_layout
 542
 543 \begin_layout Description
 544 Sample unicode-insert 0x0100
 545 \end_layout
 546
 547 \begin_layout Description
 548 Origin Lgb, 22 Oct 2006
 549 \end_layout
 550
 551 \begin_layout Subsection*
 552 LFUN_LISTING_INSERT
 553 \end_layout
 554
 555 \begin_layout Description
 556 Action Inserts a new listings inset.
 557
 558 \end_layout
 559
 560 \begin_layout Description
 561 Syntax listing-insert
 562 \end_layout
 563
 564 \begin_layout Description
 565 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
 566 \end_layout
 567
 568 \begin_layout Subsection*
 569 LFUN_QUOTE_INSERT
 570 \end_layout
 571
 572 \begin_layout Description
 573 Action Inserts quotes according to the type and quote-language preference.
 574
 575 \end_layout
 576
 577 \begin_layout Description
 578 Action Currently  English, Swedish, German, Polish, French, Danish quotes
 579  are distinguished.
 580
 581 \end_layout
 582
 583 \begin_layout Description
 584 Syntax quote-insert [<TYPE>]
 585 \end_layout
 586
 587 \begin_layout Description
 588 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
 589  be used.
 590
 591 \end_layout
 592
 593 \begin_layout Subsection*
 594 LFUN_INFO_INSERT
 595 \end_layout
 596
 597 \begin_layout Description
 598 Action Displays shortcuts, lyxrc, package and textclass availability and
 599  menu information in a non-editable boxed InsetText.
 600
 601 \end_layout
 602
 603 \begin_layout Description
 604 Notion Apart from lfun arguments you can use the following method:
 605 \newline
 606  1.
 607  input the type and argument of this inset, e.g.
 608  "menu paste", in the work area.
 609
 610 \newline
 611  2.
 612  select the text and run info-insert lfun.
 613
 614 \end_layout
 615
 616 \begin_layout Description
 617 Syntax info-insert <TYPE> <ARG>
 618 \end_layout
 619
 620 \begin_layout Description
 621 Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
 622 \newline
 623  <ARG>: argument
 624  for a given type.
 625  Look into InsetInfo.h for detailed description.
 626
 627 \end_layout
 628
 629 \begin_layout Description
 630 Origin bpeng, 7 Oct 2007
 631 \end_layout
 632
 633 \begin_layout Subsection*
 634 LFUN_BRANCH_INSERT
 635 \end_layout
 636
 637 \begin_layout Description
 638 Action Inserts branch inset.
 639
 640 \end_layout
 641
 642 \begin_layout Description
 643 Syntax branch-insert <BRANCH-NAME>
 644 \end_layout
 645
 646 \begin_layout Description
 647 Origin vermeer, 17 Aug 2003
 648 \end_layout
 649
 650 \begin_layout Subsection*
 651 LFUN_BOX_INSERT
 652 \end_layout
 653
 654 \begin_layout Description
 655 Action Inserts Box inset.
 656
 657 \end_layout
 658
 659 \begin_layout Description
 660 Syntax box-insert [<TYPE>]
 661 \end_layout
 662
 663 \begin_layout Description
 664 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
 665
 666 \newline
 667  Framed is the default one.
 668
 669 \end_layout
 670
 671 \begin_layout Description
 672 Origin vermeer, 7 Oct 2003
 673 \end_layout
 674
 675 \begin_layout Subsection*
 676 LFUN_FLEX_INSERT
 677 \end_layout
 678
 679 \begin_layout Description
 680 Action Inserts CharStyle, Custom inset or XML short element.
 681
 682 \end_layout
 683
 684 \begin_layout Description
 685 Notion Look into the Customization manual for more information about these
 686  elements.
 687
 688 \newline
 689  To make this command enabled the layout file for the document class you're
 690  using has to load the character styles.
 691  There are a few contained in the Logical Markup module.
 692  You can also of course create some yourself.
 693
 694 \newline
 695  For dissolving the element see LFUN_INSET_DISSOLVE.
 696
 697 \end_layout
 698
 699 \begin_layout Description
 700 Syntax flex-insert <TYPE:Name>
 701 \end_layout
 702
 703 \begin_layout Description
 704 Params TYPE: CharStyle|Custom|Element|Standard
 705 \newline
 706  Identifies whether this
 707  is a Character Style, a Custom Inset or an XML Element, and which dynamical
 708  sub-menu this flex inset is in on the LyX menu tree.
 709  If Standard (currently unused): none of these.
 710  Name: This name must be defined either in your layout file or imported
 711  by some module.
 712  The definition is
 713 \newline
 714  InsetLayout <TYPE:Name>
 715 \end_layout
 716
 717 \begin_layout Description
 718 Sample flex-insert CharStyle:Code
 719 \end_layout
 720
 721 \begin_layout Subsection*
 722 LFUN_SELF_INSERT
 723 \end_layout
 724
 725 \begin_layout Description
 726 Action Inserts the given string (accordingly to the correct keymap).
 727
 728 \end_layout
 729
 730 \begin_layout Description
 731 Notion Automatically replace the currently selected text.
 732  Depends on lyxrc settings "auto_region_delete".
 733
 734 \end_layout
 735
 736 \begin_layout Description
 737 Syntax self-insert <STRING>
 738 \end_layout
 739
 740 \begin_layout Subsection*
 741 LFUN_SPACE_INSERT
 742 \end_layout
 743
 744 \begin_layout Description
 745 Action Inserts one of horizontal space insets.
 746
 747 \end_layout
 748
 749 \begin_layout Description
 750 Syntax space-insert <NAME> [<LEN>]
 751 \end_layout
 752
 753 \begin_layout Description
 754 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
 755 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
 756 \newline
 757  <LEN>: length for
 758  custom spaces (hspace, hspace* for protected)
 759 \end_layout
 760
 761 \begin_layout Description
 762 Origin JSpitzm, 20 May 2003, Mar 17 2008
 763 \end_layout
 764
 765 \begin_layout Subsection*
 766 LFUN_HYPERLINK_INSERT
 767 \end_layout
 768
 769 \begin_layout Description
 770 Action Inserts hyperlinks into the document (clickable in pdf output).
 771
 772 \end_layout
 773
 774 \begin_layout Description
 775 Notion Hyperlink target can be set via selection + hyperlink-insert function.
 776
 777 \end_layout
 778
 779 \begin_layout Description
 780 Syntax href-insert [<TARGET>]
 781 \end_layout
 782
 783 \begin_layout Description
 784 Origin CFO-G, 21 Nov 1997
 785 \end_layout
 786
 787 \begin_layout Subsection*
 788 LFUN_SPECIALCHAR_INSERT
 789 \end_layout
 790
 791 \begin_layout Description
 792 Action Inserts various characters into the document.
 793
 794 \end_layout
 795
 796 \begin_layout Description
 797 Syntax specialchar-insert <CHAR>
 798 \end_layout
 799
 800 \begin_layout Description
 801 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
 802 tence, menu-separator.
 803
 804 \end_layout
 805
 806 \begin_layout Description
 807 Origin JSpitzm, 6 Dec 2007
 808 \end_layout
 809
 810 \begin_layout Subsection*
 811 LFUN_TOC_INSERT
 812 \end_layout
 813
 814 \begin_layout Description
 815 Action Inserts table of contents.
 816
 817 \end_layout
 818
 819 \begin_layout Description
 820 Syntax toc-insert
 821 \end_layout
 822
 823 \begin_layout Description
 824 Origin Lgb, 27 May 97
 825 \end_layout
 826
 827 \begin_layout Subsection*
 828 LFUN_APPENDIX
 829 \end_layout
 830
 831 \begin_layout Description
 832 Action Start (or remove) Appendix on the given cursor position.
 833
 834 \end_layout
 835
 836 \begin_layout Description
 837 Syntax appendix
 838 \end_layout
 839
 840 \begin_layout Description
 841 Origin ettrich, 5 May 1998
 842 \end_layout
 843
 844 \begin_layout Subsection*
 845 LFUN_INDEX_INSERT
 846 \end_layout
 847
 848 \begin_layout Description
 849 Action Inserts Index entry.
 850
 851 \end_layout
 852
 853 \begin_layout Description
 854 Notion It automatically takes the word on the cursor position.
 855
 856 \end_layout
 857
 858 \begin_layout Description
 859 Syntax index-insert
 860 \end_layout
 861
 862 \begin_layout Description
 863 Origin leeming, 3 Aug 2000
 864 \end_layout
 865
 866 \begin_layout Subsection*
 867 LFUN_INDEX_PRINT
 868 \end_layout
 869
 870 \begin_layout Description
 871 Action Inserts list of Index entries on a new page.
 872
 873 \end_layout
 874
 875 \begin_layout Description
 876 Syntax index-print
 877 \end_layout
 878
 879 \begin_layout Description
 880 Origin Lgb, 27 Feb 1997
 881 \end_layout
 882
 883 \begin_layout Subsection*
 884 LFUN_NOMENCL_INSERT
 885 \end_layout
 886
 887 \begin_layout Description
 888 Action Inserts Nomenclature entry.
 889
 890 \end_layout
 891
 892 \begin_layout Description
 893 Notion It automatically takes the word on the cursor position if no symbol
 894  is given.
 895
 896 \end_layout
 897
 898 \begin_layout Description
 899 Syntax nomencl-insert [<SYMBOL>]
 900 \end_layout
 901
 902 \begin_layout Description
 903 Origin Ugras, 4 Nov 2006
 904 \end_layout
 905
 906 \begin_layout Subsection*
 907 LFUN_NOMENCLATURE_PRINT
 908 \end_layout
 909
 910 \begin_layout Description
 911 Action Inserts list of Nomenclature entries.
 912
 913 \end_layout
 914
 915 \begin_layout Description
 916 Syntax nomenclature-print
 917 \end_layout
 918
 919 \begin_layout Description
 920 Origin Ugras, 4 Nov 2006
 921 \end_layout
 922
 923 \begin_layout Subsection*
 924 LFUN_NOTE_INSERT
 925 \end_layout
 926
 927 \begin_layout Description
 928 Action Inserts Note on the current cursor postion, move selection inside
 929  the inset.
 930
 931 \end_layout
 932
 933 \begin_layout Description
 934 Syntax note-insert [<TYPE>]
 935 \end_layout
 936
 937 \begin_layout Description
 938 Params <TYPE>: <Note|Greyedout|Comment> default: Note
 939 \end_layout
 940
 941 \begin_layout Subsection*
 942 LFUN_NOTE_NEXT
 943 \end_layout
 944
 945 \begin_layout Description
 946 Action Moves the cursor to the begining of next Note inset.
 947
 948 \end_layout
 949
 950 \begin_layout Description
 951 Syntax note-next
 952 \end_layout
 953
 954 \begin_layout Subsection*
 955 LFUN_NOTES_MUTATE
 956 \end_layout
 957
 958 \begin_layout Description
 959 Action Changes all Note insets of a particular type (source) to a different
 960  type (target) fot the current document.
 961
 962 \end_layout
 963
 964 \begin_layout Description
 965 Syntax notes-mutate <SOURCE> <TARGET>
 966 \end_layout
 967
 968 \begin_layout Description
 969 Params <SOURCE/TARGET>: Note|Comment|Greyedout
 970 \end_layout
 971
 972 \begin_layout Description
 973 Origin sanda, 18 Jun 2008
 974 \end_layout
 975
 976 \begin_layout Subsection*
 977 LFUN_NEWLINE_INSERT
 978 \end_layout
 979
 980 \begin_layout Description
 981 Action Inserts a line break or new line.
 982
 983 \end_layout
 984
 985 \begin_layout Description
 986 Syntax newline-insert [<ARG>]
 987 \end_layout
 988
 989 \begin_layout Description
 990 Params <ARG>: <newline|linebreak> default: newline
 991 \end_layout
 992
 993 \begin_layout Description
 994 Origin JSpitzm, 25 Mar 2008
 995 \end_layout
 996
 997 \begin_layout Subsection*
 998 LFUN_ESCAPE
 999 \end_layout
1000
1001 \begin_layout Description
1002 Action Clears the selection.
1003  If no text is selected call LFUN_FINISHED_FORWARD.
1004
1005 \end_layout
1006
1007 \begin_layout Description
1008 Syntax escape
1009 \end_layout
1010
1011 \begin_layout Description
1012 Origin Lgb, 17 May 2001
1013 \end_layout
1014
1015 \begin_layout Subsection*
1016 LFUN_DOWN
1017 \end_layout
1018
1019 \begin_layout Description
1020 Action Moves the cursor one line in downward direction.
1021
1022 \end_layout
1023
1024 \begin_layout Description
1025 Syntax down
1026 \end_layout
1027
1028 \begin_layout Subsection*
1029 LFUN_UP
1030 \end_layout
1031
1032 \begin_layout Description
1033 Action Moves the cursor one line in upward direction.
1034
1035 \end_layout
1036
1037 \begin_layout Description
1038 Syntax up
1039 \end_layout
1040
1041 \begin_layout Subsection*
1042 LFUN_DOWN_SELECT
1043 \end_layout
1044
1045 \begin_layout Description
1046 Action Moves the cursor one line in downward direction adding the current
1047  position to the selection.
1048
1049 \end_layout
1050
1051 \begin_layout Description
1052 Syntax down-select
1053 \end_layout
1054
1055 \begin_layout Subsection*
1056 LFUN_UP_SELECT
1057 \end_layout
1058
1059 \begin_layout Description
1060 Action Moves the cursor one line in upward direction adding the current
1061  position to the selection.
1062
1063 \end_layout
1064
1065 \begin_layout Description
1066 Syntax up-select
1067 \end_layout
1068
1069 \begin_layout Subsection*
1070 SCREEN_DOWN
1071 \end_layout
1072
1073 \begin_layout Description
1074 Action Moves the cursor one page in downward direction.
1075
1076 \end_layout
1077
1078 \begin_layout Description
1079 Syntax screen-down
1080 \end_layout
1081
1082 \begin_layout Subsection*
1083 LFUN_SCREEN_UP
1084 \end_layout
1085
1086 \begin_layout Description
1087 Action Moves the cursor one page in upward direction.
1088
1089 \end_layout
1090
1091 \begin_layout Description
1092 Syntax screen-up
1093 \end_layout
1094
1095 \begin_layout Subsection*
1096 LFUN_SCREEN_DOWN_SELECT
1097 \end_layout
1098
1099 \begin_layout Description
1100 Action Moves the cursor one screen in downward direction adding the current
1101  position to the selection.
1102
1103 \end_layout
1104
1105 \begin_layout Description
1106 Syntax screen-down-select
1107 \end_layout
1108
1109 \begin_layout Subsection*
1110 LFUN_SCREEN_UP_SELECT
1111 \end_layout
1112
1113 \begin_layout Description
1114 Action Moves the cursor one page in upward direction adding the current
1115  position to the selection.
1116
1117 \end_layout
1118
1119 \begin_layout Description
1120 Syntax screen-up-select
1121 \end_layout
1122
1123 \begin_layout Subsection*
1124 LFUN_SCROLL
1125 \end_layout
1126
1127 \begin_layout Description
1128 Action Scroll the buffer view.
1129
1130 \end_layout
1131
1132 \begin_layout Description
1133 Notion Only scrolls the screen up or down; does not move the cursor.
1134
1135 \end_layout
1136
1137 \begin_layout Description
1138 Syntax scroll <TYPE> <QUANTITY>
1139 \end_layout
1140
1141 \begin_layout Description
1142 Params <TYPE>:  line|page
1143 \newline
1144  <QUANTITY>: up|down|<number>
1145 \end_layout
1146
1147 \begin_layout Description
1148 Origin Abdel, Dec 27 2007
1149 \end_layout
1150
1151 \begin_layout Subsection*
1152 LFUN_SCREEN_RECENTER
1153 \end_layout
1154
1155 \begin_layout Description
1156 Action Recenters the screen on the current cursor position.
1157
1158 \end_layout
1159
1160 \begin_layout Description
1161 Syntax screen-recenter
1162 \end_layout
1163
1164 \begin_layout Subsection*
1165 LFUN_CHAR_BACKWARD
1166 \end_layout
1167
1168 \begin_layout Description
1169 Action Moves the cursor one position logically backwards.
1170
1171 \end_layout
1172
1173 \begin_layout Description
1174 Notion This is not the action which should be bound to the arrow keys, because
1175  backwards may be left or right, depending on the language.
1176  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1177  which in turn may employ this one.
1178
1179 \end_layout
1180
1181 \begin_layout Description
1182 Syntax char-backward
1183 \end_layout
1184
1185 \begin_layout Subsection*
1186 LFUN_CHAR_BACKWARD_SELECT
1187 \end_layout
1188
1189 \begin_layout Description
1190 Action Moves the cursor one position logically backwards, adding traversed
1191  position to the selection.
1192
1193 \end_layout
1194
1195 \begin_layout Description
1196 Notion See also LFUN_CHAR_BACKWARD.
1197
1198 \end_layout
1199
1200 \begin_layout Description
1201 Syntax char-backward-select
1202 \end_layout
1203
1204 \begin_layout Subsection*
1205 LFUN_CHAR_DELETE_BACKWARD
1206 \end_layout
1207
1208 \begin_layout Description
1209 Action Deletes one character in the backward direction (usually the "BackSpace"
1210  key).
1211
1212 \end_layout
1213
1214 \begin_layout Description
1215 Syntax char-delete-backward
1216 \end_layout
1217
1218 \begin_layout Subsection*
1219 LFUN_CHAR_DELETE_FORWARD
1220 \end_layout
1221
1222 \begin_layout Description
1223 Action Deletes one character in the backward direction (usually the "Delete"
1224  key).
1225
1226 \end_layout
1227
1228 \begin_layout Description
1229 Syntax char-delete-forward
1230 \end_layout
1231
1232 \begin_layout Subsection*
1233 LFUN_CHAR_FORWARD
1234 \end_layout
1235
1236 \begin_layout Description
1237 Action Moves the cursor one position logically forward.
1238
1239 \end_layout
1240
1241 \begin_layout Description
1242 Notion This is not the action which should be bound to the arrow keys, because
1243  forward may be left or right, depending on the language.
1244  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1245  which in turn may employ this one.
1246
1247 \end_layout
1248
1249 \begin_layout Description
1250 Syntax char-forward
1251 \end_layout
1252
1253 \begin_layout Subsection*
1254 LFUN_CHAR_FORWARD_SELECT
1255 \end_layout
1256
1257 \begin_layout Description
1258 Action Moves the cursor one position logically forward, adding traversed
1259  position to the selection.
1260
1261 \end_layout
1262
1263 \begin_layout Description
1264 Notion See also LFUN_CHAR_FORWARD.
1265
1266 \end_layout
1267
1268 \begin_layout Description
1269 Syntax char-forward-select
1270 \end_layout
1271
1272 \begin_layout Subsection*
1273 LFUN_CHAR_LEFT
1274 \end_layout
1275
1276 \begin_layout Description
1277 Action Moves the cursor one position "to the left".
1278
1279 \end_layout
1280
1281 \begin_layout Description
1282 Notion This is the action which should be taken when the "left" key is pressed.
1283  Generally, it moves the cursor one position to the left.
1284  However, in Bidi text this become slightly more complicated, and there
1285  are different modes of cursor movement.
1286  In "visual mode", this moves left, plain and simple.
1287  In "logical mode", movement is logically forward in RTL paragraphs, and
1288  logically backwards in LTR paragraphs.
1289
1290 \end_layout
1291
1292 \begin_layout Description
1293 Syntax char-left
1294 \end_layout
1295
1296 \begin_layout Subsection*
1297 LFUN_CHAR_LEFT_SELECT
1298 \end_layout
1299
1300 \begin_layout Description
1301 Action Moves the cursor one position "to the left", adding traversed position
1302  to the selection.
1303
1304 \end_layout
1305
1306 \begin_layout Description
1307 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1308
1309 \end_layout
1310
1311 \begin_layout Description
1312 Syntax char-left-select
1313 \end_layout
1314
1315 \begin_layout Subsection*
1316 LFUN_CHAR_RIGHT
1317 \end_layout
1318
1319 \begin_layout Description
1320 Action Moves the cursor one position "to the right".
1321
1322 \end_layout
1323
1324 \begin_layout Description
1325 Notion This is the action which should be taken when the "right" key is
1326  pressed.
1327  Generally, it moves the cursor one position to the right.
1328  However, in Bidi text this become slightly more complicated, and there
1329  are different modes of cursor movement.
1330  In "visual mode", this moves right, plain and simple.
1331  In "logical mode", movement is logically forward in LTR paragraphs, and
1332  logically backwards in RTL paragraphs.
1333
1334 \end_layout
1335
1336 \begin_layout Description
1337 Syntax char-right
1338 \end_layout
1339
1340 \begin_layout Subsection*
1341 LFUN_CHAR_RIGHT_SELECT
1342 \end_layout
1343
1344 \begin_layout Description
1345 Action Moves the cursor one position "to the right", adding traversed position
1346  to the selection.
1347
1348 \end_layout
1349
1350 \begin_layout Description
1351 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1352
1353 \end_layout
1354
1355 \begin_layout Description
1356 Syntax char-right-select
1357 \end_layout
1358
1359 \begin_layout Subsection*
1360 LFUN_WORD_BACKWARD
1361 \end_layout
1362
1363 \begin_layout Description
1364 Action Moves the cursor to the logically previous beginning of a word.
1365
1366 \end_layout
1367
1368 \begin_layout Description
1369 Notion This is not the action which should be bound to the arrow keys, because
1370  backwards may be left or right, depending on the language.
1371  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1372  which in turn may employ this one.
1373
1374 \end_layout
1375
1376 \begin_layout Description
1377 Syntax word-backward
1378 \end_layout
1379
1380 \begin_layout Subsection*
1381 LFUN_WORD_BACKWARD_SELECT
1382 \end_layout
1383
1384 \begin_layout Description
1385 Action Moves the cursor to the logically previous beginning of a word, adding
1386  the logically traversed text to the selection.
1387
1388 \end_layout
1389
1390 \begin_layout Description
1391 Notion See also LFUN_WORD_BACKWARD.
1392
1393 \end_layout
1394
1395 \begin_layout Description
1396 Syntax word-backward-select
1397 \end_layout
1398
1399 \begin_layout Subsection*
1400 LFUN_WORD_DELETE_BACKWARD
1401 \end_layout
1402
1403 \begin_layout Description
1404 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1405  key).
1406
1407 \end_layout
1408
1409 \begin_layout Description
1410 Syntax word-delete-backward
1411 \end_layout
1412
1413 \begin_layout Subsection*
1414 LFUN_WORD_DELETE_FORWARD
1415 \end_layout
1416
1417 \begin_layout Description
1418 Action Deletes characters to the end of the word (usually the "C+Delete"
1419  key).
1420
1421 \end_layout
1422
1423 \begin_layout Description
1424 Syntax word-delete-forward
1425 \end_layout
1426
1427 \begin_layout Subsection*
1428 LFUN_WORD_FIND_FORWARD
1429 \end_layout
1430
1431 \begin_layout Description
1432 Action Search for a given string in forward direction.
1433
1434 \end_layout
1435
1436 \begin_layout Description
1437 Notion Case sensitive, match words.
1438  If no argument given, last search repeated.
1439
1440 \end_layout
1441
1442 \begin_layout Description
1443 Syntax word-find-forward [<STRING>]
1444 \end_layout
1445
1446 \begin_layout Description
1447 Origin Etienne, 16 Feb 1998
1448 \end_layout
1449
1450 \begin_layout Subsection*
1451 LFUN_WORD_FIND_BACKWARD
1452 \end_layout
1453
1454 \begin_layout Description
1455 Action Search for a given string in backward direction.
1456
1457 \end_layout
1458
1459 \begin_layout Description
1460 Notion Case sensitive, match words.
1461  If no argument given, last search repeated.
1462
1463 \end_layout
1464
1465 \begin_layout Description
1466 Syntax word-find-backward [<STRING>]
1467 \end_layout
1468
1469 \begin_layout Description
1470 Origin Etienne, 20 Feb 1998
1471 \end_layout
1472
1473 \begin_layout Subsection*
1474 LFUN_WORD_FIND
1475 \end_layout
1476
1477 \begin_layout Description
1478 Action Search for next occurence of a string.
1479
1480 \end_layout
1481
1482 \begin_layout Description
1483 Syntax word-find [<DATA>]
1484 \end_layout
1485
1486 \begin_layout Description
1487 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1488  If no parameter is given, search with last find-dialog data is used for
1489  search (i.e.
1490  find-next).
1491
1492 \end_layout
1493
1494 \begin_layout Description
1495 Origin Andre, Jan 7 2004
1496 \end_layout
1497
1498 \begin_layout Subsection*
1499 LFUN_WORD_FIND
1500 \end_layout
1501
1502 \begin_layout Description
1503 Action Replace a string in the document.
1504
1505 \end_layout
1506
1507 \begin_layout Description
1508 Syntax word-replace [<DATA>]
1509 \end_layout
1510
1511 \begin_layout Description
1512 Params <DATA>: data is of the form "<search>
1513 \newline
1514  <replace>
1515 \newline
1516  <casesensitive>
1517  <matchword> <all> <forward>"
1518 \end_layout
1519
1520 \begin_layout Description
1521 Origin Andre, Jan 7 2004
1522 \end_layout
1523
1524 \begin_layout Subsection*
1525 LFUN_WORD_FORWARD
1526 \end_layout
1527
1528 \begin_layout Description
1529 Action Moves the cursor to the logically next beginning of a word.
1530
1531 \end_layout
1532
1533 \begin_layout Description
1534 Notion This is not the action which should be bound to the arrow keys, because
1535  forward may be left or right, depending on the language.
1536  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1537  which in turn may employ this one.
1538
1539 \end_layout
1540
1541 \begin_layout Description
1542 Syntax word-forward
1543 \end_layout
1544
1545 \begin_layout Subsection*
1546 LFUN_WORD_FORWARD_SELECT
1547 \end_layout
1548
1549 \begin_layout Description
1550 Action Moves the cursor to the logically next beginning of a word, adding
1551  the logically traversed text to the selection.
1552
1553 \end_layout
1554
1555 \begin_layout Description
1556 Notion See also LFUN_WORD_FORWARD.
1557
1558 \end_layout
1559
1560 \begin_layout Description
1561 Syntax word-forward-select
1562 \end_layout
1563
1564 \begin_layout Subsection*
1565 LFUN_WORD_LEFT
1566 \end_layout
1567
1568 \begin_layout Description
1569 Action Moves the cursor to the next beginning of a word "on the left".
1570
1571 \end_layout
1572
1573 \begin_layout Description
1574 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1575  key is pressed.
1576  Generally, it moves the cursor to the next beginning of a word on the left.
1577  However, in Bidi text this become slightly more complicated, and there
1578  are different modes of cursor movement.
1579  In "visual mode", this moves left, plain and simple.
1580  In "logical mode", movement is logically forward in RTL paragraphs, and
1581  logically backwards in LTR paragraphs.
1582
1583 \end_layout
1584
1585 \begin_layout Description
1586 Syntax word-left
1587 \end_layout
1588
1589 \begin_layout Description
1590 Origin dov, 28 Oct 2007
1591 \end_layout
1592
1593 \begin_layout Subsection*
1594 LFUN_WORD_LEFT_SELECT
1595 \end_layout
1596
1597 \begin_layout Description
1598 Action Moves the cursor to the next beginning of a word "on the left", adding
1599  *logically* traversed text to the selection.
1600
1601 \end_layout
1602
1603 \begin_layout Description
1604 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1605
1606 \end_layout
1607
1608 \begin_layout Description
1609 Syntax word-left-select
1610 \end_layout
1611
1612 \begin_layout Description
1613 Origin dov, 28 Oct 2007
1614 \end_layout
1615
1616 \begin_layout Subsection*
1617 LFUN_WORD_RIGHT
1618 \end_layout
1619
1620 \begin_layout Description
1621 Action Moves the cursor to the next beginning of a word "on the right".
1622
1623 \end_layout
1624
1625 \begin_layout Description
1626 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1627  key is pressed.
1628  Generally, it moves the cursor to the next beginning of a word on the right.
1629  However, in Bidi text this become slightly more complicated, and there
1630  are different modes of cursor movement.
1631  In "visual mode", this moves right, plain and simple.
1632  In "logical mode", movement is logically forward in LTR paragraphs, and
1633  logically backwards in RTL paragraphs.
1634
1635 \end_layout
1636
1637 \begin_layout Description
1638 Syntax word-right
1639 \end_layout
1640
1641 \begin_layout Description
1642 Origin dov, 28 Oct 2007
1643 \end_layout
1644
1645 \begin_layout Subsection*
1646 LFUN_WORD_RIGHT_SELECT
1647 \end_layout
1648
1649 \begin_layout Description
1650 Action Moves the cursor to the next beginning of a word "on the right",
1651  adding *logically* traversed text to the selection.
1652
1653 \end_layout
1654
1655 \begin_layout Description
1656 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1657
1658 \end_layout
1659
1660 \begin_layout Description
1661 Syntax word-right-select
1662 \end_layout
1663
1664 \begin_layout Description
1665 Origin dov, 28 Oct 2007
1666 \end_layout
1667
1668 \begin_layout Subsection*
1669 LFUN_WORD_SELECT
1670 \end_layout
1671
1672 \begin_layout Description
1673 Action Puts the word where the cursor stands into the selection.
1674
1675 \end_layout
1676
1677 \begin_layout Description
1678 Syntax word-select
1679 \end_layout
1680
1681 \begin_layout Description
1682 Origin Andre, 11 Sep 2002
1683 \end_layout
1684
1685 \begin_layout Subsection*
1686 LFUN_WORD_CAPITALIZE
1687 \end_layout
1688
1689 \begin_layout Description
1690 Action Capitalizes the words in the selection (i.e.
1691  the first letters) or the letter on the cursor position.
1692
1693 \end_layout
1694
1695 \begin_layout Description
1696 Syntax word-capitalize
1697 \end_layout
1698
1699 \begin_layout Subsection*
1700 LFUN_WORD_UPCASE
1701 \end_layout
1702
1703 \begin_layout Description
1704 Action Change the words in the selection or from the cursor position to
1705  the end of word to the upper case.
1706
1707 \end_layout
1708
1709 \begin_layout Description
1710 Syntax word-upcase
1711 \end_layout
1712
1713 \begin_layout Subsection*
1714 LFUN_WORD_LOWCASE
1715 \end_layout
1716
1717 \begin_layout Description
1718 Action Change the words in the selection or from the cursor position to
1719  the end of word to the lower case.
1720
1721 \end_layout
1722
1723 \begin_layout Description
1724 Syntax word-lowcase
1725 \end_layout
1726
1727 \begin_layout Subsection*
1728 LFUN_THESAURUS_ENTRY
1729 \end_layout
1730
1731 \begin_layout Description
1732 Action Look up thesaurus entries with respect to the word under the cursor.
1733
1734 \end_layout
1735
1736 \begin_layout Description
1737 Syntax thesaurus-entry
1738 \end_layout
1739
1740 \begin_layout Description
1741 Origin Levon, 20 Jul 2001
1742 \end_layout
1743
1744 \begin_layout Subsection*
1745 LFUN_BUFFER_BEGIN
1746 \end_layout
1747
1748 \begin_layout Description
1749 Action Move the cursor to the beginning of the document.
1750
1751 \end_layout
1752
1753 \begin_layout Description
1754 Syntax buffer-begin
1755 \end_layout
1756
1757 \begin_layout Subsection*
1758 LFUN_BUFFER_BEGIN_SELECT
1759 \end_layout
1760
1761 \begin_layout Description
1762 Action Move the cursor to the beginning of the document adding the traversed
1763  text to the selection.
1764
1765 \end_layout
1766
1767 \begin_layout Description
1768 Syntax buffer-begin-select
1769 \end_layout
1770
1771 \begin_layout Subsection*
1772 LFUN_BUFFER_END
1773 \end_layout
1774
1775 \begin_layout Description
1776 Action Move the cursor to the end of the document.
1777
1778 \end_layout
1779
1780 \begin_layout Description
1781 Syntax buffer-end
1782 \end_layout
1783
1784 \begin_layout Subsection*
1785 LFUN_BUFFER_END_SELECT
1786 \end_layout
1787
1788 \begin_layout Description
1789 Action Move the cursor to the end of the document adding the traversed text
1790  to the selection.
1791
1792 \end_layout
1793
1794 \begin_layout Description
1795 Syntax buffer-end-select
1796 \end_layout
1797
1798 \begin_layout Subsection*
1799 LFUN_LINE_BEGIN
1800 \end_layout
1801
1802 \begin_layout Description
1803 Action Move the cursor to the begining of the (screen) line.
1804
1805 \end_layout
1806
1807 \begin_layout Description
1808 Syntax line-begin
1809 \end_layout
1810
1811 \begin_layout Subsection*
1812 LFUN_LINE_BEGIN_SELECT
1813 \end_layout
1814
1815 \begin_layout Description
1816 Action Move the cursor to the beginning of the (screen) line adding the
1817  traversed text to the selection.
1818
1819 \end_layout
1820
1821 \begin_layout Description
1822 Syntax line-begin-select
1823 \end_layout
1824
1825 \begin_layout Subsection*
1826 LFUN_LINE_END
1827 \end_layout
1828
1829 \begin_layout Description
1830 Action Move the cursor to the end of the (screen) line.
1831
1832 \end_layout
1833
1834 \begin_layout Description
1835 Syntax line-end
1836 \end_layout
1837
1838 \begin_layout Subsection*
1839 LFUN_LINE_END_SELECT
1840 \end_layout
1841
1842 \begin_layout Description
1843 Action Move the cursor to the end of the (screen) line adding the traversed
1844  text to the selection.
1845
1846 \end_layout
1847
1848 \begin_layout Description
1849 Syntax line-end-select
1850 \end_layout
1851
1852 \begin_layout Subsection*
1853 LFUN_LINE_DELETE
1854 \end_layout
1855
1856 \begin_layout Description
1857 Action Deletes the letters to the end of the (screen) line or deletes the
1858  selection.
1859
1860 \end_layout
1861
1862 \begin_layout Description
1863 Syntax line-delete-forward
1864 \end_layout
1865
1866 \begin_layout Subsection*
1867 LFUN_COPY
1868 \end_layout
1869
1870 \begin_layout Description
1871 Action Copies to the clipboard the last edit.
1872
1873 \end_layout
1874
1875 \begin_layout Description
1876 Syntax copy
1877 \end_layout
1878
1879 \begin_layout Subsection*
1880 LFUN_CUT
1881 \end_layout
1882
1883 \begin_layout Description
1884 Action Cuts to the clipboard.
1885
1886 \end_layout
1887
1888 \begin_layout Description
1889 Syntax cut
1890 \end_layout
1891
1892 \begin_layout Subsection*
1893 LFUN_PASTE
1894 \end_layout
1895
1896 \begin_layout Description
1897 Action Pastes material from the active clipboard.
1898
1899 \end_layout
1900
1901 \begin_layout Description
1902 Syntax paste [<TYPE>]
1903 \end_layout
1904
1905 \begin_layout Description
1906 Params <TYPE>: pdf|png|jpeg|linkback
1907 \end_layout
1908
1909 \begin_layout Subsection*
1910 LFUN_CLIPBOARD_PASTE
1911 \end_layout
1912
1913 \begin_layout Description
1914 Action Pastes text from the active clipboard.
1915
1916 \end_layout
1917
1918 \begin_layout Description
1919 Syntax clipboard-paste [<ARG>]
1920 \end_layout
1921
1922 \begin_layout Description
1923 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1924  "Join lines".
1925
1926 \end_layout
1927
1928 \begin_layout Description
1929 Origin baum, 10 Jul 2006
1930 \end_layout
1931
1932 \begin_layout Subsection*
1933 LFUN_PRIMARY_SELECTION_PASTE
1934 \end_layout
1935
1936 \begin_layout Description
1937 Action Pastes the currently text selected text.
1938
1939 \end_layout
1940
1941 \begin_layout Description
1942 Notion Primary selection mechanism is linux-only thing.
1943
1944 \end_layout
1945
1946 \begin_layout Description
1947 Syntax primary-selection-paste [<ARG>]
1948 \end_layout
1949
1950 \begin_layout Description
1951 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
1952  "Join lines".
1953
1954 \end_layout
1955
1956 \begin_layout Subsection*
1957 LFUN_UNDO
1958 \end_layout
1959
1960 \begin_layout Description
1961 Action Undoes the last edit.
1962
1963 \end_layout
1964
1965 \begin_layout Description
1966 Syntax undo
1967 \end_layout
1968
1969 \begin_layout Subsection*
1970 LFUN_REDO
1971 \end_layout
1972
1973 \begin_layout Description
1974 Action Redoes the last thing undone.
1975
1976 \end_layout
1977
1978 \begin_layout Description
1979 Syntax redo
1980 \end_layout
1981
1982 \begin_layout Subsection*
1983 LFUN_REPEAT
1984 \end_layout
1985
1986 \begin_layout Description
1987 Action Repeat the given command.
1988
1989 \end_layout
1990
1991 \begin_layout Description
1992 Syntax repeat <COUNT> <LFUN-COMMAND>
1993 \end_layout
1994
1995 \begin_layout Description
1996 Origin Andre, , 27 Oct 2003
1997 \end_layout
1998
1999 \begin_layout Subsection*
2000 LFUN_CHARS_TRANSPOSE
2001 \end_layout
2002
2003 \begin_layout Description
2004 Action Transposes the character at the cursor with the one before it.
2005
2006 \end_layout
2007
2008 \begin_layout Description
2009 Syntax chars-transpose
2010 \end_layout
2011
2012 \begin_layout Description
2013 Origin Lgb, 25 Apr 2001
2014 \end_layout
2015
2016 \begin_layout Subsection*
2017 LFUN_DEPTH_DECREMENT
2018 \end_layout
2019
2020 \begin_layout Description
2021 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2022  lists.
2023
2024 \end_layout
2025
2026 \begin_layout Description
2027 Syntax depth-decrement
2028 \end_layout
2029
2030 \begin_layout Subsection*
2031 LFUN_DEPTH_INCREMENT
2032 \end_layout
2033
2034 \begin_layout Description
2035 Action Increase the nesting depth of the (selected) paragraph(s) inside
2036  lists.
2037
2038 \end_layout
2039
2040 \begin_layout Description
2041 Syntax depth-increment
2042 \end_layout
2043
2044 \begin_layout Subsection*
2045 LFUN_FONT_BOLD
2046 \end_layout
2047
2048 \begin_layout Description
2049 Action Toggles the bold font (selection-wise).
2050
2051 \end_layout
2052
2053 \begin_layout Description
2054 Syntax font-bold
2055 \end_layout
2056
2057 \begin_layout Subsection*
2058 LFUN_FONT_TYPEWRITER
2059 \end_layout
2060
2061 \begin_layout Description
2062 Action Toggles the typewriter family font (selection-wise).
2063
2064 \end_layout
2065
2066 \begin_layout Description
2067 Syntax font-typewriter
2068 \end_layout
2069
2070 \begin_layout Subsection*
2071 LFUN_FONT_UNDERLINE
2072 \end_layout
2073
2074 \begin_layout Description
2075 Action Toggles underline in the font (selection-wise).
2076
2077 \end_layout
2078
2079 \begin_layout Description
2080 Syntax font-underline
2081 \end_layout
2082
2083 \begin_layout Subsection*
2084 LFUN_FONT_EMPH
2085 \end_layout
2086
2087 \begin_layout Description
2088 Action Toggles the emphasis font style (selection-wise).
2089
2090 \end_layout
2091
2092 \begin_layout Description
2093 Syntax font-emph
2094 \end_layout
2095
2096 \begin_layout Subsection*
2097 LFUN_FONT_NOUN
2098 \end_layout
2099
2100 \begin_layout Description
2101 Action Toggles Noun text style font (selection-wise).
2102
2103 \end_layout
2104
2105 \begin_layout Description
2106 Syntax font-noun
2107 \end_layout
2108
2109 \begin_layout Subsection*
2110 LFUN_FONT_ROMAN
2111 \end_layout
2112
2113 \begin_layout Description
2114 Action Toggles Roman family font (selection-wise).
2115
2116 \end_layout
2117
2118 \begin_layout Description
2119 Syntax font-roman
2120 \end_layout
2121
2122 \begin_layout Subsection*
2123 LFUN_FONT_SANS
2124 \end_layout
2125
2126 \begin_layout Description
2127 Action Toggles Sans Serif family font (selection-wise).
2128
2129 \end_layout
2130
2131 \begin_layout Description
2132 Syntax font-sans
2133 \end_layout
2134
2135 \begin_layout Subsection*
2136 LFUN_FONT_FRAK
2137 \end_layout
2138
2139 \begin_layout Description
2140 Action Toggles Fraktur family font (math-mode, selection-wise).
2141
2142 \end_layout
2143
2144 \begin_layout Description
2145 Syntax font-frak
2146 \end_layout
2147
2148 \begin_layout Description
2149 Origin vermeer, 10 Jan 2002
2150 \end_layout
2151
2152 \begin_layout Subsection*
2153 LFUN_FONT_ITAL
2154 \end_layout
2155
2156 \begin_layout Description
2157 Action Toggles Italics font shape (math-mode, selection-wise).
2158
2159 \end_layout
2160
2161 \begin_layout Description
2162 Syntax font-ital
2163 \end_layout
2164
2165 \begin_layout Description
2166 Origin vermeer, 10 Jan 2002
2167 \end_layout
2168
2169 \begin_layout Subsection*
2170 LFUN_FONT_DEFAULT
2171 \end_layout
2172
2173 \begin_layout Description
2174 Action Reverts the settings of the font to the default values (selection-wise).
2175
2176 \end_layout
2177
2178 \begin_layout Description
2179 Syntax font-default
2180 \end_layout
2181
2182 \begin_layout Subsection*
2183 LFUN_FONT_SIZE
2184 \end_layout
2185
2186 \begin_layout Description
2187 Action Sets font size according to lyx format string.
2188
2189 \end_layout
2190
2191 \begin_layout Description
2192 Syntax font-size <SIZE>
2193 \end_layout
2194
2195 \begin_layout Description
2196 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2197 \newline
2198
2199  largest|huge|giant|increase|decrease|default
2200 \end_layout
2201
2202 \begin_layout Subsection*
2203 LFUN_TEXTSTYLE_APPLY
2204 \end_layout
2205
2206 \begin_layout Description
2207 Action Toggle user-defined (=last-time used) text style.
2208
2209 \end_layout
2210
2211 \begin_layout Description
2212 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2213  trigerred when using Text Style dialog.
2214
2215 \end_layout
2216
2217 \begin_layout Description
2218 Syntax textstyle-apply
2219 \end_layout
2220
2221 \begin_layout Description
2222 Origin leeming, 12 Mar 2003
2223 \end_layout
2224
2225 \begin_layout Subsection*
2226 LFUN_TEXTSTYLE_UPDATE
2227 \end_layout
2228
2229 \begin_layout Description
2230 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2231 LY.
2232
2233 \end_layout
2234
2235 \begin_layout Description
2236 Syntax textstyle-update <FONT_INFO>
2237 \end_layout
2238
2239 \begin_layout Description
2240 Params <FONT_INFO>: specifies font atributes, e.g.
2241  family, series, shape, size, emph, noun, underbar, number, color, language,
2242  toggleall.
2243
2244 \newline
2245  Use lyx -dbg action for exact syntax of text-style dialog parameters.
2246
2247 \end_layout
2248
2249 \begin_layout Description
2250 Origin leeming, 12 Mar 2003
2251 \end_layout
2252
2253 \begin_layout Subsection*
2254 LFUN_SCREEN_FONT_UPDATE
2255 \end_layout
2256
2257 \begin_layout Description
2258 Action Update fonts and its metrics.
2259
2260 \end_layout
2261
2262 \begin_layout Description
2263 Notion Automatically called after zoom, dpi, font names, or norm change.
2264
2265 \end_layout
2266
2267 \begin_layout Description
2268 Syntax screen-font-update
2269 \end_layout
2270
2271 \begin_layout Description
2272 Origin ARRae, 13 Aug 2000
2273 \end_layout
2274
2275 \begin_layout Subsection*
2276 LFUN_FONT_STATE
2277 \end_layout
2278
2279 \begin_layout Description
2280 Action Returns the info about the current font.
2281
2282 \end_layout
2283
2284 \begin_layout Description
2285 Syntax font-state
2286 \end_layout
2287
2288 \begin_layout Subsection*
2289 LFUN_CITATION_INSERT
2290 \end_layout
2291
2292 \begin_layout Description
2293 Action Inserts citation from loaded citation database.
2294
2295 \end_layout
2296
2297 \begin_layout Description
2298 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2299 \end_layout
2300
2301 \begin_layout Description
2302 Params <KEY>: Citation (shortcut listed in available citations).
2303
2304 \newline
2305  <TEXT_BEFORE>: text which should appear before citation.
2306
2307 \end_layout
2308
2309 \begin_layout Description
2310 Origin AAS, 97-02-23
2311 \end_layout
2312
2313 \begin_layout Subsection*
2314 LFUN_BIBTEX_DATABASE_ADD
2315 \end_layout
2316
2317 \begin_layout Description
2318 Action Adds database, which will be used for bibtex citations.
2319
2320 \end_layout
2321
2322 \begin_layout Description
2323 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2324  bibliography) found from the cursor postion.
2325
2326 \end_layout
2327
2328 \begin_layout Description
2329 Syntax bibtex-database-add <DATABASE-NAME>
2330 \end_layout
2331
2332 \begin_layout Description
2333 Origin Ale, 30 May 1997
2334 \end_layout
2335
2336 \begin_layout Subsection*
2337 LFUN_BIBTEX_DATABASE_DEL
2338 \end_layout
2339
2340 \begin_layout Description
2341 Action Adds database, which will be used for bibtex citations.
2342
2343 \end_layout
2344
2345 \begin_layout Description
2346 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2347 X bibliography) found from the cursor postion.
2348
2349 \end_layout
2350
2351 \begin_layout Description
2352 Syntax bibtex-database-del <DATABASE-NAME>
2353 \end_layout
2354
2355 \begin_layout Description
2356 Origin Ale, 30 May 1997
2357 \end_layout
2358
2359 \begin_layout Subsection*
2360 LFUN_LAYOUT
2361 \end_layout
2362
2363 \begin_layout Description
2364 Action Sets the layout (that is, environment) for the current paragraph.
2365
2366 \end_layout
2367
2368 \begin_layout Description
2369 Syntax layout <LAYOUT>
2370 \end_layout
2371
2372 \begin_layout Description
2373 Params <LAYOUT>: the layout to use
2374 \end_layout
2375
2376 \begin_layout Subsection*
2377 LFUN_LAYOUT_PARAGRAPH
2378 \end_layout
2379
2380 \begin_layout Description
2381 Action Launches the paragraph settings dialog.
2382
2383 \end_layout
2384
2385 \begin_layout Description
2386 Syntax layout-paragraph
2387 \end_layout
2388
2389 \begin_layout Subsection*
2390 LFUN_LAYOUT_TABULAR
2391 \end_layout
2392
2393 \begin_layout Description
2394 Action Launches the tabular settings dialog.
2395
2396 \end_layout
2397
2398 \begin_layout Description
2399 Syntax layout-tabular
2400 \end_layout
2401
2402 \begin_layout Description
2403 Origin Jug, 31 Jul 2000
2404 \end_layout
2405
2406 \begin_layout Subsection*
2407 LFUN_DROP_LAYOUTS_CHOICE
2408 \end_layout
2409
2410 \begin_layout Description
2411 Action Displays list of layout choices.
2412
2413 \end_layout
2414
2415 \begin_layout Description
2416 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2417  allowing for choice of layout.
2418
2419 \end_layout
2420
2421 \begin_layout Description
2422 Syntax drop-layouts-choice
2423 \end_layout
2424
2425 \begin_layout Subsection*
2426 LFUN_LAYOUT_MODULES_CLEAR
2427 \end_layout
2428
2429 \begin_layout Description
2430 Action Clears the module list.
2431
2432 \end_layout
2433
2434 \begin_layout Description
2435 Notion Clears the list of included modules for the current buffer.
2436
2437 \end_layout
2438
2439 \begin_layout Description
2440 Syntax layout-modules-clear
2441 \end_layout
2442
2443 \begin_layout Description
2444 Origin rgh, 25 August 2007
2445 \end_layout
2446
2447 \begin_layout Subsection*
2448 LFUN_LAYOUT_MODULE_ADD
2449 \end_layout
2450
2451 \begin_layout Description
2452 Action Adds a module.
2453
2454 \end_layout
2455
2456 \begin_layout Description
2457 Notion Adds a module to the list of included modules for the current buffer.
2458
2459 \end_layout
2460
2461 \begin_layout Description
2462 Syntax layout-module-add <MODULE>
2463 \end_layout
2464
2465 \begin_layout Description
2466 Params <MODULE>: the module to be added
2467 \end_layout
2468
2469 \begin_layout Description
2470 Origin rgh, 25 August 2007
2471 \end_layout
2472
2473 \begin_layout Subsection*
2474 LFUN_LAYOUT_RELOAD
2475 \end_layout
2476
2477 \begin_layout Description
2478 Action Reloads layout information.
2479
2480 \end_layout
2481
2482 \begin_layout Description
2483 Notion Reloads all layout information for the current buffer from disk,
2484  thus recognizing any changes that have been made to layout files on the
2485  fly.
2486  This is intended to be used only by layout developers and should not be
2487  used when one is trying to do actual work.
2488
2489 \end_layout
2490
2491 \begin_layout Description
2492 Syntax layout-reload
2493 \end_layout
2494
2495 \begin_layout Description
2496 Origin rgh, 3 September 2007
2497 \end_layout
2498
2499 \begin_layout Subsection*
2500 LFUN_TEXTCLASS_APPLY
2501 \end_layout
2502
2503 \begin_layout Description
2504 Action Sets the text class for the current buffer.
2505
2506 \end_layout
2507
2508 \begin_layout Description
2509 Syntax textclass-apply <TEXTCLASS>
2510 \end_layout
2511
2512 \begin_layout Description
2513 Params <TEXTCLASS>: the textclass to set.
2514  Note that this must be the filename, minus the ".layout" extension.
2515
2516 \end_layout
2517
2518 \begin_layout Subsection*
2519 LFUN_TEXTCLASS_LOAD
2520 \end_layout
2521
2522 \begin_layout Description
2523 Action Loads information for a textclass from disk.
2524
2525 \end_layout
2526
2527 \begin_layout Description
2528 Syntax textclass-load <TEXTCLASS>
2529 \end_layout
2530
2531 \begin_layout Description
2532 Params <TEXTCLASS>: the textclass to load.
2533  Note that this must be the filename, minus the ".layout" extension.
2534
2535 \end_layout
2536
2537 \begin_layout Subsection*
2538 LFUN_MARK_OFF
2539 \end_layout
2540
2541 \begin_layout Description
2542 Action Disable selecting of text-region.
2543
2544 \end_layout
2545
2546 \begin_layout Description
2547 Syntax mark-off
2548 \end_layout
2549
2550 \begin_layout Subsection*
2551 LFUN_MARK_ON
2552 \end_layout
2553
2554 \begin_layout Description
2555 Action Enable selecting of text-region.
2556
2557 \end_layout
2558
2559 \begin_layout Description
2560 Notion After enabling you can simply move arrow keys to get selected region.
2561
2562 \end_layout
2563
2564 \begin_layout Description
2565 Syntax mark-on
2566 \end_layout
2567
2568 \begin_layout Subsection*
2569 LFUN_MARK_TOGGLE
2570 \end_layout
2571
2572 \begin_layout Description
2573 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2574
2575 \end_layout
2576
2577 \begin_layout Description
2578 Syntax mark-toggle
2579 \end_layout
2580
2581 \begin_layout Description
2582 Origin Andre, May 5 2006
2583 \end_layout
2584
2585 \begin_layout Subsection*
2586 LFUN_MATH_DELIM
2587 \end_layout
2588
2589 \begin_layout Description
2590 Action Inserts math delimiters (e.g.
2591  parentheses, brackets) enclosing expression.
2592
2593 \end_layout
2594
2595 \begin_layout Description
2596 Syntax math-delim [<LEFT>] [<RIGHT>]
2597 \end_layout
2598
2599 \begin_layout Description
2600 Params <LEFT/RIGHT>: Delimiters to be used.
2601  Each delimiter can be specified by either a LaTeX name or a valid character.
2602  ( is the default letter.
2603
2604 \end_layout
2605
2606 \begin_layout Description
2607 Sample math-delim { rangle
2608 \end_layout
2609
2610 \begin_layout Description
2611 Origin Alejandro, 18 Jun 1996
2612 \end_layout
2613
2614 \begin_layout Subsection*
2615 LFUN_MATH_BIGDELIM
2616 \end_layout
2617
2618 \begin_layout Description
2619 Action Inserts math fixed size delimiters (e.g.
2620  parentheses, brackets) enclosing expression.
2621
2622 \end_layout
2623
2624 \begin_layout Description
2625 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2626 \end_layout
2627
2628 \begin_layout Description
2629 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2630 \newline
2631  <L/RDELIM>: TeX code for
2632  delimiter.
2633  See Delimiter dialog for delimiters to be used.
2634
2635 \end_layout
2636
2637 \begin_layout Description
2638 Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
2639 \end_layout
2640
2641 \begin_layout Description
2642 Origin Enrico & Georg, 7 May 2006
2643 \end_layout
2644
2645 \begin_layout Subsection*
2646 LFUN_MATH_DISPLAY
2647 \end_layout
2648
2649 \begin_layout Description
2650 Action Creates a new displayed equation in text mode.
2651  Toggles inlined/display formula in math mode.
2652
2653 \end_layout
2654
2655 \begin_layout Description
2656 Syntax math-display [<ARG>]
2657 \end_layout
2658
2659 \begin_layout Description
2660 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2661  new equation from the text mode.
2662
2663 \end_layout
2664
2665 \begin_layout Description
2666 Origin Alejandro, 18 Jun 1996
2667 \end_layout
2668
2669 \begin_layout Subsection*
2670 LFUN_MATH_INSERT
2671 \end_layout
2672
2673 \begin_layout Description
2674 Action Inserts math objects and symbols.
2675
2676 \end_layout
2677
2678 \begin_layout Description
2679 Syntax math-insert <ARG>
2680 \end_layout
2681
2682 \begin_layout Description
2683 Params <ARG>: Symbol or LaTeX code to be inserted.
2684
2685 \end_layout
2686
2687 \begin_layout Subsection*
2688 LFUN_MATH_SUBSCRIPT
2689 \end_layout
2690
2691 \begin_layout Description
2692 Action Enters subscript expression in math expression.
2693
2694 \end_layout
2695
2696 \begin_layout Description
2697 Syntax math-subscript
2698 \end_layout
2699
2700 \begin_layout Description
2701 Origin vermeer, 12 Dec 2001
2702 \end_layout
2703
2704 \begin_layout Subsection*
2705 LFUN_MATH_SUPERSCRIPT
2706 \end_layout
2707
2708 \begin_layout Description
2709 Action Enters subscript expression in math expression.
2710
2711 \end_layout
2712
2713 \begin_layout Description
2714 Syntax math-superscript
2715 \end_layout
2716
2717 \begin_layout Description
2718 Origin vermeer, 12 Dec 2001
2719 \end_layout
2720
2721 \begin_layout Subsection*
2722 LFUN_MATH_LIMITS
2723 \end_layout
2724
2725 \begin_layout Description
2726 Action Toggles the position of the limits from above/below to the right
2727  side an vice versa in integral symbol, a limit, a summation, etc.
2728
2729 \end_layout
2730
2731 \begin_layout Description
2732 Notion Put the cursor before the symbol with the limits and then invoke
2733  math-limits.
2734
2735 \end_layout
2736
2737 \begin_layout Description
2738 Syntax math-limits [<STATE>]
2739 \end_layout
2740
2741 \begin_layout Description
2742 Params <STATE>: limits|nolimits
2743 \end_layout
2744
2745 \begin_layout Subsection*
2746 LFUN_MATH_MACRO
2747 \end_layout
2748
2749 \begin_layout Description
2750 Action Inserts a math macro definition at the cursor position in the text.
2751
2752 \end_layout
2753
2754 \begin_layout Description
2755 Syntax math-macro <NAME> [<NARGS>] [def]
2756 \end_layout
2757
2758 \begin_layout Description
2759 Params <NAME>: The name of the macro, e.g.
2760  "mymacro".
2761  <NARGS>: The number of parameters of the macro.
2762  Default is 0.
2763  "def": Has no effect anymore, just for compatibility with former LyX versions.
2764
2765 \end_layout
2766
2767 \begin_layout Description
2768 Origin ale, 10 May 1997;  sts, 21 Dec 2007
2769 \end_layout
2770
2771 \begin_layout Subsection*
2772 LFUN_MATH_MUTATE
2773 \end_layout
2774
2775 \begin_layout Description
2776 Action Mutates the type of math inset to the newly selected one.
2777
2778 \end_layout
2779
2780 \begin_layout Description
2781 Syntax math-mutate <TYPE>
2782 \end_layout
2783
2784 \begin_layout Description
2785 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2786  multline|gather|flalign
2787 \end_layout
2788
2789 \begin_layout Description
2790 Origin Andre, 23 May 2001
2791 \end_layout
2792
2793 \begin_layout Subsection*
2794 LFUN_MATH_SPACE
2795 \end_layout
2796
2797 \begin_layout Description
2798 Action Inserts space into math expression.
2799
2800 \end_layout
2801
2802 \begin_layout Description
2803 Notion Use spacebar after entering this space to change type of space.
2804
2805 \end_layout
2806
2807 \begin_layout Description
2808 Syntax math-space [<TYPE>]
2809 \end_layout
2810
2811 \begin_layout Description
2812 Params <TYPE>: negative spaces: !|negmedspace|negthickspace
2813 \newline
2814  positive spaces:
2815  ,|:|;|quad|qquad
2816 \newline
2817  "," used by default.
2818
2819 \end_layout
2820
2821 \begin_layout Description
2822 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2823 \end_layout
2824
2825 \begin_layout Subsection*
2826 LFUN_MATH_MATRIX
2827 \end_layout
2828
2829 \begin_layout Description
2830 Action Inserts a matrix.
2831
2832 \end_layout
2833
2834 \begin_layout Description
2835 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2836 \end_layout
2837
2838 \begin_layout Description
2839 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
2840  c or t) (i.e.
2841  1 char) and the horizontal alignments (l, c or r) (i.e.
2842  <COL> chars).
2843
2844 \end_layout
2845
2846 \begin_layout Description
2847 Sample math-matrix 3 3 bccc
2848 \end_layout
2849
2850 \begin_layout Subsection*
2851 LFUN_MATH_MODE
2852 \end_layout
2853
2854 \begin_layout Description
2855 Action In text mode enters math mode (i.e.
2856  puts math insets on the current cursor position), in math mode enters text
2857  mode inside math expression.
2858
2859 \end_layout
2860
2861 \begin_layout Description
2862 Notion If there is some selected text, it puts the text inside created math
2863  box.
2864
2865 \end_layout
2866
2867 \begin_layout Description
2868 Syntax math-mode [<ARG>]
2869 \end_layout
2870
2871 \begin_layout Description
2872 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
2873  .
2874
2875 \end_layout
2876
2877 \begin_layout Description
2878 Origin Alejandro, 4 Jun 1996
2879 \end_layout
2880
2881 \begin_layout Subsection*
2882 LFUN_MATH_NUMBER_LINE_TOGGLE
2883 \end_layout
2884
2885 \begin_layout Description
2886 Action Toggles numbering of the current formula line.
2887
2888 \end_layout
2889
2890 \begin_layout Description
2891 Notion Must be in display formula mode.
2892
2893 \end_layout
2894
2895 \begin_layout Description
2896 Syntax math-number-line-toggle
2897 \end_layout
2898
2899 \begin_layout Description
2900 Origin Alejandro, 18 Jun 1996
2901 \end_layout
2902
2903 \begin_layout Subsection*
2904 LFUN_MATH_NUMBER_TOGGLE
2905 \end_layout
2906
2907 \begin_layout Description
2908 Action Toggles numbering/labeling of the current formula.
2909
2910 \end_layout
2911
2912 \begin_layout Description
2913 Notion Must be in display formula mode.
2914
2915 \end_layout
2916
2917 \begin_layout Description
2918 Syntax math-number-toggle
2919 \end_layout
2920
2921 \begin_layout Description
2922 Origin Alejandro, 4 Jun 1996
2923 \end_layout
2924
2925 \begin_layout Subsection*
2926 LFUN_MATH_EXTERN
2927 \end_layout
2928
2929 \begin_layout Description
2930 Action Calls external program and passes the current expression/equation
2931  as an argument for the calculation in the format appropriate to the given
2932  language.
2933
2934 \end_layout
2935
2936 \begin_layout Description
2937 Notion Selection can be used to determine the input for the external program.
2938
2939 \end_layout
2940
2941 \begin_layout Description
2942 Syntax math-extern <LANG> [<COMMAND>]
2943 \end_layout
2944
2945 \begin_layout Description
2946 Params <LANG>: octave|maxima|maple|mathematica|script
2947 \newline
2948  where "script" stands
2949  fot the external script (normalized expression will be passed)
2950 \end_layout
2951
2952 \begin_layout Description
2953 Origin Andre, 24 Apr 2001
2954 \end_layout
2955
2956 \begin_layout Description
2957 Sample math-extern maple simplify
2958 \end_layout
2959
2960 \begin_layout Subsection*
2961 LFUN_MATH_SIZE
2962 \end_layout
2963
2964 \begin_layout Description
2965 Action Changes arbitrarily the size used by math fonts inside a context.
2966
2967 \end_layout
2968
2969 \begin_layout Description
2970 Notion Provides an interface to the LaTeX math mode font size commands.
2971
2972 \end_layout
2973
2974 \begin_layout Description
2975 Syntax math-size <STYLE>
2976 \end_layout
2977
2978 \begin_layout Description
2979 Params <STYLE>: displaystyle|
2980 \backslash
2981 textstyle|
2982 \backslash
2983 scriptstyle|
2984 \backslash
2985 scriptscriptstyle
2986 \end_layout
2987
2988 \begin_layout Description
2989 Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
2990 \end_layout
2991
2992 \begin_layout Subsection*
2993 LFUN_MATH_MACRO_UNFOLD
2994 \end_layout
2995
2996 \begin_layout Description
2997 Action Unfold a Math Macro.
2998
2999 \end_layout
3000
3001 \begin_layout Description
3002 Notion Unfold the Math Macro the cursor is in, i.e.
3003  display it as foo.
3004
3005 \end_layout
3006
3007 \begin_layout Description
3008 Syntax math-macro-unfold
3009 \end_layout
3010
3011 \begin_layout Description
3012 Origin sts, 06 January 2008
3013 \end_layout
3014
3015 \begin_layout Subsection*
3016 LFUN_MATH_MACRO_FOLD
3017 \end_layout
3018
3019 \begin_layout Description
3020 Action Fold a Math Macro.
3021
3022 \end_layout
3023
3024 \begin_layout Description
3025 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3026  displayed as foo before.
3027
3028 \end_layout
3029
3030 \begin_layout Description
3031 Syntax math-macro-fold
3032 \end_layout
3033
3034 \begin_layout Description
3035 Origin sts, 06 January 2008
3036 \end_layout
3037
3038 \begin_layout Subsection*
3039 LFUN_MATH_MACRO_ADD_PARAM
3040 \end_layout
3041
3042 \begin_layout Description
3043 Action Add a parameter.
3044
3045 \end_layout
3046
3047 \begin_layout Description
3048 Notion Add a parameter to a Math Macro.
3049
3050 \end_layout
3051
3052 \begin_layout Description
3053 Params <NUM>: The number of the parameter behind which the new one will
3054  be added (1 for the first, i.e.
3055  use 0 for add a parameter at the left), defaults to the last one.
3056
3057 \end_layout
3058
3059 \begin_layout Description
3060 Syntax math-macro-add-param <NUM>
3061 \end_layout
3062
3063 \begin_layout Description
3064 Origin sts, 06 January 2008
3065 \end_layout
3066
3067 \begin_layout Subsection*
3068 LFUN_MATH_MACRO_REMOVE_PARAM
3069 \end_layout
3070
3071 \begin_layout Description
3072 Action Remove the last parameter.
3073
3074 \end_layout
3075
3076 \begin_layout Description
3077 Notion Remove the last parameter of a Math Macro and remove its value in
3078  all instances of the macro in the buffer.
3079
3080 \end_layout
3081
3082 \begin_layout Description
3083 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3084  defaults to the last one.
3085
3086 \end_layout
3087
3088 \begin_layout Description
3089 Syntax math-macro-remove-param <NUM>
3090 \end_layout
3091
3092 \begin_layout Description
3093 Origin sts, 06 January 2008
3094 \end_layout
3095
3096 \begin_layout Subsection*
3097 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3098 \end_layout
3099
3100 \begin_layout Description
3101 Action Append a greedy parameter.
3102
3103 \end_layout
3104
3105 \begin_layout Description
3106 Notion Append a greedy parameter to a Math Macro which eats the following
3107  mathed cell in every instance of the macro in the buffer.
3108
3109 \end_layout
3110
3111 \begin_layout Description
3112 Syntax math-macro-append-greedy-param
3113 \end_layout
3114
3115 \begin_layout Description
3116 Origin sts, 06 January 2008
3117 \end_layout
3118
3119 \begin_layout Subsection*
3120 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3121 \end_layout
3122
3123 \begin_layout Description
3124 Action Remove a greedy parameter.
3125
3126 \end_layout
3127
3128 \begin_layout Description
3129 Notion Remove a greedy parameter of a Math Macro and spit out the values
3130  of it in every instance of the macro in the buffer.
3131  If it is an optional parameter the [valud] format is used.
3132
3133 \end_layout
3134
3135 \begin_layout Description
3136 Syntax math-macro-remove-greedy-param
3137 \end_layout
3138
3139 \begin_layout Description
3140 Origin sts, 06 January 2008
3141 \end_layout
3142
3143 \begin_layout Subsection*
3144 LFUN_MATH_MACRO_MAKE_OPTIONAL
3145 \end_layout
3146
3147 \begin_layout Description
3148 Action Make a parameter optional.
3149
3150 \end_layout
3151
3152 \begin_layout Description
3153 Notion Turn the first non-optional parameter of a Math Macro into an optional
3154  parameter with a default value.
3155
3156 \end_layout
3157
3158 \begin_layout Description
3159 Syntax math-macro-make-optional
3160 \end_layout
3161
3162 \begin_layout Description
3163 Origin sts, 06 January 2008
3164 \end_layout
3165
3166 \begin_layout Subsection*
3167 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3168 \end_layout
3169
3170 \begin_layout Description
3171 Action Make a parameter non-optional.
3172
3173 \end_layout
3174
3175 \begin_layout Description
3176 Notion Turn the last optional parameter of a Math Macro into a non-optional
3177  parameter.
3178  The default value is remembered to be reused later if the user changes
3179  his mind.
3180
3181 \end_layout
3182
3183 \begin_layout Description
3184 Syntax math-macro-make-nonoptional
3185 \end_layout
3186
3187 \begin_layout Description
3188 Origin sts, 06 January 2008
3189 \end_layout
3190
3191 \begin_layout Subsection*
3192 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3193 \end_layout
3194
3195 \begin_layout Description
3196 Action Add an optional parameter.
3197
3198 \end_layout
3199
3200 \begin_layout Description
3201 Notion Insert an optional parameter just behind the already existing optional
3202  parameters.
3203
3204 \end_layout
3205
3206 \begin_layout Description
3207 Syntax math-macro-add-optional-param
3208 \end_layout
3209
3210 \begin_layout Description
3211 Origin sts, 06 January 2008
3212 \end_layout
3213
3214 \begin_layout Subsection*
3215 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3216 \end_layout
3217
3218 \begin_layout Description
3219 Action Remove the last optional parameter.
3220
3221 \end_layout
3222
3223 \begin_layout Description
3224 Notion Remove the last optional parameter of a Math Macro and remove it
3225  in all the instances of the macro in the buffer.
3226
3227 \end_layout
3228
3229 \begin_layout Description
3230 Syntax math-macro-remove-optional-param
3231 \end_layout
3232
3233 \begin_layout Description
3234 Origin sts, 06 January 2008
3235 \end_layout
3236
3237 \begin_layout Subsection*
3238 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3239 \end_layout
3240
3241 \begin_layout Description
3242 Action Add a greedy optional parameter.
3243
3244 \end_layout
3245
3246 \begin_layout Description
3247 Notion Add a greedy optional parameter which eats the value from the following
3248  cells in mathed which are in the [value] format.
3249
3250 \end_layout
3251
3252 \begin_layout Description
3253 Syntax math-macro-add-greedy-optional-param
3254 \end_layout
3255
3256 \begin_layout Description
3257 Origin sts, 06 January 2008
3258 \end_layout
3259
3260 \begin_layout Subsection*
3261 LFUN_IN_MATHMACROTEMPLATE
3262 \end_layout
3263
3264 \begin_layout Description
3265 Action Only active in Math Macro definition.
3266
3267 \end_layout
3268
3269 \begin_layout Description
3270 Notion Dummy function which is only active in a Math Macro definition.
3271  It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3272  Macro definition.
3273
3274 \end_layout
3275
3276 \begin_layout Description
3277 Syntax in-mathmacrotemplate
3278 \end_layout
3279
3280 \begin_layout Description
3281 Origin sts, 06 January 2008
3282 \end_layout
3283
3284 \begin_layout Subsection*
3285 LFUN_PARAGRAPH_MOVE_DOWN
3286 \end_layout
3287
3288 \begin_layout Description
3289 Action Moves the current paragraph downwards in the document.
3290
3291 \end_layout
3292
3293 \begin_layout Description
3294 Syntax paragraph-move-down
3295 \end_layout
3296
3297 \begin_layout Description
3298 Origin Edwin, 8 Apr 2006
3299 \end_layout
3300
3301 \begin_layout Subsection*
3302 LFUN_PARAGRAPH_MOVE_UP
3303 \end_layout
3304
3305 \begin_layout Description
3306 Action Moves the current paragraph upwards in the document.
3307
3308 \end_layout
3309
3310 \begin_layout Description
3311 Syntax paragraph-move-up
3312 \end_layout
3313
3314 \begin_layout Description
3315 Origin Edwin, 8 Apr 2006
3316 \end_layout
3317
3318 \begin_layout Subsection*
3319 LFUN_PARAGRAPH_UP
3320 \end_layout
3321
3322 \begin_layout Description
3323 Action Move the cursor to the next paragraph (or begining of the current
3324  one) in upward direction.
3325
3326 \end_layout
3327
3328 \begin_layout Description
3329 Syntax paragraph-up
3330 \end_layout
3331
3332 \begin_layout Description
3333 Origin Asger, 1 Oct 1996
3334 \end_layout
3335
3336 \begin_layout Subsection*
3337 LFUN_PARAGRAPH_UP_SELECT
3338 \end_layout
3339
3340 \begin_layout Description
3341 Action Move the cursor and select the text to the next paragraph (or begining
3342  of the current one) in upward direction.
3343
3344 \end_layout
3345
3346 \begin_layout Description
3347 Syntax paragraph-up-select
3348 \end_layout
3349
3350 \begin_layout Description
3351 Origin Asger, 1 Oct 1996
3352 \end_layout
3353
3354 \begin_layout Subsection*
3355 LFUN_PARAGRAPH_DOWN
3356 \end_layout
3357
3358 \begin_layout Description
3359 Action Move the cursor to the next paragraph (or begining of the current
3360  one) in downward direction.
3361
3362 \end_layout
3363
3364 \begin_layout Description
3365 Syntax paragraph-down
3366 \end_layout
3367
3368 \begin_layout Description
3369 Origin Asger, 1 Oct 1996
3370 \end_layout
3371
3372 \begin_layout Subsection*
3373 LFUN_PARAGRAPH_DOWN_SELECT
3374 \end_layout
3375
3376 \begin_layout Description
3377 Action Move the cursor and select the text to the next paragraph (or begining
3378  of the current one) in downward direction.
3379
3380 \end_layout
3381
3382 \begin_layout Description
3383 Syntax paragraph-down-select
3384 \end_layout
3385
3386 \begin_layout Description
3387 Origin Asger, 1 Oct 1996
3388 \end_layout
3389
3390 \begin_layout Subsection*
3391 LFUN_PARAGRAPH_GOTO
3392 \end_layout
3393
3394 \begin_layout Description
3395 Action Jump to a paragraph given by its id number and optionally the desired
3396  position within the paragraph.
3397
3398 \end_layout
3399
3400 \begin_layout Description
3401 Notion Note that id number of paragraph is not the sequential number of
3402  paragraph seen on the screen.
3403  Moreover the id is unique for all opened buffers (documents).
3404
3405 \end_layout
3406
3407 \begin_layout Description
3408 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3409 \end_layout
3410
3411 \begin_layout Description
3412 Params <PAR_ID_NUMBER>:  paragraph id
3413 \newline
3414  <POSITION_IN_PAR>: desired position
3415  within the paragraph
3416 \end_layout
3417
3418 \begin_layout Description
3419 Origin Dekel, 26 Aug 2000
3420 \end_layout
3421
3422 \begin_layout Subsection*
3423 LFUN_BREAK_PARAGRAPH
3424 \end_layout
3425
3426 \begin_layout Description
3427 Action Breaks the current paragraph at the current location.
3428
3429 \end_layout
3430
3431 \begin_layout Description
3432 Syntax break-paragraph
3433 \end_layout
3434
3435 \begin_layout Subsection*
3436 LFUN_BREAK_PARAGRAPH
3437 \end_layout
3438
3439 \begin_layout Description
3440 Action Breaks the current paragraph at the current location.
3441
3442 \end_layout
3443
3444 \begin_layout Description
3445 Notion Removes the selection.
3446
3447 \end_layout
3448
3449 \begin_layout Description
3450 Syntax break-paragraph [<LAYOUT>]
3451 \end_layout
3452
3453 \begin_layout Description
3454 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3455  default layout) when the cursor is at the end of the line.
3456
3457 \end_layout
3458
3459 \begin_layout Subsection*
3460 LFUN_PARAGRAPH_PARAMS
3461 \end_layout
3462
3463 \begin_layout Description
3464 Action Change paragraph settings.
3465
3466 \end_layout
3467
3468 \begin_layout Description
3469 Notion Modifies the current paragraph, or currently selected paragraphs.
3470  This function only modifies, and does not override, existing settings.
3471  Note that the "leftindent" indent setting is deprecated.
3472
3473 \end_layout
3474
3475 \begin_layout Description
3476 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3477 \end_layout
3478
3479 \begin_layout Description
3480 Params <INDENT>:
3481 \backslash
3482 noindent|
3483 \backslash
3484 indent|
3485 \backslash
3486 indent-toggle|
3487 \backslash
3488 leftindent LENGTH
3489 \newline
3490  <SPACING>:
3491 \backslash
3492 paragraph_spacing default|single|onehalf|double|other
3493 \newline
3494  <ALIGN>:
3495 \backslash
3496 align block|left|right|center|default
3497 \newline
3498  <OTHERS>:
3499 \backslash
3500 labelwidthstring WIDTH|
3501 \backslash
3502 start_of_appendix
3503 \newline
3504
3505 \end_layout
3506
3507 \begin_layout Description
3508 Origin rgh, Aug 15 2007
3509 \end_layout
3510
3511 \begin_layout Subsection*
3512 LFUN_PARAGRAPH_PARAMS_APPLY
3513 \end_layout
3514
3515 \begin_layout Description
3516 Action Change paragraph settings.
3517
3518 \end_layout
3519
3520 \begin_layout Description
3521 Notion Overwrite all nonspecified settings to the default ones.
3522  Use paragraph-params lfun if you don't want to overwrite others settings.
3523
3524 \end_layout
3525
3526 \begin_layout Description
3527 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3528 \end_layout
3529
3530 \begin_layout Description
3531 Params For parameters see LFUN_PARAGRAPH_PARAMS
3532 \end_layout
3533
3534 \begin_layout Description
3535 Origin leeming, 30 Mar 2004
3536 \end_layout
3537
3538 \begin_layout Subsection*
3539 LFUN_PARAGRAPH_UPDATE
3540 \end_layout
3541
3542 \begin_layout Description
3543 Action Updates the values inside the paragraph dialog from the paragraph.
3544
3545 \end_layout
3546
3547 \begin_layout Description
3548 Notion This is internal LFUN, not to be used by users.
3549  Called internally by LFUN_DIALOG_UPDATE.
3550
3551 \end_layout
3552
3553 \begin_layout Description
3554 Origin leeming, 13 Mar 2003
3555 \end_layout
3556
3557 \begin_layout Subsection*
3558 LFUN_OUTLINE_UP
3559 \end_layout
3560
3561 \begin_layout Description
3562 Action Move the current group in the upward direction in the structure of
3563  the document.
3564
3565 \end_layout
3566
3567 \begin_layout Description
3568 Notion The "group" can be Part/Chapter/Section/etc.
3569  It moves the whole substructure of the group.
3570
3571 \end_layout
3572
3573 \begin_layout Description
3574 Syntax outline-up
3575 \end_layout
3576
3577 \begin_layout Description
3578 Origin Vermeer, 23 Mar 2006
3579 \end_layout
3580
3581 \begin_layout Subsection*
3582 LFUN_OUTLINE_DOWN
3583 \end_layout
3584
3585 \begin_layout Description
3586 Action Move the current group in the downward direction in the structure
3587  of the document.
3588
3589 \end_layout
3590
3591 \begin_layout Description
3592 Notion The "group" can be Part/Chapter/Section/etc.
3593  It moves the whole substructure of the group.
3594
3595 \end_layout
3596
3597 \begin_layout Description
3598 Syntax outline-down
3599 \end_layout
3600
3601 \begin_layout Description
3602 Origin Vermeer, 23 Mar 2006
3603 \end_layout
3604
3605 \begin_layout Subsection*
3606 LFUN_OUTLINE_IN
3607 \end_layout
3608
3609 \begin_layout Description
3610 Action Moves the current group in the downward direction in the hierarchy
3611  of the document structure.
3612
3613 \end_layout
3614
3615 \begin_layout Description
3616 Notion Part -> Chapter -> Section -> etc.
3617
3618 \end_layout
3619
3620 \begin_layout Description
3621 Syntax outline-in
3622 \end_layout
3623
3624 \begin_layout Description
3625 Origin Vermeer, 23 Mar 2006
3626 \end_layout
3627
3628 \begin_layout Subsection*
3629 LFUN_OUTLINE_OUT
3630 \end_layout
3631
3632 \begin_layout Description
3633 Action Moves the current group in the upward direction in the hierarchy
3634  of the document structure.
3635
3636 \end_layout
3637
3638 \begin_layout Description
3639 Notion Part <- Chapter <- Section <- etc.
3640
3641 \end_layout
3642
3643 \begin_layout Description
3644 Syntax outline-out
3645 \end_layout
3646
3647 \begin_layout Description
3648 Origin Vermeer, 23 Mar 2006
3649 \end_layout
3650
3651 \begin_layout Subsection*
3652 LFUN_INSET_EDIT
3653 \end_layout
3654
3655 \begin_layout Description
3656 Action Edit the inset at cursor with an external application, *
3657      if one is attributed.
3658
3659 \end_layout
3660
3661 \begin_layout Description
3662 Syntax inset-edit [<INSET_PARAMS>]
3663 \end_layout
3664
3665 \begin_layout Description
3666 Params <INSET_PARAMS>: Parameters for the inset.
3667
3668 \newline
3669  Currently only the filename will be considered.
3670
3671 \end_layout
3672
3673 \begin_layout Description
3674 Origin JSpitzm, 27 Apr 2006
3675 \end_layout
3676
3677 \begin_layout Subsection*
3678 LFUN_TABULAR_INSERT
3679 \end_layout
3680
3681 \begin_layout Description
3682 Action Inserts table into the document.
3683
3684 \end_layout
3685
3686 \begin_layout Description
3687 Syntax tabular-insert [<ROWS> <COLUMNS>]
3688 \end_layout
3689
3690 \begin_layout Description
3691 Params In case no arguments are given show insert dialog.
3692
3693 \end_layout
3694
3695 \begin_layout Description
3696 Origin Jug, 12 Apr 2000
3697 \end_layout
3698
3699 \begin_layout Subsection*
3700 LFUN_TABULAR_FEATURE
3701 \end_layout
3702
3703 \begin_layout Description
3704 Action Sets various features to the table/cell on the current cursor position.
3705
3706 \end_layout
3707
3708 \begin_layout Description
3709 Notion Various math-environment features are handled here as well, e.g.
3710  add-vline-left/right for Grid/Cases environment
3711 \end_layout
3712
3713 \begin_layout Description
3714 Syntax tabular-feature <FEATURE> [<ARG>]
3715 \end_layout
3716
3717 \begin_layout Description
3718 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3719 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3720  align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3721  valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
3722 bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
3723 r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
3724 lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
3725 set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
3726 |unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3727  set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3728 |set-bottom-space|set-interline-space|set-border-lines
3729 \newline
3730  <ARG>: additional
3731  argument for some commands, use debug mode to explore its values.
3732
3733 \end_layout
3734
3735 \begin_layout Description
3736 Origin Jug, 28 Jul 2000
3737 \end_layout
3738
3739 \begin_layout Subsection*
3740 LFUN_CELL_BACKWARD
3741 \end_layout
3742
3743 \begin_layout Description
3744 Action Moves the cursor to the previous cell inside the table.
3745
3746 \end_layout
3747
3748 \begin_layout Description
3749 Syntax cell-backward
3750 \end_layout
3751
3752 \begin_layout Description
3753 Origin Jug, 22 May 2000
3754 \end_layout
3755
3756 \begin_layout Subsection*
3757 LFUN_CELL_FORWARD
3758 \end_layout
3759
3760 \begin_layout Description
3761 Action Moves the cursor to the next cell inside the table.
3762
3763 \end_layout
3764
3765 \begin_layout Description
3766 Syntax cell-forward
3767 \end_layout
3768
3769 \begin_layout Subsection*
3770 LFUN_CELL_SPLIT
3771 \end_layout
3772
3773 \begin_layout Description
3774 Action Splits cell and shifts right part to the next cell (inside the math
3775  grid).
3776
3777 \end_layout
3778
3779 \begin_layout Description
3780 Syntax cell-split
3781 \end_layout
3782
3783 \begin_layout Description
3784 Origin Ale, 15 May 1997
3785 \end_layout
3786
3787 \begin_layout Subsection*
3788 LFUN_VC_REGISTER
3789 \end_layout
3790
3791 \begin_layout Description
3792 Action Register the document as an file inside version control system (RCS,
3793  CVS).
3794
3795 \end_layout
3796
3797 \begin_layout Description
3798 Notion File is registered inside cvs, svn or rcs repository acording to
3799  the existence of cvs/svn/rcs entries in the document's directory.
3800
3801 \newline
3802  See LyX Extended Manual (Version Control Chapter) for additional information.
3803
3804 \end_layout
3805
3806 \begin_layout Description
3807 Syntax vc-register
3808 \end_layout
3809
3810 \begin_layout Description
3811 Origin Lgb, 1 Jul 1997
3812 \end_layout
3813
3814 \begin_layout Subsection*
3815 LFUN_VC_CHECK_IN
3816 \end_layout
3817
3818 \begin_layout Description
3819 Action Checks-in/commits the changes of the registered file to the repository.
3820
3821 \end_layout
3822
3823 \begin_layout Description
3824 Notion In RCS case this also unlocks the file.
3825
3826 \end_layout
3827
3828 \begin_layout Description
3829 Syntax vc-check-in
3830 \end_layout
3831
3832 \begin_layout Description
3833 Origin Lgb, 1 Jul 1997
3834 \end_layout
3835
3836 \begin_layout Subsection*
3837 LFUN_VC_CHECK_OUT
3838 \end_layout
3839
3840 \begin_layout Description
3841 Action Checks-out the document for edit (and locks it for RCS).
3842
3843 \end_layout
3844
3845 \begin_layout Description
3846 Notion This is implemented only for RCS and SVN, not CVS.
3847
3848 \end_layout
3849
3850 \begin_layout Description
3851 Syntax vc-check-out
3852 \end_layout
3853
3854 \begin_layout Description
3855 Origin Lgb, 1 Jul 1997
3856 \end_layout
3857
3858 \begin_layout Subsection*
3859 LFUN_VC_REVERT
3860 \end_layout
3861
3862 \begin_layout Description
3863 Action Reverts the document to the last check-in/commit in VCS.
3864
3865 \end_layout
3866
3867 \begin_layout Description
3868 Syntax vc-revert
3869 \end_layout
3870
3871 \begin_layout Description
3872 Origin Lgb, 1 Jul 1997
3873 \end_layout
3874
3875 \begin_layout Subsection*
3876 LFUN_VC_UNDO_LAST
3877 \end_layout
3878
3879 \begin_layout Description
3880 Action Undo last check-in.
3881
3882 \end_layout
3883
3884 \begin_layout Description
3885 Notion This is currently implemented only for RCS.
3886
3887 \end_layout
3888
3889 \begin_layout Description
3890 Syntax vc-check-out
3891 \end_layout
3892
3893 \begin_layout Description
3894 Origin Lgb, 1 Jul 1997
3895 \end_layout
3896
3897 \begin_layout Subsection*
3898 LFUN_CHANGES_TRACK
3899 \end_layout
3900
3901 \begin_layout Description
3902 Action Toggles change tracking to on/off.
3903
3904 \end_layout
3905
3906 \begin_layout Description
3907 Syntax changes-track
3908 \end_layout
3909
3910 \begin_layout Description
3911 Origin levon, 1 Oct 2002
3912 \end_layout
3913
3914 \begin_layout Subsection*
3915 LFUN_CHANGES_OUTPUT
3916 \end_layout
3917
3918 \begin_layout Description
3919 Action Toggles showing of change tracking in typesetted output.
3920
3921 \end_layout
3922
3923 \begin_layout Description
3924 Syntax changes-output
3925 \end_layout
3926
3927 \begin_layout Description
3928 Origin jspitzm, 21 Jan 2005
3929 \end_layout
3930
3931 \begin_layout Subsection*
3932 LFUN_CHANGE_NEXT
3933 \end_layout
3934
3935 \begin_layout Description
3936 Action Moves the cursor to the position of the next change of the change
3937  tracking records.
3938
3939 \end_layout
3940
3941 \begin_layout Description
3942 Syntax change-next
3943 \end_layout
3944
3945 \begin_layout Description
3946 Origin schmitt, 4 Oct 2006
3947 \end_layout
3948
3949 \begin_layout Subsection*
3950 LFUN_CHANGES_MERGE
3951 \end_layout
3952
3953 \begin_layout Description
3954 Action Open change tracking dialog for merging and moves the cursor to the
3955  position of the next change.
3956
3957 \end_layout
3958
3959 \begin_layout Description
3960 Syntax changes-merge
3961 \end_layout
3962
3963 \begin_layout Description
3964 Origin Levon, 16 Oct 2002
3965 \end_layout
3966
3967 \begin_layout Subsection*
3968 LFUN_CHANGE_ACCEPT
3969 \end_layout
3970
3971 \begin_layout Description
3972 Action Accepts tracked change inside the selection.
3973
3974 \end_layout
3975
3976 \begin_layout Description
3977 Syntax change-accept
3978 \end_layout
3979
3980 \begin_layout Description
3981 Origin Levon, 16 Oct 2002
3982 \end_layout
3983
3984 \begin_layout Subsection*
3985 LFUN_CHANGE_REJECT
3986 \end_layout
3987
3988 \begin_layout Description
3989 Action Rejects tracked change inside the selection.
3990
3991 \end_layout
3992
3993 \begin_layout Description
3994 Syntax change-accept
3995 \end_layout
3996
3997 \begin_layout Description
3998 Origin Levon, 16 Oct 2002
3999 \end_layout
4000
4001 \begin_layout Subsection*
4002 LFUN_ALL_CHANGES_ACCEPT
4003 \end_layout
4004
4005 \begin_layout Description
4006 Action Accepts all tracked changes in the document.
4007
4008 \end_layout
4009
4010 \begin_layout Description
4011 Syntax all-changes-accept
4012 \end_layout
4013
4014 \begin_layout Description
4015 Origin Levon, 16 Oct 2002
4016 \end_layout
4017
4018 \begin_layout Subsection*
4019 LFUN_ALL_CHANGES_REJECT
4020 \end_layout
4021
4022 \begin_layout Description
4023 Action Rejects all tracked changes in the document.
4024
4025 \end_layout
4026
4027 \begin_layout Description
4028 Notion Reject does not work recursively; the user may have to repeat the
4029  operation.
4030
4031 \end_layout
4032
4033 \begin_layout Description
4034 Syntax all-changes-reject
4035 \end_layout
4036
4037 \begin_layout Description
4038 Origin Levon, 16 Oct 2002
4039 \end_layout
4040
4041 \begin_layout Subsection*
4042 LFUN_INSET_APPLY
4043 \end_layout
4044
4045 \begin_layout Description
4046 Action Apply data for an inset.
4047
4048 \end_layout
4049
4050 \begin_layout Description
4051 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4052  applied.
4053  This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4054  on the context where it is called.
4055
4056 \end_layout
4057
4058 \begin_layout Description
4059 Syntax inset-apply <ARGS>
4060 \end_layout
4061
4062 \begin_layout Description
4063 Params See LFUN_INSET_INSERT .
4064
4065 \end_layout
4066
4067 \begin_layout Subsection*
4068 LFUN_INSET_DISSOLVE
4069 \end_layout
4070
4071 \begin_layout Description
4072 Action Dissolve the current inset into text.
4073
4074 \end_layout
4075
4076 \begin_layout Description
4077 Syntax inset-dissolve [<INSET>]
4078 \end_layout
4079
4080 \begin_layout Description
4081 Params <INSET>: this can be used to make sure the right kind of inset is
4082  dissolved.
4083  For example "dissolve" entry in the charstyles sub-menu should only dissolve
4084  the charstyle inset, even if the cursor is inside several nested insets
4085  of different type.
4086
4087 \newline
4088  For values see lyx::InsetLayout::lyxtype_ .
4089
4090 \end_layout
4091
4092 \begin_layout Description
4093 Origin JSpitz, 7 Aug 2006
4094 \end_layout
4095
4096 \begin_layout Subsection*
4097 LFUN_INSET_INSERT
4098 \end_layout
4099
4100 \begin_layout Description
4101 Action Insert new inset (type given by the parameters).
4102
4103 \end_layout
4104
4105 \begin_layout Description
4106 Syntax inset-insert <INSET> <ARGS>
4107 \end_layout
4108
4109 \begin_layout Description
4110 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4111 nclude|index|label|nomencl|vspace|ref|toc>
4112 \newline
4113  <ARGS>: depends on the given
4114  inset.
4115  Use "lyx -dbg action" to explore.
4116
4117 \end_layout
4118
4119 \begin_layout Description
4120 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4121 \backslash
4122 end_inset
4123 \newline
4124 where <label name> is the name of the referenced label and<Format>
4125  is one of the following:
4126 \newline
4127 ref -- <reference>
4128 \newline
4129 eqref -- (<reference>)
4130 \newline
4131 pageref
4132  -- <page>
4133 \newline
4134 vpageref -- on <page>
4135 \newline
4136 vref -- <reference> on <page>
4137 \newline
4138 prettyref
4139  -- Formatted reference
4140 \end_layout
4141
4142 \begin_layout Subsection*
4143 LFUN_INSET_MODIFY
4144 \end_layout
4145
4146 \begin_layout Description
4147 Action Modify existing inset.
4148
4149 \end_layout
4150
4151 \begin_layout Description
4152 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4153  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4154  ref insets.
4155
4156 \end_layout
4157
4158 \begin_layout Description
4159 Syntax inset-modify <INSET> <ARGS>
4160 \end_layout
4161
4162 \begin_layout Description
4163 Params See LFUN_INSET_INSERT for further details.
4164
4165 \end_layout
4166
4167 \begin_layout Subsection*
4168 LFUN_NEXT_INSET_MODIFY
4169 \end_layout
4170
4171 \begin_layout Description
4172 Action Modify the inset at cursor position, if there is one.
4173
4174 \end_layout
4175
4176 \begin_layout Description
4177 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4178  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4179  ref insets.
4180
4181 \end_layout
4182
4183 \begin_layout Description
4184 Syntax next-inset-modify <INSET> <ARGS>
4185 \end_layout
4186
4187 \begin_layout Description
4188 Syntax next-inset-modify changetype <TYPE>
4189 \end_layout
4190
4191 \begin_layout Description
4192 Params See LFUN_INSET_INSERT for further details.
4193
4194 \end_layout
4195
4196 \begin_layout Description
4197 Origin JSpitzm, 23 Mar 2008
4198 \end_layout
4199
4200 \begin_layout Subsection*
4201 LFUN_INSET_DIALOG_UPDATE
4202 \end_layout
4203
4204 \begin_layout Description
4205 Action Updates the values inside the dialog from the inset.
4206
4207 \end_layout
4208
4209 \begin_layout Description
4210 Notion This is internal LFUN, not to be used by users.
4211  Called internally by LFUN_DIALOG_UPDATE
4212 \end_layout
4213
4214 \begin_layout Description
4215 Params <DIALOG-NAME>
4216 \end_layout
4217
4218 \begin_layout Description
4219 Origin leeming, 25 Feb 2003
4220 \end_layout
4221
4222 \begin_layout Subsection*
4223 LFUN_INSET_SETTINGS
4224 \end_layout
4225
4226 \begin_layout Description
4227 Action Open the inset's properties dialog.
4228
4229 \end_layout
4230
4231 \begin_layout Description
4232 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4233
4234 \end_layout
4235
4236 \begin_layout Description
4237 Syntax inset-settings <INSET>
4238 \end_layout
4239
4240 \begin_layout Description
4241 Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
4242 \end_layout
4243
4244 \begin_layout Subsection*
4245 LFUN_NEXT_INSET_TOGGLE
4246 \end_layout
4247
4248 \begin_layout Description
4249 Action Toggles the inset at cursor position.
4250  For collapsables, this means it will be (un-)collapsed, in case of other
4251  insets, the editing widget (dialog) will be entered.
4252  Also cf.
4253  LFUN_INSET_SETTINGS.
4254
4255 \end_layout
4256
4257 \begin_layout Description
4258 Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
4259  ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
4260  ref insets.
4261
4262 \end_layout
4263
4264 \begin_layout Description
4265 Syntax next-inset-toggle <ARG>
4266 \end_layout
4267
4268 \begin_layout Description
4269 Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
4270
4271 \end_layout
4272
4273 \begin_layout Description
4274 Origin leeming, 30 Mar 2004
4275 \end_layout
4276
4277 \begin_layout Subsection*
4278 LFUN_INSET_TOGGLE
4279 \end_layout
4280
4281 \begin_layout Description
4282 Action Toggles the collapsable inset we are currently in.
4283
4284 \end_layout
4285
4286 \begin_layout Description
4287 Syntax inset-toggle [<ARG>]
4288 \end_layout
4289
4290 \begin_layout Description
4291 Params <ARG>: <open|close|toggle|assign>.
4292
4293 \newline
4294  open/close/toggle are for collapsable insets.
4295  close can be currently used by LFUN_NEXT_INSET_TOGGLE.
4296  toggle is used when no argument is given.
4297
4298 \newline
4299  assign is for branch inset.
4300
4301 \end_layout
4302
4303 \begin_layout Description
4304 Origin lasgouttes, 19 Jul 2001
4305 \end_layout
4306
4307 \begin_layout Subsection*
4308 LFUN_ALL_INSETS_TOGGLE
4309 \end_layout
4310
4311 \begin_layout Description
4312 Action Toggles (open/closes) all collapsable insets (of a given type) in
4313  the document.
4314
4315 \end_layout
4316
4317 \begin_layout Description
4318 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4319
4320 \end_layout
4321
4322 \begin_layout Description
4323 Syntax all-insets-toggle <STATE> <INSET>
4324 \end_layout
4325
4326 \begin_layout Description
4327 Params <STATE>: <toggle|open|close> default: toggle
4328 \newline
4329  <INSET>: <box|branch|ert|f
4330 loat|listings|note|tabular|wrap> default: all insets
4331 \end_layout
4332
4333 \begin_layout Description
4334 Origin leeming, 30 Mar 2004
4335 \end_layout
4336
4337 \begin_layout Subsection*
4338 LFUN_GRAPHICS_GROUPS_UNIFY
4339 \end_layout
4340
4341 \begin_layout Description
4342 Action Unify all graphics insets with the one given as an parameter.
4343
4344 \end_layout
4345
4346 \begin_layout Description
4347 Notion This is internally used for synchronize certain group of graphics
4348  insets.
4349
4350 \end_layout
4351
4352 \begin_layout Description
4353 Syntax graphics-groups-unigfy <GRAPHICS_PARAMS>
4354 \end_layout
4355
4356 \begin_layout Description
4357 Params <GRAPHICS_PARAMS>: Parameters for graphics inset (syntax can be seen
4358  in .lyx files).
4359
4360 \end_layout
4361
4362 \begin_layout Description
4363 Origin sanda, 6 May 2008
4364 \end_layout
4365
4366 \begin_layout Subsection*
4367 LFUN_SET_GRAPHICS_GROUP
4368 \end_layout
4369
4370 \begin_layout Description
4371 Action Set the group for the graphics inset on the cursor position.
4372
4373 \end_layout
4374
4375 \begin_layout Description
4376 Syntax set-graphics-group [<GROUP>]
4377 \end_layout
4378
4379 \begin_layout Description
4380 Params <GROUP>: Id for an existing group.
4381  In case tthe Id is an empty string, the graphics inset is removed from
4382  the current group.
4383
4384 \end_layout
4385
4386 \begin_layout Description
4387 Origin sanda, 6 May 2008
4388 \end_layout
4389
4390 \begin_layout Subsection*
4391 LFUN_FINISHED_FORWARD
4392 \end_layout
4393
4394 \begin_layout Description
4395 Action Moves the cursor out of the current slice, going forward.
4396
4397 \end_layout
4398
4399 \begin_layout Description
4400 Notion Cursor movement within an inset may be different than cursor movement
4401  in the surrounding text.
4402  This action should be called automatically by the cursor movement within
4403  the inset, when movement within the inset has ceased (reached the end of
4404  the last paragraph, for example), in order to move correctly back into
4405  the surrounding text.
4406
4407 \end_layout
4408
4409 \begin_layout Subsection*
4410 LFUN_FINISHED_BACKWARD
4411 \end_layout
4412
4413 \begin_layout Description
4414 Action Moves the cursor out of the current slice, going backwards.
4415
4416 \end_layout
4417
4418 \begin_layout Description
4419 Notion See also LFUN_FINISHED_FORWARD.
4420
4421 \end_layout
4422
4423 \begin_layout Subsection*
4424 LFUN_FINISHED_RIGHT
4425 \end_layout
4426
4427 \begin_layout Description
4428 Action Moves the cursor out of the current slice, going right.
4429
4430 \end_layout
4431
4432 \begin_layout Description
4433 Notion See also LFUN_FINISHED_FORWARD
4434 \end_layout
4435
4436 \begin_layout Subsection*
4437 LFUN_FINISHED_LEFT
4438 \end_layout
4439
4440 \begin_layout Description
4441 Action Moves the cursor out of the current slice, going left.
4442
4443 \end_layout
4444
4445 \begin_layout Description
4446 Notion See also LFUN_FINISHED_FORWARD.
4447
4448 \end_layout
4449
4450 \begin_layout Subsection*
4451 LFUN_LANGUAGE
4452 \end_layout
4453
4454 \begin_layout Description
4455 Action Set language from the current cursor position.
4456
4457 \end_layout
4458
4459 \begin_layout Description
4460 Syntax language <LANG>
4461 \end_layout
4462
4463 \begin_layout Description
4464 Params <LANG>: Requested language.
4465  Look in lib/languages for the list.
4466
4467 \end_layout
4468
4469 \begin_layout Description
4470 Origin Dekel, 2 Mar 2000
4471 \end_layout
4472
4473 \begin_layout Subsection*
4474 LFUN_LABEL_GOTO
4475 \end_layout
4476
4477 \begin_layout Description
4478 Action Goto a label.
4479
4480 \end_layout
4481
4482 \begin_layout Description
4483 Syntax label-goto [<LABEL>]
4484 \end_layout
4485
4486 \begin_layout Description
4487 Params <LABEL>: Requested label.
4488  If no label is given and refernce is on cursor position, Bookmark 0 is
4489  saved and cursor moves to the position of referenced label.
4490
4491 \end_layout
4492
4493 \begin_layout Description
4494 Origin Ale, 6 Aug 1997
4495 \end_layout
4496
4497 \begin_layout Subsection*
4498 LFUN_LABEL_INSERT
4499 \end_layout
4500
4501 \begin_layout Description
4502 Action Inserts label to text or displayed formula.
4503
4504 \end_layout
4505
4506 \begin_layout Description
4507 Syntax label-insert [<LABEL>]
4508 \end_layout
4509
4510 \begin_layout Description
4511 Params <LABEL>: Requested label.
4512  If no label is given dialog requesting name will be opened.
4513
4514 \end_layout
4515
4516 \begin_layout Subsection*
4517 LFUN_REFERENCE_NEXT
4518 \end_layout
4519
4520 \begin_layout Description
4521 Action Go to the next label or cross-reference.
4522
4523 \end_layout
4524
4525 \begin_layout Description
4526 Syntax reference-next
4527 \end_layout
4528
4529 \begin_layout Description
4530 Origin Dekel, 14 Jan 2001
4531 \end_layout
4532
4533 \begin_layout Subsection*
4534 LFUN_BOOKMARK_GOTO
4535 \end_layout
4536
4537 \begin_layout Description
4538 Action Goto a bookmark.
4539
4540 \end_layout
4541
4542 \begin_layout Description
4543 Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
4544  Note that bookmarsk are saved per-session, not per file.
4545
4546 \end_layout
4547
4548 \begin_layout Description
4549 Syntax bookmark-goto <NUMBER>
4550 \end_layout
4551
4552 \begin_layout Description
4553 Params <NUMBER>: the number of the bookmark to restore.
4554
4555 \end_layout
4556
4557 \begin_layout Description
4558 Origin Dekel, 27 January 2001
4559 \end_layout
4560
4561 \begin_layout Subsection*
4562 LFUN_BOOKMARK_SAVE
4563 \end_layout
4564
4565 \begin_layout Description
4566 Action Save a bookmark.
4567
4568 \end_layout
4569
4570 \begin_layout Description
4571 Notion Saves a numbered bookmark to the sessions file.
4572  The number must be between 1 and 9, inclusive.
4573  Note that bookmarks are saved per-session, not per file.
4574
4575 \end_layout
4576
4577 \begin_layout Description
4578 Syntax bookmark-save <NUMBER>
4579 \end_layout
4580
4581 \begin_layout Description
4582 Params <NUMBER>: the number of the bookmark to save.
4583
4584 \end_layout
4585
4586 \begin_layout Description
4587 Origin Dekel, 27 January 2001
4588 \end_layout
4589
4590 \begin_layout Subsection*
4591 LFUN_BOOKMARK_CLEAR
4592 \end_layout
4593
4594 \begin_layout Description
4595 Action Clears the list of saved bookmarks.
4596
4597 \end_layout
4598
4599 \begin_layout Description
4600 Syntax bookmark-clear
4601 \end_layout
4602
4603 \begin_layout Description
4604 Origin bpeng, 31 October 2006
4605 \end_layout
4606
4607 \begin_layout Subsection*
4608 LFUN_HELP_OPEN
4609 \end_layout
4610
4611 \begin_layout Description
4612 Action Open the given help file according to the language setting.
4613
4614 \end_layout
4615
4616 \begin_layout Description
4617 Syntax help-open <FILE>[.lyx]
4618 \end_layout
4619
4620 \begin_layout Description
4621 Params <FILE>: any document from (/usr/share/)doc directory.
4622
4623 \end_layout
4624
4625 \begin_layout Description
4626 Origin Jug, 27 Jun 1999
4627 \end_layout
4628
4629 \begin_layout Subsection*
4630 LFUN_LYX_QUIT
4631 \end_layout
4632
4633 \begin_layout Description
4634 Action Terminates the current LyX instance.
4635
4636 \end_layout
4637
4638 \begin_layout Description
4639 Notion Terminates the current LyX instance, asking whether to save modified
4640  documents, etc.
4641
4642 \end_layout
4643
4644 \begin_layout Description
4645 Syntax lyx-quit
4646 \end_layout
4647
4648 \begin_layout Subsection*
4649 LFUN_TOOLBAR_TOGGLE
4650 \end_layout
4651
4652 \begin_layout Description
4653 Action Toggles visibility of a given toolbar between on/off/auto.
4654
4655 \end_layout
4656
4657 \begin_layout Description
4658 Notion Skiping "auto" when allowauto is false.
4659
4660 \end_layout
4661
4662 \begin_layout Description
4663 Syntax toolbar-toggle <NAME> [allowauto]
4664 \end_layout
4665
4666 \begin_layout Description
4667 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4668 ew/update|math_panels
4669 \end_layout
4670
4671 \begin_layout Description
4672 Origin Edwin, 21 May 2007
4673 \end_layout
4674
4675 \begin_layout Subsection*
4676 LFUN_MENU_OPEN
4677 \end_layout
4678
4679 \begin_layout Description
4680 Action Opens the menu given by its name.
4681
4682 \end_layout
4683
4684 \begin_layout Description
4685 Syntax menu-open <NAME>
4686 \end_layout
4687
4688 \begin_layout Description
4689 Params <NAME>: menu name.
4690  See various .inc files in lib/ui for candidates.
4691
4692 \end_layout
4693
4694 \begin_layout Subsection*
4695 LFUN_UI_TOGGLE
4696 \end_layout
4697
4698 \begin_layout Description
4699 Action Various UI visibility-toggling actions.
4700
4701 \end_layout
4702
4703 \begin_layout Description
4704 Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
4705 \end_layout
4706
4707 \begin_layout Description
4708 Params statusbar  : Toggle visibility of the statusbar.
4709
4710 \newline
4711  menubar    : Toggle visibility of the menubar.
4712
4713 \newline
4714  scrollbar  : Toggle visibility of the scrollbar.
4715
4716 \newline
4717  frame      : Toggle visibility of the frames around editing window.
4718
4719 \newline
4720  fullscreen : Toggle fullscreen mode.
4721  This also covers calling the previous functions.
4722  However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4723  be used.
4724
4725 \end_layout
4726
4727 \begin_layout Description
4728 Origin sanda, 9 Feb 2007
4729 \end_layout
4730
4731 \begin_layout Subsection*
4732 WINDOW_NEW
4733 \end_layout
4734
4735 \begin_layout Description
4736 Action Creates new empty LyX window.
4737
4738 \end_layout
4739
4740 \begin_layout Description
4741 Notion Already opened documents from the previous window can be found under
4742  View menu.
4743
4744 \end_layout
4745
4746 \begin_layout Description
4747 Syntax window-new [<GEOMETRY>]
4748 \end_layout
4749
4750 \begin_layout Description
4751 Params <GEOMETRY>: pass the geometry of the window.
4752  This parameter is currently accepted only on Windows platform.
4753
4754 \end_layout
4755
4756 \begin_layout Description
4757 Origin Abdel, 21 Oct 2006
4758 \end_layout
4759
4760 \begin_layout Subsection*
4761 LFUN_WINDOW_CLOSE
4762 \end_layout
4763
4764 \begin_layout Description
4765 Action Closes the current LyX window.
4766
4767 \end_layout
4768
4769 \begin_layout Description
4770 Syntax window-close
4771 \end_layout
4772
4773 \begin_layout Description
4774 Origin Abdel, 23 Oct 2006
4775 \end_layout
4776
4777 \begin_layout Subsection*
4778 LFUN_SPLIT_VIEW
4779 \end_layout
4780
4781 \begin_layout Description
4782 Action Creates another split view of current buffer.
4783
4784 \end_layout
4785
4786 \begin_layout Description
4787 Notion All split views act in the same way indpendently.
4788
4789 \end_layout
4790
4791 \begin_layout Description
4792 Syntax split-view <vertical|horizontal>
4793 \end_layout
4794
4795 \begin_layout Description
4796 Params horizontal : The work areas are laid out side by side.
4797
4798 \newline
4799  vertical   : The work areas laid out vertically.
4800
4801 \end_layout
4802
4803 \begin_layout Description
4804 Origin Abdel, 20 Feb 2008
4805 \end_layout
4806
4807 \begin_layout Subsection*
4808 LFUN_CLOSE_TAB_GROUP
4809 \end_layout
4810
4811 \begin_layout Description
4812 Action Close the current tab group.
4813
4814 \end_layout
4815
4816 \begin_layout Description
4817 Notion This only closes the work areas, not the buffer themselves.
4818  The still opened buffers can be visualized in another tab group.
4819
4820 \end_layout
4821
4822 \begin_layout Description
4823 Syntax close-tab-group
4824 \end_layout
4825
4826 \begin_layout Description
4827 Origin Abdel, 21 Feb 2008
4828 \end_layout
4829
4830 \begin_layout Subsection*
4831 LFUN_DIALOG_SHOW
4832 \end_layout
4833
4834 \begin_layout Description
4835 Action Shows hidden dialog or create new one for a given function/inset
4836  settings etc.
4837
4838 \end_layout
4839
4840 \begin_layout Description
4841 Syntax dialog-show <NAME> [<DATA>]
4842 \end_layout
4843
4844 \begin_layout Description
4845 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
4846
4847 \newline
4848  document|errorlist|ert|external|file|findreplace|float|graphics|
4849 \newline
4850  include|inde
4851 x|info|nomenclature|label|log|mathdelimiter|mathmatrix|
4852 \newline
4853  note|paragraph|prefs|pr
4854 int|ref|sendto|space|spellchecker|symbols|
4855 \newline
4856  tabular|tabularcreate|thesaurus|texi
4857 nfo|toc|href|view-source|vspace
4858 \newline
4859  wrap|listings|<SPECIAL>
4860 \newline
4861  <SPECIAL>: latexlog|v
4862 clog
4863 \newline
4864  <DATA>: data, usually settings for the given dialog.
4865  Use debug mode for the details.
4866
4867 \end_layout
4868
4869 \begin_layout Description
4870 Origin leeming, 17 Jun 2003
4871 \end_layout
4872
4873 \begin_layout Subsection*
4874 LFUN_DIALOG_SHOW_NEW_INSET
4875 \end_layout
4876
4877 \begin_layout Description
4878 Action Shows hidden dialog or create new one for a given inset settings
4879  etc.
4880
4881 \end_layout
4882
4883 \begin_layout Description
4884 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
4885  inset.
4886
4887 \end_layout
4888
4889 \begin_layout Description
4890 Syntax dialog-show-new-inset <NAME> [<DATA>]
4891 \end_layout
4892
4893 \begin_layout Description
4894 Params See LFUN_DIALOG_SHOW .
4895
4896 \end_layout
4897
4898 \begin_layout Description
4899 Origin leeming, 25 Feb 2003
4900 \end_layout
4901
4902 \begin_layout Subsection*
4903 LFUN_DIALOG_UPDATE
4904 \end_layout
4905
4906 \begin_layout Description
4907 Action Updates the dialog values from the inset/paragraph/document.
4908
4909 \end_layout
4910
4911 \begin_layout Description
4912 Syntax dialog-update <NAME>
4913 \end_layout
4914
4915 \begin_layout Description
4916 Params <NAME>: paragraph|prefs|<INSET>
4917 \newline
4918  <INSET>: inset name
4919 \end_layout
4920
4921 \begin_layout Description
4922 Origin leeming, 25 Feb 2003
4923 \end_layout
4924
4925 \begin_layout Subsection*
4926 LFUN_DIALOG_HIDE
4927 \end_layout
4928
4929 \begin_layout Description
4930 Action Hides showed dialog.
4931  Counterpart to LFUN_DIALOG_SHOW .
4932
4933 \end_layout
4934
4935 \begin_layout Description
4936 Syntax dialog-hide <NAME>
4937 \end_layout
4938
4939 \begin_layout Description
4940 Params See LFUN_DIALOG_SHOW .
4941
4942 \end_layout
4943
4944 \begin_layout Description
4945 Origin leeming, 25 Feb 2003
4946 \end_layout
4947
4948 \begin_layout Subsection*
4949 LFUN_DIALOG_TOGGLE
4950 \end_layout
4951
4952 \begin_layout Description
4953 Action Toggles dialog between showed/hidden state.
4954
4955 \end_layout
4956
4957 \begin_layout Description
4958 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4959
4960 \end_layout
4961
4962 \begin_layout Description
4963 Syntax dialog-toggle <NAME> [<DATA>]
4964 \end_layout
4965
4966 \begin_layout Description
4967 Params See LFUN_DIALOG_SHOW .
4968
4969 \end_layout
4970
4971 \begin_layout Description
4972 Origin JSpitzm, 30 Apr 2007
4973 \end_layout
4974
4975 \begin_layout Subsection*
4976 LFUN_DIALOG_DISCONNECT_INSET
4977 \end_layout
4978
4979 \begin_layout Description
4980 Action Closes opened connection to opened inset.
4981
4982 \end_layout
4983
4984 \begin_layout Description
4985 Notion Connection is used for apply functions.
4986
4987 \end_layout
4988
4989 \begin_layout Description
4990 Syntax dialog-disconnect-inset <INSET-NAME>
4991 \end_layout
4992
4993 \begin_layout Description
4994 Origin leeming, 25 Feb 2003
4995 \end_layout
4996
4997 \begin_layout Subsection*
4998 LFUN_MOUSE_PRESS
4999 \end_layout
5000
5001 \begin_layout Description
5002 Action This function is called when mouse button is pressed (inside workarea).Act
5003 ion depends on the context.
5004
5005 \end_layout
5006
5007 \begin_layout Description
5008 Notion This is internal LFUN, not to be used by users.
5009
5010 \end_layout
5011
5012 \begin_layout Description
5013 Origin Andre, 9 Aug 2002
5014 \end_layout
5015
5016 \begin_layout Subsection*
5017 LFUN_MOUSE_DOUBLE
5018 \end_layout
5019
5020 \begin_layout Description
5021 Action This function is called when double click on mouse button is pressed
5022  (inside workarea).
5023  Action depends on the context.
5024
5025 \end_layout
5026
5027 \begin_layout Description
5028 Notion This is internal LFUN, not to be used by users.
5029
5030 \end_layout
5031
5032 \begin_layout Description
5033 Origin Andre, 9 Aug 2002
5034 \end_layout
5035
5036 \begin_layout Subsection*
5037 LFUN_MOUSE_TRIPLE
5038 \end_layout
5039
5040 \begin_layout Description
5041 Action This function is called when triple click on mouse button is pressed
5042  (inside workarea).
5043  Action depends on the context.
5044
5045 \end_layout
5046
5047 \begin_layout Description
5048 Notion This is internal LFUN, not to be used by users.
5049
5050 \end_layout
5051
5052 \begin_layout Description
5053 Origin Andre, 9 Aug 2002
5054 \end_layout
5055
5056 \begin_layout Subsection*
5057 LFUN_MOUSE_MOTION
5058 \end_layout
5059
5060 \begin_layout Description
5061 Action This function is called when mouse cursor is moving over the text.Action
5062  depends on the context.
5063
5064 \end_layout
5065
5066 \begin_layout Description
5067 Notion This is internal LFUN, not to be used by users.
5068
5069 \end_layout
5070
5071 \begin_layout Description
5072 Origin Andre, 9 Aug 2002
5073 \end_layout
5074
5075 \begin_layout Subsection*
5076 LFUN_MOUSE_RELEASE
5077 \end_layout
5078
5079 \begin_layout Description
5080 Action This function is called when mouse button is released (inside workarea).Ac
5081 tion depends on the context.
5082
5083 \end_layout
5084
5085 \begin_layout Description
5086 Notion This is internal LFUN, not to be used by users.
5087
5088 \end_layout
5089
5090 \begin_layout Description
5091 Origin Andre, 9 Aug 2002
5092 \end_layout
5093
5094 \begin_layout Subsection*
5095 LFUN_KEYMAP_OFF
5096 \end_layout
5097
5098 \begin_layout Description
5099 Action Turn off the loaded keyboard map.
5100
5101 \end_layout
5102
5103 \begin_layout Description
5104 Syntax keymap-off
5105 \end_layout
5106
5107 \begin_layout Subsection*
5108 LFUN_KEYMAP_PRIMARY
5109 \end_layout
5110
5111 \begin_layout Description
5112 Action Turn on the primary keyboard map.
5113
5114 \end_layout
5115
5116 \begin_layout Description
5117 Notion Maps were widely used in past, when X-windows didn't have nowadays
5118  keyboard support.
5119  They can be still used to maintain uniform keyboard layout across the various
5120  plaforms.
5121
5122 \newline
5123  The language is to be set in the Preferences dialog.
5124
5125 \end_layout
5126
5127 \begin_layout Description
5128 Syntax keymap-primary
5129 \end_layout
5130
5131 \begin_layout Subsection*
5132 LFUN_KEYMAP_SECONDARY
5133 \end_layout
5134
5135 \begin_layout Description
5136 Action Turn on the secondary keyboard map.
5137
5138 \end_layout
5139
5140 \begin_layout Description
5141 Syntax keymap-secondary
5142 \end_layout
5143
5144 \begin_layout Subsection*
5145 LFUN_KEYMAP_TOGGLE
5146 \end_layout
5147
5148 \begin_layout Description
5149 Action Toggles keyboard maps (first/second/off).
5150
5151 \end_layout
5152
5153 \begin_layout Description
5154 Syntax keymap-toggle
5155 \end_layout
5156
5157 \begin_layout Description
5158 Origin leeming, 30 Mar 2004
5159 \end_layout
5160
5161 \begin_layout Subsection*
5162 LFUN_SERVER_GET_LAYOUT
5163 \end_layout
5164
5165 \begin_layout Description
5166 Action Returns the current layout (that is environment) name on the cursor
5167  position.
5168
5169 \end_layout
5170
5171 \begin_layout Description
5172 Syntax server-get-layout
5173 \end_layout
5174
5175 \begin_layout Subsection*
5176 LFUN_SERVER_GET_FILENAME
5177 \end_layout
5178
5179 \begin_layout Description
5180 Action Returns path and file name of the currently edited document.
5181
5182 \end_layout
5183
5184 \begin_layout Description
5185 Syntax server-get-filename
5186 \end_layout
5187
5188 \begin_layout Subsection*
5189 LFUN_SERVER_GOTO_FILE_ROW
5190 \end_layout
5191
5192 \begin_layout Description
5193 Action Sets the cursor position based on the row number of generated TeX
5194  file.
5195
5196 \end_layout
5197
5198 \begin_layout Description
5199 Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
5200 \end_layout
5201
5202 \begin_layout Description
5203 Origin Edmar, 23 Dec 1998
5204 \end_layout
5205
5206 \begin_layout Subsection*
5207 LFUN_SERVER_NOTIFY
5208 \end_layout
5209
5210 \begin_layout Description
5211 Action Sends notify message about the last key-sequence to client.
5212
5213 \end_layout
5214
5215 \begin_layout Description
5216 Notion This can be used to grab last key-sequence used inside the LyX window.
5217
5218 \end_layout
5219
5220 \begin_layout Description
5221 Syntax server-notify
5222 \end_layout
5223
5224 \begin_layout Subsection*
5225 LFUN_SERVER_SET_XY
5226 \end_layout
5227
5228 \begin_layout Description
5229 Action Sets the cursor position based on the editing area coordinates (similar
5230  as clicking on that point with left mouse button).
5231
5232 \end_layout
5233
5234 \begin_layout Description
5235 Syntax server-set-xy <X> <Y>
5236 \end_layout
5237
5238 \begin_layout Subsection*
5239 LFUN_SERVER_GET_XY
5240 \end_layout
5241
5242 \begin_layout Description
5243 Action Returns the coordinates of cursor position in the editing area.
5244
5245 \end_layout
5246
5247 \begin_layout Description
5248 Syntax server-get-xy
5249 \end_layout
5250
5251 \begin_layout Subsection*
5252 LFUN_BUILD_PROGRAM
5253 \end_layout
5254
5255 \begin_layout Description
5256 Action Generates the code (literate programming).
5257
5258 \end_layout
5259
5260 \begin_layout Description
5261 Notion Latex file with extension literate_extension is generated.
5262  Then LyX invokes build_command (with a default of``make'') to generate
5263  the code and build_error_filter to process the compilation error messages.
5264
5265 \newline
5266  In case you want to process your literate file with a script, or some
5267  other program, just insert in your lyxrc file an entry with:
5268 \newline
5269  build_command
5270  "my_script my_arguments"
5271 \newline
5272  The build_error_filter differs from the literate_err
5273 or_filter only in that the former will identify error messages from your
5274  compiler.
5275
5276 \end_layout
5277
5278 \begin_layout Description
5279 Syntax build-program
5280 \end_layout
5281
5282 \begin_layout Subsection*
5283 LFUN_BUFFER_AUTO_SAVE
5284 \end_layout
5285
5286 \begin_layout Description
5287 Action Saves the current buffer to a temporary file.
5288
5289 \end_layout
5290
5291 \begin_layout Description
5292 Notion Saves the current buffer to a file named "#filename#".
5293  This LFUN is called automatically by LyX, to "autosave" the current buffer.
5294
5295 \end_layout
5296
5297 \begin_layout Description
5298 Syntax buffer-auto-save
5299 \end_layout
5300
5301 \begin_layout Subsection*
5302 LFUN_BUFFER_CHILD_OPEN
5303 \end_layout
5304
5305 \begin_layout Description
5306 Action Loads the given child document.
5307
5308 \end_layout
5309
5310 \begin_layout Description
5311 Notion The current document is treated as a parent.
5312
5313 \end_layout
5314
5315 \begin_layout Description
5316 Syntax buffer-child-open <FILE>
5317 \end_layout
5318
5319 \begin_layout Description
5320 Params <FILE>: Filename of the child.
5321  The directory of the parent is assumed by default.
5322
5323 \end_layout
5324
5325 \begin_layout Description
5326 Origin Ale, 28 May 1997
5327 \end_layout
5328
5329 \begin_layout Subsection*
5330 LFUN_BUFFER_CHKTEX
5331 \end_layout
5332
5333 \begin_layout Description
5334 Action Runs chktex for the current document.
5335
5336 \end_layout
5337
5338 \begin_layout Description
5339 Syntax buffer-chktex
5340 \end_layout
5341
5342 \begin_layout Description
5343 Origin Asger, 30 Oct 1997
5344 \end_layout
5345
5346 \begin_layout Subsection*
5347 LFUN_BUFFER_TOGGLE_COMPRESSION
5348 \end_layout
5349
5350 \begin_layout Description
5351 Action Toggles compression of the current document on/off.
5352
5353 \end_layout
5354
5355 \begin_layout Description
5356 Syntax buffer-toggle-compression
5357 \end_layout
5358
5359 \begin_layout Description
5360 Origin bpeng, 27 Apr 2006
5361 \end_layout
5362
5363 \begin_layout Subsection*
5364 LFUN_BUFFER_CLOSE
5365 \end_layout
5366
5367 \begin_layout Description
5368 Action Closes the current buffer.
5369
5370 \end_layout
5371
5372 \begin_layout Description
5373 Notion Closes the current buffer, asking whether to save it, etc, if the
5374  buffer has been modified.
5375
5376 \end_layout
5377
5378 \begin_layout Description
5379 Syntax buffer-close
5380 \end_layout
5381
5382 \begin_layout Subsection*
5383 LFUN_BUFFER_EXPORT
5384 \end_layout
5385
5386 \begin_layout Description
5387 Action Exports the current buffer (document) to the given format.
5388
5389 \end_layout
5390
5391 \begin_layout Description
5392 Syntax buffer-export <FORMAT>
5393 \end_layout
5394
5395 \begin_layout Description
5396 Params <FORMAT> is either "custom" or one of the formats which you can find
5397  in Tools->Preferences->File formats->Format.
5398  Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5399  for pdflatex) or "ps" for postscript.
5400
5401 \newline
5402  In case of "custom" you will be asked for a format you want to start from
5403  and for the command that you want to apply to this format.
5404  Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5405
5406 \end_layout
5407
5408 \begin_layout Description
5409 Origin Lgb, 29 Jul 1997
5410 \end_layout
5411
5412 \begin_layout Subsection*
5413 LFUN_BUFFER_EXPORT_CUSTOM
5414 \end_layout
5415
5416 \begin_layout Description
5417 Action Exports the current buffer (document) from the given format using
5418  the given command on it.
5419
5420 \end_layout
5421
5422 \begin_layout Description
5423 Syntax buffer-export-custom <FORMAT> <COMMAND>
5424 \end_layout
5425
5426 \begin_layout Description
5427 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5428  file).
5429
5430 \newline
5431  <COMMAND> this command will be launched on the file.
5432  Note that you can use "$$FName" string to qualify the intermediate file.
5433
5434 \end_layout
5435
5436 \begin_layout Description
5437 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5438 \end_layout
5439
5440 \begin_layout Description
5441 Origin leeming, 27 Mar 2004
5442 \end_layout
5443
5444 \begin_layout Subsection*
5445 LFUN_BUFFER_PRINT
5446 \end_layout
5447
5448 \begin_layout Description
5449 Action Prints the current document.
5450
5451 \end_layout
5452
5453 \begin_layout Description
5454 Notion Many settings can be given via the preferences dialog.
5455
5456 \end_layout
5457
5458 \begin_layout Description
5459 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5460 \end_layout
5461
5462 \begin_layout Description
5463 Params <TARGET> is either "printer" or "file".
5464
5465 \newline
5466  <TARGER-NAME> is either "default" or file name or printer name.
5467
5468 \newline
5469  <COMMAND> command ensuring the printing job.
5470
5471 \end_layout
5472
5473 \begin_layout Description
5474 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5475 \end_layout
5476
5477 \begin_layout Description
5478 Origin leeming, 28 Mar 2004
5479 \end_layout
5480
5481 \begin_layout Subsection*
5482 LFUN_BUFFER_IMPORT
5483 \end_layout
5484
5485 \begin_layout Description
5486 Action Import a given file as a lyx document.
5487
5488 \end_layout
5489
5490 \begin_layout Description
5491 Notion File can be imported iff lyx file format is (transitively) reachable
5492  via defined convertors in preferences.
5493  Look into File->Import menu to get an idea of the currently active import
5494  formats.
5495
5496 \end_layout
5497
5498 \begin_layout Description
5499 Syntax buffer-import <FORMAT> [<FILE>]
5500 \end_layout
5501
5502 \begin_layout Description
5503 Origin Asger, 24 Jul 1998
5504 \end_layout
5505
5506 \begin_layout Subsection*
5507 LFUN_BUFFER_NEW
5508 \end_layout
5509
5510 \begin_layout Description
5511 Action Creates a new buffer (that is, document).
5512
5513 \end_layout
5514
5515 \begin_layout Description
5516 Notion Implicit path can be set in Preferences dialog.
5517
5518 \end_layout
5519
5520 \begin_layout Description
5521 Syntax buffer-new [<FILE>]
5522 \end_layout
5523
5524 \begin_layout Description
5525 Params <FILE>: filename of created file with absolute path.
5526
5527 \end_layout
5528
5529 \begin_layout Subsection*
5530 LFUN_BUFFER_NEW_TEMPLATE
5531 \end_layout
5532
5533 \begin_layout Description
5534 Action Creates a new buffer (that is, document) from a template.
5535
5536 \end_layout
5537
5538 \begin_layout Description
5539 Notion Path for new files and templates can be set in Preferences dialog.
5540  Template will be asked for via Open-dialog.
5541
5542 \end_layout
5543
5544 \begin_layout Description
5545 Syntax buffer-new-template [<FILE>]
5546 \end_layout
5547
5548 \begin_layout Description
5549 Params <FILE>: filename of created file with absolute path.
5550
5551 \end_layout
5552
5553 \begin_layout Subsection*
5554 LFUN_BUFFER_RELOAD
5555 \end_layout
5556
5557 \begin_layout Description
5558 Action Reverts opened document.
5559
5560 \end_layout
5561
5562 \begin_layout Description
5563 Syntax buffer-reload
5564 \end_layout
5565
5566 \begin_layout Description
5567 Origin Asger, 2 Feb 1997
5568 \end_layout
5569
5570 \begin_layout Subsection*
5571 LFUN_BUFFER_SWITCH
5572 \end_layout
5573
5574 \begin_layout Description
5575 Action Switch to the given buffer.
5576
5577 \end_layout
5578
5579 \begin_layout Description
5580 Notion This is useful also in case you need simultaneously more views of
5581  the edited document in different LyX windows.
5582
5583 \end_layout
5584
5585 \begin_layout Description
5586 Syntax buffer-new-template <BUFFER>
5587 \end_layout
5588
5589 \begin_layout Description
5590 Params <BUFFER>: already opened document which is to be shown.
5591
5592 \end_layout
5593
5594 \begin_layout Subsection*
5595 LFUN_BUFFER_TOGGLE_READ_ONLY
5596 \end_layout
5597
5598 \begin_layout Description
5599 Action Toggle editing mode of the current document between read/write and
5600  read-only.
5601
5602 \end_layout
5603
5604 \begin_layout Description
5605 Notion In the ->Readonly mode checks-in/commits the data if the file is
5606  under version control.
5607  In the Readonly-> mode checkouts the data from repository.
5608
5609 \newline
5610  If these operations fail, buffer won't be toggled.
5611
5612 \end_layout
5613
5614 \begin_layout Description
5615 Syntax buffer-toggle-read-only
5616 \end_layout
5617
5618 \begin_layout Description
5619 Origin Lgb, 27 May 1997
5620 \end_layout
5621
5622 \begin_layout Subsection*
5623 LFUN_BUFFER_VIEW
5624 \end_layout
5625
5626 \begin_layout Description
5627 Action Displays current buffer in chosen format.
5628
5629 \end_layout
5630
5631 \begin_layout Description
5632 Notion Displays the contents of the current buffer in the chosen format,
5633  for example, PDF or DVI.
5634  This runs the necessary converter, calls the defined viewer, and so forth.
5635
5636 \end_layout
5637
5638 \begin_layout Description
5639 Syntax buffer-view <FORMAT>
5640 \end_layout
5641
5642 \begin_layout Description
5643 Params <FORMAT>: The format to display, where this is one of the formats
5644  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5645
5646 \end_layout
5647
5648 \begin_layout Subsection*
5649 LFUN_BUFFER_UPDATE
5650 \end_layout
5651
5652 \begin_layout Description
5653 Action Exports the current document and put the result into the temporary
5654  directory.
5655
5656 \end_layout
5657
5658 \begin_layout Description
5659 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5660 EW) the output will be rewriten - updated.
5661  This is useful in case your viewer is able to detect such changes (e.g.
5662  ghostview for postscript).
5663
5664 \end_layout
5665
5666 \begin_layout Description
5667 Syntax buffer-update <FORMAT>
5668 \end_layout
5669
5670 \begin_layout Description
5671 Params <FORMAT>: The format to display, where this is one of the formats
5672  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5673
5674 \end_layout
5675
5676 \begin_layout Description
5677 Origin Dekel, 5 Aug 2000
5678 \end_layout
5679
5680 \begin_layout Subsection*
5681 LFUN_BUFFER_WRITE
5682 \end_layout
5683
5684 \begin_layout Description
5685 Action Saves the current buffer.
5686
5687 \end_layout
5688
5689 \begin_layout Description
5690 Notion Saves the current buffer to disk, using the filename that is already
5691  associated with the buffer, asking for one if none is yet assigned.
5692
5693 \end_layout
5694
5695 \begin_layout Description
5696 Syntax buffer-write
5697 \end_layout
5698
5699 \begin_layout Subsection*
5700 LFUN_BUFFER_WRITE_AS
5701 \end_layout
5702
5703 \begin_layout Description
5704 Action Rename and save current buffer.
5705
5706 \end_layout
5707
5708 \begin_layout Description
5709 Syntax buffer-write-as <FILENAME>
5710 \end_layout
5711
5712 \begin_layout Description
5713 Params <FILENAME>: New name of the buffer/file.
5714  A relative path is with respect to the original location of the buffer/file.
5715
5716 \end_layout
5717
5718 \begin_layout Subsection*
5719 LFUN_BUFFER_WRITE_ALL
5720 \end_layout
5721
5722 \begin_layout Description
5723 Action Save all changed documents.
5724
5725 \end_layout
5726
5727 \begin_layout Description
5728 Syntax buffer-write-all
5729 \end_layout
5730
5731 \begin_layout Description
5732 Origin rgh, gpothier 6 Aug 2007
5733 \end_layout
5734
5735 \begin_layout Subsection*
5736 LFUN_BUFFER_NEXT
5737 \end_layout
5738
5739 \begin_layout Description
5740 Action Switch to the next opened document.
5741
5742 \end_layout
5743
5744 \begin_layout Description
5745 Notion Note that this does not necessarily mean next in tabbar (for full
5746  list see View menu).
5747
5748 \end_layout
5749
5750 \begin_layout Description
5751 Syntax buffer-next
5752 \end_layout
5753
5754 \begin_layout Subsection*
5755 LFUN_BUFFER_PREVIOUS
5756 \end_layout
5757
5758 \begin_layout Description
5759 Action Switch to the previous opened document.
5760
5761 \end_layout
5762
5763 \begin_layout Description
5764 Syntax buffer-previous
5765 \end_layout
5766
5767 \begin_layout Subsection*
5768 LFUN_MASTER_BUFFER_UPDATE
5769 \end_layout
5770
5771 \begin_layout Description
5772 Action When run from a child document, this updates (exports) document built
5773  from the master buffer.
5774  If a master is not found, it updates the current buffer.
5775
5776 \end_layout
5777
5778 \begin_layout Description
5779 Syntax master-buffer-update
5780 \end_layout
5781
5782 \begin_layout Description
5783 Origin Tommaso, 20 Sep 2007
5784 \end_layout
5785
5786 \begin_layout Subsection*
5787 LFUN_MASTER_BUFFER_VIEW
5788 \end_layout
5789
5790 \begin_layout Description
5791 Action When run from a child document, this command shows a preview built
5792  from the master buffer.
5793  If a master is not found, it previews the current buffer.
5794
5795 \end_layout
5796
5797 \begin_layout Description
5798 Syntax master-buffer-view
5799 \end_layout
5800
5801 \begin_layout Description
5802 Origin Tommaso, 20 Sep 2007
5803 \end_layout
5804
5805 \begin_layout Subsection*
5806 LFUN_BUFFER_LANGUAGE
5807 \end_layout
5808
5809 \begin_layout Description
5810 Action Set language of the current document.
5811
5812 \end_layout
5813
5814 \begin_layout Description
5815 Syntax buffer-language <LANG>
5816 \end_layout
5817
5818 \begin_layout Description
5819 Params <LANG>: language name.
5820  See lib/languages for list.
5821
5822 \end_layout
5823
5824 \begin_layout Description
5825 Origin leeming, 30 Mar 2004
5826 \end_layout
5827
5828 \begin_layout Subsection*
5829 LFUN_BUFFER_SAVE_AS_DEFAULT
5830 \end_layout
5831
5832 \begin_layout Description
5833 Action Save the current document settings as default.
5834
5835 \end_layout
5836
5837 \begin_layout Description
5838 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
5839
5840 \end_layout
5841
5842 \begin_layout Description
5843 Syntax buffer-save-as-default [<ARGS>]
5844 \end_layout
5845
5846 \begin_layout Description
5847 Params <ARGS>: contains the particular settings to be saved.
5848  They obey the syntax you can find in document header of usual .lyx file.
5849
5850 \end_layout
5851
5852 \begin_layout Description
5853 Origin leeming, 30 Mar 2004
5854 \end_layout
5855
5856 \begin_layout Subsection*
5857 LFUN_BUFFER_PARAMS_APPLY
5858 \end_layout
5859
5860 \begin_layout Description
5861 Action Apply the given settings to the current document.
5862
5863 \end_layout
5864
5865 \begin_layout Description
5866 Syntax buffer-params-apply [<ARGS>]
5867 \end_layout
5868
5869 \begin_layout Description
5870 Params <ARGS>: contains the particular settings to be saved.
5871  They obey the syntax you can find in document header of usual .lyx file.
5872
5873 \end_layout
5874
5875 \begin_layout Description
5876 Origin leeming, 30 Mar 2004
5877 \end_layout
5878
5879 \begin_layout Subsection*
5880 LFUN_FILE_INSERT
5881 \end_layout
5882
5883 \begin_layout Description
5884 Action Inserts another LyX file.
5885
5886 \end_layout
5887
5888 \begin_layout Description
5889 Syntax file-insert [<FILE>]
5890 \end_layout
5891
5892 \begin_layout Description
5893 Params <FILE>: Filename to be inserted.
5894
5895 \end_layout
5896
5897 \begin_layout Subsection*
5898 LFUN_FILE_INSERT_PLAINTEXT
5899 \end_layout
5900
5901 \begin_layout Description
5902 Action Inserts plain text file.
5903
5904 \end_layout
5905
5906 \begin_layout Description
5907 Syntax file-insert-plaintext [<FILE>]
5908 \end_layout
5909
5910 \begin_layout Description
5911 Params <FILE>: Filename to be inserted.
5912
5913 \end_layout
5914
5915 \begin_layout Description
5916 Origin CFO-G, 19 Nov 1997
5917 \end_layout
5918
5919 \begin_layout Subsection*
5920 LFUN_FILE_INSERT_PLAINTEXT_PARA
5921 \end_layout
5922
5923 \begin_layout Description
5924 Action Inserts plain text file as paragraph (i.e.
5925  join lines).
5926
5927 \end_layout
5928
5929 \begin_layout Description
5930 Syntax file-insert-plaintext-para [<FILE>]
5931 \end_layout
5932
5933 \begin_layout Description
5934 Params <FILE>: Filename to be inserted.
5935
5936 \end_layout
5937
5938 \begin_layout Description
5939 Origin Levon, 14 Feb 2001
5940 \end_layout
5941
5942 \begin_layout Subsection*
5943 LFUN_FILE_OPEN
5944 \end_layout
5945
5946 \begin_layout Description
5947 Action Open LyX document.
5948
5949 \end_layout
5950
5951 \begin_layout Description
5952 Syntax file-open [<FILE>]
5953 \end_layout
5954
5955 \begin_layout Description
5956 Params <FILE>: Filename to be opened.
5957
5958 \end_layout
5959
5960 \begin_layout Subsection*
5961 LFUN_CALL
5962 \end_layout
5963
5964 \begin_layout Description
5965 Action Executes a command defined in a .def file.
5966
5967 \end_layout
5968
5969 \begin_layout Description
5970 Notion The definitions are by default read from lib/commands/default.def.
5971
5972 \newline
5973  A .def file allows to define a command with
5974 \backslash
5975 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
5976  <LFUN> is the lfun code to be executed (see e.g.
5977  LFUN_COMMAND_SEQUENCE).
5978
5979 \backslash
5980 def_file "FileName" allows to include another .def file.
5981
5982 \newline
5983  This is particularly useful in connection with toolbar buttons: Since
5984  the name of the button image for this lfun is lib/images/commands/<NAME>.png
5985  this is the way to assign an image to a complex command-sequence.
5986
5987 \end_layout
5988
5989 \begin_layout Description
5990 Syntax call <NAME>
5991 \end_layout
5992
5993 \begin_layout Description
5994 Params <NAME>: Name of the command that must be called.
5995
5996 \end_layout
5997
5998 \begin_layout Description
5999 Origin broider, 2 Oct 2007
6000 \end_layout
6001
6002 \begin_layout Subsection*
6003 LFUN_META_PREFIX
6004 \end_layout
6005
6006 \begin_layout Description
6007 Action Simulate halting Meta key (Alt key on PCs).
6008
6009 \end_layout
6010
6011 \begin_layout Description
6012 Notion Used for buffer editation not for GUI control.
6013
6014 \end_layout
6015
6016 \begin_layout Description
6017 Syntax meta-prefix
6018 \end_layout
6019
6020 \begin_layout Subsection*
6021 LFUN_CANCEL
6022 \end_layout
6023
6024 \begin_layout Description
6025 Action Cancels sequence prepared by LFUN_META_PREFIX .
6026
6027 \end_layout
6028
6029 \begin_layout Description
6030 Syntax cancel
6031 \end_layout
6032
6033 \begin_layout Subsection*
6034 LFUN_COMMAND_EXECUTE
6035 \end_layout
6036
6037 \begin_layout Description
6038 Action Opens the minibuffer toolbar so that the user can type in there.
6039
6040 \end_layout
6041
6042 \begin_layout Description
6043 Notion Usually bound to M-x shortcut.
6044
6045 \end_layout
6046
6047 \begin_layout Description
6048 Syntax command-execute
6049 \end_layout
6050
6051 \begin_layout Subsection*
6052 LFUN_COMMAND_PREFIX
6053 \end_layout
6054
6055 \begin_layout Description
6056 Action Return the current key sequence and available options as a string.
6057
6058 \end_layout
6059
6060 \begin_layout Description
6061 Notion No options are added if no current map exists.
6062
6063 \newline
6064  This is probably usable only with connection to lyxserver.
6065
6066 \end_layout
6067
6068 \begin_layout Description
6069 Syntax command-prefix
6070 \end_layout
6071
6072 \begin_layout Subsection*
6073 LFUN_COMMAND_SEQUENCE
6074 \end_layout
6075
6076 \begin_layout Description
6077 Action Run more commands (LFUN and its parameters) in a sequence.
6078
6079 \end_layout
6080
6081 \begin_layout Description
6082 Syntax command-sequence <CMDS>
6083 \end_layout
6084
6085 \begin_layout Description
6086 Params <CMDS>: Sequence of commands separated by semicolons.
6087
6088 \end_layout
6089
6090 \begin_layout Description
6091 Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
6092  {}; inset-toggle;
6093 \end_layout
6094
6095 \begin_layout Description
6096 Origin Andre, 11 Nov 1999
6097 \end_layout
6098
6099 \begin_layout Subsection*
6100 LFUN_MESSAGE
6101 \end_layout
6102
6103 \begin_layout Description
6104 Action Shows message in statusbar (for script purposes).
6105
6106 \end_layout
6107
6108 \begin_layout Description
6109 Syntax message <STRING>
6110 \end_layout
6111
6112 \begin_layout Description
6113 Origin Lgb, 8 Apr 2001
6114 \end_layout
6115
6116 \begin_layout Subsection*
6117 LFUN_PREFERENCES_SAVE
6118 \end_layout
6119
6120 \begin_layout Description
6121 Action Save user preferences.
6122
6123 \end_layout
6124
6125 \begin_layout Description
6126 Syntax preferences-save
6127 \end_layout
6128
6129 \begin_layout Description
6130 Origin Lgb, 27 Nov 1999
6131 \end_layout
6132
6133 \begin_layout Subsection*
6134 LFUN_RECONFIGURE
6135 \end_layout
6136
6137 \begin_layout Description
6138 Action Reconfigure the automatic settings.
6139
6140 \end_layout
6141
6142 \begin_layout Description
6143 Syntax reconfigure
6144 \end_layout
6145
6146 \begin_layout Description
6147 Origin Asger, 14 Feb 1997
6148 \end_layout
6149
6150 \begin_layout Subsection*
6151 LFUN_LYXRC_APPLY
6152 \end_layout
6153
6154 \begin_layout Description
6155 Action Apply the given settings to user preferences.
6156
6157 \end_layout
6158
6159 \begin_layout Description
6160 Syntax lyxrc-apply <SETTINGS>
6161 \end_layout
6162
6163 \begin_layout Description
6164 Params <SETTINGS>: settings which are to be set.
6165  Take a look into ~/.lyx/preferences to get an idea which commands to use
6166  and their syntax.
6167  lyx::LyXRC::LyXRCTags has the list of possible commands.
6168
6169 \end_layout
6170
6171 \begin_layout Subsection*
6172 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6173 \end_layout
6174
6175 \begin_layout Description
6176 Action Determine whether keep cursor inside the editing window regardless
6177  the scrollbar movement.
6178
6179 \end_layout
6180
6181 \begin_layout Description
6182 Syntax toggle-cursor-follows-scrollbar
6183 \end_layout
6184
6185 \begin_layout Description
6186 Origin ARRae, 2 Dec 1997
6187 \end_layout
6188
6189 \begin_layout Subsection*
6190 LFUN_SET_COLOR
6191 \end_layout
6192
6193 \begin_layout Description
6194 Action Set the given LyX color to the color defined by the X11 name given.
6195
6196 \end_layout
6197
6198 \begin_layout Description
6199 Notion A new color entry is created if the color is unknown.
6200  Color names can be stored as a part of user settings.
6201
6202 \end_layout
6203
6204 \begin_layout Description
6205 Syntax set-color <LYX_NAME> <X11_NAME>
6206 \end_layout
6207
6208 \begin_layout Description
6209 Origin SLior, 11 Jun 2000
6210 \end_layout
6211
6212 \begin_layout Subsection*
6213 LFUN_STATISTICS
6214 \end_layout
6215
6216 \begin_layout Description
6217 Action Count the statistics (number of words and characters) in the document
6218  or in the given selection.
6219
6220 \end_layout
6221
6222 \begin_layout Description
6223 Notion Note that this function gives the number of words/chars written,
6224  not the number of characters which will be typeset.
6225
6226 \end_layout
6227
6228 \begin_layout Description
6229 Syntax statistics
6230 \end_layout
6231
6232 \begin_layout Description
6233 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6234 \end_layout
6235
6236 \begin_layout Subsection*
6237 LFUN_COMPLETION_INLINE
6238 \end_layout
6239
6240 \begin_layout Description
6241 Action Show the inline completion at the cursor position.
6242
6243 \end_layout
6244
6245 \begin_layout Description
6246 Syntax completion-inline
6247 \end_layout
6248
6249 \begin_layout Description
6250 Origin sts, Feb 19 2008
6251 \end_layout
6252
6253 \begin_layout Subsection*
6254 LFUN_COMPLETION_POPUP
6255 \end_layout
6256
6257 \begin_layout Description
6258 Action Show the completion popup at the cursor position.
6259
6260 \end_layout
6261
6262 \begin_layout Description
6263 Syntax completion-popup
6264 \end_layout
6265
6266 \begin_layout Description
6267 Origin sts, Feb 19 2008
6268 \end_layout
6269
6270 \begin_layout Subsection*
6271 LFUN_COMPLETION_COMPLETE
6272 \end_layout
6273
6274 \begin_layout Description
6275 Action Try to complete the word or command at the cursor position.
6276
6277 \end_layout
6278
6279 \begin_layout Description
6280 Syntax completion-complete
6281 \end_layout
6282
6283 \begin_layout Description
6284 Origin sts, Feb 19 2008
6285 \end_layout
6286
6287 \begin_layout Subsection*
6288 LFUN_BRANCH_ACTIVATE
6289 \end_layout
6290
6291 \begin_layout Description
6292 Action Activate the branch
6293 \end_layout
6294
6295 \begin_layout Description
6296 Syntax branch-activate <BRANCH>
6297 \end_layout
6298
6299 \begin_layout Description
6300 Params <BRANCH>: The branch to activate
6301 \end_layout
6302
6303 \begin_layout Description
6304 Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
6305 \newline
6306 could be used
6307  to export a pdf with the answers branch includedwithout one's having to
6308  open LyX and activate the branch manually.
6309 \end_layout
6310
6311 \begin_layout Description
6312 Origin rgh, 27 May 2008
6313 \end_layout
6314
6315 \begin_layout Subsection*
6316 LFUN_BRANCH_ACTIVATE
6317 \end_layout
6318
6319 \begin_layout Description
6320 Action De-activate the branch
6321 \end_layout
6322
6323 \begin_layout Description
6324 Syntax branch-deactivate <BRANCH>
6325 \end_layout
6326
6327 \begin_layout Description
6328 Params <BRANCH>: The branch to deactivate
6329 \end_layout
6330
6331 \begin_layout Description
6332 Origin rgh, 27 May 2008
6333 \end_layout
6334
6335 \end_body
6336 \end_document