epoc32/include/mw/akniconobserver.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:   CFbsBitmap change observer
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef AKN_ICON_OBSERVER_H
williamr@2
    20
#define AKN_ICON_OBSERVER_H
williamr@2
    21
williamr@2
    22
// INCLUDES
williamr@2
    23
williamr@2
    24
// CONSTANTS
williamr@2
    25
williamr@2
    26
// FORWARD DECLARATIONS
williamr@2
    27
class CFbsBitmap;
williamr@2
    28
williamr@2
    29
// FUNCTION PROTOTYPES
williamr@2
    30
williamr@2
    31
williamr@2
    32
// CLASS DECLARATION
williamr@2
    33
williamr@2
    34
/**
williamr@2
    35
* MAknIconObserver.
williamr@2
    36
*/
williamr@2
    37
class MAknIconObserver
williamr@2
    38
    {
williamr@2
    39
public:
williamr@2
    40
williamr@2
    41
    /**
williamr@2
    42
    * This is an abstract class for specifying an interface for 
williamr@2
    43
    * receiving notifications when an icon's frame buffer has been updated.
williamr@2
    44
    * An object of derived class implementing this interface should be registered
williamr@2
    45
    * for a given icon to the AknIcon framework using 
williamr@2
    46
    * function AknIconUtils::SetObserver().
williamr@2
    47
    * 
williamr@2
    48
    * AknIcon framework calls this function whenever the frame buffer of the observed icon
williamr@2
    49
    * changes. This observer mechanism is mainly useful in animated icons cases.
williamr@2
    50
    * The observer e.g. can redraw the icon on the screen when the frame of the animated 
williamr@2
    51
    * icon has changed.
williamr@2
    52
    *
williamr@2
    53
    * @since 2.8
williamr@2
    54
    * @param aBitmap bitmap or mask of the icon
williamr@2
    55
    */
williamr@2
    56
    virtual void BitmapChanged(CFbsBitmap *aBitmap)=0;
williamr@2
    57
    };
williamr@2
    58
    
williamr@2
    59
/*
williamr@2
    60
*
williamr@2
    61
* This class is internal and not intended for use.
williamr@2
    62
*
williamr@2
    63
*/
williamr@2
    64
class MAknIconChangeObserver
williamr@2
    65
    {
williamr@2
    66
public:
williamr@2
    67
    virtual void BitmapChanged()=0;
williamr@2
    68
    };
williamr@2
    69
    
williamr@2
    70
#endif // AKN_ICON_OBSERVER_H
williamr@2
    71
williamr@2
    72
// End of File