summaryrefslogtreecommitdiffstats
path: root/tdeui/kxmlguifactory.h
diff options
context:
space:
mode:
Diffstat (limited to 'tdeui/kxmlguifactory.h')
-rw-r--r--tdeui/kxmlguifactory.h220
1 files changed, 220 insertions, 0 deletions
diff --git a/tdeui/kxmlguifactory.h b/tdeui/kxmlguifactory.h
new file mode 100644
index 000000000..59b75c14b
--- /dev/null
+++ b/tdeui/kxmlguifactory.h
@@ -0,0 +1,220 @@
+// -*- mode: c++; c-basic-offset: 2 -*-
+/* 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 <kdelibs_export.h>
+
+class KAction;
+class KXMLGUIFactoryPrivate;
+class KXMLGUIClient;
+class KXMLGUIBuilder;
+class KInstance;
+
+namespace KXMLGUI
+{
+struct MergingIndex;
+struct ContainerNode;
+struct ContainerClient;
+class BuildHelper;
+}
+
+/**
+ * KXMLGUIFactory, together with KXMLGUIClient objects, can be used to create
+ * a GUI of container widgets (like menus, toolbars, etc.) and container items
+ * (menu items, toolbar buttons, etc.) from an XML document and action objects.
+ *
+ * Each KXMLGUIClient represents a part of the GUI, composed from containers and
+ * actions. KXMLGUIFactory takes care of building (with the help of a KXMLGUIBuilder)
+ * and merging the GUI from an unlimited number of clients.
+ *
+ * Each client provides XML through a TQDomDocument and actions through a
+ * KActionCollection . The XML document contains the rules for how to merge the
+ * GUI.
+ *
+ * KXMLGUIFactory processes the DOM tree provided by a client and plugs in the client's actions,
+ * according to the XML and the merging rules of previously inserted clients. Container widgets
+ * are built via a KXMLGUIBuilder , which has to be provided with the KXMLGUIFactory constructor.
+ */
+class KDEUI_EXPORT KXMLGUIFactory : public TQObject
+{
+ friend class KXMLGUI::BuildHelper;
+ Q_OBJECT
+ public:
+ /**
+ * Constructs a KXMLGUIFactory. The provided @p builder KXMLGUIBuilder will be called
+ * for creating and removing container widgets, when clients are added/removed from the GUI.
+ *
+ * Note that the ownership of the given KXMLGUIBuilder object won't be transferred to this
+ * KXMLGUIFactory, so you have to take care of deleting it properly.
+ */
+ KXMLGUIFactory( KXMLGUIBuilder *builder, TQObject *parent = 0, const char *name = 0 );
+
+ /**
+ * Destructor
+ */
+ ~KXMLGUIFactory();
+
+ // XXX move to somewhere else? (Simon)
+ static TQString readConfigFile( const TQString &filename, bool never_null, const KInstance *instance = 0 );
+ static TQString readConfigFile( const TQString &filename, const KInstance *instance = 0 );
+ static bool saveConfigFile( const TQDomDocument& doc, const TQString& filename,
+ const KInstance *instance = 0 );
+
+ static TQString documentToXML( const TQDomDocument& doc );
+ static TQString elementToXML( const TQDomElement& elem );
+
+ /**
+ * Removes all TQDomComment objects from the specified node and all its children.
+ */
+ static void removeDOMComments( TQDomNode &node );
+
+ /**
+ * @internal
+ * Find or create the ActionProperties element, used when saving custom action properties
+ */
+ static TQDomElement actionPropertiesElement( TQDomDocument& doc );
+
+ /**
+ * @internal
+ * Find or create the element for a given action, by name.
+ * Used when saving custom action properties
+ */
+ static TQDomElement findActionByName( TQDomElement& elem, const TQString& sName, bool create );
+
+ /**
+ * Creates the GUI described by the TQDomDocument of the client,
+ * using the client's actions, and merges it with the previously
+ * created GUI.
+ * This also means that the order in which clients are added to the factory
+ * is relevant; assuming that your application supports plugins, you should
+ * first add your application to the factory and then the plugin, so that the
+ * plugin's UI is merged into the UI of your application, and not the other
+ * way round.
+ */
+ void addClient( KXMLGUIClient *client );
+
+ /**
+ * Removes the GUI described by the client, by unplugging all
+ * provided actions and removing all owned containers (and storing
+ * container state information in the given client)
+ */
+ void removeClient( KXMLGUIClient *client );
+
+ void plugActionList( KXMLGUIClient *client, const TQString &name, const TQPtrList<KAction> &actionList );
+ void unplugActionList( KXMLGUIClient *client, const TQString &name );
+
+ /**
+ * Returns a list of all clients currently added to this factory
+ */
+ TQPtrList<KXMLGUIClient> clients() const;
+
+ /**
+ * Use this method to get access to a container widget with the name specified with @p containerName
+ * and which is owned by the @p client. The container name is specified with a "name" attribute in the
+ * XML document.
+ *
+ * This function is particularly useful for getting hold of a popupmenu defined in an XMLUI file.
+ * For instance:
+ * \code
+ * TQPopupMenu *popup = static_cast<TQPopupMenu*>(factory()->container("my_popup",this));
+ * \endcode
+ * where @p "my_popup" is the name of the menu in the XMLUI file, and
+ * @p "this" is XMLGUIClient which owns the popupmenu (e.g. the mainwindow, or the part, or the plugin...)
+ *
+ * @param containerName Name of the container widget
+ * @param client Owner of the container widget
+ * @param useTagName Specifies whether to compare the specified name with the name attribute or
+ * the tag name.
+ *
+ * This method may return 0L if no container with the given name exists or is not owned by the client.
+ */
+ TQWidget *container( const TQString &containerName, KXMLGUIClient *client, bool useTagName = false );
+
+ TQPtrList<TQWidget> containers( const TQString &tagName );
+
+ /**
+ * Use this method to free all memory allocated by the KXMLGUIFactory. This deletes the internal node
+ * tree and therefore resets the internal state of the class. Please note that the actual GUI is
+ * NOT touched at all, meaning no containers are deleted nor any actions unplugged. That is
+ * something you have to do on your own. So use this method only if you know what you are doing :-)
+ *
+ * (also note that this will call KXMLGUIClient::setFactory( 0L ) for all inserted clients)
+ */
+ void reset();
+
+ /**
+ * Use this method to free all memory allocated by the KXMLGUIFactory for a specific container,
+ * including all child containers and actions. This deletes the internal node subtree for the
+ * specified container. The actual GUI is not touched, no containers are deleted or any actions
+ * unplugged. Use this method only if you know what you are doing :-)
+ *
+ * (also note that this will call KXMLGUIClient::setFactory( 0L ) for all clients of the
+ * container)
+ */
+ void resetContainer( const TQString &containerName, bool useTagName = false );
+
+ public slots:
+ /**
+ * Show a standard configure shortcut for every action in this factory.
+ *
+ * This slot can be connected dirrectly to the action to configure shortcuts. This is very simple to
+ * do that by adding a single line
+ * \code
+ * KStdAction::keyBindings( guiFactory(), TQT_SLOT( configureShortcuts() ), actionCollection() );
+ * \endcode
+ *
+ * @param bAllowLetterShortcuts Set to false if unmodified alphanumeric
+ * keys ('A', '1', etc.) are not permissible shortcuts.
+ * @param bSaveSettings if true, the settings will also be saved back to
+ * the *uirc file which they were intially read from.
+ * @since 3.3
+ */
+ 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( KAction *action, const TQDomNamedNodeMap &attributes );
+ void configureAction( KAction *action, const TQDomAttr &attribute );
+
+protected:
+ virtual void virtual_hook( int id, void* data );
+private:
+ KXMLGUIFactoryPrivate *d;
+};
+
+#endif
+/* vim: et sw=4
+ */