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 view plugin info definition

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef CMPXVIEWPLUGININFO_H

    21 #define CMPXVIEWPLUGININFO_H

    22 

    23 

    24 // INCLUDES

    25 #include <e32base.h>

    26 #include <ecom/ecom.h>

    27 

    28 

    29 // FORWARD DECLARATIONS

    30 

    31 

    32 // CLASS DECLARATION

    33 

    34 /**

    35  *  MPX view plugin info.

    36  *

    37  *  @lib mpxviewutility.lib

    38  *  @since S60 v3.1

    39  */

    40 NONSHARABLE_CLASS( CMPXViewPluginInfo ) : public CBase

    41     {

    42 public:

    43 

    44     /**

    45      * Two-phased constructor.

    46      *

    47      * @since 3.0

    48      * @param aData Plugin's implementation information.

    49      * @return Pointer to newly created object.

    50      */

    51     static CMPXViewPluginInfo* NewL( 

    52         const CImplementationInformation& aData );

    53 

    54     /**

    55      * Two-phased constructor.

    56      *

    57      * @since 3.0

    58      * @param aData Plugin's implementation information.

    59      * @return Pointer to newly created object.

    60      */

    61     static CMPXViewPluginInfo* NewLC( 

    62         const CImplementationInformation& aData );

    63 

    64     /**

    65      * Destructor.

    66      */

    67     virtual ~CMPXViewPluginInfo();

    68 

    69     /**

    70      * Returns plugin's display name.

    71      *

    72      * @since 3.0

    73      * @return Plugin's display name.

    74      */

    75     const TDesC& DisplayName() const;

    76 

    77     /**

    78      * Returns plugin's implementation uid.

    79      *

    80      * @since 3.0

    81      * @return Plugin's implementation uid.

    82      */

    83     const TUid& ImplementationUid() const;

    84 

    85     /**

    86      * Returns plugin's supported uids.

    87      *

    88      * @since 3.0

    89      * @return Plugin's supported uids.

    90      */

    91     const RArray<TUid> SupportedUids() const;

    92 

    93     /**

    94      * Returns plugin's plugin type.

    95      *

    96      * @since 3.0

    97      * @return Plugin's plugin type.

    98      */

    99     const TUid& PluginType() const;

   100 

   101     /**

   102      * Returns plugin's view priority.

   103      *

   104      * @since 3.0

   105      * @return Plugin's view priority.

   106      */

   107     TInt Priority() const;

   108 

   109     /**

   110      * Test whether the plugin is user selectable.

   111      *

   112      * @since 3.0

   113      * @return ETrue if plugin is user selectable, EFalse otherwise.

   114      */

   115     TBool IsUserSelectable() const;

   116 

   117     /**

   118      * Test whether the plugin should be preloaded.

   119      *

   120      * @since 3.0

   121      * @return ETrue if plugin needs preloaded, EFalse otherwise.

   122      */

   123     TBool IsPreLoad() const;

   124 

   125 private:

   126 

   127     /**

   128      * C++ default constructor.

   129      */

   130     CMPXViewPluginInfo();

   131 

   132     /**

   133      * By default Symbian 2nd phase constructor is private.

   134      *

   135      * @param aData Plugin's implementation information.

   136      */

   137     void ConstructL( 

   138         const CImplementationInformation& aData );

   139 

   140     /**

   141      * Extracts plugin priority from data.

   142      *

   143      * @param aData Plugin's opaque data.

   144      * @return Plugin priority.

   145      */

   146     TInt ExtractPluginPriority( 

   147         const TDesC8& aData );

   148 

   149     /**

   150      * Extracts plugin supported Uids from data.

   151      *

   152      * @param aData Plugin's opaque data.

   153      * @param aArray On return, contains list of plugin uids.

   154      */

   155     void ExtractPluginUidsL( 

   156         const TDesC8& aData,

   157         RArray<TUid>& aArray );

   158 

   159     /**

   160      * Extracts plugin type from data.

   161      *

   162      * @param aData Plugin's opaque data.

   163      * @return Plugin type.

   164      */

   165     TUid ExtractPluginType( 

   166         const TDesC8& aData );

   167 

   168     /**

   169      * Extracts plugin flags from data.

   170      *

   171      * @param aData Plugin's opaque data.

   172      * @return Plugin feature flags.

   173      */

   174     TInt ExtractPluginFlags( 

   175         const TDesC8& aData );

   176 

   177 private:    // data

   178 

   179     /**

   180      * List of supported Uids.

   181      */

   182     RArray<TUid> iSupportedUids;

   183 

   184     /**

   185      * Plugin's display name.

   186      * Own.

   187      */

   188     HBufC* iPluginName;

   189 

   190     /**

   191      * Plugin's implementation Uid.

   192      */

   193     TUid iPluginUid;

   194 

   195     /**

   196      * Plugin's plugin type Uid.

   197      */

   198     TUid iPluginTypeUid;

   199 

   200     /**

   201      * Plugin feature flags.

   202      */

   203     TInt iFlags;

   204 

   205     /**

   206      * Plugin priority, TMPXViewPluginPriorities defined in mpxviewplugin.hrh.

   207      */

   208     TInt iPriority;

   209     };

   210 

   211 #endif  // CMPXVIEWPLUGININFO_H

   212 

   213 // End of File