summaryrefslogtreecommitdiffstats
path: root/kregexpeditor/KWidgetStreamer/kwidgetstreamer.h
diff options
context:
space:
mode:
Diffstat (limited to 'kregexpeditor/KWidgetStreamer/kwidgetstreamer.h')
-rw-r--r--kregexpeditor/KWidgetStreamer/kwidgetstreamer.h74
1 files changed, 74 insertions, 0 deletions
diff --git a/kregexpeditor/KWidgetStreamer/kwidgetstreamer.h b/kregexpeditor/KWidgetStreamer/kwidgetstreamer.h
new file mode 100644
index 0000000..9534a92
--- /dev/null
+++ b/kregexpeditor/KWidgetStreamer/kwidgetstreamer.h
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2002-2003 Jesper K. Pedersen <blackie@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 __kwidgetstreamer
+#define __kwidgetstreamer
+#include <qmap.h>
+#include <qptrlist.h>
+#include <qstringlist.h>
+#include <qobject.h>
+
+/**
+ This class defines methods for streaming widget data.
+
+ For each widget type rules are defined telling which attributes should be
+ streamed. If you need to stream other attributes or to avoid streaming
+ certain attributes, then this may be obtained by editing the property
+ map, which is obtained by calling @ref propertyMap. For further control
+ inherit from this class and override @ref toStream and @ref fromStream.
+
+ The following example shows how you can avoid streaming
+ <tt>numDigits</tt> for a QLCDNumber. The same approach applies if you
+ want to add extra properties to be streamed.
+ <pre>
+ KWidgetStreamer streamer;
+ KWidgetStreamer::PropertyMap& map = streamer.propertyMap();
+ KWidgetStreamer::PropertyList& list = *map.find("QLCDNumber");
+ list.remove("numDigits");
+ </pre>
+**/
+class KWidgetStreamer
+{
+
+public:
+ typedef QStringList PropertyList;
+ typedef QMap< QString, PropertyList > PropertyMap;
+ typedef QMap< QString, PropertyList >::ConstIterator PropertyMapIt;
+ typedef QStringList::Iterator PropertyListIt;
+
+ KWidgetStreamer();
+ virtual ~KWidgetStreamer() {}
+
+ virtual void toStream(const QObject* from, QDataStream& stream );
+ virtual void fromStream(QDataStream& stream, QObject* to);
+
+ PropertyMap& propertyMap() { return _map; }
+
+
+protected:
+ void propertyToStream( const QObject* from, QDataStream& stream );
+ void propertyFromStream( QDataStream& stream, QObject* to );
+
+private:
+ PropertyMap _map;
+
+};
+
+
+
+#endif /* __kwidgetstreamer */
+