epoc32/include/app/mpbkthumbnailoperationobservers.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*      Phonebook asyncronous thumbnail operation observer interfaces.
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef __MPbkThumbnailOperationObservers_H__
williamr@2
    21
#define __MPbkThumbnailOperationObservers_H__
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <e32def.h>
williamr@2
    25
williamr@2
    26
//  FORWARD DECLARATIONS
williamr@2
    27
class MPbkThumbnailOperation;
williamr@2
    28
class CFbsBitmap;
williamr@2
    29
class CPbkImageDataWithInfo;
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
 * Observer interface for CPbkThumbnailManager get operation.
williamr@2
    35
 * Only one of the event callbacks is called once by the operation.
williamr@2
    36
 *
williamr@2
    37
 * @see CPbkThumbnailManager::GetThumbnailAsyncL
williamr@2
    38
 */
williamr@2
    39
class MPbkThumbnailGetObserver
williamr@2
    40
    {
williamr@2
    41
    public:
williamr@2
    42
        /**
williamr@2
    43
         * Called when thumbnail loading is completed.
williamr@2
    44
         *
williamr@2
    45
         * @param aOperation    The completed operation.
williamr@2
    46
         * @param aBitmap       The loaded bitmap. Callee is responsible of 
williamr@2
    47
         *                      the bitmap.
williamr@2
    48
         */
williamr@2
    49
        virtual void PbkThumbnailGetComplete
williamr@2
    50
            (MPbkThumbnailOperation& aOperation, CFbsBitmap* aBitmap) =0;
williamr@2
    51
williamr@2
    52
        /**
williamr@2
    53
         * Called if the thumbnail loading fails.
williamr@2
    54
         *
williamr@2
    55
         * @param aOperation    The failed operation.
williamr@2
    56
         * @param aError        Error code of the failure.
williamr@2
    57
         */
williamr@2
    58
        virtual void PbkThumbnailGetFailed
williamr@2
    59
            (MPbkThumbnailOperation& aOperation, TInt aError) =0;
williamr@2
    60
    };
williamr@2
    61
williamr@2
    62
williamr@2
    63
/**
williamr@2
    64
 * Observer interface for CPbkThumbnailManager get image operation.
williamr@2
    65
 * Only one of the event callbacks is called once by the operation.
williamr@2
    66
 *
williamr@2
    67
 * @see CPbkThumbnailManager::GetThumbnailImageAsyncL
williamr@2
    68
 */
williamr@2
    69
class MPbkThumbnailGetImageObserver
williamr@2
    70
    {
williamr@2
    71
    public:
williamr@2
    72
        /**
williamr@2
    73
         * Called when thumbnail loading is completed.
williamr@2
    74
         *
williamr@2
    75
         * @param aOperation    The completed operation.
williamr@2
    76
         * @param aImageData    The thumbnail image. Caller is responsible
williamr@2
    77
         *                      of the object.
williamr@2
    78
         */
williamr@2
    79
        virtual void PbkThumbnailGetImageComplete
williamr@2
    80
            (MPbkThumbnailOperation& aOperation, CPbkImageDataWithInfo* aImageData) =0;
williamr@2
    81
williamr@2
    82
        /**
williamr@2
    83
         * Called if the thumbnail loading fails.
williamr@2
    84
         *
williamr@2
    85
         * @param aOperation    The failed operation.
williamr@2
    86
         * @param aError        Error code of the failure.
williamr@2
    87
         */
williamr@2
    88
        virtual void PbkThumbnailGetImageFailed
williamr@2
    89
            (MPbkThumbnailOperation& aOperation, TInt aError) =0;
williamr@2
    90
    };
williamr@2
    91
williamr@2
    92
williamr@2
    93
/**
williamr@2
    94
 * Observer interface for CPbkThumbnailManager set operations.
williamr@2
    95
 * Only one of the event callbacks is called once by the operation.
williamr@2
    96
 *
williamr@2
    97
 * @see CPbkThumbnailManager::SetThumbnailAsyncL
williamr@2
    98
 */
williamr@2
    99
class MPbkThumbnailSetObserver
williamr@2
   100
    {
williamr@2
   101
    public:
williamr@2
   102
        /**
williamr@2
   103
         * Called when thumbnail setting is completed.
williamr@2
   104
         *
williamr@2
   105
         * @param aOperation    The completed operation.
williamr@2
   106
         */
williamr@2
   107
        virtual void PbkThumbnailSetComplete
williamr@2
   108
            (MPbkThumbnailOperation& aOperation) =0;
williamr@2
   109
williamr@2
   110
        /**
williamr@2
   111
         * Called if the thumbnail setting fails.
williamr@2
   112
         *
williamr@2
   113
         * @param aOperation    The failed operation.
williamr@2
   114
         * @param aError        Error code of the failure.
williamr@2
   115
         */
williamr@2
   116
        virtual void PbkThumbnailSetFailed
williamr@2
   117
            (MPbkThumbnailOperation& aOperation, TInt aError) =0;
williamr@2
   118
    };
williamr@2
   119
williamr@2
   120
#endif // __MPbkThumbnailOperationObservers_H__
williamr@2
   121
williamr@2
   122
// End of File