+// MacOSX specific stuff is at the end.
+
+class Menu;
+
+///
+class MenuItem {
+public:
+ /// 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,
+ /** This is the bookmarks */
+ Bookmarks,
+ ///
+ 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 elements available
+ * for insertion into document. */
+ CharStyles,
+ /** This is the list of user-configurable
+ insets to insert into document */
+ Custom,
+ /** This is the list of XML elements to
+ insert into the document */
+ Elements,
+ /** 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
+ };
+
+ explicit MenuItem(Kind kind);
+
+ MenuItem(Kind kind,
+ QString const & label,
+ QString const & submenu = QString(),
+ bool optional = false);
+
+ MenuItem(Kind kind,
+ QString const & label,
+ FuncRequest const & func,
+ bool optional = false);
+
+ /// This one is just to please boost::shared_ptr<>
+ ~MenuItem();
+ /// The label of a given menuitem
+ QString label() const;
+ /// The keyboard shortcut (usually underlined in the entry)
+ QString shortcut() const;
+ /// The complete label, with label and shortcut separated by a '|'
+ QString fulllabel() const { return label_;}
+ /// The kind of entry
+ Kind kind() const { return kind_; }
+ /// the action (if relevant)
+ 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.
+ QString binding() const;
+ /// the description of the submenu (if relevant)
+ QString const & submenuname() const { return submenuname_; }
+ /// set the description of the submenu
+ void submenuname(QString const & name) { submenuname_ = name; }
+ ///
+ Menu * submenu() const { return submenu_.get(); }
+ ///
+ void setSubmenu(Menu * menu);
+
+private:
+ ///
+ Kind kind_;
+ ///
+ QString label_;
+ ///
+ FuncRequest func_;
+ ///
+ QString submenuname_;
+ ///
+ bool optional_;
+ ///
+ FuncStatus status_;
+ ///
+ boost::shared_ptr<Menu> submenu_;
+};
+
+///
+class Menu {
+public:
+ ///
+ typedef std::vector<MenuItem> ItemList;
+ ///
+ typedef ItemList::const_iterator const_iterator;
+
+ ///
+ explicit Menu(QString const & name = QString()) : name_(name) {}
+
+ ///
+ void read(Lexer &);
+ ///
+ QString const & name() const { return name_; }
+ ///
+ bool empty() const { return items_.empty(); }
+ /// Clear the menu content.
+ void clear() { items_.clear(); }
+ ///
+ size_t size() const { return items_.size(); }
+ ///
+ MenuItem const & operator[](size_t) const;
+ ///
+ const_iterator begin() const { return items_.begin(); }
+ ///
+ const_iterator end() const { return items_.end(); }
+
+ // search for func in this menu iteratively, and put menu
+ // names in a stack.
+ bool searchMenu(FuncRequest const & func, std::vector<docstring> & names)
+ const;
+
+private:
+ friend class Menus;
+ ///
+ bool hasFunc(FuncRequest const &) const;
+ /// Add the menu item unconditionally
+ void add(MenuItem const & item) { items_.push_back(item); }
+ /// Checks the associated FuncRequest status before adding the
+ /// menu item.
+ void addWithStatusCheck(MenuItem const &);
+ // Check whether the menu shortcuts are unique
+ void checkShortcuts() const;
+ ///
+ void expandLastfiles();
+ void expandDocuments();
+ void expandBookmarks();
+ void expandFormats(MenuItem::Kind kind, Buffer const * buf);
+ void expandFloatListInsert(Buffer const * buf);
+ void expandFloatInsert(Buffer const * buf);
+ void expandFlexInsert(Buffer const * buf, std::string s);
+ void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
+ void expandToc(Buffer const * buf);
+ void expandPasteRecent();
+ void expandToolbars();
+ void expandBranches(Buffer const * buf);
+
+ ItemList items_;
+ ///
+ QString name_;
+};
+
+/// a submenu
+class GuiPopupMenu : public QMenu
+{
+public:
+ ///
+ GuiPopupMenu(GuiView * owner, MenuItem const & mi, bool top_level)
+ : QMenu(owner), owner_(owner), top_level_(top_level)
+ {
+ name_ = mi.submenuname();
+ setTitle(label(mi));
+ }
+
+ /// populates the menu or one of its submenu
+ /// This is used as a recursive function
+ void populate(QMenu * qMenu, Menu * menu);
+
+ /// Get a Menu item label from the menu backend
+ QString label(MenuItem const & mi) const;
+
+ void showEvent(QShowEvent * ev)
+ {
+ if (top_level_)
+ guiApp->menus().updateMenu(name_);
+ QMenu::showEvent(ev);
+ }
+
+ bool const top_level_;
+
+ ///
+ Menu topLevelMenu_;
+
+ /// our owning view
+ GuiView * owner_;
+ /// the name of this menu
+ QString name_;
+};
+
+