-/* 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
-#ifdef __GNUG__
-#pragma interface
-#endif
-
#include "LString.h"
+
+#include <boost/shared_ptr.hpp>
+
#include <vector>
+#include "FuncStatus.h"
+
class LyXLex;
-class Buffer;
+class LyXView;
+class Menu;
///
class MenuItem {
FloatListInsert,
/** This is the list of floats that we can
insert. */
- FloatInsert
+ 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,
MenuItem(Kind kind,
string const & label,
int action,
- bool optional = false)
- : kind_(kind), label_(label),
- action_(action), submenu_(), optional_(optional) {}
+ 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)
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_;
///
///
int action_;
///
- string submenu_;
+ string submenuname_;
///
bool optional_;
+ ///
+ FuncStatus status_;
+ ///
+ boost::shared_ptr<Menu> submenu_;
};
///
typedef ItemList::const_iterator const_iterator;
///
+ typedef ItemList::size_type size_type;
+ ///
explicit Menu(string const & name = string())
: name_(name) {}
///
- Menu & add(MenuItem const &);
+ Menu & add(MenuItem const &, LyXView const * view = 0);
///
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;
///
string const & name() const { return name_; }
///
void checkShortcuts() const;
private:
+ friend class MenuBackend;
///
ItemList items_;
///
typedef MenuList::const_iterator const_iterator;
///
void read(LyXLex &);
- /// Set default values for menu structure.
- void defaults();
///
void add(Menu const &);
///
bool hasMenu(string const &) const;
///
- Menu & getMenu (string const &);
+ Menu & getMenu(string const &);
///
- Menu const & getMenu (string const &) const;
+ Menu const & getMenu(string const &) const;
///
Menu const & getMenubar() const;
///
bool empty() const { return menulist_.empty(); }
+ /// 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();