kxmlguifactory.h

/* 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 <tqobject.h>
#include <tqptrlist.h>
#include <tqdom.h>
#include <tqvaluelist.h>
 
#include <tdelibs_export.h>
 
class TDEAction;
class KXMLGUIFactoryPrivate;
class KXMLGUIClient;
class KXMLGUIBuilder;
class TDEInstance;
 
namespace KXMLGUI
{
struct MergingIndex;
struct ContainerNode;
struct ContainerClient;
class BuildHelper;
}

class TDEUI_EXPORT KXMLGUIFactory : public TQObject
{
  friend class KXMLGUI::BuildHelper;
  TQ_OBJECT
 public:
  KXMLGUIFactory( KXMLGUIBuilder *builder, TQObject *parent = 0, const char *name = 0 );

  ~KXMLGUIFactory();
 
  // XXX move to somewhere else? (Simon)
  static TQString readConfigFile( const TQString &filename, bool never_null, const TDEInstance *instance = 0 );
  static TQString readConfigFile( const TQString &filename, const TDEInstance *instance = 0 );
  static bool saveConfigFile( const TQDomDocument& doc, const TQString& filename,
                              const TDEInstance *instance = 0 );
 
  static TQString documentToXML( const TQDomDocument& doc );
  static TQString elementToXML( const TQDomElement& elem );

  static void removeDOMComments( TQDomNode &node );

  static TQDomElement actionPropertiesElement( TQDomDocument& doc );

  static TQDomElement findActionByName( TQDomElement& elem, const TQString& sName, bool create );

  void addClient( KXMLGUIClient *client );

  void removeClient( KXMLGUIClient *client );
 
  void plugActionList( KXMLGUIClient *client, const TQString &name, const TQPtrList<TDEAction> &actionList );
  void unplugActionList( KXMLGUIClient *client, const TQString &name );

  TQPtrList<KXMLGUIClient> clients() const;

  TQWidget *container( const TQString &containerName, KXMLGUIClient *client, bool useTagName = false );
 
  TQPtrList<TQWidget> containers( const TQString &tagName );

  void reset();

  void resetContainer( const TQString &containerName, bool useTagName = false );
 
 public slots:
  int configureShortcuts(bool bAllowLetterShortcuts = true, bool bSaveSettings = true);
 
 signals:
  void clientAdded( KXMLGUIClient *client );
  void clientRemoved( KXMLGUIClient *client );
 
 private:
 
  TQWidget *findRecursive( KXMLGUI::ContainerNode *node, bool tag );
 
  TQPtrList<TQWidget> findRecursive( KXMLGUI::ContainerNode *node, const TQString &tagName );
 
  void applyActionProperties( const TQDomElement &element );
  void configureAction( TDEAction *action, const TQDomNamedNodeMap &attributes );
  void configureAction( TDEAction *action, const TQDomAttr &attribute );
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  KXMLGUIFactoryPrivate *d;
};
 
#endif