ui/uiengine/drmutility/inc/glxdrmutility.h
changeset 49 f291796e213d
parent 23 74c9f037fd5d
equal deleted inserted replaced
48:d0b4e67b3a60 49:f291796e213d
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    13 *
    13 *
    14 * Description:   DRM utility implementation
    14 * Description:    DRM utility implementation
    15 *
    15 *
    16 */
    16 */
    17 
    17 
    18 
    18 
    19 
    19 
    26 #define C_GLXDRMUTILITY_H
    26 #define C_GLXDRMUTILITY_H
    27 
    27 
    28 // INCLUDES
    28 // INCLUDES
    29 
    29 
    30 #include <e32base.h>
    30 #include <e32base.h>
    31 
    31 #include <f32file.h>
    32 // FORWARD DECLARATIONS
    32 // FORWARD DECLARATIONS
    33 
    33 
    34 class CDRMHelper;
    34 class CDRMHelper;
    35 
    35 
    36 namespace ContentAccess
    36 namespace ContentAccess
    80      */
    80      */
    81     ~CGlxDRMUtility();
    81     ~CGlxDRMUtility();
    82 
    82 
    83     /**
    83     /**
    84      * Check whether DRM rights are valid for specified item
    84      * Check whether DRM rights are valid for specified item
    85      *
    85      * is called before right is consumed and for all items (focused or unfocused).
    86      * @param aUri URI of the media item.
    86      * 
    87      * @param aCheckViewRights, check view rights if true, play if false
    87      * @param aUri URI of the media item.
    88      * @return ETrue if valid rights exist for the media item.
    88      * @param aCheckViewRights, check view rights if true, play if false
    89      */
    89      * @return ETrue if valid rights exist for the media item.
    90     IMPORT_C TBool CheckOpenRightsL(const TDesC& aUri, TBool aCheckViewRights);
    90      */
       
    91     IMPORT_C TBool ItemRightsValidityCheckL(const TDesC& aUri, TBool aCheckViewRights);
       
    92     
       
    93     /**
       
    94      * Check whether DRM rights are valid for specified item
       
    95      * is called before right is consumed and for all items (focused or unfocused).
       
    96      * 
       
    97      * @param filehandle of the media item.
       
    98      * @param aCheckViewRights, check view rights if true, play if false
       
    99      * @return ETrue if valid rights exist for the media item.
       
   100      */
       
   101     IMPORT_C TBool ItemRightsValidityCheckL(RFile& aFileHandle, TBool aCheckViewRights);
    91 
   102 
    92     /**
   103     /**
    93      * Check whether DRM rights are valid for specified item
   104      * Check whether DRM rights are valid for specified item
    94      * If the rights were just consumed, then allow to display
   105      * If the rights were just consumed, then allow to display
    95      * Otherwise, obtain current rights
   106      * Otherwise, obtain current rights
    96      *
   107      * is called after right is consumed and for only focused/displayed item.
    97      * @param aUri URI of the media item.
   108      * 
    98      * @param aCheckViewRights, check view rights if true, play if false
   109      * @param aUri URI of the media item.
    99      * @return ETrue if valid rights exist for the media item.
   110      * @param aCheckViewRights, check view rights if true, play if false
   100      */
   111      * @return ETrue if valid rights exist for the media item.
   101     IMPORT_C TBool CheckDisplayRightsL(const TDesC& aUri, TBool aCheckViewRights);
   112      */
       
   113     IMPORT_C TBool DisplayItemRightsCheckL(const TDesC& aUri, TBool aCheckViewRights);
       
   114     
       
   115     /**
       
   116      * Check whether DRM rights are valid for specified item
       
   117      * If the rights were just consumed, then allow to display
       
   118      * Otherwise, obtain current rights
       
   119      * is called after right is consumed and for only focused/displayed item.
       
   120      * 
       
   121      * @param filehandle of the media item.
       
   122      * @param aCheckViewRights, check view rights if true, play if false
       
   123      * @return ETrue if valid rights exist for the media item.
       
   124      */
       
   125     IMPORT_C TBool DisplayItemRightsCheckL(RFile& aFileHandle, TBool aCheckViewRights);
   102     
   126     
   103     /**
   127     /**
   104       * Consume rights for specified item
   128       * Consume rights for specified item
   105       * Caches item so that a client has right to display the item
   129       * Caches item so that a client has right to display the item
   106       *
   130       *
   107       * @param aUri URI for item
   131       * @param aUri URI for item
   108       * @return ETrue to no error in rights consumption
   132       * @return ETrue to no error in rights consumption
   109       */
   133       */
   110     IMPORT_C TBool ConsumeRightsL(const TDesC& aUri);
   134     IMPORT_C TBool ConsumeRightsL(const TDesC& aUri);
   111     
   135     
   112     
   136     /**
       
   137       * Consume rights for specified item
       
   138       * Caches item so that a client has right to display the item
       
   139       *
       
   140       * @param  Filehandle for item
       
   141       * @return ETrue to no error in rights consumption
       
   142       */
       
   143     IMPORT_C TBool ConsumeRightsL(RFile& aFileHandle);
       
   144 
       
   145     /**
       
   146      * Clears Last Consumed Uri
       
   147      */
       
   148     IMPORT_C void ClearLastConsumedItemUriL();
   113 
   149 
   114     /**
   150     /**
   115      * Test whether a media item is OMA DRM 2.0 protected and has an associated
   151      * Test whether a media item is OMA DRM 2.0 protected and has an associated
   116      * info URL.
   152      * info URL.
   117      * @param aUri URI of the media item.
   153      * @param aUri URI of the media item.
   118      * @return ETrue if it does.
   154      * @return ETrue if it does.
   119      */
   155      */
   120     IMPORT_C TBool CanShowInfoOnlineL(TDesC& aUri);
   156     IMPORT_C TBool CanShowInfoOnlineL(const TDesC& aUri);
   121 
   157 
   122     /**
   158     /**
   123      * Open the associated info URL for a media item in the browser.
   159      * Open the associated info URL for a media item in the browser.
   124      * @param aUri URI of the media item.
   160      * @param aUri URI of the media item.
   125      */
   161      */
   126     IMPORT_C void ShowInfoOnlineL(TDesC& aUri);
   162     IMPORT_C void ShowInfoOnlineL(const TDesC& aUri);
   127 
   163 
   128     /**
   164     /**
   129      * Test whether a media item can be set as automated content.     *
   165      * Test whether a media item can be set as automated content.     *
   130      * @param aUri URI of the media item.
   166      * @param aUri URI of the media item.
   131      * @param aType Automated content type, eg. wallpaper.
   167      * @param aType Automated content type, eg. wallpaper.
   145      * @param aUri URI of the media item.
   181      * @param aUri URI of the media item.
   146      */
   182      */
   147     IMPORT_C void ShowDRMDetailsPaneL(const TDesC& aUri);
   183     IMPORT_C void ShowDRMDetailsPaneL(const TDesC& aUri);
   148     
   184     
   149     /**
   185     /**
       
   186      * Show DRM details for specified item.
       
   187      * @param Filehandle of the media item.
       
   188      */
       
   189     IMPORT_C void ShowDRMDetailsPaneL(RFile& aFileHandle);
       
   190     
       
   191     /**
   150       * Ask DRM manager if file is forward locked
   192       * Ask DRM manager if file is forward locked
   151       */
   193       */
   152     IMPORT_C TBool IsForwardLockedL(const TDesC& aUri);
   194     IMPORT_C TBool IsForwardLockedL(const TDesC& aUri);
   153     
   195     
   154     /**
   196     /**
   155       * Show rights info
   197       * Show rights info
   156       * @param aUri URI of the media item.
   198       * @param aUri URI of the media item.
   157       */
   199       */
   158     IMPORT_C void ShowRightsInfoL(const TDesC& aUri);
   200     IMPORT_C void ShowRightsInfoL(const TDesC& aUri);
       
   201     
       
   202     /**
       
   203       * Show rights info
       
   204       * @param filehandle of the media item.
       
   205       */
       
   206     IMPORT_C void ShowRightsInfoL(RFile& aFileHandle);
   159     
   207     
   160     /**
   208     /**
   161       * Get size of thumbnail to be requested for DRM invalid item
   209       * Get size of thumbnail to be requested for DRM invalid item
   162       * @param aSize size of image
   210       * @param aSize size of image
   163       * @return suggested thumbnail size (1/4 of original size)
   211       * @return suggested thumbnail size (1/4 of original size)