Kwave::MenuRoot Class Reference

#include <MenuRoot.h>

Inheritance diagram for Kwave::MenuRoot:

Collaboration diagram for Kwave::MenuRoot:

Public Member Functions
	MenuRoot (QMenuBar &bar)
virtual	~MenuRoot () Q_DECL_OVERRIDE
virtual void	insertNode (const QString &name, const QString &position, const QString &command, const QKeySequence &shortcut, const QString &uid) Q_DECL_OVERRIDE
virtual Kwave::MenuSub *	insertBranch (const QString &name, const QString &command, const QKeySequence &shortcut, const QString &uid) Q_DECL_OVERRIDE
virtual Kwave::MenuNode *	insertLeaf (const QString &name, const QString &command, const QKeySequence &shortcut, const QString &uid) Q_DECL_OVERRIDE
virtual void	removeChild (Kwave::MenuNode *child) Q_DECL_OVERRIDE
virtual bool	specialCommand (const QString &command) Q_DECL_OVERRIDE
virtual QHash< QString, Kwave::MenuGroup * > &	groupList () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::MenuNode
	MenuNode (Kwave::MenuNode *parent, const QString &name, const QString &command, const QKeySequence &shortcut, const QString &uid)
virtual	~MenuNode ()
const QString	path () const
const QString &	name () const
const QString &	command () const
virtual QAction *	action ()
const QString &	uid () const
void	setUID (const QString &uid)
const QKeySequence &	shortcut () const
virtual void	setShortcut (const QKeySequence &shortcut)
virtual const QIcon	icon ()
virtual void	setIcon (const QIcon &icon)
virtual bool	isBranch () const
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	insertChild (Kwave::MenuNode *node, Kwave::MenuNode *before)
virtual Kwave::MenuNode *	leafToBranch (Kwave::MenuNode *node)
virtual void	actionSelected ()
void	joinGroup (const QString &group, Kwave::MenuGroup::Mode mode)
void	leaveGroup (const QString &group)

Static Public Member Functions
static void	deleteLater (Kwave::MenuNode *node)

Protected Member Functions
void	showChild (Kwave::MenuSub *child)
void	hideChild (Kwave::MenuSub *child)
Protected Member Functions inherited from Kwave::MenuNode
Kwave::MenuNode *	rootNode ()
void	emitCommand (const QString &command)

Private Attributes
QMenuBar &	m_menu_bar
QHash< QString, Kwave::MenuGroup * >	m_group_list

Static Private Attributes
static QList< Kwave::MenuNode * >	m_garbage

Friends
class	MenuSub

Additional Inherited Members
Signals inherited from Kwave::MenuNode
void	sigCommand (const QString &command)
Protected Attributes inherited from Kwave::MenuNode
QList< Kwave::MenuNode * >	m_children
QStringList	m_groups

Detailed Description

This is the class for the root of a Menu (e.g. a MenuBar) that contains all toplevel menus of a menu hierarchy.

Author

Thomas Eschenbacher

Definition at line 39 of file MenuRoot.h.

Constructor & Destructor Documentation

MenuRoot()

Kwave::MenuRoot::MenuRoot ( QMenuBar &  bar )

explicit

Constructor.

Parameters

bar	reference to a QMenuBar

Definition at line 38 of file MenuRoot.cpp.

    :Kwave::MenuNode(Q_NULLPTR, _("(root)"), QString(), 0, QString()),
     m_menu_bar(bar), m_group_list()
{
}

~MenuRoot()

Kwave::MenuRoot::~MenuRoot ( )

virtual

Destructor

Definition at line 45 of file MenuRoot.cpp.

References Kwave::MenuNode::clear().

{
    clear();
}

Here is the call graph for this function:

Member Function Documentation

deleteLater()

void Kwave::MenuRoot::deleteLater ( Kwave::MenuNode *  node )

static

replacement for QObject::deleteLater(...), which does not work in this context

Definition at line 177 of file MenuRoot.cpp.

References m_garbage.

Referenced by Kwave::MenuNode::leafToBranch().

{
    if (node) m_garbage.append(node);
}

Here is the caller graph for this function:

