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

kdeui

Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KPopupMenu Class Reference

#include <kpopupmenu.h>

Inheritance diagram for KPopupMenu:
KPanelMenu

Signals

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

Public Member Functions

 KPopupMenu (TQWidget *parent=0, const char *name=0)
 
 ~KPopupMenu ()
 
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)
 
 KPopupMenu (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 KPopupMenu * 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.

KPopupMenu 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 mosfe.nosp@m.t@kd.nosp@m.e.org
Hamish Rodda rodda.nosp@m.@kde.nosp@m..org

Definition at line 123 of file kpopupmenu.h.

Constructor & Destructor Documentation

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

Constructs a KPopupMenu.

Definition at line 166 of file kpopupmenu.cpp.

KPopupMenu::~KPopupMenu ( )

Destructs the object.

Definition at line 174 of file kpopupmenu.cpp.

KPopupMenu::KPopupMenu ( 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 kpopupmenu.cpp.

Member Function Documentation

void KPopupMenu::aboutToShowContextMenu ( KPopupMenu *  menu,
int  menuItem,
TQPopupMenu *  ctxMenu 
)
signal

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

Parameters
menuThe menu that the context menu is about to be shown for
menuItemThe menu item that the context menu is currently on
ctxMenuThe context menu itself
Since
3.2
void KPopupMenu::activateItemAt ( int  index)
virtual

Reimplemented for internal purposes.

Since
3.4

Definition at line 279 of file kpopupmenu.cpp.

void KPopupMenu::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 kpopupmenu.cpp.

void KPopupMenu::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 kpopupmenu.cpp.

void KPopupMenu::closeEvent ( TQCloseEvent *  e)
protectedvirtual

This is re-implemented for keyboard navigation.

Definition at line 272 of file kpopupmenu.cpp.

TQPopupMenu * KPopupMenu::contextMenu ( )

Returns the context menu associated with this menu.

Since
3.2

Definition at line 516 of file kpopupmenu.cpp.

const TQPopupMenu * KPopupMenu::contextMenu ( ) const

Returns the context menu associated with this menu.

Since
3.2

Definition at line 527 of file kpopupmenu.cpp.

KPopupMenu * KPopupMenu::contextMenuFocus ( )
static

Returns the KPopupMenu associated with the current context menu.

Since
3.2

Definition at line 542 of file kpopupmenu.cpp.

int KPopupMenu::contextMenuFocusItem ( )
static

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

Since
3.2

Definition at line 537 of file kpopupmenu.cpp.

void KPopupMenu::hideContextMenu ( )

Hides the context menu if shown.

Since
3.2

Definition at line 532 of file kpopupmenu.cpp.

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

Inserts a title item with no icon.

Definition at line 185 of file kpopupmenu.cpp.

int KPopupMenu::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 kpopupmenu.cpp.

void KPopupMenu::mousePressEvent ( TQMouseEvent *  e)
protectedvirtual

End keyboard navigation.

RMB menus on menus

Definition at line 496 of file kpopupmenu.cpp.

void KPopupMenu::mouseReleaseEvent ( TQMouseEvent *  e)
protectedvirtual
Since
3.4

Definition at line 507 of file kpopupmenu.cpp.

void KPopupMenu::resetKeyboardVars ( bool  noMatches = false)
protectedslot
Since
3.1

Definition at line 464 of file kpopupmenu.cpp.

void KPopupMenu::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 kpopupmenu.cpp.

void KPopupMenu::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 kpopupmenu.cpp.

void KPopupMenu::setTitle ( const TQString &  title)
Deprecated:
Obsolete method provided for backwards compatibility only. Use insertTitle and changeTitle instead.

Definition at line 680 of file kpopupmenu.cpp.

TQt::ButtonState KPopupMenu::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 kpopupmenu.cpp.

TQString KPopupMenu::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 kpopupmenu.cpp.

TQPixmap KPopupMenu::titlePixmap ( int  id) const

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

Definition at line 254 of file kpopupmenu.cpp.

TQString KPopupMenu::underlineText ( const TQString &  text,
uint  length 
)
protectedslot
Since
3.1

Definition at line 454 of file kpopupmenu.cpp.


The documentation for this class was generated from the following files:
  • kpopupmenu.h
  • kpopupmenu.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.6
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |