Kwave::MenuGroup Class Reference

#include <MenuGroup.h>

Collaboration diagram for Kwave::MenuGroup:

Public Types
enum	Mode { NORMAL, EXCLUSIVE }

Public Member Functions
	MenuGroup (Kwave::MenuNode *parent, const QString &name, Kwave::MenuGroup::Mode mode)
virtual	~MenuGroup ()
virtual void	join (Kwave::MenuNode *node)
virtual void	leave (Kwave::MenuNode *node)
virtual void	setEnabled (bool enable)
virtual bool	isEnabled () const
virtual bool	isEmpty () const
virtual void	selectItem (const QString &uid)
virtual void	clear ()

Private Attributes
Kwave::MenuNode *	m_parent
QString	m_name
QList< Kwave::MenuNode * >	m_members
QActionGroup *	m_action_group
bool	m_enabled

Detailed Description

A MenuGroup controls a group of menu nodes (items, submenus).

Definition at line 34 of file MenuGroup.h.

Member Enumeration Documentation

Mode

enum Kwave::MenuGroup::Mode

mode for group membership

Enumerator
NORMAL	normal group, no dependencies
EXCLUSIVE	exclusive group, one of many (radio buttons)

Definition at line 39 of file MenuGroup.h.

        {
            NORMAL,   
            EXCLUSIVE 
        } Mode;

Constructor & Destructor Documentation

MenuGroup()

Kwave::MenuGroup::MenuGroup	(	Kwave::MenuNode *	parent,
		const QString &	name,
		Kwave::MenuGroup::Mode	mode
	)

Constructor.

Parameters

parent	pointer to the group's parent (might be 0)
name	the unique name of the group
mode	the mode of the group, normal or exclusive

Definition at line 29 of file MenuGroup.cpp.

References Kwave::MenuNode::groupList(), m_action_group, m_name, and m_parent.

    :m_parent(parent),
     m_name(name),
     m_members(),
     m_action_group((mode == EXCLUSIVE) ? new QActionGroup(parent) : Q_NULLPTR),
     m_enabled(true)
{
    Q_ASSERT(parent);
    Q_ASSERT(m_name.length());

    // register this group in the top level group list
    QHash<QString, Kwave::MenuGroup *> &group_list = m_parent->groupList();
    if (!group_list.contains(m_name))
        group_list[m_name] = this;

    if (m_action_group)
        m_action_group->setExclusive(true);
}

Here is the call graph for this function:

~MenuGroup()

Kwave::MenuGroup::~MenuGroup ( )

virtual

Destructor. cleans up.

See also

clear()

Definition at line 51 of file MenuGroup.cpp.

References clear(), Kwave::MenuNode::groupList(), m_name, and m_parent.

{
    clear();

    // de-register this group from the top level group list
    QHash<QString, Kwave::MenuGroup *> &group_list = m_parent->groupList();
    if (group_list.contains(m_name))
        group_list.remove(m_name);
}

Here is the call graph for this function:

Member Function Documentation

clear()

void Kwave::MenuGroup::clear ( )

virtual

De-registers all child nodes from us and removes them from our internal list of child nodes.

Definition at line 107 of file MenuGroup.cpp.

References leave(), and m_members.

Referenced by isEmpty(), and ~MenuGroup().

{
    // de-register all member nodes from us
    while (!m_members.isEmpty())
        leave(m_members.first());
}

Here is the call graph for this function:

Here is the caller graph for this function:

isEmpty()

virtual bool Kwave::MenuGroup::isEmpty ( ) const

inlinevirtual

returns true if the group contains no members

Definition at line 87 of file MenuGroup.h.

References clear(), m_members, and selectItem().

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

{ return m_members.isEmpty(); }

Here is the call graph for this function:

Here is the caller graph for this function:

isEnabled()

virtual bool Kwave::MenuGroup::isEnabled ( ) const

inlinevirtual

returns the "enabled" state of the group

Definition at line 82 of file MenuGroup.h.

References m_enabled.

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

{ return m_enabled; }

Here is the caller graph for this function:

join()

void Kwave::MenuGroup::join ( Kwave::MenuNode *  node )

virtual

add a menu node to the group

Parameters

node	a MenuNode to join, must not be NULL

Definition at line 62 of file MenuGroup.cpp.

References Kwave::MenuNode::action(), m_action_group, and m_members.

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

{
    if (node && !m_members.contains(node)) {
        m_members.append(node);
        if (m_action_group && node->action())
            m_action_group->addAction(node->action());
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

leave()

void Kwave::MenuGroup::leave ( Kwave::MenuNode *  node )

virtual

remove a menu node from the group

Parameters

node	a MenuNode to remove, must not be NULL

Definition at line 72 of file MenuGroup.cpp.

References Kwave::MenuNode::action(), m_action_group, and m_members.

Referenced by clear(), and Kwave::MenuNode::leaveGroup().

{
    if (node && m_members.contains(node)) {
        m_members.removeAll(node);
        if (m_action_group && node->action())
            m_action_group->removeAction(node->action());
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

selectItem()

void Kwave::MenuGroup::selectItem ( const QString &  uid )

virtual

Resets all checkmarks of the group members except the one member that will get the new selected one. If no new member id is given no member will get selected. This method is useful for making exclusive selections of menu items.

Parameters

uid	the unique id string of the member to be selected or 0

Definition at line 90 of file MenuGroup.cpp.

References m_members, Kwave::MenuNode::setChecked(), and Kwave::MenuNode::uid().

Referenced by isEmpty(), and Kwave::MenuManager::selectItem().

{
    Kwave::MenuNode *new_selection = Q_NULLPTR;

    foreach (Kwave::MenuNode *member, m_members) {
        if (member && (uid == member->uid()))
            new_selection = member;    // new selected member found !
        else
            member->setChecked(false); // remove check from others
    }

    // select the new one if found
    if (new_selection) new_selection->setChecked(true);

}

Here is the call graph for this function:

Here is the caller graph for this function:

setEnabled()

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

virtual

Enables/disables all members of the group.

Parameters

enable

true to enable the item, false to disable

Definition at line 82 of file MenuGroup.cpp.

References m_members, and Kwave::MenuNode::setEnabled().

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

{
    foreach (Kwave::MenuNode *member, m_members) {
        if (member) member->setEnabled(enable);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_action_group

QActionGroup* Kwave::MenuGroup::m_action_group

private

a QActionGroup, in case of "exclusive" mode

Definition at line 116 of file MenuGroup.h.

Referenced by join(), leave(), and MenuGroup().

m_enabled

bool Kwave::MenuGroup::m_enabled

private

the group's enabled/disabled flag

Definition at line 119 of file MenuGroup.h.

Referenced by isEnabled().

m_members

QList<Kwave::MenuNode *> Kwave::MenuGroup::m_members

private

list of group members

Definition at line 113 of file MenuGroup.h.

Referenced by clear(), isEmpty(), join(), leave(), selectItem(), and setEnabled().

m_name

QString Kwave::MenuGroup::m_name

private

name of the group

Definition at line 110 of file MenuGroup.h.

Referenced by MenuGroup(), and ~MenuGroup().

m_parent

Kwave::MenuNode* Kwave::MenuGroup::m_parent

private

the parent menu node

Definition at line 107 of file MenuGroup.h.

Referenced by MenuGroup(), and ~MenuGroup().

---

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

• libgui/MenuGroup.h
• libgui/MenuGroup.cpp