]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/Menus.cpp
#7452, no spellcheck menu needed when no text is below cursor
[lyx.git] / src / frontends / qt4 / Menus.cpp
index 5e4665499e2ce717d76173cbee5b87fb0175d328..e150b08758af7676f79bc8a864511cffabbd5a4f 100644 (file)
@@ -21,6 +21,7 @@
 #include "Action.h"
 #include "GuiApplication.h"
 #include "GuiView.h"
+#include "GuiWorkArea.h"
 #include "qt_helpers.h"
 
 #include "BiblioInfo.h"
 #include "LyXAction.h"
 #include "LyX.h"
 #include "LyXRC.h"
+#include "lyxfind.h"
 #include "Paragraph.h"
 #include "ParIterator.h"
 #include "Session.h"
+#include "SpellChecker.h"
 #include "TextClass.h"
 #include "TocBackend.h"
 #include "Toolbars.h"
@@ -68,6 +71,9 @@
 #include <QList>
 #include <QMenuBar>
 #include <QString>
+#if QT_VERSION >= 0x040600
+#include <QProxyStyle>
+#endif
 
 #include "support/shared_ptr.h"
 
@@ -127,7 +133,7 @@ public:
                    typically for the File->Export menu. */
                ExportFormats,
                /** This is a list of importable formats
-                   typically for the File->Export menu. */
+                   typically for the File->Import menu. */
                ImportFormats,
                /** This is the list of elements available
                 * for insertion into document. */
@@ -174,8 +180,10 @@ public:
        MenuItem(Kind kind,
                 QString const & label,
                 QString const & submenu = QString(),
+                QString const & tooltip = QString(),
                 bool optional = false)
-               : kind_(kind), label_(label), submenuname_(submenu), optional_(optional)
+               : kind_(kind), label_(label), submenuname_(submenu),
+                 tooltip_(tooltip), optional_(optional)
        {
                LASSERT(kind == Submenu || kind == Help || kind == Info, /**/);
        }
@@ -183,9 +191,11 @@ public:
        MenuItem(Kind kind,
                 QString const & label,
                 FuncRequest const & func,
+                QString const & tooltip = QString(),
                 bool optional = false,
                 FuncRequest::Origin origin = FuncRequest::MENU)
-               : kind_(kind), label_(label), func_(func), optional_(optional)
+               : kind_(kind), label_(label), func_(func),
+                 tooltip_(tooltip), optional_(optional)
        {
                func_.setOrigin(origin);
        }
@@ -207,11 +217,13 @@ public:
                return index == -1 ? QString() : label_.mid(index + 1); 
        }
        /// The complete label, with label and shortcut separated by a '|'
-       QString fulllabel() const { return label_;}
+       QString fulllabel() const { return label_; }
        /// The kind of entry
        Kind kind() const { return kind_; }
        /// the action (if relevant)
        FuncRequest const & func() const { return func_; }
+       /// the tooltip
+       QString const & tooltip() const { return tooltip_; }
        /// returns true if the entry should be omitted when disabled
        bool optional() const { return optional_; }
        /// returns the status of the lfun associated with this entry
@@ -264,6 +276,8 @@ private:
        ///
        QString submenuname_;
        ///
+       QString tooltip_;
+       ///
        bool optional_;
        ///
        FuncStatus status_;
@@ -297,6 +311,10 @@ public:
        const_iterator begin() const { return items_.begin(); }
        ///
        const_iterator end() const { return items_.end(); }
+       ///
+       void cat(MenuDefinition const & other);
+       ///
+       void catSub(docstring const & name);
        
        // search for func in this menu iteratively, and put menu
        // names in a stack.
@@ -493,7 +511,7 @@ void MenuDefinition::read(Lexer & lex)
                        FuncRequest::Origin origin = FuncRequest::MENU;
                        if (name_.startsWith("context-toc-"))
                                origin = FuncRequest::TOC;
