inc/FAppTypes.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (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://www.apache.org/licenses/LICENSE-2.0
   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                FAppTypes.h
  19  * @brief               This is the header file for the enumerations of the %App class.
  20  *
  21  * This header file contains the declarations of the enumerations of the App class.
  22  */
  23
  24 #ifndef _FAPP_TYPES_H_
  25 #define _FAPP_TYPES_H_
  26
  27 #include <FBaseString.h>
  28
  29 namespace Tizen { namespace App
  30 {
  31
  32 /**
  33  * The package ID
  34  *
  35  * @since       2.0
  36  */
  37 typedef Tizen::Base::String PackageId;
  38
  39 /**
  40  * The application ID
  41  *
  42  * @since       2.0
  43  */
  44 typedef Tizen::Base::String AppId;
  45
  46 /**
  47  * @if OSPDEPREC
  48  * The application secret
  49  * @brief               <i> [Deprecated] </i>
  50  * @deprecated  This type is deprecated because the associated App::GetAppSecret() method is deprecated.
  51  *
  52  * @since               2.0
  53  * @endif
  54  */
  55 typedef Tizen::Base::String AppSecret;
  56
  57 /**
  58  * @enum        AppState
  59  * Defines the various states of an application's life cycle.
  60  *
  61  * @since       2.0
  62  */
  63 enum AppState
  64 {
  65         INITIALIZING,   /**< The application has been launched */
  66         RUNNING,        /**< The application has been initialized and is currently being executed */
  67         TERMINATING,    /**< The application is about to exit, release its resources, and save its preferences */
  68         TERMINATED      /**< The application has been destroyed */
  69 };
  70
  71 /**
  72  * @enum        AppUiState
  73  * Defines the UI state of an application.
  74  *
  75  * @since               2.0
  76  */
  77 enum AppUiState
  78 {
  79         APP_UI_STATE_FOREGROUND = 0x01,             /**< The application is completely visible in the foreground */
  80         APP_UI_STATE_PARTIAL_BACKGROUND = 0x02,     /**< The application is partially hidden by another window, such as a system pop-up */
  81         APP_UI_STATE_BACKGROUND = 0x04              /**< The application is completely hidden by a full-screen window, usually by another application, or an application control */
  82 };
  83
  84 /**
  85  * @enum        AppCtrlResult
  86  * Defines the application control result.
  87  *
  88  * @since       2.0
  89  */
  90 enum AppCtrlResult
  91 {
  92         APP_CTRL_RESULT_SUCCEEDED = 0x00,       /**< The application operation is successful */
  93         APP_CTRL_RESULT_FAILED = 0x01,          /**< The application operation has failed */
  94         APP_CTRL_RESULT_CANCELED = 0x02,        /**< The application operation is cancelled by the calling application */
  95         APP_CTRL_RESULT_TERMINATED = 0x04,      /**< The calling application is terminated without sending the result */
  96         APP_CTRL_RESULT_ABORTED = 0x08,         /**< The application operation is aborted by the platform */
  97 };
  98
  99 /**
 100  * @if OSPDEPREC
 101  * The application launch request ID. @n
 102  * Represents the application launch arguments in the App::App::OnUserEventReceivedN() method.
 103  *
 104  * @brief       <i> [Deprecated] </i>
 105  * @deprecated  This variable is deprecated. From Tizen API version 2.1, the App::App::OnUserEventReceivedN()
 106  *                              method is not invoked for the request from the application and the %AppLaunchRequestId() method is not used anymore.
 107  *                              Instead, use IAppControlProviderEventListener.
 108  * @since               2.0
 109  *
 110  * @endif
 111  */
 112 const long AppLaunchRequestId = (-0xFFFF);
 113
 114 /**
 115  * @if OSPDEPREC
 116  * Defines the launch type, for example, normal launch.
 117  *
 118  * @brief               <i> [Deprecated] </i>
 119  * @deprecated  This variable is provided only for backward compatibility and will be deleted in the near future.
 120  *                              Instead of using this variable, it is recommended to use IAppControlProviderEventListener to acquire the launch information.
 121  * @since               2.0
 122  * @endif
 123  */
 124 _OSP_EXPORT_ extern const Tizen::Base::String APP_LAUNCH_NORMAL;
 125
 126 /**
 127  * @if OSPDEPREC
 128  * Defines the launch type, for example, conditional launch.
 129  *
 130  * @brief       <i> [Deprecated] </i>
 131  * @deprecated  This variable is provided only for backward compatibility and will be deleted in the near future.
 132  *                              Instead of using this variable, it is recommended to use IAppLaunchConditionEventListener to acquire the conditional launch information.
 133  * @since       2.0
 134  * @endif
 135  */
 136 _OSP_EXPORT_ extern const Tizen::Base::String APP_LAUNCH_CONDITIONAL;
 137
 138 }} // Tizen::App
 139
 140 #endif // _FAPP_TYPES_H_