diff options
author | Timothy Pearson <[email protected]> | 2011-11-06 15:56:40 -0600 |
---|---|---|
committer | Timothy Pearson <[email protected]> | 2011-11-06 15:56:40 -0600 |
commit | e16866e072f94410321d70daedbcb855ea878cac (patch) | |
tree | ee3f52eabde7da1a0e6ca845fb9c2813cf1558cf /tdeui/kcmenumngr.h | |
parent | a58c20c1a7593631a1b50213c805507ebc16adaf (diff) | |
download | tdelibs-e16866e072f94410321d70daedbcb855ea878cac.tar.gz tdelibs-e16866e072f94410321d70daedbcb855ea878cac.zip |
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'tdeui/kcmenumngr.h')
-rw-r--r-- | tdeui/kcmenumngr.h | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/tdeui/kcmenumngr.h b/tdeui/kcmenumngr.h new file mode 100644 index 000000000..ce05f6b9d --- /dev/null +++ b/tdeui/kcmenumngr.h @@ -0,0 +1,116 @@ +/* This file is part of the KDE libraries + Copyright (C) 1999 Matthias Ettrich ([email protected]) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + 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., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef KCMENUMNGR_H +#define KCMENUMNGR_H + +// #include <tqt.h> + +#include <tqobject.h> +#include <tqptrdict.h> +#include <tqkeysequence.h> + +#include <kdelibs_export.h> + +class TQWidget; +class TQPopupMenu; +class KContextMenuManagerPrivate; + +/** +@short Convenience class to mangage context menus +@author Matthias Ettrich <[email protected]> + +KContextMenuManager manages configurable context popup menus. Instead +of reimplementing TQWidget::mousePressEvent() or + TQWidget::mouseReleaseEvent() and/or TQWidget::keyPressEvent(), simply +create the popup menu and insert it into the context menu manager with +the static function insert(). + +Example: +\code + KContextMenuManager::insert( myWidget, myPopupMenu ); +\endcode + + +Context menus are invoked with either a special shortcut key (usually +the menu key) or the right mouse button. + +Menus are configurable in the [ContextMenus] group of the application's +configuration file, usually in kdeglobals: +\code + [ContextMenus] + ShowOnPress=true|false +\endcode + +@p ShowOnPress defines whether the menu shall be shown on mouse +press or on mouse release. + +The shortcut key to invoke the context menu is defined in the standard +[Keys] section of the application configuration: +\code + [Keys] + ... + PopupContextMenu=Menu + ... +\endcode +The key can be configured with the standard keys module in the KDE control center. + +If the popup menu is invoked with the keyboard shortcut, it's shown at +the position of the micro focus hint of the widget ( TQWidget::microFocusHint() ). +*/ + +class KDEUI_EXPORT KContextMenuManager : public TQObject +{ + Q_OBJECT +public: + + /** + Makes @p popup a context popup menu for widget @p widget. + + Ownership of the popup menu is not transferred to the context + menu manager. + */ + static void insert( TQWidget* widget, TQPopupMenu* popup ); + + /** + * Use this method to get information about when a popup menu + * should be activated. This can be useful if the popup menu is + * to be activated from a listview. + * + * @return true if the menu should be made visible on a button press + * or false after a button press-release sequence. + */ + static bool showOnButtonPress( void ); + +private slots: + void widgetDestroyed(); +private: + KContextMenuManager( TQObject* parent = 0, const char* name = 0); + ~KContextMenuManager(); + bool eventFilter( TQObject *, TQEvent * ); + TQPtrDict<TQPopupMenu> menus; + bool showOnPress; + TQKeySequence menuKey; + static KContextMenuManager* manager; + friend class I_really_like_this_class; // avoid warning + + KContextMenuManagerPrivate *d; +}; + +#endif |