groupList()

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

virtual

Returns a pointer to the list of groups

Reimplemented from Kwave::MenuNode.

Definition at line 51 of file MenuRoot.cpp.

References m_group_list.

Referenced by hideChild(), removeChild(), Kwave::MenuManager::selectItem(), Kwave::MenuManager::setItemEnabled(), and showChild().

{
    return m_group_list;
}

Here is the caller graph for this function:

hideChild()

void Kwave::MenuRoot::hideChild ( Kwave::MenuSub *  child )

protected

Makes a child node invisible, by removing it from the menu bar

Parameters

child

pointer to the child node (normally a MenuSub)

Definition at line 110 of file MenuRoot.cpp.

References Kwave::MenuNode::action(), Kwave::MenuSub::action(), groupList(), Kwave::MenuNode::m_children, m_menu_bar, and Kwave::MenuNode::name().

Referenced by Kwave::MenuSub::setVisible().

{
    Q_ASSERT(child);
    if (!child) return;
    if (!m_children.contains(child)) return;
    if (groupList().contains(child->name())) return;

    QAction *action = child->action();
    if (action) m_menu_bar.removeAction(action);
}

Here is the call graph for this function:

Here is the caller graph for this function:

insertBranch()

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

virtual

Inserts a new branch node into the menu structure.

Parameters

