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

tdeui

Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions

TDEPopupMenu Class Reference

A menu with title items. More...

#include <tdepopupmenu.h>

Inheritance diagram for TDEPopupMenu:
TQPopupMenu KPanelMenu

List of all members.

Signals

void aboutToShowContextMenu (TDEPopupMenu *menu, int menuItem, TQPopupMenu *ctxMenu)

Public Member Functions

 TDEPopupMenu (TQWidget *parent=0, const char *name=0)
 ~TDEPopupMenu ()
int insertTitle (const TQString &text, int id=-1, int index=-1)
int insertTitle (const TQPixmap &icon, const TQString &text, int id=-1, int index=-1)
void changeTitle (int id, const TQString &text)
void changeTitle (int id, const TQPixmap &icon, const TQString &text)
TQString title (int id=-1) const
TQPixmap titlePixmap (int id) const
void setKeyboardShortcutsEnabled (bool enable)
void setKeyboardShortcutsExecute (bool enable)
 TDEPopupMenu (const TQString &title, TQWidget *parent=0, const char *name=0) KDE_DEPRECATED
void setTitle (const TQString &title) KDE_DEPRECATED
TQPopupMenu * contextMenu ()
const TQPopupMenu * contextMenu () const
void hideContextMenu ()
virtual void activateItemAt (int index)
TQt::ButtonState state () const

Static Public Member Functions

static TDEPopupMenu * contextMenuFocus ()
static int contextMenuFocusItem ()

Protected Slots

TQString underlineText (const TQString &text, uint length)
void resetKeyboardVars (bool noMatches=false)
void itemHighlighted (int whichItem)
void showCtxMenu (TQPoint pos)
void ctxMenuHiding ()
void ctxMenuHideShowingMenu ()

Protected Member Functions

virtual void closeEvent (TQCloseEvent *)
virtual void keyPressEvent (TQKeyEvent *e)
virtual void mouseReleaseEvent (TQMouseEvent *e)
virtual void mousePressEvent (TQMouseEvent *e)
virtual bool focusNextPrevChild (bool next)
virtual void contextMenuEvent (TQContextMenuEvent *e)
virtual void hideEvent (TQHideEvent *)
virtual void virtual_hook (int id, void *data)

Detailed Description

A menu with title items.

TDEPopupMenu is a class for menus with standard title items and keyboard accessibility for popups with many options and/or varying options. It acts identically to TQPopupMenu, with the addition of insertTitle(), changeTitle(), setKeyboardShortcutsEnabled() and setKeyboardShortcutsExecute() methods.

The titles support a text string, an icon, plus user defined gradients, colors, and background pixmaps.

The keyboard search algorithm is incremental with additional underlining for user feedback.

Author:
Daniel M. Duley <mosfet@kde.org>
Hamish Rodda <rodda@kde.org>

Definition at line 123 of file tdepopupmenu.h.


Constructor & Destructor Documentation

TDEPopupMenu::TDEPopupMenu ( TQWidget *  parent = 0,
const char *  name = 0 
)

Constructs a TDEPopupMenu.

Definition at line 166 of file tdepopupmenu.cpp.

TDEPopupMenu::~TDEPopupMenu (  ) 

Destructs the object.

Definition at line 174 of file tdepopupmenu.cpp.

TDEPopupMenu::TDEPopupMenu ( const TQString &  title,
TQWidget *  parent = 0,
const char *  name = 0 
)

end of RMB menus on menus support

Deprecated:
Obsolete method provided for backwards compatibility only.

Use the normal constructor and insertTitle instead.

Definition at line 672 of file tdepopupmenu.cpp.


Member Function Documentation

void TDEPopupMenu::aboutToShowContextMenu ( TDEPopupMenu *  menu,
int  menuItem,
TQPopupMenu *  ctxMenu 
) [signal]

connect to this signal to be notified when a context menu is about to be shown

Parameters:
menu The menu that the context menu is about to be shown for
menuItem The menu item that the context menu is currently on
ctxMenu The context menu itself
Since:
3.2
void TDEPopupMenu::activateItemAt ( int  index  )  [virtual]

Reimplemented for internal purposes.

Since:
3.4

Definition at line 279 of file tdepopupmenu.cpp.

void TDEPopupMenu::changeTitle ( int  id,
const TQPixmap &  icon,
const TQString &  text 
)

Changes the title and icon of the title item at the specified id.

Definition at line 221 of file tdepopupmenu.cpp.

void TDEPopupMenu::changeTitle ( int  id,
const TQString &  text 
)

Changes the title of the item at the specified id.

If a icon was previously set it is cleared.

Definition at line 204 of file tdepopupmenu.cpp.

void TDEPopupMenu::closeEvent ( TQCloseEvent *  e  )  [protected, virtual]

This is re-implemented for keyboard navigation.

Definition at line 272 of file tdepopupmenu.cpp.

TQPopupMenu * TDEPopupMenu::contextMenu (  ) 

Returns the context menu associated with this menu.

Since:
3.2

Definition at line 516 of file tdepopupmenu.cpp.

const TQPopupMenu * TDEPopupMenu::contextMenu (  )  const

Returns the context menu associated with this menu.

Since:
3.2

Definition at line 527 of file tdepopupmenu.cpp.

TDEPopupMenu * TDEPopupMenu::contextMenuFocus (  )  [static]

Returns the TDEPopupMenu associated with the current context menu.

Since:
3.2

Definition at line 542 of file tdepopupmenu.cpp.

int TDEPopupMenu::contextMenuFocusItem (  )  [static]

returns the ID of the menuitem associated with the current context menu

Since:
3.2

Definition at line 537 of file tdepopupmenu.cpp.

void TDEPopupMenu::hideContextMenu (  ) 

Hides the context menu if shown.

Since:
3.2

Definition at line 532 of file tdepopupmenu.cpp.

int TDEPopupMenu::insertTitle ( const TQPixmap &  icon,
const TQString &  text,
int  id = -1,
int  index = -1 
)

Inserts a title item with the given icon and title.

Definition at line 194 of file tdepopupmenu.cpp.

int TDEPopupMenu::insertTitle ( const TQString &  text,
int  id = -1,
int  index = -1 
)

Inserts a title item with no icon.

Definition at line 185 of file tdepopupmenu.cpp.

void TDEPopupMenu::mousePressEvent ( TQMouseEvent *  e  )  [protected, virtual]

End keyboard navigation.

RMB menus on menus

Definition at line 496 of file tdepopupmenu.cpp.

void TDEPopupMenu::mouseReleaseEvent ( TQMouseEvent *  e  )  [protected, virtual]
Since:
3.4

Definition at line 507 of file tdepopupmenu.cpp.

void TDEPopupMenu::resetKeyboardVars ( bool  noMatches = false  )  [protected, slot]
Since:
3.1

Definition at line 464 of file tdepopupmenu.cpp.

void TDEPopupMenu::setKeyboardShortcutsEnabled ( bool  enable  ) 

Enables keyboard navigation by searching for the entered key sequence.

Also underlines the currently selected item, providing feedback on the search.

Defaults to off.

WARNING: calls to text() of currently keyboard-selected items will contain additional ampersand characters.

WARNING: though pre-existing keyboard shortcuts will not interfere with the operation of this feature, they may be confusing to the user as the existing shortcuts will not work.

Since:
3.1

Definition at line 479 of file tdepopupmenu.cpp.

void TDEPopupMenu::setKeyboardShortcutsExecute ( bool  enable  ) 

Enables execution of the menu item once it is uniquely specified.

Defaults to off.

Since:
3.1

Definition at line 484 of file tdepopupmenu.cpp.

void TDEPopupMenu::setTitle ( const TQString &  title  ) 
Deprecated:
Obsolete method provided for backwards compatibility only.

Use insertTitle and changeTitle instead.

Definition at line 680 of file tdepopupmenu.cpp.

TQt::ButtonState TDEPopupMenu::state (  )  const

Return the state of the mouse button and keyboard modifiers when the last menuitem was activated.

Since:
3.4

Definition at line 285 of file tdepopupmenu.cpp.

TQString TDEPopupMenu::title ( int  id = -1  )  const

Returns the title of the title item at the specified id.

The default id of -1 is for backwards compatibility only, you should always specify the id.

Definition at line 238 of file tdepopupmenu.cpp.

TQPixmap TDEPopupMenu::titlePixmap ( int  id  )  const

Returns the icon of the title item at the specified id.

Definition at line 254 of file tdepopupmenu.cpp.

TQString TDEPopupMenu::underlineText ( const TQString &  text,
uint  length 
) [protected, slot]
Since:
3.1

Definition at line 454 of file tdepopupmenu.cpp.


The documentation for this class was generated from the following files:
  • tdepopupmenu.h
  • tdepopupmenu.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.7.1
This website is maintained by Timothy Pearson.