kxmlguiclient.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2000 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 KXMLGUICLIENT_H
#define KXMLGUICLIENT_H

#include <kdeui_export.h>

#include <QtCore/QMap>
#include <QtCore/QStringList>

class QDomDocument;
class QDomElement;
class QWidget;

class QAction;
class KActionCollection;
class KComponentData;
class KXMLGUIClientPrivate;
class KXMLGUIFactory;
class KXMLGUIBuilder;

namespace KDEPrivate { class KEditToolBarWidget; }

class KDEUI_EXPORT KXMLGUIClient
{
    friend class KDEPrivate::KEditToolBarWidget; // for setXMLFile(3 args)
public:
  KXMLGUIClient();

  explicit KXMLGUIClient( KXMLGUIClient *parent );

  virtual ~KXMLGUIClient();

  QAction* action( const char* name ) const;

  virtual QAction *action( const QDomElement &element ) const;

  virtual KActionCollection* actionCollection() const;

  virtual KComponentData componentData() const;

  virtual QDomDocument domDocument() const;

  virtual QString xmlFile() const;

  virtual QString localXMLFile() const;

  void setXMLGUIBuildDocument( const QDomDocument &doc );
  QDomDocument xmlguiBuildDocument() const;

  void setFactory( KXMLGUIFactory *factory );
  KXMLGUIFactory *factory() const;

  KXMLGUIClient *parentClient() const;

  void insertChildClient( KXMLGUIClient *child );

  void removeChildClient( KXMLGUIClient *child );

  QList<KXMLGUIClient*> childClients();

  void setClientBuilder( KXMLGUIBuilder *builder );

  KXMLGUIBuilder *clientBuilder() const;

  void reloadXML();

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

  void unplugActionList( const QString &name );

  static QString findMostRecentXMLFile( const QStringList &files, QString &doc );

  void addStateActionEnabled(const QString& state, const QString& action);

  void addStateActionDisabled(const QString& state, const QString& action);

  enum ReverseStateChange { StateNoReverse, StateReverse };
  struct StateChange
  {
    QStringList actionsToEnable;
    QStringList actionsToDisable;
  };

  StateChange getActionsToChangeForState(const QString& state);

  void beginXMLPlug( QWidget * );
  void endXMLPlug();
  void prepareXMLUnplug( QWidget * );

  void replaceXMLFile( const QString& xmlfile, const QString& localxmlfile, bool merge = false );

protected:
  //bool addSuperClient( KXMLGUIClient * );

  virtual void setComponentData(const KComponentData &componentData);

  virtual void setXMLFile( const QString& file, bool merge = false, bool setXMLDoc = true );

    void loadStandardsXmlFile();

  virtual void setLocalXMLFile( const QString &file );

  virtual void setXML( const QString &document, bool merge = false );

  virtual void setDOMDocument( const QDomDocument &document, bool merge = false );

   virtual void stateChanged(const QString &newstate, ReverseStateChange reverse = StateNoReverse);

   // KDE5 TODO: virtual void loadActionLists() {}, called when the guiclient is added to the xmlgui factory

protected:
  virtual void virtual_hook( int id, void* data );

private:
  KXMLGUIClientPrivate * const d;
};

#endif