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