-                       add(MenuItem(MenuItem::Command, toqstr(name), func, optional, origin));
+                       add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
                        optional = false;
                        break;
                }
@@ -607,7 +625,7 @@ void MenuDefinition::read(Lexer & lex)
                        lex.next(true);
                        docstring const mname = lex.getDocString();
                        add(MenuItem(MenuItem::Submenu,
-                               toqstr(mlabel), toqstr(mname), optional));
+                               toqstr(mlabel), toqstr(mname), QString(), optional));
                        optional = false;
                        break;
                }
@@ -640,6 +658,20 @@ bool MenuDefinition::hasFunc(FuncRequest const & func) const
 }
 
 
+void MenuDefinition::catSub(docstring const & name)
+{
+       add(MenuItem(MenuItem::Submenu,
+                    qt_("More...|M"), toqstr(name), QString(), false));
+}
+
+void MenuDefinition::cat(MenuDefinition const & other)
+{
+       const_iterator et = other.end();
+       for (const_iterator it = other.begin(); it != et; ++it)
+               add(*it);
+}
+
+
 void MenuDefinition::checkShortcuts() const
 {
        // This is a quadratic algorithm, but we do not care because
@@ -730,39 +762,64 @@ void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
 
 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
 {
-       if (!bv || !lyxrc.spellcheck_continuously)
+       if (!bv)
+               return;
+       Cursor const & cur = bv->cursor();
+       if (!cur.inTexted())
                return;
        WordLangTuple wl;
        docstring_list suggestions;
-       pos_type from = bv->cursor().pos();
+       Paragraph const & par = cur.paragraph();
+       pos_type from = cur.pos();
        pos_type to = from;
-       Paragraph const & par = bv->cursor().paragraph();
-       if (!par.spellCheck(from, to, wl, suggestions))
-               return;
-       LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
-       size_t i = 0;
-       MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
-       item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
-       for (; i != suggestions.size(); ++i) {
-               docstring const & suggestion = suggestions[i];
-               LYXERR(Debug::GUI, suggestion);
-               MenuItem w(MenuItem::Command, toqstr(suggestion),
-                       FuncRequest(LFUN_WORD_REPLACE, suggestion));
-               if (i < 10)
-                       add(w);
-               else
-                       item.submenu().add(w);
+       SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
+       switch (res) {
+       case SpellChecker::UNKNOWN_WORD:
+               if (lyxrc.spellcheck_continuously) {
+                       LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
+                       docstring const & selection = cur.selectionAsString(false);
+                       if (!cur.selection() || selection == wl.word()) {
+                               size_t i = 0;
+                               size_t m = 10; // first submenu index
+                               MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
+                               item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
+                               for (; i != suggestions.size(); ++i) {
+                                       docstring const & suggestion = suggestions[i];
+                                       LYXERR(Debug::GUI, suggestion);
+                                       MenuItem w(MenuItem::Command, toqstr(suggestion),
+                                               FuncRequest(LFUN_WORD_REPLACE, 
+                                                       replace2string(suggestion,selection,
+                                                               true, true, false, false)));
+                                       if (i < m)
+                                               add(w);
+                                       else
+                                               item.submenu().add(w);
+                               }
+                               if (i > m)
+                                       add(item);
+                               if (i > 0)
+                                       add(MenuItem(MenuItem::Separator));
+                               docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
+                               add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
+                                               FuncRequest(LFUN_SPELLING_ADD, arg)));
+                               add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
+                                               FuncRequest(LFUN_SPELLING_IGNORE, arg)));
+                       }
+               }
+               break;
+       case SpellChecker::LEARNED_WORD: {
+                       LYXERR(Debug::GUI, "Learned Word.");
+                       docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
+                       add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
+                                       FuncRequest(LFUN_SPELLING_REMOVE, arg)));
+               }
+               break;
+       case SpellChecker::WORD_OK:
+       case SpellChecker::COMPOUND_WORD:
+       case SpellChecker::ROOT_FOUND:
+       case SpellChecker::IGNORED_WORD:
+               break;
        }
