X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FMenuBackend.h;h=c704539eb0a600b6d738939f7e802647e33a9b6c;hb=32d281cba0a2e4d0e8425a34a1a8d1f5e7251412;hp=c5621a3c39f4215ee2fb8c80ae78685422ce3546;hpb=9625f5e2300339330e099ccea259c46667ea1461;p=lyx.git diff --git a/src/MenuBackend.h b/src/MenuBackend.h index c5621a3c39..c704539eb0 100644 --- a/src/MenuBackend.h +++ b/src/MenuBackend.h @@ -1,28 +1,28 @@ -/* This file is part of -*- C++ -*- -* ====================================================== -* -* LyX, The Document Processor -* -* Copyright 1995 Matthias Ettrich -* Copyright 1995-2000 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 "FuncStatus.h" +#include "funcrequest.h" + +#include -#include "LString.h" -#include "support/lstrings.h" #include class LyXLex; +class LyXView; +class Menu; /// class MenuItem { @@ -41,44 +41,95 @@ public: /** This is the list of opened Documents, typically for the Documents menu. */ Documents, + /// + Toc, /** This is a list of viewable formats - typically for the Documents menu. */ + typically for the File->View menu. */ ViewFormats, /** This is a list of updatable formats - typically for the Documents menu. */ + typically for the File->Update menu. */ UpdateFormats, /** This is a list of exportable formats - typically for the Documents menu. */ - ExportFormats + typically for the File->Export menu. */ + ExportFormats, + /** 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, + /** This is the list of floats that we can + insert. */ + 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, - string const & label = string(), - string const & command = string(), + + explicit MenuItem(Kind kind); + + MenuItem(Kind kind, + std::string const & label, + std::string const & command = std::string(), + bool optional = false); + + MenuItem(Kind kind, + std::string 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 label() const { return token(label_, '|', 0); } - /// - string shortcut() const { return token(label_, '|', 1); } + std::string const label() const; + /// The keyboard shortcut (usually underlined in the entry) + std::string const shortcut() const; + /// The complete label, with label and shortcut separated by a '|' + std::string const fulllabel() const { return label_;} /// The kind of entry - Kind kind() const { return kind_; } + Kind kind() const { return kind_; } /// the action (if relevant) - int action() const { return action_; } - /// the description of the submenu (if relevant) - string const & submenu() const { return submenu_; } + 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 + 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 + std::string const binding() const; + /// the description of the submenu (if relevant) + std::string const & submenuname() const { return submenuname_; } + /// set the description of the submenu + void submenuname(std::string const & name) { submenuname_ = name; } + /// + Menu * submenu() const { return submenu_.get(); } + /// + void submenu(Menu * menu); + private: + //friend class MenuBackend; /// Kind kind_; /// - string label_; + std::string label_; /// - int action_; + FuncRequest func_; /// - string submenu_; + std::string submenuname_; /// bool optional_; + /// + FuncStatus status_; + /// + boost::shared_ptr submenu_; }; @@ -90,33 +141,40 @@ public: /// typedef ItemList::const_iterator const_iterator; /// - explicit Menu(string const & name, bool mb = false) - : menubar_(mb), name_(name) {} + typedef ItemList::size_type size_type; /// - Menu & add(MenuItem const &); + explicit Menu(std::string const & name = std::string()) + : name_(name) {} + /// + Menu & add(MenuItem const &, LyXView const * view = 0); /// Menu & read(LyXLex &); - /// - bool menubar() const { return menubar_; } - /// - string const & name() const { return name_; } + /// + std::string const & name() const { return name_; } /// bool empty() const { return items_.empty(); } - /// - const_iterator begin() const { - return items_.begin(); - } - /// - const_iterator end() const { - return items_.end(); - } + /// + ItemList::size_type size() const { return items_.size(); } + /// + bool hasSubmenu(std::string const &) const; + /// + const_iterator begin() const { + return items_.begin(); + } + /// + const_iterator end() const { + return items_.end(); + } + + // Check whether the menu shortcuts are unique + void checkShortcuts() const; + private: + friend class MenuBackend; /// ItemList items_; /// - bool menubar_; - /// - string name_; + std::string name_; }; @@ -128,30 +186,49 @@ public: /// typedef MenuList::const_iterator const_iterator; /// + typedef MenuList::iterator iterator; + /// void read(LyXLex &); - /// Set default values for menu structure. - void defaults(); /// void add(Menu const &); /// - bool hasMenu (string const &) const; + bool hasMenu(std::string const &) const; /// - Menu & getMenu (string const &); + Menu & getMenu(std::string const &); + /// + Menu const & getMenu(std::string const &) const; + /// + Menu const & getMenubar() const; /// - Menu const & getMenu (string const &) const; - // bool empty() const { return menulist_.empty(); } - /// - const_iterator begin() const { - return menulist_.begin(); - } - /// - const_iterator end() const { - return menulist_.end(); - } + /// 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; + /// + 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_; }; ///