tdeactioncollection.h

/* This file is part of the KDE libraries
    Copyright (C) 1999 Reginald Stadlbauer <reggie@kde.org>
              (C) 1999 Simon Hausmann <hausmann@kde.org>
              (C) 2000 Nicolas Hadacek <haadcek@kde.org>
              (C) 2000 Kurt Granroth <granroth@kde.org>
              (C) 2000 Michael Koch <koch@kde.org>
              (C) 2001 Holger Freyther <freyther@kde.org>
              (C) 2002 Ellis Whitehead <ellis@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., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef __tdeactioncollection_h__
#define __tdeactioncollection_h__
 
#include <tdeaction.h>
 
#include <tqkeysequence.h>
#include <tqobject.h>
#include <tqvaluelist.h>
#include <tqguardedptr.h>
#include <kguiitem.h>
#include <tdeshortcut.h>
#include <kstdaction.h>
#include <kicontheme.h>
 
class TQMenuBar;
class TQPopupMenu;
class TQComboBox;
class TQPoint;
class TQIconSet;
class TQString;
class TDEToolBar;
 
class TDEAccel;
class TDEAccelActions;
class TDEConfig;
class TDEConfigBase;
class KURL;
class TDEInstance;
class TDEToolBar;
class TDEActionCollection;
class TDEPopupMenu;
class TDEMainWindow;
class KXMLGUIClient;
 
typedef TQValueList<TDEAction *> TDEActionPtrList;

class TDEUI_EXPORT TDEActionCollection : public TQObject
{
  friend class TDEAction;
  friend class KXMLGUIClient;
 
  TQ_OBJECT
 
public:
  TDEActionCollection( TQWidget *parent, const char *name = 0, TDEInstance *instance = 0 );
  TDEActionCollection( TQWidget *watch, TQObject* parent, const char *name = 0, TDEInstance *instance = 0 );
#ifndef KDE_NO_COMPAT
  TDEActionCollection( const TDEActionCollection &copy );
#endif
  virtual ~TDEActionCollection();

  virtual void setWidget( TQWidget *widget );

  void setAutoConnectShortcuts( bool );

  bool isAutoConnectShortcuts();

  //void setDefaultScope( TDEAction::Scope );

  bool addDocCollection( TDEActionCollection* pDoc );

  //uint widgetCount() const;

  //bool ownsTDEAccel() const;

  virtual TDEAccel* accel() TDE_DEPRECATED;
  virtual const TDEAccel* accel() const TDE_DEPRECATED;

  TDEAccel* tdeaccel();
  const TDEAccel* tdeaccel() const;

  TDEAccel* builderTDEAccel() const;
  //TDEAccel* widgetTDEAccel( uint i );
  //const TDEAccel* widgetTDEAccel( uint i ) const;

  virtual uint count() const;
  bool isEmpty() const { return (count() == 0); }
  virtual TDEAction* action( int index ) const;
  virtual TDEAction* action( const char* name, const char* classname = 0 ) const;

  virtual TQStringList groups() const;
  virtual TDEActionPtrList actions( const TQString& group ) const;
  virtual TDEActionPtrList actions() const;

  bool readShortcutSettings( const TQString& sConfigGroup = TQString::null, TDEConfigBase* pConfig = 0 );
  bool writeShortcutSettings( const TQString& sConfigGroup = TQString::null, TDEConfigBase* pConfig = 0 ) const;
 
  void setInstance( TDEInstance *instance );
  TDEInstance *instance() const;

  void setXMLFile( const TQString& );
  const TQString& xmlFile() const;
 
  //TODO FOR KDE4 make this default true
  void setHighlightingEnabled( bool enable );
  bool highlightingEnabled() const;

  void connectHighlight( TQWidget *container, TDEAction *action );
  void disconnectHighlight( TQWidget *container, TDEAction *action );

  const KXMLGUIClient *parentGUIClient() const;
 
signals:
  void inserted( TDEAction* );
  void removed( TDEAction* );

  void actionHighlighted( TDEAction *action );
  void actionHighlighted( TDEAction *action, bool highlight );
  void actionStatusText( const TQString &text );
  void clearStatusText();
 
private:
  void beginXMLPlug( TQWidget *widget );
  void endXMLPlug();
  void prepareXMLUnplug();
  void unplugShortcuts( TDEAccel* tdeaccel );
 
  void _clear();
  void _insert( TDEAction* );
  void _remove( TDEAction* );
  TDEAction* _take( TDEAction* );
 
private slots:
   void slotMenuItemHighlighted( int id );
   void slotToolBarButtonHighlighted( int id, bool highlight );
   void slotMenuAboutToHide();
   void slotDestroyed();
 
private:
   TDEAction *findAction( TQWidget *container, int id );
 
#ifndef KDE_NO_COMPAT
public:
  TDEActionCollection( TQObject *parent, const char *name = 0, TDEInstance *instance = 0 );
#endif
 
public:
  void insert( TDEAction* action);

  void remove( TDEAction* action );

  TDEAction* take( TDEAction* action );
 
#ifndef KDE_NO_COMPAT
  TDEActionCollection operator+ ( const TDEActionCollection& ) const;
  TDEActionCollection& operator= ( const TDEActionCollection& );
  TDEActionCollection& operator+= ( const TDEActionCollection& );
#endif // !KDE_NO_COMPAT
 
  // KDE4: clear() doesn't need to be a slot
public slots:
  void clear();
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    TDEActionCollection( const char* name, const KXMLGUIClient* parent );
    class TDEActionCollectionPrivate;
    TDEActionCollectionPrivate *d;
};
 
#endif