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

kdeui

Public Member Functions | Protected Member Functions | Properties
KToolBarPopupAction Class Reference

#include <kactionclasses.h>

Inheritance diagram for KToolBarPopupAction:
KAction

List of all members.

Public Member Functions

 KToolBarPopupAction (const TQString &text, const TQString &icon, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KToolBarPopupAction (const TQString &text, const TQString &icon, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent=0, const char *name=0)
 KToolBarPopupAction (const KGuiItem &item, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
virtual int plug (TQWidget *widget, int index=-1)
KPopupMenu * popupMenu () const
bool delayed () const
void setDelayed (bool delayed)
bool stickyMenu () const
void setStickyMenu (bool sticky)

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Properties

bool delayed
bool stickyMenu

Detailed Description

This action is a normal action everywhere, except in a toolbar where it also has a popupmenu (optionnally delayed).

This action is designed for history actions (back/forward, undo/redo) and for any other action that has more detail in a toolbar than in a menu (e.g. tool chooser with "Other" leading to a dialog...).

Definition at line 1094 of file kactionclasses.h.


Constructor & Destructor Documentation

KToolBarPopupAction::KToolBarPopupAction ( const TQString &  text,
const TQString &  icon,
const KShortcut &  cut = KShortcut(),
TQObject *  parent = 0,
const char *  name = 0 
)

Create a KToolBarPopupAction, with a text, an icon, an optional accelerator, parent and name.

Parameters:
textThe text that will be displayed.
iconThe icon to display.
cutThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.

Definition at line 1883 of file kactionclasses.cpp.

KToolBarPopupAction::KToolBarPopupAction ( const TQString &  text,
const TQString &  icon,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent = 0,
const char *  name = 0 
)

Create a KToolBarPopupAction, with a text, an icon, an accelerator, a slot connected to the action, parent and name.

If you do not want or have a keyboard accelerator, set the cut param to 0.

Parameters:
textThe text that will be displayed.
iconThe icon to display.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's owner.
slotThe TQT_SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

Definition at line 1894 of file kactionclasses.cpp.

KToolBarPopupAction::KToolBarPopupAction ( const KGuiItem &  item,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
KActionCollection *  parent,
const char *  name 
)

Create a KToolBarPopupAction, with a KGuiItem, an accelerator, a slot connected to the action, parent and name.

The text and the icon are taken from the KGuiItem.

If you do not want or have a keyboard accelerator, set the cut param to 0.

Parameters:
itemThe text and icon that will be displayed.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's owner.
slotThe TQT_SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

Definition at line 1907 of file kactionclasses.cpp.


Member Function Documentation

bool KToolBarPopupAction::delayed ( ) const

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

int KToolBarPopupAction::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 1940 of file kactionclasses.cpp.

KPopupMenu * KToolBarPopupAction::popupMenu ( ) const

The popup menu that is shown when clicking (some time) on the toolbar button.

You may want to plug items into it on creation, or connect to aboutToShow for a more dynamic menu.

Definition at line 1989 of file kactionclasses.cpp.

void KToolBarPopupAction::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.

Definition at line 1928 of file kactionclasses.cpp.

void KToolBarPopupAction::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. Only available if delayed() is true. Default: sticky.

Definition at line 1936 of file kactionclasses.cpp.

bool KToolBarPopupAction::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.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |