]> git.lyx.org Git - lyx.git/blobdiff - src/lfuns.h
cut down pch.h to more frequently needed headers
[lyx.git] / src / lfuns.h
index 8ac3c0a17aa1ea7273495c67f9a32c5e99c2d156..299166c6a23d459c8deaa6e9ea0ed18e69de1499 100644 (file)
@@ -29,6 +29,19 @@ namespace lyx {
  * BufferView::dispatch(), Cursor::dispatch() and
  * Inset*::doDispatch();
  */
+
+/** LFUN documentation (a start at least, Chr 2007-08-12)
+ *
+ * The documentation below is primarily notes about restrictions and
+ * oddities relating to the different LFUNs. Note that this
+ * documentation may well be moved to a more suitable location later
+ * on.
+ *
+ * The documentation is interspersed with the enum:s. Another choice
+ * was to put it in a separate list. The best choice was unclear, so
+ * this may change. Particularly if doxygen can be used somehow.
+ */
+
 enum kb_action {
        LFUN_UNKNOWN_ACTION = -1,
        // 0
@@ -39,6 +52,12 @@ enum kb_action {
        LFUN_BUFFER_WRITE,
        // 5
        LFUN_BUFFER_WRITE_AS,
+/**    LFUN_BUFFER_WRITE_AS,           
+ * Function:   Rename and save current buffer.
+ * Syntax:     buffer-write-as <filename>
+ * In:         <filename> = New name of the buffer/file. A relative path
+ *             is with respect to the original location of the buffer/file.
+ */
        LFUN_BUILD_PROGRAM,
        LFUN_BUFFER_VIEW,
        LFUN_BUFFER_CLOSE,
@@ -327,7 +346,7 @@ enum kb_action {
        LFUN_FINISHED_LEFT,
        // 245
        LFUN_FINISHED_RIGHT,
-       LFUN_CHARSTYLE_INSERT,
+       LFUN_FLEX_INSERT,
        LFUN_WORD_FIND,
        LFUN_WORD_REPLACE,
        LFUN_BUFFER_EXPORT_CUSTOM,
@@ -371,15 +390,19 @@ enum kb_action {
        LFUN_WINDOW_CLOSE,               // Abdel 20061023
        LFUN_UNICODE_INSERT,             // Lgb 20061022
        LFUN_BOOKMARK_CLEAR,             // bpeng 20061031
-       LFUN_TOOLBAR_TOGGLE_STATE,       // bpeng 20061101
        LFUN_NOMENCL_INSERT,             // Ugras
-       // 285
        LFUN_NOMENCL_PRINT,              // Ugras
+       // 285
        LFUN_CLEARPAGE_INSERT,           // Ugras 20061125
        LFUN_CLEARDOUBLEPAGE_INSERT,     // Ugras 20061125
        LFUN_LISTING_INSERT,             // Herbert 20011110, bpeng 20070502
        LFUN_TOOLBAR_TOGGLE,             // Edwin 20070521
+       LFUN_BUFFER_WRITE_ALL,           // rgh, gpothier 200707XX
        //290
+       LFUN_PARAGRAPH_PARAMS,           // rgh, 200708XX
+       LFUN_LAYOUT_MODULES_CLEAR,       // rgh, 20070825
+       LFUN_LAYOUT_MODULE_ADD,          // rgh, 20070825
+       LFUN_LAYOUT_RELOAD,              // rgh, 20070903
 
        LFUN_LASTACTION                  // end of the table
 };