X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FMenuBackend.h;h=136814ad809e02d72a737b742161f805bb80760e;hb=5d3718cad2a2ef6a4d6a495054ab0705ba27b6b5;hp=4a1d16bf7f70f79823b8af6763a01d8dbf7f5620;hpb=4b2a999762c83627476428e595d3c1e3704a3da0;p=lyx.git diff --git a/src/MenuBackend.h b/src/MenuBackend.h index 4a1d16bf7f..136814ad80 100644 --- a/src/MenuBackend.h +++ b/src/MenuBackend.h @@ -1,10 +1,10 @@ /* This file is part of -*- C++ -*- * ====================================================== -* +* * LyX, The Document Processor * -* Copyright (C) 1995 Matthias Ettrich -* Copyright (C) 1995-1999 The LyX Team. +* Copyright 1995 Matthias Ettrich +* Copyright 1995-2001 The LyX Team. * * This file is Copyright 1999 * Jean-Marc Lasgouttes @@ -14,94 +14,162 @@ #ifndef MENUBACKEND_H #define MENUBACKEND_H -#ifdef __GNUG__ -#pragma interface -#endif - #include "LString.h" -#include "support/LAssert.h" + +#include + #include +#include "FuncStatus.h" + class LyXLex; -class MenuItem; +class LyXView; +class Menu; +/// 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, + /** This is a list of viewable formats + typically for the File->View menu. */ + ViewFormats, + /** This is a list of updatable formats + typically for the File->Update menu. */ + UpdateFormats, + /** This is a list of exportable formats + 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 floats that we can + insert a list for. */ + FloatListInsert, + /** This is the list of floats that we can + insert. */ + FloatInsert }; - // 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 - Kind kind() const { return kind_; } - // the action (if relevant) + /// Create a Command type MenuItem + MenuItem(Kind kind, + string const & label = string(), + string const & command = string(), + bool optional = false); + MenuItem(Kind kind, + string const & label, + int action, + bool optional = false); + + /// This one is just to please boost::shared_ptr<> + ~MenuItem(); + /// The label of a given menuitem + string const label() const; + /// The keyboard shortcut (usually underlined in the entry) + string const shortcut() const; + /// The complete label, with label and shortcut separated by a '|' + string const fulllabel() const { return label_;} + /// The kind of entry + 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_; } - + /// 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_; } + /// set the description of the submenu + void submenuname(string const & name) { submenuname_ = name; } + /// + Menu * submenu() const { return submenu_.get(); } + /// + void submenu(Menu * menu); + private: + //friend class MenuBackend; + /// Kind kind_; + /// string label_; + /// int action_; - string submenu_; - MenuItem() {} + /// + string submenuname_; + /// + bool optional_; + /// + FuncStatus status_; + /// + boost::shared_ptr submenu_; }; +/// class Menu { public: - // + /// typedef std::vector 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 &); - // - bool menubar() const { return menubar_; } - // + /// + typedef ItemList::size_type size_type; + /// + explicit Menu(string const & name = string()) + : name_(name) {} + /// + Menu & add(MenuItem const &, LyXView const * view = 0); + /// + Menu & read(LyXLex &); + /// 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(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_; - /// }; +/// class MenuBackend { public: /// @@ -115,24 +183,38 @@ public: /// void add(Menu const &); /// - bool hasMenu (string const &) const; + bool hasMenu(string const &) const; + /// + Menu & getMenu (string const &); /// Menu const & getMenu (string const &) const; - // + /// + Menu const & getMenubar() 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 + */ + void expand(Menu const & frommenu, Menu & tomenu, + LyXView const *) const; + /// + const_iterator begin() const { + return menulist_.begin(); + } + /// + const_iterator end() const { + return menulist_.end(); + } private: /// MenuList menulist_; + /// + Menu menubar_; }; +/// extern MenuBackend menubackend; #endif /* MENUBACKEND_H */