Nokia N97 SDK
Example Applications Guide

RImageCommander Class Reference

#include <clientimagecommander.h>

Inheritance diagram for RImageCommander:

List of all members.

Detailed Description

RImageCommander An instance of RImageCommander is an Animation Client Commander which sends commands to the Animation Server

Definition at line 29 of file clientimagecommander.h.


Public Types

enum   KAnimationTypes { KAnimationSquare = 1 }
enum   KAnimationCommands { KAnimationReset = 1, KResolutionChange = 2 }

Public Member Functions

IMPORT_C  RImageCommander (RAnimDll &aAnimDll)
IMPORT_C void  ImageConstruct (const RWindowBase &aDevice, TInt aType, const TDesC8 &aParams)
IMPORT_C void  ImageCommand (TInt aCommand)


Member Enumeration Documentation

enum RImageCommander::KAnimationTypes
 

KAnimationTypes. Constant used to indicate the animation of a bouncing square should be created, enumeration can be expanded

Definition at line 72 of file clientimagecommander.h.

00073             {
00074             KAnimationSquare = 1
00075             };

enum RImageCommander::KAnimationCommands
 

KAnimationCommands. Constant used to request a reset of the bouncing square, enumeration can be expanded

Definition at line 82 of file clientimagecommander.h.

00083             {
00084             KAnimationReset  = 1,
00085             KResolutionChange = 2
00086             };


Constructor & Destructor Documentation

EXPORT_C RImageCommander::RImageCommander (  RAnimDll &  aAnimDll  ) 
 

RImageCommander. Construct an Animation Client object for Animation Client DLL aAnimDll

Parameters:
aAnimDll  the Animation Client DLL to use

Definition at line 26 of file clientimagecommander.cpp.

00026                                                               :
00027                                                               RAnim( aAnimDll )
00028     {
00029     // No implementation required
00030     }


Member Function Documentation

EXPORT_C void RImageCommander::ImageConstruct (  const RWindowBase &  aDevice,
TInt  aType,
const TDesC8 &  aParams
) 
 

ImageConstruct. Complete Animation Client construction

Parameters:
aDevice  the window device
aType  KAnimationSquare implies "Construct a bouncing square"
aParams  parameters to pass to the server side to tell it how to construct or initialise itself.

Definition at line 37 of file clientimagecommander.cpp.

Referenced by CAnimationAppUi::SetupImageCommanderL().

00039     {
00040     // Send the parameters to the animation server object construction
00041     RAnim::Construct( aDevice, aType, aParams );
00042     }

EXPORT_C void RImageCommander::ImageCommand (  TInt  aCommand  ) 
 

ImageCommand. Send aCommand to the Animation Server object; aCommand == KAnimationReset implies "reset the animation". Note! Because there is no way to return an error from the server side using this method, it is important that any server side code for these commands should not be able to fail or leave. This command is also buffered and may not be performed immediately.

Parameters:
aCommand  the enumerated code for the option selected

Definition at line 53 of file clientimagecommander.cpp.

Referenced by CAnimationAppUi::HandleCommandL(), and CAnimationAppUi::HandleResourceChangeL().

00054     {
00055     // Could optionally decode the commands here
00056     RAnim::Command( aCommand );
00057     }


The documentation for this class was generated from the following files:

© Nokia 2009

Back to top