appfoundation/statemodel/src/hsstateprovidermanifest.cpp
changeset 103 b99b84bcd2d1
parent 83 156f692b1687
child 104 9b022b1f357c
equal deleted inserted replaced
83:156f692b1687 103:b99b84bcd2d1
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  State provider manifest.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include <QDomDocument>
       
    20 #include <QFile>
       
    21 
       
    22 #include "hsstateprovidermanifest.h"
       
    23 #include "hsstateprovidermanifest_p.h"
       
    24 #include "hstest_global.h"
       
    25 
       
    26 HsStateProviderManifestPrivate::HsStateProviderManifestPrivate(HsStateProviderManifest* aPublic)
       
    27     : QObject(aPublic),
       
    28       mQ(aPublic),
       
    29       mLoadOnQuery(false)
       
    30 {
       
    31 }
       
    32 
       
    33 HsStateProviderManifestPrivate::~HsStateProviderManifestPrivate()
       
    34 {
       
    35 
       
    36 }
       
    37 
       
    38 bool HsStateProviderManifestPrivate::loadFromXml(const QString& aFileName)
       
    39 {
       
    40     mStateTokens.clear();
       
    41 
       
    42     QFile file(aFileName);
       
    43     if(!file.exists())
       
    44     {
       
    45         return false;
       
    46     }
       
    47 
       
    48     QDomDocument document;
       
    49     if(!document.setContent(&file))
       
    50     {
       
    51         return false;
       
    52     }
       
    53 
       
    54     QDomElement element = document.documentElement();
       
    55     if(element.tagName() != "stateprovider")
       
    56     {
       
    57         return false;
       
    58     }
       
    59 
       
    60     mLoadOnQuery = false;
       
    61     QDomAttr attribute = element.attributeNode("loadonquery");
       
    62 	if(attribute.value().toLower() == "true")
       
    63 	{
       
    64         mLoadOnQuery = true;
       
    65 	}
       
    66     
       
    67     QList<HsStateToken> tokens;
       
    68     HsStateToken token;
       
    69 
       
    70     QDomNodeList states = element.elementsByTagName("state");
       
    71 
       
    72     for(int i = 0; i < states.count(); ++i)
       
    73     {
       
    74         element = states.at(i).toElement();
       
    75         token.mLibrary = parseAttribute(element, "library");
       
    76         token.mUri = parseAttribute(element, "uri");
       
    77         tokens << token;
       
    78     }
       
    79 
       
    80     mStateTokens = tokens;
       
    81     return true;
       
    82 }
       
    83 
       
    84 QList<HsStateToken> HsStateProviderManifestPrivate::states() const
       
    85 {
       
    86     return mStateTokens;
       
    87 }
       
    88 
       
    89 QString HsStateProviderManifestPrivate::parseAttribute(QDomElement& aElement, const QString& aAttributeName, bool aIsRequired) const
       
    90 {
       
    91     QDomAttr attribute = aElement.attributeNode(aAttributeName);
       
    92     if(attribute.isNull() || attribute.value().isEmpty())
       
    93     {
       
    94         if(aIsRequired)
       
    95         {
       
    96             HSDEBUG("Required attribute missing")            
       
    97         }
       
    98         else
       
    99         {
       
   100             HSDEBUG("Attribute missing")
       
   101         }
       
   102 
       
   103         return QString();
       
   104     }
       
   105 
       
   106     return attribute.value();
       
   107 }
       
   108 
       
   109 
       
   110 /*!
       
   111     \class HsStateProviderManifest
       
   112     \ingroup group_hsstatemodel
       
   113     \brief Loads home screen state tokens from an XML manifest file.
       
   114     Used by the HsStateFactory for loading state tokens from an XML
       
   115     manifest file.
       
   116 */
       
   117 
       
   118 /*!
       
   119     Constructor. Loads states as state tokens from the given
       
   120     manifest file.
       
   121     \a aParent Parent object.
       
   122 */
       
   123 HsStateProviderManifest::HsStateProviderManifest(QObject* aParent)
       
   124     : QObject(aParent)
       
   125 {
       
   126     mD = new HsStateProviderManifestPrivate(this);
       
   127 }
       
   128 
       
   129 /*!
       
   130     Destructor.
       
   131 */
       
   132 HsStateProviderManifest::~HsStateProviderManifest()
       
   133 {
       
   134 
       
   135 }
       
   136 
       
   137 /*!
       
   138     Returns loaded states as state tokens.
       
   139 */
       
   140 QList<HsStateToken> HsStateProviderManifest::states() const
       
   141 {
       
   142     return mD->states();
       
   143 }
       
   144 
       
   145 /*!
       
   146     Returns true if the state tokens must be asked from plugin
       
   147     instead of manifest file.
       
   148 */
       
   149 bool HsStateProviderManifest::loadOnQuery()const
       
   150 {
       
   151 	return mD->mLoadOnQuery;
       
   152 }
       
   153 
       
   154 /*!
       
   155     Loads states as state tokens from a manifest file.
       
   156     \a aFileName Manifest file name.
       
   157 
       
   158     Returns true if load was succesfull, false otherwise
       
   159 */
       
   160 bool HsStateProviderManifest::loadFromXml(const QString& aFileName)
       
   161 {
       
   162     return mD->loadFromXml(aFileName);
       
   163 }
       
   164