kactioncollection.h

Go to the documentation of this file.

/* 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>
              (C) 2005-2006 Hamish Rodda <rodda@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 KACTIONCOLLECTION_H
#define KACTIONCOLLECTION_H

#include <kdeui_export.h>
#include <kstandardaction.h>
#include <kcomponentdata.h>

#include <QtCore/QObject>

class QAction;
class KXMLGUIClient;

class QActionGroup;
class QString;

class KDEUI_EXPORT KActionCollection : public QObject
{
  friend class KXMLGUIClient;

  Q_OBJECT

  Q_PROPERTY( QString configGroup READ configGroup WRITE setConfigGroup )
  Q_PROPERTY( bool configIsGlobal READ configIsGlobal WRITE setConfigGlobal )

public:
  explicit KActionCollection(QObject *parent, const KComponentData &cData = KComponentData());

  virtual ~KActionCollection();

  static const QList<KActionCollection*>& allCollections();

  void clear();

  void associateWidget(QWidget* widget) const;

  void addAssociatedWidget(QWidget* widget);

  void removeAssociatedWidget(QWidget* widget);

  QList<QWidget*> associatedWidgets() const;

  void clearAssociatedWidgets();

  QString configGroup() const;

  bool configIsGlobal() const;

  void setConfigGroup( const QString& group );

  void setConfigGlobal( bool global );

  void readSettings( KConfigGroup* config = 0 );

  void importGlobalShortcuts( KConfigGroup* config );

  void exportGlobalShortcuts( KConfigGroup* config, bool writeDefaults = false ) const;

  void writeSettings( KConfigGroup* config = 0, bool writeDefaults = false, QAction* oneAction = 0 ) const;

  int count() const;

  bool isEmpty() const;

  QAction *action(int index) const;

  QAction* action( const QString& name ) const;

  QList<QAction*> actions() const;

  const QList<QAction*> actionsWithoutGroup() const;

  const QList<QActionGroup*> actionGroups() const;

  void setComponentData(const KComponentData &componentData);

  KComponentData componentData() const;

  const KXMLGUIClient *parentGUIClient() const;

Q_SIGNALS:
  void inserted( QAction* action );

  QT_MOC_COMPAT void removed( QAction* action );

  QT_MOC_COMPAT void actionHighlighted(QAction* action);
  
  void actionHovered(QAction* action);

  void actionTriggered(QAction* action);

protected Q_SLOTS:
  virtual void connectNotify ( const char * signal );

  virtual void slotActionTriggered();
  
  QT_MOC_COMPAT virtual void slotActionHighlighted();

private Q_SLOTS:
  void slotActionHovered();
  

public:
  QAction *addAction(const QString &name, QAction *action);
  KAction *addAction(const QString &name, KAction *action);

  void removeAction(QAction *action);

  QAction* takeAction(QAction *action);

  KAction *addAction(KStandardAction::StandardAction actionType, const QObject *receiver = 0, const char *member = 0);

  KAction *addAction(KStandardAction::StandardAction actionType, const QString &name,
                     const QObject *receiver = 0, const char *member = 0);

  KAction *addAction(const QString &name, const QObject *receiver = 0, const char *member = 0);

  template<class ActionType>
  ActionType *add(const QString &name, const QObject *receiver = 0, const char *member = 0)
  {
      ActionType *a = new ActionType(this);
      if (receiver && member)
          connect(a, SIGNAL(triggered(bool)), receiver, member);
      addAction(name, a);
      return a;
  }

private:
  Q_PRIVATE_SLOT(d, void _k_actionDestroyed(QObject *))
  Q_PRIVATE_SLOT(d, void _k_associatedWidgetDestroyed(QObject*))

  KActionCollection( const KXMLGUIClient* parent ); // used by KXMLGUIClient

  friend class KActionCollectionPrivate;
  class KActionCollectionPrivate* const d;
};

#endif