epoc32/include/app/mpbkthumbnailoperationobservers.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2002 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: 
    15 *      Phonebook asyncronous thumbnail operation observer interfaces.
    16 *
    17 */
    18 
    19 
    20 #ifndef __MPbkThumbnailOperationObservers_H__
    21 #define __MPbkThumbnailOperationObservers_H__
    22 
    23 //  INCLUDES
    24 #include <e32def.h>
    25 
    26 //  FORWARD DECLARATIONS
    27 class MPbkThumbnailOperation;
    28 class CFbsBitmap;
    29 class CPbkImageDataWithInfo;
    30 
    31 // CLASS DECLARATION
    32 
    33 /**
    34  * Observer interface for CPbkThumbnailManager get operation.
    35  * Only one of the event callbacks is called once by the operation.
    36  *
    37  * @see CPbkThumbnailManager::GetThumbnailAsyncL
    38  */
    39 class MPbkThumbnailGetObserver
    40     {
    41     public:
    42         /**
    43          * Called when thumbnail loading is completed.
    44          *
    45          * @param aOperation    The completed operation.
    46          * @param aBitmap       The loaded bitmap. Callee is responsible of 
    47          *                      the bitmap.
    48          */
    49         virtual void PbkThumbnailGetComplete
    50             (MPbkThumbnailOperation& aOperation, CFbsBitmap* aBitmap) =0;
    51 
    52         /**
    53          * Called if the thumbnail loading fails.
    54          *
    55          * @param aOperation    The failed operation.
    56          * @param aError        Error code of the failure.
    57          */
    58         virtual void PbkThumbnailGetFailed
    59             (MPbkThumbnailOperation& aOperation, TInt aError) =0;
    60     };
    61 
    62 
    63 /**
    64  * Observer interface for CPbkThumbnailManager get image operation.
    65  * Only one of the event callbacks is called once by the operation.
    66  *
    67  * @see CPbkThumbnailManager::GetThumbnailImageAsyncL
    68  */
    69 class MPbkThumbnailGetImageObserver
    70     {
    71     public:
    72         /**
    73          * Called when thumbnail loading is completed.
    74          *
    75          * @param aOperation    The completed operation.
    76          * @param aImageData    The thumbnail image. Caller is responsible
    77          *                      of the object.
    78          */
    79         virtual void PbkThumbnailGetImageComplete
    80             (MPbkThumbnailOperation& aOperation, CPbkImageDataWithInfo* aImageData) =0;
    81 
    82         /**
    83          * Called if the thumbnail loading fails.
    84          *
    85          * @param aOperation    The failed operation.
    86          * @param aError        Error code of the failure.
    87          */
    88         virtual void PbkThumbnailGetImageFailed
    89             (MPbkThumbnailOperation& aOperation, TInt aError) =0;
    90     };
    91 
    92 
    93 /**
    94  * Observer interface for CPbkThumbnailManager set operations.
    95  * Only one of the event callbacks is called once by the operation.
    96  *
    97  * @see CPbkThumbnailManager::SetThumbnailAsyncL
    98  */
    99 class MPbkThumbnailSetObserver
   100     {
   101     public:
   102         /**
   103          * Called when thumbnail setting is completed.
   104          *
   105          * @param aOperation    The completed operation.
   106          */
   107         virtual void PbkThumbnailSetComplete
   108             (MPbkThumbnailOperation& aOperation) =0;
   109 
   110         /**
   111          * Called if the thumbnail setting fails.
   112          *
   113          * @param aOperation    The failed operation.
   114          * @param aError        Error code of the failure.
   115          */
   116         virtual void PbkThumbnailSetFailed
   117             (MPbkThumbnailOperation& aOperation, TInt aError) =0;
   118     };
   119 
   120 #endif // __MPbkThumbnailOperationObservers_H__
   121 
   122 // End of File