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

tdeui

Public Member Functions | Protected Member Functions | List of all members
TDEToolBarPopupAction Class Reference

#include <tdeactionclasses.h>

Inheritance diagram for TDEToolBarPopupAction:
TDEAction

Public Member Functions

 TDEToolBarPopupAction (const TQString &text, const TQString &icon, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
 
 TDEToolBarPopupAction (const TQString &text, const TQString &icon, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent=0, const char *name=0)
 
 TDEToolBarPopupAction (const KGuiItem &item, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
 
virtual int plug (TQWidget *widget, int index=-1)
 
TDEPopupMenu * popupMenu () const
 
bool delayed () const
 
void setDelayed (bool delayed)
 
bool stickyMenu () const
 
void setStickyMenu (bool sticky)
 
- Public Member Functions inherited from TDEAction
 TDEAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
 
 TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
 
 TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
 
 TDEAction (const KGuiItem &item, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
 
 TDEAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
 
 TDEAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 
 TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
 
 TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
 
 TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 
 TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 
 TDEAction (TQObject *parent=0, const char *name=0)
 
virtual ~TDEAction ()
 
virtual int plug (TQWidget *widget, int index=-1)
 
virtual void plugAccel (TDEAccel *accel, bool configurable=true) TDE_DEPRECATED
 
virtual void unplug (TQWidget *w)
 
virtual void unplugAccel () TDE_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 tdeaccelCount () const
 
virtual bool hasIcon () const
 
bool hasIconSet () const
 
virtual TQString plainText () const
 
virtual TQString text () const
 
virtual const TDEShortcut & shortcut () const
 
virtual const TDEShortcut & 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 (TDEIcon::Group group, int size=0) const
 
TQIconSet iconSet () const
 
virtual TQString icon () const
 
TDEActionCollection * parentCollection () const
 
void unplugAll ()
 
int accel () const TDE_DEPRECATED
 
TQString statusText () const
 
void setAccel (int key) TDE_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 TDEAction
TDEToolBar * 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
 
virtual void virtual_hook (int id, void *data)
 

Additional Inherited Members

- Public Types inherited from TDEAction
enum  ActivationReason {
  UnknownActivation , EmulatedActivation , AccelActivation , PopupMenuActivation ,
  ToolBarActivation
}
 
- Public Slots inherited from TDEAction
virtual void setText (const TQString &text)
 
virtual bool setShortcut (const TDEShortcut &)
 
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 TDEAction
void activated ()
 
void activated (TDEAction::ActivationReason reason, TQt::ButtonState state)
 
void enabled (bool)
 
- Static Public Member Functions inherited from TDEAction
static int getToolButtonID ()
 
- Protected Slots inherited from TDEAction
virtual void slotDestroyed ()
 
virtual void slotKeycodeChanged ()
 
virtual void slotActivated ()
 
void slotPopupActivated ()
 
void slotButtonClicked (int, TQt::ButtonState state)
 
- Protected Attributes inherited from TDEAction
TDEActionCollection * m_parentCollection
 

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 tdeactionclasses.h.

Constructor & Destructor Documentation

◆ TDEToolBarPopupAction() [1/3]

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

Create a TDEToolBarPopupAction, 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 tdeactionclasses.cpp.

◆ TDEToolBarPopupAction() [2/3]

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

Create a TDEToolBarPopupAction, 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 slot to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

Definition at line 1894 of file tdeactionclasses.cpp.

◆ TDEToolBarPopupAction() [3/3]

TDEToolBarPopupAction::TDEToolBarPopupAction ( const KGuiItem &  item,
const TDEShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TDEActionCollection *  parent,
const char *  name 
)

Create a TDEToolBarPopupAction, 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 slot to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

Definition at line 1907 of file tdeactionclasses.cpp.

◆ ~TDEToolBarPopupAction()

TDEToolBarPopupAction::~TDEToolBarPopupAction ( )
virtual

Definition at line 1919 of file tdeactionclasses.cpp.

Member Function Documentation

◆ delayed()

bool TDEToolBarPopupAction::delayed ( ) const

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

Definition at line 1924 of file tdeactionclasses.cpp.

◆ plug()

int TDEToolBarPopupAction::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 TDEAction 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 TDEAction.

Definition at line 1940 of file tdeactionclasses.cpp.

◆ popupMenu()

TDEPopupMenu * TDEToolBarPopupAction::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 tdeactionclasses.cpp.

◆ setDelayed()

void TDEToolBarPopupAction::setDelayed ( bool  delayed)

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

Otherwise it creates a normal popup. Default: delayed.

Definition at line 1928 of file tdeactionclasses.cpp.

◆ setStickyMenu()

void TDEToolBarPopupAction::setStickyMenu ( bool  sticky)

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

"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 tdeactionclasses.cpp.

◆ stickyMenu()

bool TDEToolBarPopupAction::stickyMenu ( ) const

Returns true if this action creates a sticky popup menu.

See setStickyMenu().

Definition at line 1932 of file tdeactionclasses.cpp.

◆ virtual_hook()

void TDEToolBarPopupAction::virtual_hook ( int  id,
void *  data 
)
protectedvirtual

Reimplemented from TDEAction.

Definition at line 2401 of file tdeactionclasses.cpp.


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

tdeui

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

tdeui

Skip menu "tdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeui by doxygen 1.9.4
This website is maintained by Timothy Pearson.