Kwave::MenuSub Class Reference

#include <MenuSub.h>

Inheritance diagram for Kwave::MenuSub:

Collaboration diagram for Kwave::MenuSub:

Public Member Functions
	MenuSub (Kwave::MenuNode *parent, QMenu *menu, const QString &name, const QString &command, const QKeySequence &shortcut, const QString &uid)
virtual	~MenuSub () Q_DECL_OVERRIDE
virtual bool	isBranch () const 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 QAction *	action () Q_DECL_OVERRIDE
virtual void	removeChild (Kwave::MenuNode *child) Q_DECL_OVERRIDE
virtual bool	specialCommand (const QString &command) Q_DECL_OVERRIDE
virtual void	setVisible (bool visible) Q_DECL_OVERRIDE
virtual bool	isEnabled () Q_DECL_OVERRIDE
virtual void	setEnabled (bool enable) Q_DECL_OVERRIDE
virtual const QIcon	icon () Q_DECL_OVERRIDE
virtual void	setIcon (const QIcon &icon) 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
const QString &	uid () const
void	setUID (const QString &uid)
const QKeySequence &	shortcut () const
virtual void	setShortcut (const QKeySequence &shortcut)
virtual void	clear ()
virtual Kwave::MenuNode *	parentNode () const
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 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 void	actionSelected ()
virtual QHash< QString, Kwave::MenuGroup * > &	groupList ()
void	joinGroup (const QString &group, Kwave::MenuGroup::Mode mode)
void	leaveGroup (const QString &group)

Protected Member Functions
virtual QMenu *	menu ()
Protected Member Functions inherited from Kwave::MenuNode
Kwave::MenuNode *	rootNode ()
void	emitCommand (const QString &command)

Private Attributes
QMenu *	m_menu

Friends
class	MenuRoot

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 submenu entries in a Menu. It is normally owned by a root menu node, a toplevel menu or another submenu.

Definition at line 36 of file MenuSub.h.

Constructor & Destructor Documentation

MenuSub()

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

Constructor.

Parameters

parent	pointer to the node's parent (might be 0)
menu	the already generated QMenu
name	the non-localized name of the submenu
command	the command to be sent when the submenu is selected (optional, default=0)
shortcut	keyboard shortcut, (optional, default=0)
uid	unique id string (optional, default=0)

Definition at line 33 of file MenuSub.cpp.

References _, action(), Kwave::MenuNode::path(), and UTF8.

    :Kwave::MenuNode(parent, name, command, shortcut, uid), m_menu(menu)
{
    QAction *act = action();
    Q_ASSERT(act);
    if (act) act->setText(i18nc(UTF8(_("menu: ") + path()), UTF8(name)));
}

Here is the call graph for this function:

~MenuSub()

Kwave::MenuSub::~MenuSub ( )

virtual

Destructor

Definition at line 47 of file MenuSub.cpp.

{
}

Member Function Documentation

action()

virtual QAction* Kwave::MenuSub::action ( )

inlinevirtual

Returns the corresponding menu action

Reimplemented from Kwave::MenuNode.

Definition at line 102 of file MenuSub.h.

References icon(), isEnabled(), m_menu, removeChild(), setEnabled(), setIcon(), setVisible(), and specialCommand().

