lib

Classes | Public Member Functions | Friends | List of all members
KoOasisSettings Class Reference

#include <KoOasisSettings.h>

Classes

class  Items
class  Map

Public Member Functions

 KoOasisSettings (const TQDomDocument &doc)
 KoOasisSettings (const TQDomDocument &doc, const char *officeNSURI, const char *configNSURI)
Items itemSet (const TQString &itemSetName) const

Friends

class Items
class IndexedMap
class NamedMap

Detailed Description

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.

Definition at line 70 of file KoOasisSettings.h.

Constructor & Destructor Documentation

◆ KoOasisSettings() [1/2]

KoOasisSettings::KoOasisSettings ( const TQDomDocument & doc)
explicit

Normal KoOasisSettings constructor, for an OASIS settings.xml.

Definition at line 25 of file KoOasisSettings.cpp.

◆ KoOasisSettings() [2/2]

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

KoOasisSettings constructor for an OpenOffice-1.1 file.

Definition at line 34 of file KoOasisSettings.cpp.

Member Function Documentation

◆ itemSet()

KoOasisSettings::Items KoOasisSettings::itemSet ( const TQString & itemSetName) const

Returns the toplevel item-set named itemSetName.

If not found, the returned items instance is null.

Definition at line 43 of file KoOasisSettings.cpp.

◆ IndexedMap

friend class IndexedMap
friend

Definition at line 170 of file KoOasisSettings.h.

◆ Items

friend class Items
friend

Definition at line 169 of file KoOasisSettings.h.

◆ NamedMap

friend class NamedMap
friend

Definition at line 171 of file KoOasisSettings.h.

The documentation for this class was generated from the following files: