]> git.lyx.org Git - features.git/blobdiff - src/MenuBackend.h
Replace LString.h with support/std_string.h,
[features.git] / src / MenuBackend.h
index b7a3abeb7aba4d62754e42f5ad479f40015663c6..f6746e08bbe2a80222d81790a45e0b37aa045bb0 100644 (file)
@@ -1,29 +1,28 @@
-/* This file is part of              -*- C++ -*-
-* ======================================================
-*
-*           LyX, The Document Processor
-*
-*           Copyright 1995 Matthias Ettrich
-*           Copyright 1995-2001 The LyX Team.
-*
-*           This file is Copyright 1999
-*           Jean-Marc Lasgouttes
-*
-*======================================================*/
+// -*- C++ -*-
+/**
+ * \file MenuBackend.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef MENUBACKEND_H
 #define MENUBACKEND_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "support/std_string.h"
 
-#include "LString.h"
-#include <vector>
 #include <boost/shared_ptr.hpp>
 
+#include <vector>
+
+#include "FuncStatus.h"
+
 class LyXLex;
-class Buffer;
+class LyXView;
 class Menu;
 
 ///
@@ -62,7 +61,12 @@ public:
                FloatListInsert,
                /** This is the list of floats that we can
                    insert. */
-               FloatInsert
+               FloatInsert,
+               /** This is the list of selections that can
+                   be pasted. */
+               PasteRecent,
+               /** Available branches in document */
+               Branches
        };
        /// Create a Command type MenuItem
        MenuItem(Kind kind,
@@ -72,9 +76,7 @@ public:
        MenuItem(Kind kind,
                 string const & label,
                 int action,
-                bool optional = false)
-               : kind_(kind), label_(label),
-                 action_(action), submenuname_(), optional_(optional) {}
+                bool optional = false);
 
        /// This one is just to please boost::shared_ptr<>
        ~MenuItem();
@@ -90,14 +92,22 @@ public:
        int action() const { return action_; }
        /// returns true if the entry should be ommited when disabled
        bool optional() const { return optional_; }
+       /// returns the status of the lfun associated with this entry
+       FuncStatus const & status() const { return status_; }
+       /// returns the status of the lfun associated with this entry
+       FuncStatus & status() { return status_; }
+       /// returns the status of the lfun associated with this entry
+       void status(FuncStatus const & status) { status_ = status; }
+       /// returns the binding associated to this action
+       string const binding() const;
        /// the description of the  submenu (if relevant)
        string const & submenuname() const { return submenuname_; }
-       /// the description of the  submenu (if relevant)
+       /// set the description of the  submenu
        void submenuname(string const & name) { submenuname_ = name; }
        ///
        Menu * submenu() const { return submenu_.get(); }
        ///
-       void submenu(Menu * menu) { submenu_.reset(menu); }
+       void submenu(Menu * menu);
 
 private:
        //friend class MenuBackend;
@@ -112,6 +122,8 @@ private:
        ///
        bool optional_;
        ///
+       FuncStatus status_;
+       ///
        boost::shared_ptr<Menu> submenu_;
 };
 
@@ -129,7 +141,7 @@ public:
        explicit Menu(string const & name = string())
                : name_(name) {}
        ///
-       Menu & add(MenuItem const &);
+       Menu & add(MenuItem const &, LyXView const * view = 0);
        ///
        Menu & read(LyXLex &);
        ///
@@ -153,6 +165,7 @@ public:
        void checkShortcuts() const;
 
 private:
+       friend class MenuBackend;
        ///
        ItemList items_;
        ///
@@ -169,16 +182,14 @@ public:
        typedef MenuList::const_iterator const_iterator;
        ///
        void read(LyXLex &);
-       /// Set default values for menu structure.
-       void defaults();
        ///
        void add(Menu const &);
        ///
        bool hasMenu(string const &) const;
        ///
-       Menu & getMenu (string const &);
+       Menu & getMenu(string const &);
        ///
-       Menu const & getMenu (string const &) const;
+       Menu const & getMenu(string const &) const;
        ///
        Menu const & getMenubar() const;
        ///
@@ -186,10 +197,10 @@ public:
        /// Expands some special entries of the menu
        /** The entries with the following kind are expanded to a
            sequence of Command MenuItems: Lastfiles, Documents,
-           ViewFormats, ExportFormats, UpdateFormats
+           ViewFormats, ExportFormats, UpdateFormats, Branches
        */
        void expand(Menu const & frommenu, Menu & tomenu,
-                   Buffer const *) const;
+                   LyXView const *) const;
        ///
        const_iterator begin() const {
                return menulist_.begin();