lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 QMUL.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _SUBDIVIDING_MENU_H_
lbajardsilogic@0: #define _SUBDIVIDING_MENU_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include <QMenu>
lbajardsilogic@0: 
lbajardsilogic@0: #include <QString>
lbajardsilogic@0: #include <set>
lbajardsilogic@0: #include <map>
lbajardsilogic@0: 
lbajardsilogic@0: /**
lbajardsilogic@0:  * A menu that divides its entries into submenus, alphabetically.  For
lbajardsilogic@0:  * menus that may contain a very large or small number of named items
lbajardsilogic@0:  * (e.g. plugins).
lbajardsilogic@0:  *
lbajardsilogic@0:  * The menu needs to be told, before any of the actions are added,
lbajardsilogic@0:  * what the set of entry strings will be, so it can determine a
lbajardsilogic@0:  * reasonable categorisation.  Do this by calling the setEntries()
lbajardsilogic@0:  * method.  If it isn't practical to do this in advance, then add the
lbajardsilogic@0:  * entries and call entriesAdded() afterwards instead. 
lbajardsilogic@0:  */
lbajardsilogic@0: 
lbajardsilogic@0: class SubdividingMenu : public QMenu
lbajardsilogic@0: {
lbajardsilogic@0:     Q_OBJECT
lbajardsilogic@0: 
lbajardsilogic@0: public:
lbajardsilogic@0:     SubdividingMenu(size_t lowerLimit = 0, size_t upperLimit = 0,
lbajardsilogic@0:                     QWidget *parent = 0);
lbajardsilogic@0:     SubdividingMenu(const QString &title, size_t lowerLimit = 0,
lbajardsilogic@0:                     size_t upperLimit = 0, QWidget *parent = 0);
lbajardsilogic@0:     virtual ~SubdividingMenu();
lbajardsilogic@0: 
lbajardsilogic@0:     void setEntries(const std::set<QString> &entries);
lbajardsilogic@0:     void entriesAdded();
lbajardsilogic@0: 
lbajardsilogic@0:     // Action names and strings passed to addAction and addMenu must
lbajardsilogic@0:     // appear in the set previously given to setEntries.  If you want
lbajardsilogic@0:     // to use a different string, use the two-argument method and pass
lbajardsilogic@0:     // the entry string (used to determine which submenu the action
lbajardsilogic@0:     // ends up on) as the first argument.
lbajardsilogic@0: 
lbajardsilogic@0:     virtual void addAction(QAction *);
lbajardsilogic@0:     virtual QAction *addAction(const QString &);
lbajardsilogic@0:     virtual void addAction(const QString &entry, QAction *);
lbajardsilogic@0:     
lbajardsilogic@0:     virtual void addMenu(QMenu *);
lbajardsilogic@0:     virtual QMenu *addMenu(const QString &);
lbajardsilogic@0:     virtual void addMenu(const QString &entry, QMenu *);
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     std::map<QString, QMenu *> m_nameToChunkMenuMap;
lbajardsilogic@0: 
lbajardsilogic@0:     size_t m_lowerLimit;
lbajardsilogic@0:     size_t m_upperLimit;
lbajardsilogic@0: 
lbajardsilogic@0:     bool m_entriesSet;
lbajardsilogic@0:     std::map<QString, QObject *> m_pendingEntries;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif
lbajardsilogic@0: