Référence de la classe KoOasisSettings

Parse settings.xml file. Plus de détails...

#include <KoOasisSettings.h>

Liste de tous les membres

Fonctions membres publiques
	KoOasisSettings (const KoXmlDocument &doc)
	KoOasisSettings (const KoXmlDocument &doc, const char *officeNSURI, const char *configNSURI)
Items	itemSet (const QString &itemSetName) const
Attributs privés
const KoXmlElement	m_settingsElement
const char *	m_configNSURI
Private *	d
Amis
class	Items
class	IndexedMap
class	NamedMap
Classes
class	IndexedMap
class	Items
	Represents a collection of items (config-item or maps). Plus de détails...
class	Map
	Internal base class for IndexedMap and NamedMap. Plus de détails...
class	NamedMap

---

Description détaillée

Parse settings.xml file.

This class helps parsing the settings.xml file of an OASIS document.

For reference, the structure of settings.xml looks like:

   <office:settings>
      <config:config-item-set config:name="configure-settings">
      ....
      </config:config-item-set>
      <config:config-item-set config:name="view-settings">
         <config:config-item-map-indexed config:name="Views">
           <config:config-item-map-entry>
             <config:config-item config:name="SnapLinesDrawing" config:type="string">value</config:config-item>
               ....
                <config:config-item-map-named config:name="Tables">
                  <config:config-item-map-entry config:name="Sheet1">
                    <config:config-item config:name="CursorPositionX">
                    ......
                  </config:config-item-map-entry>
                  <config:config-item-map-entry config:name="Sheet2">
                  ....
                  </config:config-item-map-entry>
                </config:config-item-map-named>
           .....
           </config:config-item-map-entry>
         </config:config-item-map-indexed>
         <config:config-item-map-indexed config:name="Interface">
         .......
         </config:config-item-map-indexed>
      </config:config-item-set>
   </office:settings>
 

Basically, an item-set is a set of named <config-item>s and/or maps. There are two kinds of maps (by-index or by-name), and entries in the maps contain <config-item>s too, or nested maps.

The API of KoOasisSettings allows the caller to look for a given item-set or item-map once, and then lookup multiple items inside it. It also allows "drilling down" inside the tree in case of nesting.

Définition à la ligne 71 du fichier KoOasisSettings.h.

---

Documentation des contructeurs et destructeur

KoOasisSettings::KoOasisSettings

(

const KoXmlDocument &

doc

)

[explicit]

Normal KoOasisSettings constructor, for an OASIS settings.xml

Définition à la ligne 25 du fichier KoOasisSettings.cpp.

Références m_settingsElement.

KoOasisSettings::KoOasisSettings	(	const KoXmlDocument &	doc,
		const char *	officeNSURI,
		const char *	configNSURI
	)

KoOasisSettings constructor for an OpenOffice-1.1 file

Définition à la ligne 34 du fichier KoOasisSettings.cpp.

Références m_settingsElement.

---

Documentation des fonctions membres

KoOasisSettings::Items KoOasisSettings::itemSet

(

const QString &

itemSetName

)

const

Returns the toplevel item-set named itemSetName. If not found, the returned items instance is null.

Définition à la ligne 43 du fichier KoOasisSettings.cpp.

Références forEachElement, Items, m_configNSURI, et m_settingsElement.

Référencé par KoVariableSettings::loadOasis(), testIndexedMap(), testNamedMap(), testParseConfigItemString(), et testSelectItemSet().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions amies et associées

friend class Items [friend]

Définition à la ligne 170 du fichier KoOasisSettings.h.

Référencé par itemSet().

friend class IndexedMap [friend]

Définition à la ligne 171 du fichier KoOasisSettings.h.

friend class NamedMap [friend]

Définition à la ligne 172 du fichier KoOasisSettings.h.

---

Documentation des données membres

const KoXmlElement KoOasisSettings::m_settingsElement [private]

Définition à la ligne 173 du fichier KoOasisSettings.h.

Référencé par itemSet(), et KoOasisSettings().

const char* KoOasisSettings::m_configNSURI [private]

Définition à la ligne 174 du fichier KoOasisSettings.h.

Référencé par KoOasisSettings::NamedMap::entry(), KoOasisSettings::IndexedMap::entry(), KoOasisSettings::Items::findConfigItem(), KoOasisSettings::Items::indexedMap(), itemSet(), et KoOasisSettings::Items::namedMap().

Private* KoOasisSettings::d [private]

Définition à la ligne 176 du fichier KoOasisSettings.h.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• F:/KPlato/koffice/libs/kofficecore/KoOasisSettings.h
• F:/KPlato/koffice/libs/kofficecore/KoOasisSettings.cpp

---