MenuNode.h

Go to the documentation of this file.

/***************************************************************************
                          MenuNode.h  -  generic menu node type
                             -------------------
    begin                : Mon Jan 10 2000
    copyright            : (C) 2000 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef MENU_NODE_H
#define MENU_NODE_H

#include "config.h"

#include <QHash>
#include <QIcon>
#include <QKeySequence>
#include <QObject>
#include <QPixmap>
#include <QString>
#include <QStringList>

#include "libgui/MenuGroup.h"

class QAction;

namespace Kwave
{

    class MenuSub;

    class MenuNode: public QObject
    {
        Q_OBJECT

    public:

        MenuNode(Kwave::MenuNode *parent,
                 const QString &name,
                 const QString &command,
                 const QKeySequence &shortcut,
                 const QString &uid);

        virtual ~MenuNode();

        const QString path() const;

        inline const QString &name() const { return m_name; }

        inline const QString &command() const { return m_command; }

        virtual QAction *action() { return Q_NULLPTR; }

        inline const QString &uid() const { return m_uid; }

        void setUID(const QString &uid);

        inline const QKeySequence &shortcut() const { return m_shortcut; }

        virtual void setShortcut(const QKeySequence &shortcut) {
            m_shortcut = shortcut;
        }

        virtual const QIcon icon();

        virtual void setIcon(const QIcon &icon);

        virtual bool isBranch() const { return false; }

        virtual void clear();

        virtual Kwave::MenuNode *parentNode() const;

        virtual void setVisible(bool visible);

        virtual bool isEnabled();

        virtual void setEnabled(bool enable);

        virtual void setChecked(bool check);

        virtual void setText(const QString &text);

        Kwave::MenuNode *findUID(const QString &uid);

        Kwave::MenuNode *findChild(const QString &name);

        virtual void removeChild(Kwave::MenuNode *child);

        virtual Kwave::MenuSub *insertBranch(const QString &name,
                                             const QString &command,
                                             const QKeySequence &shortcut,
                                             const QString &uid);

        virtual Kwave::MenuNode *insertLeaf(const QString &name,
                                            const QString &command,
                                            const QKeySequence &shortcut,
                                            const QString &uid);

        virtual void insertChild(Kwave::MenuNode *node,
                                 Kwave::MenuNode *before);

        virtual void insertNode(const QString &name,
                                const QString &position,
                                const QString &command,
                                const QKeySequence &shortcut,
                                const QString &uid);

        virtual Kwave::MenuNode *leafToBranch(Kwave::MenuNode *node);

        virtual bool specialCommand(const QString &command);

        virtual void actionSelected();

        virtual QHash<QString, Kwave::MenuGroup *> &groupList();

        void joinGroup(const QString &group, Kwave::MenuGroup::Mode mode);

        void leaveGroup(const QString &group);

    protected:

        Kwave::MenuNode *rootNode();

        void emitCommand(const QString &command);

    signals:
        void sigCommand(const QString &command);

    protected:

        QList<Kwave::MenuNode *> m_children;

        QStringList m_groups;

    private:

        QString m_uid;

        QKeySequence m_shortcut;

        QString m_name;

        QString m_command;

        Kwave::MenuNode *m_parentNode;

    };
}

#endif // _MENU_NODE_H_

//***************************************************************************
//***************************************************************************