Kwave::MenuItem Class Reference

#include <MenuItem.h>

Inheritance diagram for Kwave::MenuItem:

Collaboration diagram for Kwave::MenuItem:

Public Member Functions
	MenuItem (Kwave::MenuNode *parent, const QString &name, const QString &command, const QKeySequence &shortcut, const QString &uid)
virtual	~MenuItem () Q_DECL_OVERRIDE
virtual void	actionSelected () 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 void	setCheckable (bool checkable)
virtual bool	isCheckable ()
virtual void	setChecked (bool check) Q_DECL_OVERRIDE
virtual void	setText (const QString &text) Q_DECL_OVERRIDE
virtual const QIcon	icon () Q_DECL_OVERRIDE
virtual void	setIcon (const QIcon &icon) Q_DECL_OVERRIDE
virtual QAction *	action () 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 bool	isBranch () const
virtual void	clear ()
virtual Kwave::MenuNode *	parentNode () const
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 QHash< QString, Kwave::MenuGroup * > &	groupList ()
void	joinGroup (const QString &group, Kwave::MenuGroup::Mode mode)
void	leaveGroup (const QString &group)

Private Slots
virtual void	actionTriggered (bool checked)

Private Attributes
QString	m_exclusive_group
QAction	m_action

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

Detailed Description

Base class for entries in a Menu. It is normally owned by a toplevel menu or a submenu.

Definition at line 35 of file MenuItem.h.

Constructor & Destructor Documentation

MenuItem()

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

Constructor.

Parameters

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

Definition at line 33 of file MenuItem.cpp.

References _, actionTriggered(), Kwave::connect(), m_action, Kwave::MenuNode::path(), and UTF8.

    :Kwave::MenuNode(parent, name, command, shortcut, uid),
     m_exclusive_group(), m_action(Q_NULLPTR)
{
    Q_ASSERT(parent);
    if (!parent) return;

    m_action.setText(i18nc(UTF8(_("menu: ") + path()), UTF8(name)));
    if (!shortcut.isEmpty()) m_action.setShortcut(shortcut);

    connect(&m_action, SIGNAL(triggered(bool)),
            this, SLOT(actionTriggered(bool)));
}

Here is the call graph for this function:

~MenuItem()

Kwave::MenuItem::~MenuItem ( )

virtual

virtual destructor

Definition at line 52 of file MenuItem.cpp.

{
}

Member Function Documentation

action()

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

inlinevirtual

Returns the corresponding menu action

Reimplemented from Kwave::MenuNode.

Definition at line 122 of file MenuItem.h.

References actionTriggered(), and m_action.

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

{ return &m_action; }

Here is the call graph for this function:

Here is the caller graph for this function:

actionSelected()

void Kwave::MenuItem::actionSelected ( )

virtual

Called to notify the item that it has been selected.

Reimplemented from Kwave::MenuNode.

Definition at line 64 of file MenuItem.cpp.

References Kwave::MenuNode::actionSelected(), isCheckable(), m_exclusive_group, and setChecked().

Referenced by actionTriggered().

{
    if (isCheckable() && !m_exclusive_group.length())
        setChecked(true);

    Kwave::MenuNode::actionSelected();
}

Here is the call graph for this function:

Here is the caller graph for this function:

actionTriggered

void Kwave::MenuItem::actionTriggered ( bool  checked )

privatevirtualslot

Definition at line 57 of file MenuItem.cpp.

References actionSelected().

Referenced by action(), and MenuItem().

{
    Q_UNUSED(checked);
    actionSelected();
}

Here is the call graph for this function:

Here is the caller graph for this function:

icon()

const QIcon Kwave::MenuItem::icon ( )

virtual

Returns the menu nodes' icon.

Reimplemented from Kwave::MenuNode.

Definition at line 151 of file MenuItem.cpp.

References m_action.

{
    return m_action.icon();
}

isCheckable()

bool Kwave::MenuItem::isCheckable ( )

virtual

Returns true if the node is checkable/selectable

Definition at line 127 of file MenuItem.cpp.

References m_action.

Referenced by actionSelected().

{
    return m_action.isCheckable();
}

