epoc32/include/app/mpbkthumbnailoperationobservers.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/app/mpbkthumbnailoperationobservers.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/app/mpbkthumbnailoperationobservers.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,122 @@
     1.4 -mpbkthumbnailoperationobservers.h
     1.5 +/*
     1.6 +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description: 
    1.19 +*      Phonebook asyncronous thumbnail operation observer interfaces.
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +#ifndef __MPbkThumbnailOperationObservers_H__
    1.25 +#define __MPbkThumbnailOperationObservers_H__
    1.26 +
    1.27 +//  INCLUDES
    1.28 +#include <e32def.h>
    1.29 +
    1.30 +//  FORWARD DECLARATIONS
    1.31 +class MPbkThumbnailOperation;
    1.32 +class CFbsBitmap;
    1.33 +class CPbkImageDataWithInfo;
    1.34 +
    1.35 +// CLASS DECLARATION
    1.36 +
    1.37 +/**
    1.38 + * Observer interface for CPbkThumbnailManager get operation.
    1.39 + * Only one of the event callbacks is called once by the operation.
    1.40 + *
    1.41 + * @see CPbkThumbnailManager::GetThumbnailAsyncL
    1.42 + */
    1.43 +class MPbkThumbnailGetObserver
    1.44 +    {
    1.45 +    public:
    1.46 +        /**
    1.47 +         * Called when thumbnail loading is completed.
    1.48 +         *
    1.49 +         * @param aOperation    The completed operation.
    1.50 +         * @param aBitmap       The loaded bitmap. Callee is responsible of 
    1.51 +         *                      the bitmap.
    1.52 +         */
    1.53 +        virtual void PbkThumbnailGetComplete
    1.54 +            (MPbkThumbnailOperation& aOperation, CFbsBitmap* aBitmap) =0;
    1.55 +
    1.56 +        /**
    1.57 +         * Called if the thumbnail loading fails.
    1.58 +         *
    1.59 +         * @param aOperation    The failed operation.
    1.60 +         * @param aError        Error code of the failure.
    1.61 +         */
    1.62 +        virtual void PbkThumbnailGetFailed
    1.63 +            (MPbkThumbnailOperation& aOperation, TInt aError) =0;
    1.64 +    };
    1.65 +
    1.66 +
    1.67 +/**
    1.68 + * Observer interface for CPbkThumbnailManager get image operation.
    1.69 + * Only one of the event callbacks is called once by the operation.
    1.70 + *
    1.71 + * @see CPbkThumbnailManager::GetThumbnailImageAsyncL
    1.72 + */
    1.73 +class MPbkThumbnailGetImageObserver
    1.74 +    {
    1.75 +    public:
    1.76 +        /**
    1.77 +         * Called when thumbnail loading is completed.
    1.78 +         *
    1.79 +         * @param aOperation    The completed operation.
    1.80 +         * @param aImageData    The thumbnail image. Caller is responsible
    1.81 +         *                      of the object.
    1.82 +         */
    1.83 +        virtual void PbkThumbnailGetImageComplete
    1.84 +            (MPbkThumbnailOperation& aOperation, CPbkImageDataWithInfo* aImageData) =0;
    1.85 +
    1.86 +        /**
    1.87 +         * Called if the thumbnail loading fails.
    1.88 +         *
    1.89 +         * @param aOperation    The failed operation.
    1.90 +         * @param aError        Error code of the failure.
    1.91 +         */
    1.92 +        virtual void PbkThumbnailGetImageFailed
    1.93 +            (MPbkThumbnailOperation& aOperation, TInt aError) =0;
    1.94 +    };
    1.95 +
    1.96 +
    1.97 +/**
    1.98 + * Observer interface for CPbkThumbnailManager set operations.
    1.99 + * Only one of the event callbacks is called once by the operation.
   1.100 + *
   1.101 + * @see CPbkThumbnailManager::SetThumbnailAsyncL
   1.102 + */
   1.103 +class MPbkThumbnailSetObserver
   1.104 +    {
   1.105 +    public:
   1.106 +        /**
   1.107 +         * Called when thumbnail setting is completed.
   1.108 +         *
   1.109 +         * @param aOperation    The completed operation.
   1.110 +         */
   1.111 +        virtual void PbkThumbnailSetComplete
   1.112 +            (MPbkThumbnailOperation& aOperation) =0;
   1.113 +
   1.114 +        /**
   1.115 +         * Called if the thumbnail setting fails.
   1.116 +         *
   1.117 +         * @param aOperation    The failed operation.
   1.118 +         * @param aError        Error code of the failure.
   1.119 +         */
   1.120 +        virtual void PbkThumbnailSetFailed
   1.121 +            (MPbkThumbnailOperation& aOperation, TInt aError) =0;
   1.122 +    };
   1.123 +
   1.124 +#endif // __MPbkThumbnailOperationObservers_H__
   1.125 +
   1.126 +// End of File