kdeui Library API Documentation

KActionMenu Class Reference

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

#include <kactionclasses.h>

Inheritance diagram for KActionMenu:

KAction QObject List of all members.

Public Methods

bool delayed () const
void setDelayed (bool _delayed)
bool stickyMenu () const
void setStickyMenu (bool sticky)
virtual int plug (QWidget *widget, int index=-1)

Protected Methods

virtual void virtual_hook (int id, void *data)

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 947 of file kactionclasses.h.


Member Function Documentation

bool KActionMenu::delayed  
 

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

Definition at line 1640 of file kactionclasses.cpp.

Referenced by plug().

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 1644 of file kactionclasses.cpp.

bool KActionMenu::stickyMenu  
 

Returns true if this action creates a sticky popup menu.

See setStickyMenu.

Definition at line 1648 of file kactionclasses.cpp.

Referenced by plug().

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 1652 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 1656 of file kactionclasses.cpp.

References QWhatsThis::add(), QObject::connect(), KActionCollection::connectHighlight(), delayed(), QObject::destroyed(), KToolBar::getButton(), KAction::getToolButtonID(), KAction::iconSet(), KToolBar::insertButton(), QMenuBar::insertItem(), QPopupMenu::insertItem(), KGlobal::instance(), KActionCollection::instance(), KNotifyClient::instance(), QString::isEmpty(), KAction::isEnabled(), QIconSet::isNull(), QObject::name(), KToolBar::setDelayedPopup(), QMenuBar::setItemEnabled(), QPopupMenu::setItemEnabled(), KToolBarButton::setPopup(), stickyMenu(), KAction::text(), and KAction::whatsThis().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.2.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 4 12:34:22 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003