summaryrefslogtreecommitdiffstats
path: root/kdeui/kxmlguifactory_p.h
diff options
context:
space:
mode:
Diffstat (limited to 'kdeui/kxmlguifactory_p.h')
-rw-r--r--kdeui/kxmlguifactory_p.h254
1 files changed, 254 insertions, 0 deletions
diff --git a/kdeui/kxmlguifactory_p.h b/kdeui/kxmlguifactory_p.h
new file mode 100644
index 000000000..6e7f8f15a
--- /dev/null
+++ b/kdeui/kxmlguifactory_p.h
@@ -0,0 +1,254 @@
+/* This file is part of the KDE libraries
+ Copyright (C) 2001 Simon Hausmann <hausmann@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 as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ 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_p_h__
+#define __kxmlguifactory_p_h__
+
+#include <qstringlist.h>
+#include <qmap.h>
+#include <qdom.h>
+#include <qvaluestack.h>
+
+#include <kaction.h>
+
+class QWidget;
+class KXMLGUIClient;
+class KXMLGUIBuilder;
+class KXMLGUIFactory;
+
+namespace KXMLGUI
+{
+
+struct BuildState;
+
+class KDEUI_EXPORT ActionList : public QPtrList<KAction>
+{
+public:
+ ActionList() {}
+ ActionList( const QPtrList<KAction> &rhs )
+ : QPtrList<KAction>( rhs )
+ {}
+ ActionList &operator=( const QPtrList<KAction> &rhs )
+ { QPtrList<KAction>::operator=( rhs ); return *this; }
+
+ void plug( QWidget *container, int index ) const;
+ void unplug( QWidget *container ) const;
+};
+
+typedef QPtrListIterator<KAction> ActionListIt;
+typedef QMap< QString, ActionList > ActionListMap;
+
+/*
+ * This structure is used to know to which client certain actions and custom elements
+ * (i.e. menu separators) belong.
+ * We do not only use a ContainerClient per GUIClient but also per merging group.
+ *
+ * groupName : Used for grouped merging. Specifies the group name to which these actions/elements
+ * belong to.
+ * actionLists : maps from action list name to action list.
+ * mergingName : The (named) merging point.
+ *
+ * A ContainerClient always belongs to a ContainerNode.
+ */
+struct ContainerClient
+{
+ KXMLGUIClient *client;
+ ActionList actions;
+ QValueList<int> customElements;
+ QString groupName; //is empty if no group client
+ ActionListMap actionLists;
+ QString mergingName;
+};
+typedef QPtrList<ContainerClient> ContainerClientList;
+typedef QPtrListIterator<ContainerClient> ContainerClientListIt;
+
+struct ContainerNode;
+
+struct MergingIndex
+{
+ int value; // the actual index value, used as index for plug() or createContainer() calls
+ QString mergingName; // the name of the merging index (i.e. the name attribute of the
+ // Merge or DefineGroup tag)
+ QString clientName; // the name of the client that defined this index
+};
+typedef QValueList<MergingIndex> MergingIndexList;
+
+/*
+ * Here we store detailed information about a container, its clients (client=a guiclient having actions
+ * plugged into the container), child nodes, naming information (tagname and name attribute) and
+ * merging index information, to plug/insert new actions/items a the correct position.
+ *
+ * The builder variable is needed for using the proper GUIBuilder for destruction ( to use the same for
+ * con- and destruction ). The builderCustomTags and builderContainerTags variables are cached values
+ * of what the corresponding methods of the GUIBuilder which built the container return. The stringlists
+ * is shared all over the place, so there's no need to worry about memory consumption for these
+ * variables :-)
+ *
+ * The mergingIndices list contains the merging indices ;-) , as defined by <Merge>, <DefineGroup>
+ * or by <ActionList> tags. The order of these index structures within the mergingIndices list
+ * is (and has to be) identical with the order in the DOM tree.
+ *
+ * Beside the merging indices we have the "real" index of the container. It points to the next free
+ * position.
+ * (used when no merging index is used for a certain action, custom element or sub-container)
+ */
+struct KDEUI_EXPORT ContainerNode
+{
+ ContainerNode( QWidget *_container, const QString &_tagName, const QString &_name,
+ ContainerNode *_parent = 0L, KXMLGUIClient *_client = 0L,
+ KXMLGUIBuilder *_builder = 0L, int id = -1,
+ const QString &_mergingName = QString::null,
+ const QString &groupName = QString::null,
+ const QStringList &customTags = QStringList(),
+ const QStringList &containerTags = QStringList() );
+
+ ContainerNode *parent;
+ KXMLGUIClient *client;
+ KXMLGUIBuilder *builder;
+ QStringList builderCustomTags;
+ QStringList builderContainerTags;
+ QWidget *container;
+ int containerId;
+
+ QString tagName;
+ QString name;
+
+ QString groupName; //is empty if the container is in no group
+
+ ContainerClientList clients;
+ QPtrList<ContainerNode> children;
+
+ int index;
+ MergingIndexList mergingIndices;
+
+ QString mergingName;
+
+ void clearChildren() { children.clear(); }
+ void removeChild( ContainerNode *child );
+
+ MergingIndexList::Iterator findIndex( const QString &name );
+ ContainerNode *findContainerNode( QWidget *container );
+ ContainerNode *findContainer( const QString &_name, bool tag );
+ ContainerNode *findContainer( const QString &name, const QString &tagName,
+ const QPtrList<QWidget> *excludeList,
+ KXMLGUIClient *currClient );
+
+ ContainerClient *findChildContainerClient( KXMLGUIClient *currentGUIClient,
+ const QString &groupName,
+ const MergingIndexList::Iterator &mergingIdx );
+
+ void plugActionList( BuildState &state );
+ void plugActionList( BuildState &state, const MergingIndexList::Iterator &mergingIdxIt );
+
+ void unplugActionList( BuildState &state );
+ void unplugActionList( BuildState &state, const MergingIndexList::Iterator &mergingIdxIt );
+
+ void adjustMergingIndices( int offset, const MergingIndexList::Iterator &it );
+
+ bool destruct( QDomElement element, BuildState &state );
+ void destructChildren( const QDomElement &element, BuildState &state );
+ static QDomElement findElementForChild( const QDomElement &baseElement,
+ ContainerNode *childNode );
+ void unplugActions( BuildState &state );
+ void unplugClient( ContainerClient *client );
+
+ void reset();
+
+ int calcMergingIndex( const QString &mergingName,
+ MergingIndexList::Iterator &it,
+ BuildState &state,
+ bool ignoreDefaultMergingIndex );
+};
+
+typedef QPtrList<ContainerNode> ContainerNodeList;
+typedef QPtrListIterator<ContainerNode> ContainerNodeListIt;
+
+class KDEUI_EXPORT BuildHelper
+{
+public:
+ BuildHelper( BuildState &state,
+ ContainerNode *node );
+
+ void build( const QDomElement &element );
+
+private:
+ void processElement( const QDomElement &element );
+
+ void processActionOrCustomElement( const QDomElement &e, bool isActionTag );
+ bool processActionElement( const QDomElement &e, int idx );
+ bool processCustomElement( const QDomElement &e, int idx );
+
+ void processStateElement( const QDomElement &element );
+
+ void processMergeElement( const QString &tag, const QString &name, const QDomElement &e );
+
+ void processContainerElement( const QDomElement &e, const QString &tag,
+ const QString &name );
+
+
+ QWidget *createContainer( QWidget *parent, int index, const QDomElement &element,
+ int &id, KXMLGUIBuilder **builder );
+
+ int calcMergingIndex( const QDomElement &element, MergingIndexList::Iterator &it, QString &group );
+
+ QStringList customTags;
+ QStringList containerTags;
+
+ QPtrList<QWidget> containerList;
+
+ ContainerClient *containerClient;
+
+ bool ignoreDefaultMergingIndex;
+
+ BuildState &m_state;
+
+ ContainerNode *parentNode;
+};
+
+struct KDEUI_EXPORT BuildState
+{
+ BuildState() : guiClient( 0 ), builder( 0 ), clientBuilder( 0 ) {}
+
+ void reset();
+
+ QString clientName;
+
+ QString actionListName;
+ ActionList actionList;
+
+ KXMLGUIClient *guiClient;
+
+ MergingIndexList::Iterator currentDefaultMergingIt;
+ MergingIndexList::Iterator currentClientMergingIt;
+
+ KXMLGUIBuilder *builder;
+ QStringList builderCustomTags;
+ QStringList builderContainerTags;
+
+ KXMLGUIBuilder *clientBuilder;
+ QStringList clientBuilderCustomTags;
+ QStringList clientBuilderContainerTags;
+};
+
+typedef QValueStack<BuildState> BuildStateStack;
+
+}
+
+#endif
+/* vim: et sw=4
+ */