cxXmlOptionItem.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/


/*
 * sscXmlOptionItem.h
 *
 *  Created on: May 28, 2010
 *      Author: christiana
 */
#ifndef CXXMLOPTIONITEM_H_
#define CXXMLOPTIONITEM_H_

#include "cxResourceExport.h"

#include <QString>
#include <QDomElement>
#include <QVariant>

namespace cx
{

class cxResource_EXPORT XmlOptionItem
{
public:
        XmlOptionItem()
        {
        }
        XmlOptionItem(const QString& uid, QDomElement root);
        QString readValue(const QString& defval) const;
        void writeValue(const QString& val);

        QVariant readVariant(const QVariant& defval=QVariant()) const;
        void writeVariant(const QVariant& val);

private:
        QDomElement findElemFromUid(const QString& uid, QDomNode root) const;
        QString mUid;
        QDomElement mRoot;

        static QString SerializeDataToB64String(const QVariant& data);
        static QVariant DeserializeB64String(const QString& serializedVariant);
};

class cxResource_EXPORT XmlOptionFile
{
public:
        static XmlOptionFile createNull(); 

        explicit XmlOptionFile(QString filename); 
        XmlOptionFile();
        ~XmlOptionFile();

        QString getFileName();

        bool isNull() const; 

        XmlOptionFile root() const; 
        XmlOptionFile descend(QString element) const; 
        XmlOptionFile descend(QString element, QString attributeName, QString attributeValue) const; // stepdown to element with given attribute
        XmlOptionFile ascend() const; 
        XmlOptionFile tryDescend(QString element, QString attributeName, QString attributeValue) const; // stepdown only if present

        QDomDocument getDocument(); 
        QDomElement getElement(); 
        QDomElement getElement(QString level1); 
        QDomElement getElement(QString level1, QString level2); 

        void save(); 

        void removeChildren(); 
        void deleteNode(); 

        QDomElement safeGetElement(QDomElement parent, QString childName);

        //Debugging
        void printDocument(); 
        void printElement(); 
    static void printDocument(QDomDocument document);
    static void printElement(QDomElement element);

private:
        void load();

        QString mFilename;
        QDomDocument mDocument;
        QDomElement mCurrentElement; 

};

} // namespace cx

#endif /* CXXMLOPTIONITEM_H_ */