summaryrefslogtreecommitdiffstats
path: root/kpovmodeler/pmdocumentationmap.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit47d455dd55be855e4cc691c32f687f723d9247ee (patch)
tree52e236aaa2576bdb3840ebede26619692fed6d7d /kpovmodeler/pmdocumentationmap.h
downloadtdegraphics-47d455dd55be855e4cc691c32f687f723d9247ee.tar.gz
tdegraphics-47d455dd55be855e4cc691c32f687f723d9247ee.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdegraphics@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kpovmodeler/pmdocumentationmap.h')
-rw-r--r--kpovmodeler/pmdocumentationmap.h138
1 files changed, 138 insertions, 0 deletions
diff --git a/kpovmodeler/pmdocumentationmap.h b/kpovmodeler/pmdocumentationmap.h
new file mode 100644
index 00000000..3027095c
--- /dev/null
+++ b/kpovmodeler/pmdocumentationmap.h
@@ -0,0 +1,138 @@
+//-*-C++-*-
+/*
+**************************************************************************
+ description
+ --------------------
+ copyright : (C) 2002 by Andreas Zehender
+ email : zehender@kde.org
+**************************************************************************
+
+**************************************************************************
+* *
+* This program is free software; you can redistribute it and/or modify *
+* it under the terms of the GNU General Public License as published by *
+* the Free Software Foundation; either version 2 of the License, or *
+* (at your option) any later version. *
+* *
+**************************************************************************/
+
+#ifndef PMDOCUMENTATIONMAP_H
+#define PMDOCUMENTATIONMAP_H
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <qstring.h>
+#include <qmap.h>
+#include <qptrlist.h>
+#include <qvaluelist.h>
+#include <kstaticdeleter.h>
+
+class KConfig;
+class QDomElement;
+
+/**
+ * Class used internally by @ref PMDocumentationMap
+ */
+class PMDocumentationVersion
+{
+public:
+ /**
+ * Constructor
+ */
+ PMDocumentationVersion( ) { }
+ /**
+ * Destructor
+ */
+ ~PMDocumentationVersion( ) { }
+
+ QString version( ) const { return m_version; }
+ void setVersion( const QString& str ) { m_version = str; }
+ QString index( ) const { return m_index; }
+ void setIndex( const QString& str ) { m_index = str; }
+
+ QString documentation( const QString& className ) const;
+
+ void loadData( QDomElement& e );
+
+private:
+ QString m_version;
+ QString m_index;
+ QMap< QString, QString > m_map;
+};
+
+/**
+ * Class that maps the class name to the corresponding povray
+ * user documentation file
+ */
+class PMDocumentationMap
+{
+public:
+ /**
+ * Destructor
+ */
+ ~PMDocumentationMap( );
+ /**
+ * Returns the map instance (singleton)
+ */
+ static PMDocumentationMap* theMap( );
+
+ /**
+ * Sets the path to the povray user documentation
+ */
+ void setPovrayDocumentationPath( const QString& s )
+ {
+ m_documentationPath = s;
+ }
+ /**
+ * Returns the path to the povray user documentation
+ */
+ QString povrayDocumentationPath( )
+ {
+ return m_documentationPath;
+ }
+
+ /**
+ * Sets the povray documentation version
+ */
+ void setDocumentationVersion( const QString& str );
+ /**
+ * Returns the povray documentation version
+ */
+ QString documentationVersion( ) const { return m_currentVersion; }
+
+ /**
+ * Returns the list of available documentation versions
+ */
+ QValueList<QString> availableVersions( );
+
+ /**
+ * Returns the povray documentation file for the
+ * given object type
+ */
+ QString documentation( const QString& objectName );
+
+ void saveConfig( KConfig* cfg );
+ void restoreConfig( KConfig* cfg );
+
+private:
+
+ /**
+ * Constructor
+ */
+ PMDocumentationMap( );
+ void loadMap( );
+ void findVersion( );
+
+ QString m_documentationPath;
+ bool m_mapLoaded;
+ QPtrList< PMDocumentationVersion > m_maps;
+ PMDocumentationVersion* m_pCurrentVersion;
+ QString m_currentVersion;
+
+ static PMDocumentationMap* s_pInstance;
+ static KStaticDeleter<PMDocumentationMap> s_staticDeleter;
+};
+
+#endif