1 /*

     2 * Copyright (c) 2006 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:  Definitions for command type

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef CMPXCOMMANDGENERALDEFS_H

    21 #define CMPXCOMMANDGENERALDEFS_H

    22 

    23 

    24 #include <e32base.h>

    25 #include <mpxattribute.h>

    26 

    27 /**

    28 * Content ID identifying general category of content provided

    29 * in the command object and associated attributes. This should

    30 * be supported by ALL command objects as a common base

    31 */

    32 const TInt KMPXCommandContentIdGeneral = 0x101FFC48;

    33 

    34 /**

    35 *  Attributes supported for KMPXCommandIdGeneral

    36 */

    37 /**

    38 *  TMPXCommandId, *unique* id of the command

    39 */

    40 const TMPXAttributeData KMPXCommandGeneralId = {KMPXCommandContentIdGeneral, 0x01};

    41 /**

    42 *  Optional: Request to block until command is complete

    43 *  TBool value

    44 */

    45 const TMPXAttributeData KMPXCommandGeneralDoSync = {KMPXCommandContentIdGeneral, 0x02};

    46 /**

    47  * Optional: TInt, Collection id

    48  */

    49 const TMPXAttributeData KMPXCommandGeneralCollectionId = {KMPXCommandContentIdGeneral, 0x04};

    50 /**

    51  * Optional: Unique id from client

    52  */

    53 const TMPXAttributeData KMPXCommandGeneralSessionId = {KMPXCommandContentIdGeneral, 0x08};

    54 /**

    55  * Optional: Collection path of source ids

    56  */

    57 const TMPXAttributeData KMPXCommandGeneralSourceIds = {KMPXCommandContentIdGeneral, 0x10};

    58 /**

    59  * Optional: Descriptor, Source uri

    60  */

    61 const TMPXAttributeData KMPXCommandGeneralSourceUri = {KMPXCommandContentIdGeneral, 0x20};

    62 /**

    63  * Optional: CMPXCollectionPath, Target ids

    64  */

    65 const TMPXAttributeData KMPXCommandGeneralTargetIds = {KMPXCommandContentIdGeneral, 0x40};

    66 

    67 

    68 /*******************************************************************************

    69  * ContentID for media command

    70  *

    71  ******************************************************************************/

    72 const TInt KMPXCommandContentIdMedia = 0x10282974;

    73 

    74 /**

    75  *  Attributes supported for KMPXCommandConentIdMedia

    76  */

    77 /**

    78  * CMPXAttributeSpecs, attribute specs for the media request

    79  */

    80 const TMPXAttributeData KMPXCommandMediaAttributeSpecs = { KMPXCommandContentIdMedia, 0x01 };

    81 

    82 /**

    83  * TInt, index to the current item, for multiple selection

    84  */

    85 const TMPXAttributeData KMPXCommandMediaIndex = { KMPXCommandContentIdMedia, 0x02 };

    86 

    87 /**

    88  * TDesC, externalized version of a TMPXAttribute array

    89  */

    90 const TMPXAttributeData KMPXCommandMediaAttribute = { KMPXCommandContentIdMedia, 0x04 };

    91 

    92 /**

    93  * CMPXFilter, filter for the media request

    94  */

    95 const TMPXAttributeData KMPXCommandMediaFilter = { KMPXCommandContentIdMedia, 0x08 };

    96 

    97 /**

    98  * TCapabilitySet, set of capabilities

    99  */

   100 const TMPXAttributeData KMPXCommandMediaCapbilitySet = { KMPXCommandContentIdMedia, 0x10 };

   101 

   102 /*******************************************************************************

   103  * Subscription commands

   104  *

   105  ******************************************************************************/

   106 

   107 /**

   108  *  Add Subscription command

   109  */

   110 const TInt KMPXCommandSubscriptionAdd = 0x10282977;

   111 

   112 /**

   113  *  Add subscription attributes

   114  */

   115 const TMPXAttributeData KMPXCommandSubscriptionAddItems = { KMPXCommandSubscriptionAdd, 0x01 };

   116 

   117 /**

   118  *  Remove subscription command

   119  */

   120 const TInt KMPXCommandSubscriptionRemove = 0x10282978;

   121 

   122 /**

   123  *  Remove subscription attributes

   124  */

   125 const TMPXAttributeData KMPXCommandSubscriptionRemoveItems = { KMPXCommandSubscriptionRemove, 0x01 };

   126 

   127 /**

   128  *  Remove all subscriptions command

   129  */

   130 const TInt KMPXCommandSubscriptionRemoveAll = 0x10282979;

   131 

   132 

   133 

   134 /** 

   135 *  Attributes supported for KMPXCommandIdGeneral.

   136 *

   137 *  @deprecated Use the above consts instead

   138 */

   139 enum

   140     {

   141     /**

   142     *  TMPXCommandId, *unique* id of the command

   143     */

   144     EMPXCommandGeneralId = 0x01,

   145 

   146     /**

   147     *  Optional: Request to block until command is complete

   148     *  TBool value

   149     */

   150     EMPXCommandGeneralDoSync = 0x02,

   151 

   152     /**

   153      * Optional: TInt, Collection id

   154      */

   155     EMPXCommandGeneralCollectionId = 0x04,

   156 

   157     /**

   158      * Optional: Unique id from client

   159      */

   160     EMPXCommandGeneralSessionId = 0x08,

   161 

   162     /**

   163      * Optional: Array of Source ids

   164      */

   165     EMPXCommandGeneralSourceIds = 0x10,

   166 

   167     /**

   168      * Optional: Descriptor, Source uri

   169      */

   170     EMPXCommandGeneralSourceUri = 0x20

   171     };

   172 

   173 #endif // CMPXCOMMANDGENERALDEFS_H