blob: 8588c6a0ba61889adaac2ed4c86c1ad5e535ad85 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/*
**************************************************************************
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 <tqstring.h>
#include <tqmap.h>
#include <tqptrlist.h>
#include <tqvaluelist.h>
#include <kstaticdeleter.h>
class TDEConfig;
class TQDomElement;
/**
* Class used internally by @ref PMDocumentationMap
*/
class PMDocumentationVersion
{
public:
/**
* Constructor
*/
PMDocumentationVersion( ) { }
/**
* Destructor
*/
~PMDocumentationVersion( ) { }
TQString version( ) const { return m_version; }
void setVersion( const TQString& str ) { m_version = str; }
TQString index( ) const { return m_index; }
void setIndex( const TQString& str ) { m_index = str; }
TQString documentation( const TQString& className ) const;
void loadData( TQDomElement& e );
private:
TQString m_version;
TQString m_index;
TQMap< TQString, TQString > 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 TQString& s )
{
m_documentationPath = s;
}
/**
* Returns the path to the povray user documentation
*/
TQString povrayDocumentationPath( )
{
return m_documentationPath;
}
/**
* Sets the povray documentation version
*/
void setDocumentationVersion( const TQString& str );
/**
* Returns the povray documentation version
*/
TQString documentationVersion( ) const { return m_currentVersion; }
/**
* Returns the list of available documentation versions
*/
TQValueList<TQString> availableVersions( );
/**
* Returns the povray documentation file for the
* given object type
*/
TQString documentation( const TQString& objectName );
void saveConfig( TDEConfig* cfg );
void restoreConfig( TDEConfig* cfg );
private:
/**
* Constructor
*/
PMDocumentationMap( );
void loadMap( );
void findVersion( );
TQString m_documentationPath;
bool m_mapLoaded;
TQPtrList< PMDocumentationVersion > m_maps;
PMDocumentationVersion* m_pCurrentVersion;
TQString m_currentVersion;
static PMDocumentationMap* s_pInstance;
static KStaticDeleter<PMDocumentationMap> s_staticDeleter;
};
#endif
|