-       if (i >= 10)
-               add(item);
-       if (i > 0)
-               add(MenuItem(MenuItem::Separator));
-       docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
-       add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|c"),
-                       FuncRequest(LFUN_SPELLING_ADD, arg)));
-       add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
-                       FuncRequest(LFUN_SPELLING_IGNORE, arg)));
-       
 }
 
 struct sortLanguageByName {
@@ -848,54 +905,70 @@ void MenuDefinition::expandLastfiles()
 
        for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
                string const file = lfit->absFileName();
+               QString const short_path = toqstr(makeDisplayPath(file, 30));
+               QString const long_path = toqstr(makeDisplayPath(file));
                QString label;
                if (ii < 10)
-                       label = QString("%1. %2|%3").arg(ii)
-                               .arg(toqstr(makeDisplayPath(file, 30))).arg(ii);
+                       label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
                else
-                       label = QString("%1. %2").arg(ii)
-                               .arg(toqstr(makeDisplayPath(file, 30)));
-               add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
+                       label = QString("%1. %2").arg(ii).arg(short_path);
+               add(MenuItem(MenuItem::Command, label,
+                       FuncRequest(LFUN_FILE_OPEN, file), long_path));
        }
 }
 
 
 void MenuDefinition::expandDocuments()
 {
-       MenuItem item(MenuItem::Submenu, qt_("Invisible"));
-       item.setSubmenu(MenuDefinition(qt_("Invisible")));
+       MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
+       item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
 
        Buffer * first = theBufferList().first();
-       if (first) {
-               Buffer * b = first;
-               int vis = 1;
-               int invis = 1;
-               
-               // We cannot use a for loop as the buffer list cycles.
-               do {
+       if (!first) {
+               add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
+               return;
+       }
+
+       int i = 0;
+       while (true) {
+               if (!guiApp->currentView())
+                       break;
+               GuiWorkArea * wa = guiApp->currentView()->workArea(i);
+               if (!wa)
+                       break;
+               Buffer const & b = wa->bufferView().buffer();
+               QString label = toqstr(b.fileName().displayName(20));
+               if (!b.isClean())
+                       label += "*";
+               if (i < 10)
+                       label = QString::number(i) + ". " + label + '|' + QString::number(i);
+               add(MenuItem(MenuItem::Command, label,
+                       FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
+               ++i;
+       }
+
+
+       i = 0;
+       Buffer * b = first;
+       // We cannot use a for loop as the buffer list cycles.
+       do {
+               bool const shown = guiApp->currentView()
+                       ? guiApp->currentView()->workArea(*b) : false;
+               if (!shown) {
                        QString label = toqstr(b->fileName().displayName(20));
                        if (!b->isClean())
                                label += "*";
-                       bool const shown = guiApp->currentView()
-                                          ? guiApp->currentView()->workArea(*b) : false;
-                       int ii = shown ? vis : invis;
-                       if (ii < 10)
-                               label = QString::number(ii) + ". " + label + '|' + QString::number(ii);
-                       if (shown) {
-                               add(MenuItem(MenuItem::Command, label,
-                                       FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
-                               ++vis;
-                       } else {
-                               item.submenu().add(MenuItem(MenuItem::Command, label,
-                                       FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
-                               ++invis;
-                       }
-                       b = theBufferList().next(b);
-               } while (b != first); 
-               if (!item.submenu().empty())
-                       add(item);
-       } else
-               add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
+                       if (i < 10)
+                               label = QString::number(i) + ". " + label + '|' + QString::number(i);
+                       item.submenu().add(MenuItem(MenuItem::Command, label,
+                               FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
+                       ++i;
+               }
+               b = theBufferList().next(b);
+       } while (b != first); 
+       
+       if (!item.submenu().empty())
+               add(item);
 }
 
 
@@ -990,12 +1063,12 @@ void MenuDefinition::expandFormats(MenuItem::Kind kind, Buffer const * buf)
                                        bformat(_("View [%1$s]|V"), qstring_to_ucs4(label))
                                        : bformat(_("Update [%1$s]|U"), qstring_to_ucs4(label)));
                                MenuItem w(MenuItem::Command, toqstr(lbl),
-                                               FuncRequest(action, (*fit)->name()));
+                                          FuncRequest(action));
                                add(w);
                                continue;
                        }
                case MenuItem::ExportFormats:
-                       if (!(*fit)->documentFormat())
+                       if (!(*fit)->inExportMenu())
                                continue;
                        break;
                default:
@@ -1034,11 +1107,26 @@ void MenuDefinition::expandFloatListInsert(Buffer const * buf)
        FloatList const & floats = buf->params().documentClass().floats();
        FloatList::const_iterator cit = floats.begin();
        FloatList::const_iterator end = floats.end();
+       set<string> seen;
        for (; cit != end; ++cit) {
-               addWithStatusCheck(MenuItem(MenuItem::Command,
-                                   qt_(cit->second.listName()),
-                                   FuncRequest(LFUN_FLOAT_LIST_INSERT,
-                                               cit->second.floattype())));
+               if (!cit->second.usesFloatPkg()) {
+                       // Different floats could declare the same ListCommand. We only
+                       // want it on the list once, though.
+                       string const & list_cmd = cit->second.listCommand();
+                       if (list_cmd.empty())
+                               // we do not know how to generate such a list
+                               continue;
+                       // This form of insert returns an iterator pointing to the newly
+                       // inserted element OR the existing element with that value, and
+                       // a bool indicating whether we inserted a new element. So we can
+                       // see if one is there and insert it if not all at once.
+                       pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
+                       if (!ret.second)
+                               continue;
+               }
+               string const & list_name = cit->second.listName();
+               addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
+                       FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
        }
 }
 
@@ -1073,7 +1161,10 @@ void MenuDefinition::expandFlexInsert(
        TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
        for (; cit != end; ++cit) {
                if (cit->second.lyxtype() == type) {
-                       docstring const label = cit->first;
+                       docstring label = cit->first;
+                       // we remove the "Flex:" prefix, if it is present
+                       if (prefixIs(label, from_utf8("Flex:")))
+                               label = label.substr(5);
                        addWithStatusCheck(MenuItem(MenuItem::Command, 
                                toqstr(translateIfPossible(label)),
                                FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
@@ -1338,16 +1429,16 @@ void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
        IndicesList::const_iterator end = params.indiceslist().end();
 
        for (int ii = 1; cit != end; ++cit, ++ii) {
-               if (listof)
-                       addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
-                                          FuncRequest(LFUN_INDEX_PRINT,
-                                                 cit->shortcut())));
-               else {
-                       docstring label = _("Index Entry");
-                       label += " (" + cit->index() + ")";
+               if (listof) {
+                       docstring const label = 
+                               bformat(_("Index: %1$s"), cit->index());
                        addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
-                                          FuncRequest(LFUN_INDEX_INSERT,
-                                                 cit->shortcut())));
+                                          FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
+               } else {
+                       docstring const label = 
+                               bformat(_("Index Entry (%1$s)"), cit->index());
+                       addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
+                                          FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
                }
        }
 }
@@ -1369,12 +1460,12 @@ void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
                if (listof) {
                        InsetCommandParams p(INDEX_PRINT_CODE);
                        p["type"] = cit->shortcut();
-                       string const data = InsetCommand::params2string("index_print", p);
+                       string const data = InsetCommand::params2string(p);
                        addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
                                           FuncRequest(LFUN_INSET_MODIFY, data)));
                } else {
-                       docstring label = _("Index Entry");
-                       label += " (" + cit->index() + ")";
+                       docstring const label = 
+                                       bformat(_("Index Entry (%1$s)"), cit->index());
                        addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
                                           FuncRequest(LFUN_INSET_MODIFY,
                                                  from_ascii("changetype ") + cit->shortcut())));
@@ -1486,24 +1577,43 @@ void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
                } else {
                        // we have a MenuItem::Command
                        qMenu.addAction(new Action(view, QIcon(), label(*m), 
-                               m->func(), QString(), &qMenu));
+                               m->func(), m->tooltip(), &qMenu));
                }
        }
 }
 
