KActionMenu Class Reference

A KActionMenu is an action that holds a sub-menu of other actions. More...

#include <kactionclasses.h>

Inheritance diagram for KActionMenu:

[legend]

List of all members.

Public Member Functions
bool	delayed () const
virtual void	insert (KAction *, int index=-1)
	KActionMenu (QObject *parent=0, const char *name=0)
	KActionMenu (const QString &text, const QString &icon, QObject *parent=0, const char *name=0)
	KActionMenu (const QString &text, const QIconSet &icon, QObject *parent=0, const char *name=0)
	KActionMenu (const QString &text, QObject *parent=0, const char *name=0)
virtual int	plug (QWidget *widget, int index=-1)
void	popup (const QPoint &global)
KPopupMenu *	popupMenu () const
virtual void	remove (KAction *)
void	setDelayed (bool _delayed)
void	setStickyMenu (bool sticky)
bool	stickyMenu () const
virtual	~KActionMenu ()
Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Properties
bool	delayed
bool	stickyMenu

---

Detailed Description

A KActionMenu is an action that holds a sub-menu of other actions.

insert() and remove() allow to insert and remove actions into this action-menu. Plugged in a popupmenu, it will create a submenu. Plugged in a toolbar, it will create a button with a popup menu.

This is the action used by the XMLGUI since it holds other actions. If you want a submenu for selecting one tool among many (without icons), see KSelectAction. See also setDelayed about the main action.

Definition at line 1013 of file kactionclasses.h.

---

Constructor & Destructor Documentation

KActionMenu::KActionMenu	(	const QString &	text,
		QObject *	parent = 0,
		const char *	name = 0
	)

Definition at line 1704 of file kactionclasses.cpp.

KActionMenu::KActionMenu	(	const QString &	text,
		const QIconSet &	icon,
		QObject *	parent = 0,
		const char *	name = 0
	)

Definition at line 1712 of file kactionclasses.cpp.

KActionMenu::KActionMenu	(	const QString &	text,
		const QString &	icon,
		QObject *	parent = 0,
		const char *	name = 0
	)

Definition at line 1720 of file kactionclasses.cpp.

KActionMenu::KActionMenu	(	QObject *	parent = 0,
		const char *	name = 0
	)

Definition at line 1697 of file kactionclasses.cpp.

KActionMenu::~KActionMenu

(

)

[virtual]

Definition at line 1728 of file kactionclasses.cpp.

---

Member Function Documentation

bool KActionMenu::delayed

(

)

const

Returns true if this action creates a delayed popup menu when plugged in a KToolbar.

void KActionMenu::insert	(	KAction *	cmd,
		int	index = -1
	)			[virtual]

Definition at line 1745 of file kactionclasses.cpp.

int KActionMenu::plug	(	QWidget *	widget,
		int	index = -1
	)			[virtual]

"Plug" or insert this action into a given widget.

This will typically be a menu or a toolbar. From this point on, you will never need to directly manipulate the item in the menu or toolbar. You do all enabling/disabling/manipulation directly with your KAction object.

Parameters:

	widget	The GUI element to display this action
	index	The position into which the action is plugged. If this is negative, the action is inserted at the end.

Reimplemented from KAction.

Definition at line 1773 of file kactionclasses.cpp.

void KActionMenu::popup

(

const QPoint &

global

)

Definition at line 1735 of file kactionclasses.cpp.

KPopupMenu * KActionMenu::popupMenu

(

)

const

Definition at line 1740 of file kactionclasses.cpp.

void KActionMenu::remove

(

KAction *

cmd

)

[virtual]

Definition at line 1751 of file kactionclasses.cpp.

void KActionMenu::setDelayed

(

bool

_delayed

)

If set to true, this action will create a delayed popup menu when plugged in a KToolbar.

Otherwise it creates a normal popup. Default: delayed

Remember that if the "main" action (the toolbar button itself) cannot be clicked, then you should call setDelayed(false).

On the opposite, if the main action can be clicked, it can only happen in a toolbar: in a menu, the parent of a submenu can't be activated. To get a "normal" menu item when plugged a menu (and no submenu) use KToolBarPopupAction.

Definition at line 1761 of file kactionclasses.cpp.

void KActionMenu::setStickyMenu

(

bool

sticky

)

If set to true, this action will create a sticky popup menu when plugged in a KToolbar.

"Sticky", means it's visible until a selection is made or the mouse is clicked elsewhere. This feature allows you to make a selection without having to press and hold down the mouse while making a selection. Default: sticky.

Definition at line 1769 of file kactionclasses.cpp.

bool KActionMenu::stickyMenu

(

)

const

Returns true if this action creates a sticky popup menu.

See setStickyMenu().

void KActionMenu::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KAction.

Definition at line 2377 of file kactionclasses.cpp.

---

Property Documentation

bool KActionMenu::delayed [read, write]

Definition at line 1016 of file kactionclasses.h.

bool KActionMenu::stickyMenu [read, write]

Definition at line 1017 of file kactionclasses.h.

---

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

• kactionclasses.h
• kactionclasses.cpp