X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FMenuBackend.h;h=07c115a2727d052cc42e978e9a084d38c3634c89;hb=e344cc1160ed24a2cd05d84c351f4644326cf47e;hp=d47968d18eeec7b0a0d12c24eda1610d73d91fbd;hpb=fd6cd728a390aeac274f505723c1cdc92a60010a;p=lyx.git

diff --git a/src/MenuBackend.h b/src/MenuBackend.h
index d47968d18e..07c115a272 100644
--- a/src/MenuBackend.h
+++ b/src/MenuBackend.h
@@ -1,29 +1,30 @@
-/* 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
 
-#include "LString.h"
+#include "FuncStatus.h"
+#include "FuncRequest.h"
 
 #include <boost/shared_ptr.hpp>
 
 #include <vector>
 
-#include "FuncStatus.h"
 
-class LyXLex;
-class LyXView;
+namespace lyx {
+
+class Lexer;
+class Buffer;
 class Menu;
 
 ///
@@ -43,6 +44,8 @@ public:
 		/** This is the list of opened Documents,
 		    typically for the Documents menu. */
 		Documents,
+		/** This is the bookmarks */
+		Bookmarks,
 		///
 		Toc,
 		/** This is a list of viewable formats
@@ -57,6 +60,9 @@ public:
 		/** This is a list of importable formats
 		    typically for the File->Export menu. */
 		ImportFormats,
+		/** This is the list of elements available
+		 * for insertion into document. */
+		CharStyles,
 		/** This is the list of floats that we can
 		    insert a list for. */
 		FloatListInsert,
@@ -66,31 +72,36 @@ public:
 		/** This is the list of selections that can
 		    be pasted. */
 		PasteRecent,
+		/** toolbars */
+		Toolbars,
 		/** Available branches in document */
 		Branches
 	};
-	/// Create a Command type MenuItem
+
+	explicit MenuItem(Kind kind);
+
 	MenuItem(Kind kind,
-		 string const & label = string(),
-		 string const & command = string(),
+		 docstring const & label,
+		 docstring const & submenu = docstring(),
 		 bool optional = false);
+
 	MenuItem(Kind kind,
-		 string const & label,
-		 int action,
+		 docstring const & label,
+		 FuncRequest const & func,
 		 bool optional = false);
 
 	/// This one is just to please boost::shared_ptr<>
 	~MenuItem();
 	/// The label of a given menuitem
-	string const label() const;
+	docstring const label() const;
 	/// The keyboard shortcut (usually underlined in the entry)
-	string const shortcut() const;
+	docstring const shortcut() const;
 	/// The complete label, with label and shortcut separated by a '|'
-	string const fulllabel() const { return label_;}
+	docstring const fulllabel() const { return label_;}
 	/// The kind of entry
 	Kind kind() const { return kind_; }
 	/// the action (if relevant)
-	int action() const { return action_; }
+	FuncRequest const & func() const { return func_; }
 	/// 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
@@ -99,12 +110,15 @@ public:
 	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;
+	/**
+	 * returns the binding associated to this action.
+	 * Use the native UI format when \c forgui is true.
+	 */
+	docstring const binding(bool forgui) const;
 	/// the description of the  submenu (if relevant)
-	string const & submenuname() const { return submenuname_; }
+	docstring const & submenuname() const { return submenuname_; }
 	/// set the description of the  submenu
-	void submenuname(string const & name) { submenuname_ = name; }
+	void submenuname(docstring const & name) { submenuname_ = name; }
 	///
 	Menu * submenu() const { return submenu_.get(); }
 	///
@@ -115,11 +129,11 @@ private:
 	///
 	Kind kind_;
 	///
-	string label_;
+	docstring label_;
 	///
-	int action_;
+	FuncRequest func_;
 	///
-	string submenuname_;
+	docstring submenuname_;
 	///
 	bool optional_;
 	///
@@ -139,20 +153,27 @@ public:
 	///
 	typedef ItemList::size_type size_type;
 	///
-	explicit Menu(string const & name = string())
+	explicit Menu(docstring const & name = docstring())
 		: name_(name) {}
+	/// Add the menu item unconditionally
+	Menu & add(MenuItem const &);
+	/// Checks the associated FuncRequest status before adding the
+	/// menu item.
+	Menu & addWithStatusCheck(MenuItem const &);
 	///
-	Menu & add(MenuItem const &, LyXView const * view = 0);
+	Menu & read(Lexer &);
 	///
-	Menu & read(LyXLex &);
-	///
-	string const & name() const { return name_; }
+	docstring const & name() const { return name_; }
 	///
 	bool empty() const { return items_.empty(); }
+	/// Clear the menu content.
+	void clear() { items_.clear(); }
 	///
 	ItemList::size_type size() const { return items_.size(); }
 	///
-	bool hasSubmenu(string const &) const;
+	MenuItem const & operator[](size_type) const;
+	///
+	bool hasFunc(FuncRequest const &) const;
 	///
 	const_iterator begin() const {
 		return items_.begin();
@@ -170,7 +191,7 @@ private:
 	///
 	ItemList items_;
 	///
-	string name_;
+	docstring name_;
 };
 
 
@@ -182,42 +203,67 @@ public:
 	///
 	typedef MenuList::const_iterator const_iterator;
 	///
-	void read(LyXLex &);
+	typedef MenuList::iterator iterator;
+	///
+	MenuBackend() {}
+	///
+	void read(Lexer &);
 	///
 	void add(Menu const &);
 	///
-	bool hasMenu(string const &) const;
+	bool hasMenu(docstring const &) const;
 	///
-	Menu & getMenu(string const &);
+	Menu & getMenu(docstring const &);
 	///
-	Menu const & getMenu(string const &) const;
+	Menu const & getMenu(docstring const &) const;
 	///
 	Menu const & getMenubar() const;
 	///
 	bool empty() const { return menulist_.empty(); }
+	/** This defines a menu whose entries list the FuncRequests
+	    that will be removed by expand() in other menus. This is
+	    used by the Qt/Mac code
+	*/
+	void specialMenu(Menu const &);
+	///
+	Menu const & specialMenu() { return specialmenu_; }
+
 	/// 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, Branches
 	*/
 	void expand(Menu const & frommenu, Menu & tomenu,
-		    LyXView const *) const;
+		    Buffer const *) const;
 	///
 	const_iterator begin() const {
 		return menulist_.begin();
 	}
 	///
+	iterator begin() {
+		return menulist_.begin();
+	}
+	///
 	const_iterator end() const {
 		return menulist_.end();
 	}
+	///
+	iterator end() {
+		return menulist_.end();
+	}
 private:
 	///
 	MenuList menulist_;
 	///
 	Menu menubar_;
+	///
+	Menu specialmenu_;
 };
 
 ///
 extern MenuBackend menubackend;
 
+
+} // namespace lyx
+
 #endif /* MENUBACKEND_H */