lib/doc/LFUNs.lyx

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