kdeui Library API Documentation

kactioncollection.h

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 
00010     This library is free software; you can redistribute it and/or
00011     modify it under the terms of the GNU Library General Public
00012     License version 2 as published by the Free Software Foundation.
00013 
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Library General Public License for more details.
00018 
00019     You should have received a copy of the GNU Library General Public License
00020     along with this library; see the file COPYING.LIB.  If not, write to
00021     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00022     Boston, MA 02111-1307, USA.
00023 */
00024 
00025 #ifndef __kactioncollection_h__
00026 #define __kactioncollection_h__
00027 
00028 #include <kaction.h>
00029 
00030 #include <qkeysequence.h>
00031 #include <qobject.h>
00032 #include <qvaluelist.h>
00033 #include <qguardedptr.h>
00034 #include <kguiitem.h>
00035 #include <kshortcut.h>
00036 #include <kstdaction.h>
00037 #include <kicontheme.h>
00038 
00039 class QMenuBar;
00040 class QPopupMenu;
00041 class QComboBox;
00042 class QPoint;
00043 class QIconSet;
00044 class QString;
00045 class KToolBar;
00046 
00047 class KAccel;
00048 class KAccelActions;
00049 class KConfig;
00050 class KConfigBase;
00051 class KURL;
00052 class KInstance;
00053 class KToolBar;
00054 class KActionCollection;
00055 class KPopupMenu;
00056 class KMainWindow;
00057 
00058 typedef QValueList<KAction *> KActionPtrList;
00059 
00077 class KDEUI_EXPORT KActionCollection : public QObject
00078 {
00079   friend class KAction;
00080   friend class KXMLGUIClient;
00081 
00082   Q_OBJECT
00083 
00084 public:
00085   KActionCollection( QWidget *parent, const char *name = 0, KInstance *instance = 0 );
00091   KActionCollection( QWidget *watch, QObject* parent, const char *name = 0, KInstance *instance = 0 );
00092   KActionCollection( const KActionCollection &copy );
00093   virtual ~KActionCollection();
00094 
00099   virtual void setWidget( QWidget *widget );
00100 
00108   void setAutoConnectShortcuts( bool );
00109 
00116   bool isAutoConnectShortcuts();
00117 
00124   //void setDefaultScope( KAction::Scope );
00125 
00130   bool addDocCollection( KActionCollection* pDoc );
00131 
00133   //uint widgetCount() const;
00134 
00140   //bool ownsKAccel() const;
00141 
00143   virtual KAccel* accel() KDE_DEPRECATED;
00145   virtual const KAccel* accel() const KDE_DEPRECATED;
00146 
00148   KAccel* kaccel();
00150   const KAccel* kaccel() const;
00151 
00153   KAccel* builderKAccel() const;
00155   //KAccel* widgetKAccel( uint i );
00156   //const KAccel* widgetKAccel( uint i ) const;
00157 
00159   virtual uint count() const;
00160   bool isEmpty() const { return (count() == 0); }
00165   virtual KAction* action( int index ) const;
00173   virtual KAction* action( const char* name, const char* classname = 0 ) const;
00174 
00179   virtual QStringList groups() const;
00184   virtual KActionPtrList actions( const QString& group ) const;
00186   virtual KActionPtrList actions() const;
00187 
00191   bool readShortcutSettings( const QString& sConfigGroup = QString::null, KConfigBase* pConfig = 0 );
00195   bool writeShortcutSettings( const QString& sConfigGroup = QString::null, KConfigBase* pConfig = 0 ) const;
00196 
00197   void setInstance( KInstance *instance );
00199   KInstance *instance() const;
00200 
00204   void setXMLFile( const QString& );
00208   const QString& xmlFile() const;
00209 
00210   //TODO FOR KDE4 make this default true
00222   void setHighlightingEnabled( bool enable );
00231   bool highlightingEnabled() const;
00232 
00246   void connectHighlight( QWidget *container, KAction *action );
00260   void disconnectHighlight( QWidget *container, KAction *action );
00261 
00265   const KXMLGUIClient *parentGUIClient() const;
00266 
00267 signals:
00268   void inserted( KAction* );
00269   void removed( KAction* );
00270 
00279   void actionHighlighted( KAction *action );
00288   void actionHighlighted( KAction *action, bool highlight );
00298   void actionStatusText( const QString &text );
00304   void clearStatusText();
00305 
00306 private:
00313   void beginXMLPlug( QWidget *widget );
00314   void endXMLPlug();
00316   void prepareXMLUnplug();
00317   void unplugShortcuts( KAccel* kaccel );
00318 
00319   void _clear();
00320   void _insert( KAction* );
00321   void _remove( KAction* );
00322   KAction* _take( KAction* );
00323 
00324 private slots:
00325    void slotMenuItemHighlighted( int id );
00326    void slotToolBarButtonHighlighted( int id, bool highlight );
00327    void slotMenuAboutToHide();
00328    void slotDestroyed();
00329 
00330 private:
00331    KAction *findAction( QWidget *container, int id );
00332 
00333 #ifndef KDE_NO_COMPAT
00334 public:
00335   KActionCollection( QObject *parent, const char *name = 0, KInstance *instance = 0 );
00336 #endif
00337 
00338 public:
00349   void insert( KAction* action);
00350 
00357   void remove( KAction* action );
00358 
00366   KAction* take( KAction* action );
00367 
00368 #ifndef KDE_NO_COMPAT
00369   KActionCollection operator+ ( const KActionCollection& ) const;
00370   KActionCollection& operator= ( const KActionCollection& );
00371   KActionCollection& operator+= ( const KActionCollection& );
00372 #endif // !KDE_NO_COMPAT
00373 
00374   // KDE4: clear() doesn't need to be a slot
00375 public slots:
00380   void clear();
00381 
00382 protected:
00383     virtual void virtual_hook( int id, void* data );
00384 private:
00385     KActionCollection( const char* name, const KXMLGUIClient* parent );
00386     class KActionCollectionPrivate;
00387     KActionCollectionPrivate *d;
00388 };
00389 
00390 #endif
KDE Logo
This file is part of the documentation for kdeui Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Jul 21 13:14:00 2006 by doxygen 1.4.0 written by Dimitri van Heesch, © 1997-2003