citation patch from Angus

[lyx.git] / src / MenuBackend.h

diff --git a/src/MenuBackend.h b/src/MenuBackend.h
index 4a1d16bf7f70f79823b8af6763a01d8dbf7f5620..d0a3e1e8dd5ce80f37aab63afc24e11ce1bbe710 100644 (file)
--- a/src/MenuBackend.h
+++ b/src/MenuBackend.h
@@ -3,8 +3,8 @@
 * 
 *           LyX, The Document Processor
 *
-*           Copyright (C) 1995 Matthias Ettrich
-*           Copyright (C) 1995-1999 The LyX Team.
+*           Copyright 1995 Matthias Ettrich
+*           Copyright 1995-2000 The LyX Team.
 *
 *           This file is Copyright 1999
 *           Jean-Marc Lasgouttes
@@ -19,69 +19,95 @@
 #endif
 
 #include "LString.h"
-#include "support/LAssert.h"
+#include "support/lstrings.h"
 #include <vector>
 
 class LyXLex;
-class MenuItem;
 
+///
 class MenuItem {
 public:
-       // The type of elements that can be in a menu
-       enum Kind { 
-               Command, 
-               Submenu, 
-               Separator, 
-               Lastfiles, // This is the list of last opened file,
-                          // typically for the File menu. 
-               Documents  // This is the list of opened Documents,
-                          // typically for the Documents menu.
+       /// The type of elements that can be in a menu
+       enum Kind {
+               ///
+               Command,
+               ///
+               Submenu,
+               ///
+               Separator,
+               /** This is the list of last opened file,
+                   typically for the File menu. */
+               Lastfiles,
+               /** This is the list of opened Documents,
+                   typically for the Documents menu. */
+               Documents,
+               ///
+               Toc,
+               ///
+               References,
+               /** This is a list of viewable formats
+                   typically for the Documents menu. */
+               ViewFormats,
+               /** This is a list of updatable formats
+                   typically for the Documents menu. */
+               UpdateFormats,
+               /** This is a list of exportable formats
+                   typically for the Documents menu. */
+               ExportFormats
        };
-       // Create a copy of a given MenuItem
-       MenuItem(MenuItem const &);
-       // Create a Command type MenuItem
-       MenuItem(Kind kind_, string const & label_ = string(), 
-                string const & command_ = string());
-       //
-       ~MenuItem() {}
-
-       // The label of a given menuitem
-       string const & label() const { return label_; }
-       // The kind of entry
+       /// Create a Command type MenuItem
+       MenuItem(Kind kind, 
+                string const & label = string(), 
+                string const & command = string(), 
+                bool optional = false);
+       /// The label of a given menuitem
+       string label() const { return token(label_, '|', 0); }
+       ///
+       string shortcut() const { return token(label_, '|', 1); }
+       /// The kind of entry
        Kind kind() const { return kind_; } 
-       // the action (if relevant)
+       /// the action (if relevant)
        int action() const { return action_; }
-       // the description of the  submenu (if relevant)
+       /// the description of the  submenu (if relevant)
        string const & submenu() const { return submenu_; }
-       
+       /// returns true if the entry should be ommited when disabled
+       bool optional() const { return optional_; }
 private:
+       ///
        Kind kind_;
+       ///
        string label_;
+       ///
        int action_;
+       ///
        string submenu_;
-       MenuItem() {}
+       ///
+       bool optional_;
 };
 
 
+///
 class Menu {
 public:
-       //
+       ///
        typedef std::vector<MenuItem> ItemList;
-       //
+       ///
        typedef ItemList::const_iterator const_iterator;
-       //
+       ///
        explicit Menu(string const & name, bool mb = false) 
                : menubar_(mb), name_(name) {}
-       //
-       void add(MenuItem const &);
-       //
-       void read(LyXLex &);
-       // 
+       ///
+       Menu & add(MenuItem const &);
+       ///
+       Menu & read(LyXLex &);
+       /// 
        bool menubar() const { return menubar_; }
-       // 
+       /// 
        string const & name() const { return name_; }
-       //
+       ///
        bool empty() const { return items_.empty(); }
+       ///
+       ItemList::size_type size() const { return items_.size(); }
         ///
         const_iterator begin() const {
                 return items_.begin();
@@ -90,7 +116,6 @@ public:
         const_iterator end() const {
                 return items_.end();
         }
-    
 private:
        ///
        ItemList items_;
@@ -98,10 +123,10 @@ private:
        bool menubar_;
        ///
        string name_;
-       ///
 };
 
 
+///
 class MenuBackend {
 public:
        ///
@@ -117,6 +142,8 @@ public:
        ///
        bool hasMenu (string const &) const;
        ///
+       Menu & getMenu (string const &);
+       ///
        Menu const & getMenu (string const &) const;
        //
        bool empty() const { return menulist_.empty(); }
@@ -133,6 +160,7 @@ private:
        MenuList menulist_;
 };
 
+///
 extern MenuBackend menubackend;
 
 #endif /* MENUBACKEND_H */