• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

kaction.h

Go to the documentation of this file.
00001 /* This file is part of the KDE libraries
00002     Copyright (C) 1999 Reginald Stadlbauer <reggie@kde.org>
00003               (C) 1999 Simon Hausmann <hausmann@kde.org>
00004               (C) 2000 Nicolas Hadacek <haadcek@kde.org>
00005               (C) 2000 Kurt Granroth <granroth@kde.org>
00006               (C) 2000 Michael Koch <koch@kde.org>
00007               (C) 2001 Holger Freyther <freyther@kde.org>
00008               (C) 2002 Ellis Whitehead <ellis@kde.org>
00009               (C) 2005-2006 Hamish Rodda <rodda@kde.org>
00010 
00011     This library is free software; you can redistribute it and/or
00012     modify it under the terms of the GNU Library General Public
00013     License version 2 as published by the Free Software Foundation.
00014 
00015     This library is distributed in the hope that it will be useful,
00016     but WITHOUT ANY WARRANTY; without even the implied warranty of
00017     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018     Library General Public License for more details.
00019 
00020     You should have received a copy of the GNU Library General Public License
00021     along with this library; see the file COPYING.LIB.  If not, write to
00022     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00023     Boston, MA 02110-1301, USA.
00024 */
00025 
00026 #ifndef KACTION_H
00027 #define KACTION_H
00028 
00029 #include <kdeui_export.h>
00030 #include <kguiitem.h>
00031 #include <kshortcut.h>
00032 
00033 #include <QtGui/QWidgetAction>
00034 
00035 class KIcon;
00036 class KShapeGesture;
00037 class KRockerGesture;
00038 
00039 //TODO Reduce the word count. This is not very focused and takes too long to read.
00040 //Keep in mind that QAction also has documentation that we don't need to repeat here.
00207 class KDEUI_EXPORT KAction : public QWidgetAction
00208 {
00209   Q_OBJECT
00210 
00211   Q_PROPERTY( KShortcut shortcut READ shortcut WRITE setShortcut )
00212   Q_PROPERTY( bool shortcutConfigurable READ isShortcutConfigurable WRITE setShortcutConfigurable )
00213   Q_PROPERTY( KShortcut globalShortcut READ globalShortcut WRITE setGlobalShortcut )
00214   Q_PROPERTY( bool globalShortcutAllowed READ globalShortcutAllowed WRITE setGlobalShortcutAllowed )
00215   Q_PROPERTY( bool globalShortcutEnabled READ isGlobalShortcutEnabled )
00216   Q_FLAGS( ShortcutType )
00217 
00218 public:
00222     enum ShortcutType {
00224       ActiveShortcut = 0x1,
00227       DefaultShortcut = 0x2
00228     };
00229     Q_DECLARE_FLAGS(ShortcutTypes, ShortcutType)
00230 
00231     
00234     //This enum will be ORed with ShortcutType in calls to KGlobalAccel, so it must not contain
00235     //any value equal to a value in ShortcutType.
00236     enum GlobalShortcutLoading {
00240       Autoloading = 0x0,
00242       NoAutoloading = 0x4
00243     };
00247     explicit KAction(QObject *parent);
00248 
00255     KAction(const QString& text, QObject *parent);
00256 
00268     KAction(const KIcon& icon, const QString& text, QObject *parent);
00269 
00273     virtual ~KAction();
00274 
00286     KShortcut shortcut(ShortcutTypes types = ActiveShortcut) const;
00287 
00298     void setShortcut(const KShortcut& shortcut, ShortcutTypes type = ShortcutTypes(ActiveShortcut | DefaultShortcut));
00299 
00312     void setShortcut(const QKeySequence& shortcut, ShortcutTypes type = ShortcutTypes(ActiveShortcut | DefaultShortcut));
00313 
00326     void setShortcuts(const QList<QKeySequence>& shortcuts, ShortcutTypes type = ShortcutTypes(ActiveShortcut | DefaultShortcut));
00327 
00331     bool isShortcutConfigurable() const;
00332 
00338     void setShortcutConfigurable(bool configurable);
00339 
00353     const KShortcut& globalShortcut(ShortcutTypes type = ActiveShortcut) const;
00354 
00391     void setGlobalShortcut(const KShortcut& shortcut, ShortcutTypes type =
00392                            ShortcutTypes(ActiveShortcut | DefaultShortcut),
00393                            GlobalShortcutLoading loading = Autoloading);
00394 
00400     KDE_DEPRECATED bool globalShortcutAllowed() const;
00401 
00410     KDE_DEPRECATED void setGlobalShortcutAllowed(bool allowed, GlobalShortcutLoading loading = Autoloading);
00411 
00417     bool isGlobalShortcutEnabled() const;
00418 
00428     void forgetGlobalShortcut();
00429 
00430     KShapeGesture shapeGesture(ShortcutTypes type = ActiveShortcut) const;
00431     KRockerGesture rockerGesture(ShortcutTypes type = ActiveShortcut) const;
00432 
00433     void setShapeGesture(const KShapeGesture& gest, ShortcutTypes type = ShortcutTypes(ActiveShortcut | DefaultShortcut));
00434     void setRockerGesture(const KRockerGesture& gest, ShortcutTypes type = ShortcutTypes(ActiveShortcut | DefaultShortcut));
00435 
00436 Q_SIGNALS:
00437 #ifdef KDE3_SUPPORT
00438 
00443     QT_MOC_COMPAT void activated();
00444 #endif
00445 
00450     void triggered(Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers);
00451 
00452 private:
00453     friend class KGlobalAccelPrivate;
00454     friend class KActionCollectionPrivate;
00455     Q_PRIVATE_SLOT(d, void slotTriggered())
00456     class KActionPrivate* const d;
00457     friend class KActionPrivate;
00458     friend class KGlobalShortcutTest;
00459 };
00460 
00461 Q_DECLARE_OPERATORS_FOR_FLAGS(KAction::ShortcutTypes)
00462 
00463 #endif

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal