1 /*

     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 *

     5 * This program is free software: you can redistribute it and/or modify

     6 * it under the terms of the GNU Lesser General Public License as published by

     7 * the Free Software Foundation, version 2.1 of the License.

     8 * 

     9 * This program is distributed in the hope that it will be useful,

    10 * but WITHOUT ANY WARRANTY; without even the implied warranty of

    11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    12 * GNU Lesser General Public License for more details.

    13 *

    14 * You should have received a copy of the GNU Lesser General Public License

    15 * along with this program.  If not, 

    16 * see "http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html/".

    17 *

    18 * Description:

    19 *

    20 */

    21 

    22 #include "xqsettingskey.h"

    23 

    24 /****************************************************

    25  *

    26  * XQSettingsKey

    27  *

    28  ****************************************************/

    29 

    30 /*!

    31     \class XQSettingsKey

    32 

    33     \brief The XQSettingsKey defines the target for XQSettingsManager operations.

    34 */

    35 

    36 /*!

    37     \enum XQSettingsKey::Target

    38 

    39     This enum defines the possible item target for an XQSettingsKey object.

    40 */

    41 /*! \var XQSettingsKey::TargetCentralRepository XQSettingsKey::TargetCentralRepository

    42     The settings key targets to Symbian OS's Central Repository.

    43 */

    44 /*! \var XQSettingsKey::TargetPublishAndSubscribe XQSettingsKey::TargetPublishAndSubscribe

    45     The settings key targets to Symbian OS's Publish and Subscribe property.

    46 */

    47 

    48 /*!

    49     Constructs an XQSettingsKey object.

    50     \param target This is either XQSettingsKey::TargetCentralRepository or 

    51     XQSettingsKey::TargetPublishAndSubscribe.

    52     \param uid In case of Central Repository a CenRep Uid. In case of

    53     Publish and Subscribe an RProperty category Uid.

    54     \param key Settings Key

    55 */

    56 XQSettingsKey::XQSettingsKey(

    57     XQSettingsKey::Target target, long int uid, unsigned long int key) :

    58     m_target(target), m_uid(uid), m_key(key)

    59 {   

    60 }

    61 

    62 /*!

    63     Destructs an XQSettingsKey object.

    64 */

    65 XQSettingsKey::~XQSettingsKey()

    66 {

    67 }

    68 

    69 /*!

    70     Gets a target of the item.

    71 

    72     \return target Either XQSettingsKey::TargetCentralRepository or 

    73     XQSettingsKey::TargetPublishAndSubscribe.

    74 */

    75 XQSettingsKey::Target XQSettingsKey::target() const

    76 {

    77     return m_target;

    78 }

    79 

    80 /*!

    81     Gets a uid of the item

    82 

    83     \return uid. In case of Central Repository a CenRep Uid. In case of

    84     Publish and Subscribe an RProperty category Uid.

    85 */

    86 long int XQSettingsKey::uid() const

    87 {    

    88     return m_uid;

    89 }

    90 

    91 /*!

    92     Gets a key of the item

    93 

    94     \return Key

    95 */

    96 unsigned long int XQSettingsKey::key() const

    97 {

    98     return m_key;

    99 }

   100 

   101 /*!

   102     \class XQCentralRepositorySettingsKey

   103 

   104     \brief The XQCentralRepositorySettingsKey defines the Central Repository

   105     target for XQSettingsManager operations.

   106 */

   107 

   108 /*!

   109     Constructs an XQCentralRepositorySettingsKey object.

   110     \param repositoryUid CenRep Uid

   111     \param key Settings Key

   112 */

   113 XQCentralRepositorySettingsKey::XQCentralRepositorySettingsKey(long int repositoryUid, unsigned long int key) :

   114     XQSettingsKey(XQSettingsKey::TargetCentralRepository, repositoryUid, key)

   115 {

   116 }

   117 

   118 /*!

   119     Destructs an XQCentralRepositorySettingsKey object.

   120 */

   121 XQCentralRepositorySettingsKey::~XQCentralRepositorySettingsKey()

   122 {

   123 }

   124 

   125 /*!

   126     \class XQPublishAndSubscribeSettingsKey

   127 

   128     \brief The XQPublishAndSubscribeSettingsKey defines the Publish and

   129     Subscribe target for XQSettingsManager operations.

   130 */

   131 

   132 /*!

   133     Constructs an XQPublishAndSubscribeSettingsKey object.

   134     \param categoryUid RProperty category Uid.

   135     \param key Settings Key

   136 */

   137 XQPublishAndSubscribeSettingsKey::XQPublishAndSubscribeSettingsKey(long int categoryUid, unsigned long int key) :

   138     XQSettingsKey(XQSettingsKey::TargetPublishAndSubscribe, categoryUid, key)

   139 {

   140 }

   141 

   142 /*!

   143     Destructs an XQPublishAndSubscribeSettingsKey object.

   144 */

   145 XQPublishAndSubscribeSettingsKey::~XQPublishAndSubscribeSettingsKey()

   146 {

   147 }

   148 

   149 // End of file