symbian/include/sdlepocapi.h

   1 #ifndef EPOC_SDL_H
   2 #define EPOC_SDL_H
   3
   4 #include <e32std.h>
   5 #include <remconcoreapitargetobserver.h>
   6
   7 class CDesC8Array;
   8 class TWsEvent;
   9 class RWindow;
  10 class CAknAppUi;
  11 class RWsSession;
  12 class CWsScreenDevice;
  13 class CBitmapContext;
  14 class CFbsBitmap;
  15
  16 //internal stuff
  17 extern "C"
  18 {
  19         typedef int (*mainfunc1) ();
  20         typedef int (*mainfunc2) (int argc, char* argv[]);
  21         typedef int (*mainfunc3) (int argc, char* argv[], char* env[]);
  22         typedef void (*mainfunc4) ();
  23         typedef void (*mainfunc5) (int argc, char* argv[]);
  24         typedef void (*mainfunc6) (int argc, char* argv[], char* env[]);
  25 }
  26
  27 //internal stuff
  28 extern "C"
  29 {
  30         int SDL_main (int argc, char* argv[]);
  31 }
  32
  33 //internal stuff
  34 NONSHARABLE_CLASS(TMainFunc)
  35 {
  36         public:
  37                 IMPORT_C TMainFunc();
  38                 IMPORT_C TMainFunc(mainfunc1);
  39                 IMPORT_C TMainFunc(mainfunc2);
  40                 IMPORT_C TMainFunc(mainfunc3);
  41                 IMPORT_C TMainFunc(mainfunc4);
  42                 IMPORT_C TMainFunc(mainfunc5);
  43                 IMPORT_C TMainFunc(mainfunc6);
  44                 const void* operator[](TInt aIndex) const;
  45
  46         private:
  47                 void* iMainFunc[6];
  48 };
  49
  50 NONSHARABLE_CLASS(MSDLObserver)
  51 {
  52         public:
  53                 enum //these events indicates the state changes in SDL
  54                 {
  55                         EEventWindowReserved, //window is created, nothing else should use the window
  56                         EEventWindowNotAvailable, //window not available, can be ignored
  57                         EEventSuspend, //SDL thread will be stopped next
  58                         EEventResume, //SDL thread resumed
  59                         EEventKeyMapInit, //Keymap is inited and can now be rewritten
  60                         EEventMainExit,
  61                 };
  62                 enum  //these are fixed return values that event handler sends back to SDL
  63                 {
  64                         EParameterNone,
  65                         ESuspendNoSuspend                                  //after EEventSuspend, prevents the suspend.
  66                 };
  67                 virtual TInt SdlEvent(TInt aEvent, TInt aParam) = 0; //event is called in application thread
  68                 virtual TInt SdlThreadEvent(TInt aEvent, TInt aParam) = 0; //event is called in SDL thread
  69 };
  70
  71
  72 class CSDL : public CBase, public MRemConCoreApiTargetObserver
  73 {
  74         public:
  75                 enum TFlags //these flags set SDL modes
  76                 {
  77                         ENoFlags                        = 0x0,
  78                         EEnableFocusStop                = 0x1, //let SDL thread to be stopped if not on top
  79                         EOwnThread                      = 0x1000, //always put SDL running its own thread
  80                         EMainThread                     = 0x2000, //always put SDL in application thread
  81                 };
  82
  83                 IMPORT_C static CSDL* NewL(TInt aFlags = CSDL::ENoFlags);
  84                 IMPORT_C MSDLObserver* Observer(); //get current observer
  85                 IMPORT_C void SetObserver(MSDLObserver* aObserver);  //set observer to receive events, if NULL then observer is removed
  86                 IMPORT_C void SetContainerWindowL(RWindow& aWindow, RWsSession& aSession, CWsScreenDevice& aDevice); //the window where drawn happens, should be recalled (propably in application HandleResourceChange) if screen device changes
  87                 IMPORT_C ~CSDL();
  88                 IMPORT_C TInt AppendWsEvent(const TWsEvent& aEvent); //give event to SDL, return error code if event buffer is full (insert in application HandleWsEvent)
  89                 IMPORT_C TInt GetSDLCode(TInt aScanCode);                //get SDL internal key code bind to given scancode, return -1 if scancode is not found, aScancode must be postive number
  90                 IMPORT_C TInt SetSDLCode(TInt aScanCode, TInt aSDLCode); //set internal SDL code with given key code, return replaced code
  91                 IMPORT_C TInt SDLCodesCount() const; //return count of scancodes
  92                 IMPORT_C void ResetSDLCodes(); //rest all code replacement to their initial values
  93                 IMPORT_C void Resume(); //restart SDL main
  94                 IMPORT_C void Suspend(); //stop SDL main
  95                 IMPORT_C void SDLPanic(const TDesC& aInfo, TInt aErr); //Panic from SDL thread (see SDLThreadEvent)
  96                 IMPORT_C TThreadId CallMainL(const TMainFunc& aFunc, TRequestStatus* const aStatus, const CDesC8Array* const iArg, TInt aStackSize); //internal
  97                 IMPORT_C void Resize();
  98
  99                 void MrccatoCommand(TRemConCoreApiOperationId aOperationId, TRemConCoreApiButtonAction aButtonAct);
 100
 101         protected:
 102                 IMPORT_C CSDL();
 103 };
 104
 105 #endif