inc/FShell_AppWidgetContextBase.h

   1 //
   2 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Flora License, Version 1.1 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://floralicense.org/license/
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file        FShell_AppWidgetContextBase.h
  19  * @brief       This is the header file for the _AppWidgetContextBase class.
  20  *
  21  * This header file contains the declarations of the _AppWidgetContextBase class.
  22  */
  23
  24 #ifndef _FSHELL_INTERNAL_APPWIDGET_CONTEXT_BASE_H_
  25 #define _FSHELL_INTERNAL_APPWIDGET_CONTEXT_BASE_H_
  26
  27 #include <provider_buffer.h>
  28 #include <FAppTypes.h>
  29
  30 #define APPWIDGET_PROVIDER_ID_ENABLE true
  31
  32 namespace Tizen { namespace Base  { namespace Collection
  33 {
  34 class HashMap;
  35 }}}
  36
  37 namespace Tizen { namespace Shell  { namespace App
  38 {
  39
  40 class _AppWidgetContextBase
  41         : public Tizen::Base::Object
  42 {
  43 protected:
  44         enum _AppWidgetProviderState
  45         {
  46                 INVALID = 0,
  47                 RUNNING,
  48                 SUSPENDED,
  49         };
  50
  51 public:
  52         _AppWidgetContextBase(target_type type, const Tizen::Base::String& userInfo, const Tizen::Base::String& providerId, const Tizen::Base::String& instanceId, int width, int height, int priority);
  53         virtual ~_AppWidgetContextBase(void);
  54         virtual void OnPopupCreated(double x, double y, int width, int height) = 0;
  55         virtual void OnPopupDestoyed(void) = 0;
  56         virtual result SendTouchEvent(buffer_event event, double timestamp, double x, double y) = 0;
  57         void SetIpcClientId(int clientId);
  58         bool HasValidClientId(void) const;
  59         // for buffered appWidget
  60         int GetSharedMemId(int w, int h);
  61         result ReleaseSharedMem(void);
  62         void Suspend(void);
  63         Tizen::Base::String GetInstanceId(void) const;
  64         int GetWidth(void) const;
  65         int GetHeight(void) const;
  66         Tizen::Base::String GetProviderId(void) const;
  67         Tizen::Base::String GetAppId(void) const;
  68         int GetPriority(void) const;
  69         Tizen::Base::String GetProviderName(void) const;
  70
  71 protected:
  72         bool IsRunning(void) const;
  73         bool IsSharedMemCreated(void) const;
  74         virtual Tizen::Base::Collection::HashMap* CreateRequestArgsN(void) = 0;
  75         result SendRequestToApp(const Tizen::App::AppId& appId, const Tizen::Base::String& operation, Tizen::Base::Collection::HashMap* pArgs);
  76         void SetForeground(bool forground);
  77         bool IsForeground(void) const;
  78         Tizen::Base::String GetUserInfo(void) const;
  79         int GetClientId(void) const;
  80
  81         void SetWidth(int width);
  82         void SetHeight(int height);
  83
  84 private:
  85         target_type __type;
  86         Tizen::Base::String __userInfo;
  87         Tizen::Base::String __providerId;
  88         Tizen::Base::String __instanceId;
  89         int __width;
  90         int __height;
  91         int __priority;
  92         bool __isForeground;
  93         int __ipcClientId;
  94         Tizen::Base::String __appId;
  95         Tizen::Base::String __providerName;
  96         struct livebox_buffer *__buffer_info;
  97         void *__buffer;
  98         _AppWidgetProviderState __providerState;
  99
 100 };      // class _AppWidgetContextBase
 101
 102 class _AppWidgetRequestHelper
 103 {
 104 public:
 105         static result SendRequestToApp(const Tizen::App::AppId& appId, const Tizen::Base::String& operation, Tizen::Base::Collection::HashMap* pArgs);
 106 };      // class _AppWidgetRequestHelper
 107
 108 extern const wchar_t ARG_KEY_INSTANCE_ID[];
 109 extern const wchar_t ARG_KEY_PROVIDER_NAME[];
 110 extern const wchar_t ARG_KEY_USER_INFO[];
 111 extern const wchar_t ARG_KEY_X[];
 112 extern const wchar_t ARG_KEY_Y[];
 113 extern const wchar_t ARG_KEY_WIDTH[];
 114 extern const wchar_t ARG_KEY_HEIGHT[];
 115 extern const wchar_t ARG_KEY_POPUP_WIDTH[];
 116 extern const wchar_t ARG_KEY_POPUP_HEIGHT[];
 117 extern const wchar_t ARG_KEY_ARGUMENT[];
 118 extern const wchar_t ARG_KEY_EVENT_TYPE[];
 119 extern const wchar_t ARG_KEY_TIME_STAMP[];
 120
 121 }}}      // Tizen::Shell::App
 122
 123 #endif // _FSHELL_INTERNAL_APPWIDGET_CONTEXT_BASE_H_