//FIXME what is ODE? ODE Desktop Environemt? -zecke //FIXME do we need titles? space is limited that is only eyecandy? -zecke //FIXME keyboard navigation is also not that popular on a PDA might be with a keyboard (tuxphone) -zecke /* This file is part of the ODE libraries Copyright (C) 2000 Daniel M. Duley <mosfet@kde.org> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License version 2 as published by the Free Software Foundation. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef _OPOPUP_H #define _OPOPUP_H #define INCLUDE_MENUITEM_DEF /* QT */ #include <qpopupmenu.h> /* OPIE */ #include <opie2/opixmapeffect.h> /** * Title widget for use in @ref OPopupMenu. * * You usually don't have to create this manually since * @ref OPopupMenu::insertTitle will do it for you, but it is allowed if * you wish to customize it's look. * * @author Daniel M. Duley <mosfet@kde.org> * @short OPopupMenu title widget. */ class OPopupTitle : public QWidget { Q_OBJECT public: /** * Constructs a title widget with the user specified gradient, pixmap, * and colors. */ OPopupTitle(QWidget *parent=0, const char *name=0); /** * @deprecated * Constructs a title widget with the specified gradient and colors. */ OPopupTitle(OPixmapEffect::GradientType gradient, const QColor &color, const QColor &textColor, QWidget *parent=0, const char *name=0); /** * @deprecated * Constructs a title widget with the specified pixmap and colors. */ OPopupTitle(const OPixmap &background, const QColor &color, const QColor &textColor, QWidget *parent=0, const char *name=0); /** * Sets the title string and optional icon for the title widget. * * You will want to call this before inserting into a menu. */ void setTitle(const QString &text, const QPixmap *icon=NULL); /** * Returns the current title. */ QString title() const { return(titleStr); } /** * Returns the current icon. */ QPixmap icon() const { return(miniicon); } QSize sizeHint() const; public slots: /// @since 3.1 void setText( const QString &text ); /// @since 3.1 void setIcon( const QPixmap &pix ); protected: void paintEvent(QPaintEvent *ev); QString titleStr; QPixmap miniicon; // Remove in KDE4 OPixmapEffect::GradientType grType; QPixmap fill; QColor fgColor, bgColor, grHigh, grLow; bool useGradient; protected: virtual void virtual_hook( int id, void* data ); private: class OPopupTitlePrivate; OPopupTitlePrivate *d; }; /** * OPopupMenu 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 QPopupMenu, 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. * * @short A menu with title items. * @author Daniel M. Duley <mosfet@kde.org> * @author Hamish Rodda <meddie@yoyo.its.monash.edu.au> */ class OPopupMenu : public QPopupMenu { Q_OBJECT public: /** * Constructs a OPopupMenu. */ OPopupMenu(QWidget *parent=0, const char *name=0); /** * Destructs the object */ ~OPopupMenu(); /** * Inserts a title item with no icon. */ int insertTitle(const QString &text, int id=-1, int index=-1); /** * Inserts a title item with the given icon and title. */ int insertTitle(const QPixmap &icon, const QString &text, int id=-1, int index=-1); /** * Changes the title of the item at the specified id. If a icon was * previously set it is cleared. */ void changeTitle(int id, const QString &text); /** * Changes the title and icon of the title item at the specified id. */ void changeTitle(int id, const QPixmap &icon, const QString &text); /** * 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. */ QString title(int id=-1) const; /** * Returns the icon of the title item at the specified id. */ QPixmap titlePixmap(int id) const; /** * 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 */ void setKeyboardShortcutsEnabled(bool enable); /** * Enables execution of the menu item once it is uniquely specified. * Defaults to off. * @since 3.1 */ void setKeyboardShortcutsExecute(bool enable); /** * Obsolete method provided for backwards compatibility only. Use the * normal constructor and insertTitle instead. */ OPopupMenu(const QString &title, QWidget *parent=0, const char *name=0); /** * Obsolete method provided for backwards compatibility only. Use * insertTitle and changeTitle instead. */ void setTitle(const QString &title); /** * Returns the context menu associated with this menu * @since 3.2 */ QPopupMenu* contextMenu(); /** * Hides the context menu if shown * @since 3.2 */ void cancelContextMenuShow(); /** * Returns the OPopupMenu associated with the current context menu * @since 3.2 */ static OPopupMenu* contextMenuFocus(); /** * returns the ID of the menuitem associated with the current context menu * @since 3.2 */ static int contextMenuFocusItem(); signals: /** * connect to this signal to be notified when a context menu is about to be shown * @param menu The menu that the context menu is about to be shown for * @param menuItem The menu item that the context menu is currently on * @param ctxMenu The context menu itself * @since 3.2 */ void aboutToShowContextMenu(OPopupMenu* menu, int menuItem, QPopupMenu* ctxMenu); protected: virtual void closeEvent(QCloseEvent *); virtual void keyPressEvent(QKeyEvent* e); virtual bool eventFilter(QObject* obj, QEvent* event); virtual void hideEvent(QHideEvent*); virtual void virtual_hook( int id, void* data ); protected slots: /// @since 3.1 QString underlineText(const QString& text, uint length); /// @since 3.1 void resetKeyboardVars(bool noMatches = false); void itemHighlighted(int whichItem); void showCtxMenu(QPoint pos); void ctxMenuHiding(); private: class OPopupMenuPrivate; OPopupMenuPrivate *d; }; #endif