Nokia N97 SDK
Example Applications Guide

clientimagecommander.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : clientimagecommander.h
00004 *  Part of     : Animation example
00005 *  Interface   :
00006 *  Description :
00007 *  Version     :
00008 *
00009 *  Copyright (c) 2004 - 2006 Nokia Corporation.
00010 *  This material, including documentation and any related
00011 *  computer programs, is protected by copyright controlled by
00012 *  Nokia Corporation.
00013 * ==============================================================================
00014 */
00015 
00016 #ifndef __CLIENTIMAGE_COMMANDER_H__
00017 #define __CLIENTIMAGE_COMMANDER_H__
00018 
00019 // INCLUDES
00020 #include <w32adll.h>
00021 
00022 // CLASS DECLARATION
00023 
00024 /**
00025 * RImageCommander
00026 * An instance of RImageCommander is an Animation Client Commander which
00027 * sends commands to the Animation Server
00028 */
00029 class RImageCommander : public RAnim
00030     {
00031     public: // Constructors
00032 
00033         /**
00034         * RImageCommander.
00035         * Construct an Animation Client object for Animation Client DLL aAnimDll
00036         * @param aAnimDll the Animation Client DLL to use
00037         */
00038         IMPORT_C RImageCommander( RAnimDll& aAnimDll );
00039 
00040         /**
00041         * ImageConstruct.
00042         * Complete Animation Client construction
00043         * @param aDevice the window device
00044         * @param aType KAnimationSquare implies "Construct a bouncing square"
00045         * @param aParams parameters to pass to the server side to tell it how to
00046         * construct or initialise itself.
00047         */
00048         IMPORT_C void ImageConstruct( const RWindowBase& aDevice, TInt aType,
00049                                                         const TDesC8& aParams );
00050 
00051     public: // New functions
00052 
00053         /**
00054         * ImageCommand.
00055         * Send aCommand to the Animation Server object;
00056         * aCommand == KAnimationReset implies "reset the animation".
00057         * Note! Because there is no way to return an error from the server side
00058         * using this method, it is important that any server side code for these
00059         * commands should not be able to fail or leave.
00060         * This command is also buffered and may not be performed immediately.
00061         * @param aCommand the enumerated code for the option selected
00062         */
00063         IMPORT_C void ImageCommand( TInt aCommand );
00064 
00065     public: // Enumerations
00066 
00067         /**
00068         * KAnimationTypes.
00069         * Constant used to indicate the animation of a bouncing square should
00070         * be created, enumeration can be expanded
00071         */
00072         enum KAnimationTypes
00073             {
00074             KAnimationSquare = 1
00075             };
00076 
00077         /**
00078         * KAnimationCommands.
00079         * Constant used to request a reset of the bouncing square,
00080         * enumeration can be expanded
00081         */
00082         enum KAnimationCommands
00083             {
00084             KAnimationReset  = 1,
00085             KResolutionChange = 2
00086             };
00087     };
00088 
00089 #endif // __CLIENTIMAGE_COMMANDER_H__
00090 
00091 // End of File

© Nokia 2009

Back to top