Here is the caller graph for this function:

isEnabled()

bool Kwave::MenuItem::isEnabled ( )

virtual

Returns true if the node is enabled.

Reimplemented from Kwave::MenuNode.

Definition at line 114 of file MenuItem.cpp.

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

{
    if (!m_action.isEnabled()) return false;
    return Kwave::MenuNode::isEnabled();
}

Here is the call graph for this function:

setCheckable()

void Kwave::MenuItem::setCheckable ( bool  checkable )

virtual

Enables/disabled checking/selecting the item

Parameters

checkable

true to enable checking, false for disabling

Definition at line 133 of file MenuItem.cpp.

References m_action.

Referenced by specialCommand().

{
    m_action.setCheckable(checkable);
}

Here is the caller graph for this function:

setChecked()

void Kwave::MenuItem::setChecked ( bool  check )

virtual

Sets/removes the checkmark from the current menu item.

Parameters

check

true to set the mark, false to remove

Reimplemented from Kwave::MenuNode.

Definition at line 139 of file MenuItem.cpp.

References m_action.

Referenced by actionSelected().

{
    m_action.setChecked(check);
}

Here is the caller graph for this function:

setEnabled()

void Kwave::MenuItem::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 121 of file MenuItem.cpp.

References m_action.

{
    m_action.setEnabled(enable);
}

setIcon()

void Kwave::MenuItem::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 157 of file MenuItem.cpp.

References m_action.

{
    m_action.setIcon(icon);
}

setText()

void Kwave::MenuItem::setText ( const QString &  text )

virtual

Sets the visible text of an item to a new value. (Only useful for a MenuItem)

Parameters

text	the new text

Reimplemented from Kwave::MenuNode.

Definition at line 145 of file MenuItem.cpp.

References m_action.

{
    m_action.setText(text);
}

setVisible()

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

virtual

Shows/hides the current menu node.

Parameters

visible

true to show the item, false to hide

Reimplemented from Kwave::MenuNode.

Definition at line 108 of file MenuItem.cpp.

References m_action.

Referenced by specialCommand().

{
    m_action.setVisible(visible);
}

Here is the caller graph for this function:

specialCommand()

bool Kwave::MenuItem::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 73 of file MenuItem.cpp.

References _, Kwave::Parser::command(), DBG, Kwave::MenuGroup::EXCLUSIVE, Kwave::Parser::firstParam(), Kwave::MenuNode::joinGroup(), m_exclusive_group, Kwave::MenuNode::name(), Kwave::Parser::nextParam(), setCheckable(), setVisible(), and Kwave::MenuNode::specialCommand().

{
    Kwave::Parser parser(command);

    if (command == _("#checkable")) {
        // checking/selecting of the item (non-exclusive)
        setCheckable(true);
    }
    else if (parser.command() == _("#exclusive")) {
        // join to a list of groups
        QString group = parser.firstParam();
        while (group.length()) {
            if (!m_exclusive_group.length()) {
                m_exclusive_group = group;
                joinGroup(group, Kwave::MenuGroup::EXCLUSIVE);
            } else if (m_exclusive_group != group) {
                qWarning("menu item '%s' already member of "
                        "exclusive group '%s'",
                        DBG(name()), DBG(m_exclusive_group));
            }
            group = parser.nextParam();
        }

        // make the item checkable
        setCheckable(true);
        return true;
    }
    else if (command == _("#hidden")) {
        setVisible(false);
    }

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

Here is the call graph for this function:

Member Data Documentation

m_action

QAction Kwave::MenuItem::m_action

private

the QAction behind this menu entry

Definition at line 137 of file MenuItem.h.

Referenced by action(), icon(), isCheckable(), isEnabled(), MenuItem(), setCheckable(), setChecked(), setEnabled(), setIcon(), setText(), and setVisible().

m_exclusive_group

QString Kwave::MenuItem::m_exclusive_group

private

name of a group for exclusive selection (optional, set by special command, default=0)

Definition at line 134 of file MenuItem.h.

Referenced by actionSelected(), and specialCommand().

---

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

• libgui/MenuItem.h
• libgui/MenuItem.cpp