name	non-localized name of the node
command	the command template used for creating commands of submenus (leafes) that don't have an own command but contain data for their parent's command. Should contain a s that will be replaced by some data from a child entry. (this is used for menus with data selection lists like "recent files) If not used, pass 0.
shortcut	keyboard shortcut, 0 if unused
uid	unique id string (might be 0)

Returns

pointer to the new branch node

Reimplemented from Kwave::MenuNode.

Definition at line 73 of file MenuRoot.cpp.

References Kwave::MenuNode::insertChild(), and m_menu_bar.

{
    QMenu *menu = m_menu_bar.addMenu(name);
    Q_ASSERT(menu);
    if (!menu) return Q_NULLPTR;

    Kwave::MenuSub *sub = new(std::nothrow)
        Kwave::MenuSub(this, menu, name, command, shortcut, uid);
    Q_ASSERT(sub);
    if (!sub) return Q_NULLPTR;

    insertChild(sub, Q_NULLPTR);

    return sub;
}

Here is the call graph for this function:

insertLeaf()

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

virtual

Inserts a new leaf node into the menu structure. The new node normally is (derived from) MenuItem.

Parameters

name	non-localized name of the node
command	the command to be sent when the node is selected (might be 0)
shortcut	keyboard shortcut, 0 if unused
uid	unique id string (might be 0)

Returns

pointer to the new leaf node

Reimplemented from Kwave::MenuNode.

Definition at line 93 of file MenuRoot.cpp.

References Kwave::MenuItem::action(), Kwave::MenuNode::insertChild(), and m_menu_bar.

{
    Kwave::MenuItem *item = new(std::nothrow)
        Kwave::MenuItem(this, name, command, shortcut, uid);
    Q_ASSERT(item);
    if (!item) return Q_NULLPTR;

    insertChild(item, Q_NULLPTR);
    m_menu_bar.addAction(item->action());

    return item;
}

Here is the call graph for this function:

insertNode()

void Kwave::MenuRoot::insertNode ( const QString &  name, const QString &  position, const QString &  command, const QKeySequence &  shortcut, const QString &  uid  )

virtual

overloaded version from MenuNode, which does a cleanup of the "garbage collector" afterwards.

See also

MenuNode::insertNode()

Parameters

name	non-localized name of the first node (might be 0)
position	path consiting of several node names separated by a '/'. All strings are non-localized.
command	the command to be sent when the node is selected (might be 0)
shortcut	keyboard shortcut, 0 if unused
uid	unique id string (might be 0)

Reimplemented from Kwave::MenuNode.

Definition at line 57 of file MenuRoot.cpp.

References Kwave::MenuNode::insertNode(), and m_garbage.

Referenced by Kwave::MenuManager::executeCommand().

{
    Kwave::MenuNode::insertNode(name, position, command, shortcut, uid);

    // now delete all leafs that have been converted to branches
    while (!m_garbage.isEmpty()) {
        Kwave::MenuNode *node = m_garbage.takeFirst();
        if (node) delete node;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

removeChild()

void Kwave::MenuRoot::removeChild ( Kwave::MenuNode *  child )

virtual

Removes a child node of the current node. If the child was not found or is already removed this does nothing.

Parameters

child

pointer to the child node

Reimplemented from Kwave::MenuNode.

Definition at line 146 of file MenuRoot.cpp.

References Kwave::MenuNode::action(), groupList(), Kwave::MenuNode::m_children, m_menu_bar, Kwave::MenuNode::name(), and Kwave::MenuNode::removeChild().

{
    Q_ASSERT(child);
    if (!child) return;
    if (!m_children.contains(child)) return;

    QHash<QString, Kwave::MenuGroup *> &group_list = groupList();
    if (!group_list.contains(child->name())) {
        // only remove what has been added to the menu bar,
        // but not menu groups
        QAction *action = child->action();
        if (action) m_menu_bar.removeAction(action);
    }
    Kwave::MenuNode::removeChild(child);
}

Here is the call graph for this function:

showChild()

void Kwave::MenuRoot::showChild ( Kwave::MenuSub *  child )

protected

Makes a child node visible, by adding it to the menu bar

Parameters

child

pointer to the child node (normally a MenuSub)

Definition at line 122 of file MenuRoot.cpp.

References Kwave::MenuNode::action(), groupList(), Kwave::MenuNode::m_children, m_menu_bar, Kwave::MenuSub::menu(), and Kwave::MenuNode::name().

Referenced by Kwave::MenuSub::setVisible().

{
    Q_ASSERT(child);
    if (!child) return;
    if (!m_children.contains(child)) return;
    if (groupList().contains(child->name())) return;

    // find the menu bar entry after which we can insert
    QAction *action_before = Q_NULLPTR;
    QListIterator<Kwave::MenuNode *> it(m_children);
    it.toBack();
    while (it.hasPrevious()) {
        Kwave::MenuNode *c = it.previous();
        if (c == child) break;
        if (c) action_before = c->action();
    }

    if (action_before)
        m_menu_bar.insertMenu(action_before, child->menu());
    else
        m_menu_bar.addMenu(child->menu());
}

Here is the call graph for this function:

Here is the caller graph for this function:

specialCommand()

bool Kwave::MenuRoot::specialCommand ( const QString &  command )

virtual

Handles/interprets special menu commands.

Parameters

command

name of a menu node or command

Returns

true if the name was recognized as a command and handled

Reimplemented from Kwave::MenuNode.

Definition at line 163 of file MenuRoot.cpp.

References _, m_menu_bar, and Kwave::MenuNode::specialCommand().

{
    Q_ASSERT(command.length());
    if (!command.length()) return false;

    if (command == _("#separator")) {
        m_menu_bar.addSeparator();
        return true;
    }

    return Kwave::MenuNode::specialCommand(command);
}

Here is the call graph for this function:

Friends And Related Function Documentation

MenuSub

friend class MenuSub

friend

Definition at line 135 of file MenuRoot.h.

Member Data Documentation

m_garbage

QList< Kwave::MenuNode * > Kwave::MenuRoot::m_garbage

staticprivate

list of nodes to delete, as deleteLater() does not work :-(

garbage collector for menu nodes

Definition at line 158 of file MenuRoot.h.

Referenced by deleteLater(), and insertNode().

m_group_list

QHash<QString, Kwave::MenuGroup *> Kwave::MenuRoot::m_group_list

private

list of menu groups

Definition at line 155 of file MenuRoot.h.

Referenced by groupList().

m_menu_bar

QMenuBar& Kwave::MenuRoot::m_menu_bar

private

reference to a QMenuBar

Definition at line 152 of file MenuRoot.h.

Referenced by hideChild(), insertBranch(), insertLeaf(), removeChild(), showChild(), and specialCommand().

---

The documentation for this class was generated from the following files:

• libgui/MenuRoot.h
• libgui/MenuRoot.cpp