kxmlguifactory.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 1999 Simon Hausmann <hausmann@kde.org>
   Copyright (C) 2000 Kurt Granroth <granroth@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 kxmlguifactory_h
#define kxmlguifactory_h

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

#include <QtCore/QObject>

class QAction;
class KXMLGUIFactoryPrivate;
class KXMLGUIClient;
class KXMLGUIBuilder;
class KComponentData;

class QDomAttr;
class QDomDocument;
class QDomElement;
class QDomNode;
class QDomNamedNodeMap;

namespace KXMLGUI
{
struct MergingIndex;
struct ContainerNode;
struct ContainerClient;
class BuildHelper;
}

class KDEUI_EXPORT KXMLGUIFactory : public QObject
{
  friend class KXMLGUI::BuildHelper;
  Q_OBJECT
 public:
  explicit KXMLGUIFactory( KXMLGUIBuilder *builder, QObject *parent = 0 );

  ~KXMLGUIFactory();

  // XXX move to somewhere else? (Simon)
  static QString readConfigFile(const QString &filename,
          const KComponentData &componentData = KComponentData());
  static bool saveConfigFile(const QDomDocument& doc, const QString& filename,
          const KComponentData &componentData = KComponentData());

  static QDomElement actionPropertiesElement( QDomDocument& doc );

  static QDomElement findActionByName( QDomElement& elem, const QString& sName, bool create );

  void addClient( KXMLGUIClient *client );

  void removeClient( KXMLGUIClient *client );

  void plugActionList( KXMLGUIClient *client, const QString &name, const QList<QAction*> &actionList );
  void unplugActionList( KXMLGUIClient *client, const QString &name );

  QList<KXMLGUIClient*> clients() const;

  QWidget *container( const QString &containerName, KXMLGUIClient *client, bool useTagName = false );

  QList<QWidget*> containers( const QString &tagName );

  void reset();

  void resetContainer( const QString &containerName, bool useTagName = false );

  void refreshActionProperties();

 public Q_SLOTS:
  int configureShortcuts(bool bAllowLetterShortcuts = true, bool bSaveSettings = true);

  void changeShortcutScheme(const QString &scheme);

Q_SIGNALS:
  void clientAdded( KXMLGUIClient *client );
  void clientRemoved( KXMLGUIClient *client );

    void makingChanges(bool);

private:
    friend class KXMLGUIClient;
    void forgetClient(KXMLGUIClient *client);

    KXMLGUIFactoryPrivate *const d;
};

#endif
/* vim: et sw=4
 */