+#if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
+class AlwaysMnemonicStyle : public QProxyStyle {
+public:
+       int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
+               QStyleHintReturn *returnData = 0) const 
+       {
+               if (hint == QStyle::SH_UnderlineShortcut)
+                       return 1;
+               return QProxyStyle::styleHint(hint, opt, widget, returnData);
+       }
+};
+#endif
+
 /////////////////////////////////////////////////////////////////////
 // Menu implementation
 /////////////////////////////////////////////////////////////////////
 
-Menu::Menu(GuiView * gv, QString const & name, bool top_level)
+Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
 : QMenu(gv), d(new Menu::Impl)
 {
+#if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
+       if (keyboard)
+               setStyle(new AlwaysMnemonicStyle);
+#else
+       (void) keyboard;
+#endif
        d->top_level_menu = top_level? new MenuDefinition : 0;
        d->view = gv;
        d->name = name;
        setTitle(name);
        if (d->top_level_menu)
-               connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
+               connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView())); 
 }
 
 
@@ -1831,7 +1941,7 @@ void Menus::read(Lexer & lex)
        enum {
                md_menu,
                md_menubar,
-               md_endmenuset,
+               md_endmenuset
        };
 
        LexerKeyword menutags[] = {
@@ -1955,14 +2065,35 @@ void Menus::updateMenu(Menu * qmenu)
        if (qmenu->d->name.isEmpty())
                return;
 
-       if (!d->hasMenu(qmenu->d->name)) {
+       docstring identifier = qstring_to_ucs4(qmenu->d->name);
+       MenuDefinition fromLyxMenu(qmenu->d->name);
+       while (!identifier.empty()) {
+               docstring menu_name;
+               identifier = split(identifier, menu_name, ';');
+
+               if (!d->hasMenu(toqstr(menu_name))) {
+                       LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
+                               << menu_name);
+                       continue;
+               }
+
+               MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
+               //FIXME: 50 is a wild guess. We should take into account here
+               //the expansion of menu items, disabled optional items etc.
+               bool const in_sub_menu = fromLyxMenu.size() > 0 
+                       && fromLyxMenu.size() + cat_menu.size() > 50 ;
+               if (in_sub_menu)
+                       fromLyxMenu.catSub(menu_name);
+               else
+                       fromLyxMenu.cat(cat_menu);
+               fromLyxMenu.add(MenuItem(MenuItem::Separator));
+       }
+
+       if (fromLyxMenu.empty()) {
                qmenu->addAction(qt_("No Action Defined!"));
-               LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
-                       << qmenu->d->name);
                return;
        }
 
-       MenuDefinition const & fromLyxMenu = d->getMenu(qmenu->d->name);
        BufferView * bv = 0;
        if (qmenu->d->view)
                bv = qmenu->d->view->currentBufferView();
@@ -1971,7 +2102,7 @@ void Menus::updateMenu(Menu * qmenu)
 }
 
 
-Menu * Menus::menu(QString const & name, GuiView & view)
+Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
 {
        LYXERR(Debug::GUI, "Context menu requested: " << name);
        Menu * menu = d->name_map_[&view].value(name, 0);
@@ -1980,7 +2111,7 @@ Menu * Menus::menu(QString const & name, GuiView & view)
                return 0;
        }
 
-       menu = new Menu(&view, name, true);
+       menu = new Menu(&view, name, true, keyboard);
        d->name_map_[&view][name] = menu;
        return menu;
 }