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:  MPX parameter for commandline/message

    15 *

    16 */

    17 

    18 

    19 #ifndef CMPXPARAMETER_H

    20 #define CMPXPARAMETER_H

    21 

    22 // INCLUDES

    23 #include <e32base.h>

    24 

    25 enum TMPXPathType

    26     {

    27     EMPXTypeCollectionPath,

    28     EMPXTypeCollectionPlaylist

    29     };

    30 

    31 enum TMPXCmdFwdType

    32     {

    33     EMPXCmdFwdNone,

    34     EMPXCmdFwdStandAlone,

    35     EMPXCmdFwdNowPlaying

    36     };

    37 

    38 // FORWARD DECLARATIONS

    39 class CMPXCollectionPath;

    40 

    41 // CLASS DECLARATION

    42 /**

    43 * Usage:

    44 * - To open a specific view, set iType to the view type.

    45 *

    46 * - To open a specific path, set iCollectionPath, music player will select

    47 *   the best matching view to display the result.

    48 *

    49 * - using iCollectionPath/iCollectionPlaylist + iType is supported, but not recommended

    50 *   since music player already selects the best matching view to display the result.

    51 *

    52 * - If the client wants the command to be processed by a specific music player instance

    53 *   they should set iCmdForward to a value defined by TMPXCmdFwdType. The default forwarding is to

    54 *   stand alone musicplayer (it'll be launched if it doesn't exist).

    55 *

    56 *  @lib mpxcommon.lib

    57 */

    58 class CMPXParameter : public CBase

    59     {

    60     public: // Constructors and destructor

    61 

    62         /**

    63         * C++ Constructor.

    64         *

    65         * @since S60 3.2.3

    66         */

    67         IMPORT_C CMPXParameter();

    68 

    69         /**

    70          * Destructor.

    71          *

    72          * @since S60 3.2.3

    73          */

    74         IMPORT_C virtual ~CMPXParameter();

    75 

    76     public: // New funtions

    77 

    78         /**

    79          * Externalize a object of this class to steam.

    80          *

    81          * @since S60 3.2.3

    82          * @param aStream write stream

    83          */

    84         IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;

    85 

    86         /**

    87          * Internalize a object of this class from steam.

    88          *

    89          * @since S60 3.2.3

    90          * @param aStream read stream

    91          * @leave KErrNotSupported The collection path is not valid,

    92          */

    93         IMPORT_C void InternalizeL( RReadStream& aStream );

    94 

    95     public: // data member

    96         CMPXCollectionPath*     iCollectionPath; // OWNED

    97         TMPXPathType            iPathType;

    98         TUid                    iType;

    99         TInt                    iCmdForward; // TMPXCmdFwdType

   100 

   101     private:

   102         TInt                    iVersion;

   103     };

   104 

   105 #endif // CMPXPARAMETER_H

   106 

   107 // End of File

   108