• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdeui
 

kdeui

Public Member Functions | Protected Member Functions | Properties | List of all members
KActionMenu Class Reference

#include <kactionclasses.h>

Inheritance diagram for KActionMenu:
KAction

Public Member Functions

 KActionMenu (const TQString &text, TQObject *parent=0, const char *name=0)
 KActionMenu (const TQString &text, const TQIconSet &icon, TQObject *parent=0, const char *name=0)
 KActionMenu (const TQString &text, const TQString &icon, TQObject *parent=0, const char *name=0)
 KActionMenu (TQObject *parent=0, const char *name=0)
virtual void insert (KAction *, int index=-1)
virtual void remove (KAction *)
KPopupMenu * popupMenu () const
void popup (const TQPoint &global)
bool delayed () const
void setDelayed (bool _delayed)
bool stickyMenu () const
void setStickyMenu (bool sticky)
virtual int plug (TQWidget *widget, int index=-1)
- Public Member Functions inherited from KAction
 KAction (const TQString &text, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const TQString &text, const TQString &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const KGuiItem &item, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const TQString &text, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KAction (const TQString &text, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KAction (const TQString &text, const TQString &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KAction (const TQString &text, const TQString &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KAction (TQObject *parent=0, const char *name=0)
virtual ~KAction ()
virtual void plugAccel (KAccel *accel, bool configurable=true) KDE_DEPRECATED
virtual void unplug (TQWidget *w)
virtual void unplugAccel () KDE_DEPRECATED
virtual bool isPlugged () const
bool isPlugged (const TQWidget *container) const
virtual bool isPlugged (const TQWidget *container, int id) const
virtual bool isPlugged (const TQWidget *container, const TQWidget *_representative) const
TQWidget * container (int index) const
int itemId (int index) const
TQWidget * representative (int index) const
int containerCount () const
uint kaccelCount () const
virtual bool hasIcon () const
bool hasIconSet () const
virtual TQString plainText () const
virtual TQString text () const
virtual const KShortcut & shortcut () const
virtual const KShortcut & shortcutDefault () const
TQString shortcutText () const
void setShortcutText (const TQString &)
virtual bool isEnabled () const
virtual bool isShortcutConfigurable () const
virtual TQString group () const
virtual TQString whatsThis () const
virtual TQString toolTip () const
virtual TQIconSet iconSet (KIcon::Group group, int size=0) const
TQIconSet iconSet () const
virtual TQString icon () const
KActionCollection * parentCollection () const
void unplugAll ()
int accel () const KDE_DEPRECATED
TQString statusText () const
void setAccel (int key) KDE_DEPRECATED
void setStatusText (const TQString &text)
int menuId (int i)

Protected Member Functions

virtual void virtual_hook (int id, void *data)
- Protected Member Functions inherited from KAction
KToolBar * toolBar (int index) const
TQPopupMenu * popupMenu (int index) const
void removeContainer (int index)
int findContainer (const TQWidget *widget) const
int findContainer (int id) const
void plugMainWindowAccel (TQWidget *w)
void addContainer (TQWidget *parent, int id)
void addContainer (TQWidget *parent, TQWidget *representative)
virtual void updateShortcut (int i)
virtual void updateShortcut (TQPopupMenu *menu, int id)
virtual void updateGroup (int id)
virtual void updateText (int i)
virtual void updateEnabled (int i)
virtual void updateIconSet (int i)
virtual void updateIcon (int i)
virtual void updateToolTip (int id)
virtual void updateWhatsThis (int i)
TQString whatsThisWithIcon () const
const KGuiItem & guiItem () const

Properties

bool delayed
bool stickyMenu
- Properties inherited from KAction
int containerCount
TQString plainText
TQString text
TQString shortcut
bool enabled
TQString group
TQString whatsThis
TQString toolTip
TQString icon

Additional Inherited Members

- Public Types inherited from KAction
enum  ActivationReason {
  UnknownActivation, EmulatedActivation, AccelActivation, PopupMenuActivation,
  ToolBarActivation
}
- Public Slots inherited from KAction
virtual void setText (const TQString &text)
virtual bool setShortcut (const KShortcut &)
virtual void setGroup (const TQString &)
virtual void setWhatsThis (const TQString &text)
virtual void setToolTip (const TQString &)
virtual void setIconSet (const TQIconSet &iconSet)
virtual void setIcon (const TQString &icon)
virtual void setEnabled (bool enable)
void setDisabled (bool disable)
virtual void setShortcutConfigurable (bool)
virtual void activate ()
- Signals inherited from KAction
void activated ()
void activated (KAction::ActivationReason reason, TQt::ButtonState state)
void enabled (bool)
- Static Public Member Functions inherited from KAction
static int getToolButtonID ()
- Protected Slots inherited from KAction
virtual void slotDestroyed ()
virtual void slotKeycodeChanged ()
virtual void slotActivated ()
void slotPopupActivated ()
void slotButtonClicked (int, TQt::ButtonState state)
- Protected Attributes inherited from KAction
KActionCollection * m_parentCollection

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

Member Function Documentation

bool KActionMenu::delayed ( ) const

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

int KActionMenu::plug ( TQWidget *  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
widgetThe GUI element to display this action
indexThe position into which the action is plugged. If this is negative, the action is inserted at the end.

Reimplemented from KAction.

Definition at line 1794 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 1782 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 1790 of file kactionclasses.cpp.

bool KActionMenu::stickyMenu ( ) const

Returns true if this action creates a sticky popup menu.

See setStickyMenu().


The documentation for this class was generated from the following files:
  • kactionclasses.h
  • kactionclasses.cpp

kdeui

Skip menu "kdeui"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeui

Skip menu "kdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdeui by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |