kxmlguiclient.h

/* 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 <tqdom.h>
#include <tqptrlist.h>
#include <tqmap.h>
#include <tqstringlist.h>
 
#include <tdelibs_export.h>
 
class TQWidget;
class TDEAction;
class TDEActionCollection;
class TDEInstance;
class KXMLGUIClientPrivate;
class KXMLGUIFactory;
class KXMLGUIBuilder;

class TDEUI_EXPORT KXMLGUIClient
{
    friend class KEditToolbarWidget; // for setXMLFile(3 args)
public:
  KXMLGUIClient();

  KXMLGUIClient( KXMLGUIClient *parent );

  virtual ~KXMLGUIClient();

  TDEAction* action( const char* name ) const;

  virtual TDEAction *action( const TQDomElement &element ) const;

  virtual TDEActionCollection* actionCollection() const;

  virtual TDEInstance *instance() const;

  virtual TQDomDocument domDocument() const;

  virtual TQString xmlFile() const;
 
  virtual TQString localXMLFile() const;

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

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

  KXMLGUIClient *parentClient() const;

  void insertChildClient( KXMLGUIClient *child );

  void removeChildClient( KXMLGUIClient *child );

  const TQPtrList<KXMLGUIClient> *childClients();

  void setClientBuilder( KXMLGUIBuilder *builder );

  KXMLGUIBuilder *clientBuilder() const;

  void reloadXML();

  void plugActionList( const TQString &name, const TQPtrList<TDEAction> &actionList );

  void unplugActionList( const TQString &name );
 
  static TQString findMostRecentXMLFile( const TQStringList &files, TQString &doc );
 
  void addStateActionEnabled(const TQString& state, const TQString& action);
 
  void addStateActionDisabled(const TQString& state, const TQString& action);
 
  enum ReverseStateChange { StateNoReverse, StateReverse };
  struct StateChange
  {
    TQStringList actionsToEnable;
    TQStringList actionsToDisable;
  };
 
  StateChange getActionsToChangeForState(const TQString& state);

  void beginXMLPlug( TQWidget * );
  void endXMLPlug();
  void prepareXMLUnplug( TQWidget * );
 
protected:
  //bool addSuperClient( KXMLGUIClient * );

  virtual void setInstance( TDEInstance *instance );

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

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

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

  virtual void conserveMemory();

   virtual void stateChanged(const TQString &newstate, ReverseStateChange reverse = StateNoReverse);
 
   // Use this one for KDE 4.0
   //virtual void stateChanged(const TQString &newstate, bool reverse = false);
 
private:
  struct DocStruct
  {
    TQString file;
    TQString data;
  };
 
  bool mergeXML( TQDomElement &base, const TQDomElement &additive,
                 TDEActionCollection *actionCollection );
 
  TQDomElement findMatchingElement( const TQDomElement &base,
                                   const TQDomElement &additive );
 
  typedef TQMap<TQString, TQMap<TQString, TQString> > ActionPropertiesMap;
 
  static ActionPropertiesMap extractActionProperties( const TQDomDocument &doc );
 
  static void storeActionProperties( TQDomDocument &doc, const ActionPropertiesMap &properties );
 
  static TQString findVersionNumber( const TQString &_xml );
 
  // Actions to enable/disable on a state change
  TQMap<TQString,StateChange> m_actionsStateMap;
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  KXMLGUIClientPrivate *d;
};
 
#endif