photosgallery/collectionframework/thumbnailcreator/inc/mglxtnthumbnailcreatorclient.h
changeset 0 4e91876724a2
equal deleted inserted replaced
-1:000000000000 0:4e91876724a2
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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:    Thumbnail creator client interface
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 /**
       
    22  * @internal reviewed 30/07/2007 by Simon Brooks
       
    23  */
       
    24 
       
    25 #ifndef M_GLXTNTHUMBNAILCREATORCLIENT_H
       
    26 #define M_GLXTNTHUMBNAILCREATORCLIENT_H
       
    27 
       
    28 // INCLUDES
       
    29 
       
    30 #include <e32std.h>
       
    31 #include <glxthumbnailinfo.h>
       
    32 
       
    33 // FUNCTION PROTOTYPES
       
    34 
       
    35 class CGlxtnFileInfo;
       
    36 class MGlxtnThumbnailStorage;
       
    37 class TGlxMediaId;
       
    38 
       
    39 // CLASS DECLARATION
       
    40 
       
    41 /**
       
    42 *  Interface for clients of the TNC.
       
    43 *
       
    44 * @ingroup glx_thumbnail_creator
       
    45 */
       
    46 class MGlxtnThumbnailCreatorClient
       
    47     {
       
    48 public:
       
    49     /**
       
    50 	* Notifies that a thumbnail for a given item is available, or that
       
    51 	* thumbnail generation failed.
       
    52     * @param aItemId The item for which the thumbnail was required.
       
    53     * @param aQuality quality of the thumbnail
       
    54     * @param aErrorCode KErrNone if successful, otherwise an error code.
       
    55     */
       
    56     virtual void ThumbnailFetchComplete(const TGlxMediaId& aItemId,
       
    57                         TGlxThumbnailQuality aQuality, TInt aErrorCode) = 0;
       
    58     /**
       
    59 	* Notifies that deletion of thumbnails for a given item is complete, or
       
    60 	* the operation failed.
       
    61     * @param aItemId The item whose thumbnails were deleted.
       
    62     * @param aErrorCode KErrNone if successful, otherwise an error code.
       
    63     */
       
    64     virtual void ThumbnailDeletionComplete(const TGlxMediaId& aItemId,
       
    65                                             TInt aErrorCode) = 0;
       
    66     /**
       
    67 	* Notifies that filtering items with available thumbnails from a list is
       
    68 	* complete, or the operation failed.
       
    69     * @param aIdArray Array of IDs of items which don't have a thumbnail
       
    70     *           available.
       
    71     * @param aErrorCode KErrNone if successful, otherwise an error code.
       
    72     */
       
    73     virtual void FilterAvailableComplete(const RArray<TGlxMediaId>& aIdArray,
       
    74                                             TInt aErrorCode) = 0;
       
    75     /**
       
    76     * Called by a task to request file information for an item.  The
       
    77     * information is returned asynchronously.
       
    78     * @param aInfo Buffer to hold the information.
       
    79     * @param aItemId The item for which the URI is required.
       
    80     * @param aStatus Request status for the asynchronous operation.
       
    81     */
       
    82     virtual void FetchFileInfoL(CGlxtnFileInfo* aInfo,
       
    83                     const TGlxMediaId& aItemId, TRequestStatus* aStatus) = 0;
       
    84     /**
       
    85     * Cancel the request for an URI.
       
    86     * @param aItemId The item for which the URI was required.
       
    87     */
       
    88     virtual void CancelFetchUri(const TGlxMediaId& aItemId) = 0;
       
    89     /**
       
    90     * Get the thumbnail storage used by this client.
       
    91     * @return Pointer to the storage.
       
    92     */
       
    93     virtual MGlxtnThumbnailStorage* ThumbnailStorage() = 0;
       
    94     };
       
    95 
       
    96 #endif  // M_GLXTNTHUMBNAILCREATORCLIENT_H
       
    97 
       
    98 // End of File