controlpanelui/src/cpcategorymodel/src/cppluginconfigreader.h
branchRCL_3
changeset 14 5f281e37a2f5
parent 13 90fe62538f66
equal deleted inserted replaced
13:90fe62538f66 14:5f281e37a2f5
     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:  This class reads cpcfg files.
       
    15 *
       
    16 */
       
    17 
       
    18 /* configuration format:
       
    19  
       
    20   <childplugins>
       
    21     <plugin displayname = "Personalization" id = "0xE195181a" dll = "cppersonaliztionplugin.dll">
       
    22       <desc>This is Personalization</desc>
       
    23     </plugin>
       
    24     <plugin displayname = "Communication" id = "0xE195181b" dll = "cpcommunicationplugin.dll">
       
    25       <desc>This is Communication</desc>
       
    26     </plugin>
       
    27     <plugin displayname = "Application settings" id = "0xE195181c" dll = "cpapplicationsettingsplugin.dll">
       
    28       <desc>This is Application settings</desc>
       
    29     </plugin>
       
    30     <plugin displayname = "Device" id = "0xE195181d" dll = "cpdeviceplugin.dll">
       
    31       <desc>This is Device</desc>
       
    32     </plugin>
       
    33   </childplugins>
       
    34 */
       
    35 
       
    36 /* Usage:
       
    37 
       
    38   const QString file("\\resource\\qt\\plugins\\controlpanel\\config\\applicationsettingsplugin.cpcfg");
       
    39   
       
    40   CpPluginConfigReader cfgReader(file);
       
    41   QList<CpPluginConfig> cfgList = cfgReader.readCpPluginConfigs();
       
    42   
       
    43   foreach (CpPluginConfig cfg, cfgList)
       
    44   {
       
    45     cfg.dump();
       
    46   }
       
    47 */
       
    48 
       
    49 #ifndef CPPLUGINCONFIGREADER_H
       
    50 #define CPPLUGINCONFIGREADER_H
       
    51 
       
    52 #include <QString>
       
    53 #include <QList>
       
    54 #include "cppluginconfig.h"
       
    55 
       
    56 class QXmlStreamReader;
       
    57 
       
    58 class CpPluginConfigReader
       
    59 {
       
    60 public:
       
    61     explicit CpPluginConfigReader(const QString &configPath);
       
    62     ~CpPluginConfigReader();
       
    63 
       
    64     QList<CpPluginConfig> readCpPluginConfigs();
       
    65 
       
    66 private:
       
    67     void readCpPluginConfigs(QXmlStreamReader &xmlReader,
       
    68             QList<CpPluginConfig> &cpPluginConfigList);
       
    69     void readChildPluginsElement(QXmlStreamReader &xmlReader, 
       
    70             QList<CpPluginConfig> &cpPluginConfigList);
       
    71     void readPluginElement(QXmlStreamReader &xmlReader,
       
    72             QList<CpPluginConfig> &cpPluginConfigList);
       
    73     void readDescElement(QXmlStreamReader &xmlReader,
       
    74             CpPluginConfig &cpPluginConfig);
       
    75     void skipUnknownElement(QXmlStreamReader &xmlReader);
       
    76 private:
       
    77     QString mConfigPath;
       
    78 };
       
    79 
       
    80 #endif /* CPPLUGINCONFIGREADER_H */