Referenced by Kwave::MenuRoot::hideChild(), and MenuSub().

                                                  {
            return (m_menu) ? m_menu->menuAction() : Q_NULLPTR;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

icon()

const QIcon Kwave::MenuSub::icon ( )

virtual

Returns the menu nodes' icon.

Reimplemented from Kwave::MenuNode.

Definition at line 86 of file MenuSub.cpp.

References m_menu.

Referenced by action().

{
    return (m_menu) ? m_menu->icon() : QIcon();
}

Here is the caller graph for this function:

insertBranch()

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

virtual

Inserts a new branch node under the submenu. The new node normally is (derived from) MenuSub.

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 98 of file MenuSub.cpp.

References Kwave::MenuNode::insertChild(), m_menu, and menu().

Referenced by isBranch().

{
    QMenu *menu = (m_menu) ? m_menu->addMenu(name) : Q_NULLPTR;
    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:

Here is the caller graph for this function:

insertLeaf()

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

virtual

Inserts a new leaf node under the submenu. 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 118 of file MenuSub.cpp.

References Kwave::MenuNode::action(), Kwave::MenuItem::action(), Kwave::MenuNode::insertChild(), Kwave::MenuNode::m_children, m_menu, Kwave::MenuNode::name(), and Kwave::MenuNode::uid().

Referenced by isBranch().

{
    Q_ASSERT(name.length());
    Q_ASSERT(m_menu);
    if (!name.length() || !m_menu) return Q_NULLPTR;

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

    /*
     * find out where to insert the leaf: if there is a placeholder
     * with the matching uid, insert after that one, otherwise append
     * to the end
     */
    bool found = false;
    Kwave::MenuNode *child_after = Q_NULLPTR;
    QListIterator<Kwave::MenuNode *> it(m_children);
    it.toBack();
    while (!found && it.hasPrevious()) {
        Kwave::MenuNode *child = it.previous();
        if (!child) continue;
        if (uid.length() && ((uid == child->uid()) || (uid == child->name())))
            found = true;
        else if (child->action())
            child_after = child;
    }

    insertChild(item, (found) ? child_after : Q_NULLPTR);

    QAction *action_after = (found && child_after) ?
        child_after->action() : Q_NULLPTR;
    if (action_after)
        m_menu->insertAction(action_after, item->action());
    else
        m_menu->addAction(item->action());

    return item;
}

Here is the call graph for this function:

Here is the caller graph for this function:

isBranch()

virtual bool Kwave::MenuSub::isBranch ( ) const

inlinevirtual

Always returns true, as the nodes of this type are branches.

Reimplemented from Kwave::MenuNode.

Definition at line 64 of file MenuSub.h.

References insertBranch(), and insertLeaf().

{ return true; }

Here is the call graph for this function:

isEnabled()

bool Kwave::MenuSub::isEnabled ( )

virtual

Returns true if the node is enabled.

Reimplemented from Kwave::MenuNode.

Definition at line 73 of file MenuSub.cpp.

References Kwave::MenuNode::isEnabled(), and m_menu.

Referenced by action().

{
    if (m_menu && !m_menu->isEnabled()) return false;
    return Kwave::MenuNode::isEnabled();
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu()

virtual QMenu* Kwave::MenuSub::menu ( )

inlineprotectedvirtual

return the pointer to our QMenu

Definition at line 150 of file MenuSub.h.

References m_menu.

Referenced by insertBranch(), and Kwave::MenuRoot::showChild().

{ return m_menu; }

Here is the caller graph for this function:

removeChild()

void Kwave::MenuSub::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 163 of file MenuSub.cpp.

References Kwave::MenuNode::action(), m_menu, and Kwave::MenuNode::removeChild().

Referenced by action().

{
    QAction *act = (child) ? child->action() : Q_NULLPTR;
    if (act && m_menu) m_menu->removeAction(act);

    Kwave::MenuNode::removeChild(child);
}

Here is the call graph for this function:

Here is the caller graph for this function:

setEnabled()

void Kwave::MenuSub::setEnabled ( bool  enable )

virtual

Enables/disables the current menu node.

Parameters

enable

true to enable the item, false to disable

Reimplemented from Kwave::MenuNode.

Definition at line 80 of file MenuSub.cpp.

References m_menu.

Referenced by action(), and Kwave::MenuNode::leafToBranch().

{
    if (m_menu) m_menu->setEnabled(enable);
}

Here is the caller graph for this function:

setIcon()

void Kwave::MenuSub::setIcon ( const QIcon &  icon )

virtual

Sets a new icon of a menu node.

Parameters

icon	QPixmap with the icon

Reimplemented from Kwave::MenuNode.

Definition at line 92 of file MenuSub.cpp.

References m_menu.

Referenced by action(), and Kwave::MenuNode::leafToBranch().

{
    if (m_menu) m_menu->setIcon(icon);
}

Here is the caller graph for this function:

setVisible()

void Kwave::MenuSub::setVisible ( bool  visible )

virtual

Shows/hides the current sub menu.

Parameters

visible

true to show the sub menu, false to hide

Reimplemented from Kwave::MenuNode.

Definition at line 52 of file MenuSub.cpp.

References Kwave::MenuRoot::hideChild(), m_menu, Kwave::MenuNode::parentNode(), Kwave::MenuNode::rootNode(), and Kwave::MenuRoot::showChild().

Referenced by action().

{
    if (!m_menu) return;

    Kwave::MenuRoot *root = qobject_cast<Kwave::MenuRoot *>(rootNode());
    Q_ASSERT(root);
    if (root && (parentNode() == root)) {
        // special case: entries of the main menu can only be made
        // visible/invisible by adding to/removing from the main menu
        if (visible) {
            root->showChild(this);
        }
        else
            root->hideChild(this);
    } else {
        // normal menu entry
        m_menu->setVisible(visible);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

specialCommand()

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

virtual

Handles/interpretes 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 172 of file MenuSub.cpp.

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

Referenced by action().

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

    if (command.startsWith(_("#exclusive"))) {
        return true;
    } else if (command.startsWith(_("#separator"))) {
        if (m_menu) m_menu->addSeparator();
        return true;
    }

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

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

MenuRoot

friend class MenuRoot

friend

Definition at line 147 of file MenuSub.h.

Member Data Documentation

m_menu

QMenu* Kwave::MenuSub::m_menu

private

the QMenu that is controlled

Definition at line 155 of file MenuSub.h.

Referenced by action(), icon(), insertBranch(), insertLeaf(), isEnabled(), menu(), removeChild(), setEnabled(), setIcon(), setVisible(), and specialCommand().

---

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

• libgui/MenuSub.h
• libgui/MenuSub.cpp