X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FMenuBackend.h;h=07c115a2727d052cc42e978e9a084d38c3634c89;hb=e54ae72e5fac6f750c3f7972c74bb42b57f3a049;hp=169b9d56183794d59f6761d4035f4f9cd4a22250;hpb=29f7055e9527314060b4a74c31a46155ff264a63;p=lyx.git diff --git a/src/MenuBackend.h b/src/MenuBackend.h index 169b9d5618..07c115a272 100644 --- a/src/MenuBackend.h +++ b/src/MenuBackend.h @@ -1,29 +1,31 @@ -/* 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; + +namespace lyx { + +class Lexer; class Buffer; +class Menu; /// class MenuItem { @@ -42,10 +44,10 @@ public: /** This is the list of opened Documents, typically for the Documents menu. */ Documents, + /** This is the bookmarks */ + Bookmarks, /// Toc, - /// - References, /** This is a list of viewable formats typically for the File->View menu. */ ViewFormats, @@ -57,45 +59,87 @@ public: ExportFormats, /** This is a list of importable formats typically for the File->Export menu. */ - ImportFormats + 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, + /** toolbars */ + Toolbars, + /** 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, + docstring const & label, + docstring const & submenu = docstring(), bool optional = false); + MenuItem(Kind kind, - string const & label, - int action, - bool optional = false) - : kind_(kind), label_(label), - action_(action), submenu_(), optional_(optional) {} - + 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 { return token(label_, '|', 0); } + docstring const label() const; /// The keyboard shortcut (usually underlined in the entry) - string const shortcut() const { return token(label_, '|', 1); } + 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_; } + 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. + * Use the native UI format when \c forgui is true. + */ + docstring const binding(bool forgui) const; + /// the description of the submenu (if relevant) + docstring const & submenuname() const { return submenuname_; } + /// set the description of the submenu + void submenuname(docstring const & name) { submenuname_ = name; } + /// + Menu * submenu() const { return submenu_.get(); } + /// + void submenu(Menu * menu); + private: + //friend class MenuBackend; /// Kind kind_; /// - string label_; + docstring label_; /// - int action_; + FuncRequest func_; /// - string submenu_; + docstring submenuname_; /// bool optional_; + /// + FuncStatus status_; + /// + boost::shared_ptr submenu_; }; @@ -107,45 +151,47 @@ public: /// typedef ItemList::const_iterator const_iterator; /// - explicit Menu(string const & name = string(), bool mb = false) - : menubar_(mb), name_(name) {} + typedef ItemList::size_type size_type; /// + 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 & read(LyXLex &); - /// 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 - */ - void expand(Menu & tomenu, Buffer *) const; - /// - bool menubar() const { return menubar_; } - /// - string const & name() const { return name_; } + Menu & read(Lexer &); + /// + 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(); } - /// - const_iterator begin() const { - return items_.begin(); - } - /// - const_iterator end() const { - return items_.end(); - } + /// + MenuItem const & operator[](size_type) const; + /// + bool hasFunc(FuncRequest 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_; + docstring name_; }; @@ -157,33 +203,67 @@ public: /// typedef MenuList::const_iterator const_iterator; /// - void read(LyXLex &); - /// Set default values for menu structure. - void defaults(); + 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(docstring 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(); - } + /** 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, + 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 */