KDE3Support
K3PopupMenu Class Reference
#include <k3popupmenu.h>

Detailed Description
A menu with keyboard searching and convenience methods for title items.K3PopupMenu is a compatability class for KPopupMenu from KDE 3. It provides menus with standard title items and keyboard accessibility for popups with many options and/or varying options. It acts identically to QMenu, with the addition of insertTitle(), changeTitle(), setKeyboardShortcutsEnabled() and setKeyboardShortcutsExecute() methods.
The titles support a text string and an icon.
The keyboard search algorithm is incremental with additional underlining for user feedback.
Definition at line 49 of file k3popupmenu.h.
Signals | |
void | aboutToShowContextMenu (K3PopupMenu *menu, int menuItem, Q3PopupMenu *ctxMenu) |
void | aboutToShowContextMenu (K3PopupMenu *menu, QAction *menuAction, QMenu *ctxMenu) |
Public Member Functions | |
virtual void | activateItemAt (int index) |
QAction * | addTitle (const QIcon &icon, const QString &text, QAction *before=0L) |
QAction * | addTitle (const QString &text, QAction *before=0L) |
void | changeTitle (int id, const QPixmap &icon, const QString &text) |
void | changeTitle (int id, const QString &text) |
const Q3PopupMenu * | contextMenu () const |
Q3PopupMenu * | contextMenu () |
void | hideContextMenu () |
int | insertTitle (const QPixmap &icon, const QString &text, int id=-1, int index=-1) |
int | insertTitle (const QString &text, int id=-1, int index=-1) |
K3PopupMenu (const QString &title, QWidget *parent=0) | |
K3PopupMenu (QWidget *parent=0) | |
Qt::KeyboardModifiers | keyboardModifiers () const |
Qt::MouseButtons | mouseButtons () const |
void | setKeyboardShortcutsEnabled (bool enable) |
void | setKeyboardShortcutsExecute (bool enable) |
void | setTitle (const QString &title) |
Qt::ButtonState | state () const |
QString | title (int id=-1) const |
QPixmap | titlePixmap (int id) const |
~K3PopupMenu () | |
Static Public Member Functions | |
static int | actionId (QAction *action) |
static K3PopupMenu * | contextMenuFocus () |
static QAction * | contextMenuFocusAction () |
static int | contextMenuFocusItem () |
Protected Slots | |
void | actionHovered (QAction *action) |
void | ctxMenuHideShowingMenu () |
void | ctxMenuHiding () |
void | resetKeyboardVars (bool noMatches=false) |
void | showCtxMenu (const QPoint &pos) |
QString | underlineText (const QString &text, uint length) |
Protected Member Functions | |
virtual void | closeEvent (QCloseEvent *) |
virtual void | contextMenuEvent (QContextMenuEvent *e) |
virtual bool | focusNextPrevChild (bool next) |
virtual void | hideEvent (QHideEvent *) |
virtual void | keyPressEvent (QKeyEvent *e) |
virtual void | mousePressEvent (QMouseEvent *e) |
virtual void | mouseReleaseEvent (QMouseEvent *e) |
virtual void | virtual_hook (int id, void *data) |
Constructor & Destructor Documentation
K3PopupMenu::K3PopupMenu | ( | QWidget * | parent = 0 |
) |
K3PopupMenu::~K3PopupMenu | ( | ) |
- Deprecated:
- Obsolete method provided for backwards compatibility only. Use the normal constructor and insertTitle instead.
Definition at line 545 of file k3popupmenu.cpp.
Member Function Documentation
void K3PopupMenu::aboutToShowContextMenu | ( | K3PopupMenu * | menu, | |
int | menuItem, | |||
Q3PopupMenu * | ctxMenu | |||
) | [signal] |
compat
void K3PopupMenu::aboutToShowContextMenu | ( | K3PopupMenu * | menu, | |
QAction * | menuAction, | |||
QMenu * | 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 menuAction The action that the context menu is currently on ctxMenu The context menu itself
void K3PopupMenu::actionHovered | ( | QAction * | action | ) | [protected, slot] |
Definition at line 432 of file k3popupmenu.cpp.
static int K3PopupMenu::actionId | ( | QAction * | action | ) | [inline, static] |
Helper for porting things.
Returns ID of action, or -1 if passed null. ### KDE4: should be able to remove on Monday
Definition at line 194 of file k3popupmenu.h.
void K3PopupMenu::activateItemAt | ( | int | index | ) | [virtual] |
Changes the title and icon of the title item at the specified id.
Definition at line 591 of file k3popupmenu.cpp.
void K3PopupMenu::changeTitle | ( | int | id, | |
const QString & | text | |||
) |
Changes the title of the item at the specified id.
If a icon was previously set it is cleared.
Definition at line 580 of file k3popupmenu.cpp.
void K3PopupMenu::closeEvent | ( | QCloseEvent * | e | ) | [protected, virtual] |
const Q3PopupMenu * K3PopupMenu::contextMenu | ( | ) | const |
Q3PopupMenu * K3PopupMenu::contextMenu | ( | ) |
void K3PopupMenu::contextMenuEvent | ( | QContextMenuEvent * | e | ) | [protected, virtual] |
Definition at line 499 of file k3popupmenu.cpp.
K3PopupMenu * K3PopupMenu::contextMenuFocus | ( | ) | [static] |
Returns the K3PopupMenu associated with the current context menu.
Definition at line 427 of file k3popupmenu.cpp.
QAction * K3PopupMenu::contextMenuFocusAction | ( | ) | [static] |
returns the QAction associated with the current context menu
Definition at line 422 of file k3popupmenu.cpp.
int K3PopupMenu::contextMenuFocusItem | ( | ) | [static] |
returns the ID of the menuitem associated with the current context menu
Definition at line 625 of file k3popupmenu.cpp.
void K3PopupMenu::ctxMenuHideShowingMenu | ( | ) | [protected, slot] |
Definition at line 482 of file k3popupmenu.cpp.
void K3PopupMenu::ctxMenuHiding | ( | ) | [protected, slot] |
Definition at line 489 of file k3popupmenu.cpp.
Definition at line 328 of file k3popupmenu.cpp.
void K3PopupMenu::hideContextMenu | ( | ) |
void K3PopupMenu::hideEvent | ( | QHideEvent * | e | ) | [protected, virtual] |
Definition at line 519 of file k3popupmenu.cpp.
int K3PopupMenu::insertTitle | ( | const QString & | text, | |
int | id = -1 , |
|||
int | index = -1 | |||
) |
Qt::KeyboardModifiers K3PopupMenu::keyboardModifiers | ( | ) | const |
Return the state of the keyboard modifiers when the last menuitem was activated.
Definition at line 160 of file k3popupmenu.cpp.
void K3PopupMenu::keyPressEvent | ( | QKeyEvent * | e | ) | [protected, virtual] |
Definition at line 165 of file k3popupmenu.cpp.
Qt::MouseButtons K3PopupMenu::mouseButtons | ( | ) | const |
Return the state of the mouse buttons when the last menuitem was activated.
Definition at line 155 of file k3popupmenu.cpp.
void K3PopupMenu::mousePressEvent | ( | QMouseEvent * | e | ) | [protected, virtual] |
void K3PopupMenu::mouseReleaseEvent | ( | QMouseEvent * | e | ) | [protected, virtual] |
Definition at line 387 of file k3popupmenu.cpp.
void K3PopupMenu::resetKeyboardVars | ( | bool | noMatches = false |
) | [protected, slot] |
Definition at line 344 of file k3popupmenu.cpp.
void K3PopupMenu::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.
Definition at line 359 of file k3popupmenu.cpp.
void K3PopupMenu::setKeyboardShortcutsExecute | ( | bool | enable | ) |
Enables execution of the menu item once it is uniquely specified.
Defaults to off.
Definition at line 364 of file k3popupmenu.cpp.
void K3PopupMenu::setTitle | ( | const QString & | title | ) |
- Deprecated:
- Obsolete method provided for backwards compatibility only. Use insertTitle and changeTitle instead.
Definition at line 620 of file k3popupmenu.cpp.
void K3PopupMenu::showCtxMenu | ( | const QPoint & | pos | ) | [protected, slot] |
Definition at line 443 of file k3popupmenu.cpp.
Qt::ButtonState K3PopupMenu::state | ( | ) | const |
Return the state of the mouse button and keyboard modifiers when the last menuitem was activated.
Definition at line 149 of file k3popupmenu.cpp.
QString K3PopupMenu::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 602 of file k3popupmenu.cpp.
QPixmap K3PopupMenu::titlePixmap | ( | int | id | ) | const |
Returns the icon of the title item at the specified id.
Definition at line 611 of file k3popupmenu.cpp.
Definition at line 334 of file k3popupmenu.cpp.
void K3PopupMenu::virtual_hook | ( | int | id, | |
void * | data | |||
) | [protected, virtual] |
The documentation for this class was generated from the following files: