imagehandling_plat/thumbnailmanager_api/inc/thumbnaildata.h
changeset 0 2014ca87e772
equal deleted inserted replaced
-1:000000000000 0:2014ca87e772
       
     1 /*
       
     2 * Copyright (c) 2006-2007 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 object
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef THUMBNAILDATA_H
       
    20 #define THUMBNAILDATA_H
       
    21 
       
    22 #include <e32std.h>
       
    23 
       
    24 class CFbsBitmap;
       
    25 
       
    26 /**
       
    27  *  Thumbnail object.
       
    28  *
       
    29  *  @since S60 S60 v5.0
       
    30  */
       
    31 NONSHARABLE_CLASS( MThumbnailData )
       
    32     {
       
    33 public:
       
    34 
       
    35     /**
       
    36      * Get a pointer to a CFbsBitmap containing the thumbnail image. Ownership
       
    37      * of the object is not transferred (i.e. client must not delete the
       
    38      * pointer).
       
    39      *
       
    40      * @since S60 v5.0
       
    41      * @return Pointer to a bitmap representing the thumbnail or NULL if
       
    42      *         thumbnail pointer is not available or it has been detached.
       
    43      */
       
    44     virtual CFbsBitmap* Bitmap() = 0;
       
    45 
       
    46     /**
       
    47      * Get a pointer to a CFbsBitmap containing the thumbnail image. Ownership
       
    48      * of the object is transferred to the caller. Client must delete the
       
    49      * bitmap after it is done processing it.
       
    50      *
       
    51      * @since S60 v5.0
       
    52      * @return Pointer to a bitmap representing the thumbnail or NULL if
       
    53      *         thumbnail pointer is not available or it has been detached.
       
    54      *         Caller assumes ownership of the bitmap.
       
    55      */
       
    56     virtual CFbsBitmap* DetachBitmap() = 0;
       
    57 
       
    58     /**
       
    59      * Get client data structure.
       
    60      *
       
    61      * @since S60 v5.0
       
    62      * @return A pointer for client data specified as a parameter for
       
    63      *         GetThumbnailL() or NULL if not specified.
       
    64      */
       
    65     virtual TAny* ClientData() = 0;
       
    66 };
       
    67 
       
    68 #endif // THUMBNAILDATA_H