adaptors/public-api/adaptor-framework/application.h

   1 #ifndef __DALI_APPLICATION_H__
   2 #define __DALI_APPLICATION_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23 #include <dali/public-api/common/view-mode.h>
  24 #include <dali/public-api/object/base-handle.h>
  25 #include <dali/public-api/signals/callback.h>
  26
  27
  28 // INTERNAL INCLUDES
  29 #include "application-configuration.h"
  30 #include "window.h"
  31
  32 namespace Dali
  33 {
  34 /**
  35  * @addtogroup dali_adaptor_framework
  36  * @{
  37  */
  38
  39 namespace Internal DALI_INTERNAL
  40 {
  41 namespace Adaptor
  42 {
  43 class Application;
  44 }
  45 }
  46 /**
  47  * @brief An Application class object should be created by every application
  48  * that wishes to use Dali.
  49  *
  50  * It provides a means for initialising the
  51  * resources required by the Dali::Core.
  52  *
  53  * The Application class emits several signals which the user can
  54  * connect to.  The user should not create any Dali objects in the main
  55  * function and instead should connect to the Init signal of the
  56  * Application and create the Dali objects in the connected callback.
  57  *
  58  * Applications should follow the example below:
  59  *
  60  * @code
  61  * class ExampleController: public ConnectionTracker
  62  * {
  63  * public:
  64  *   ExampleController( Application& application )
  65  *   : mApplication( application )
  66  *   {
  67  *     mApplication.InitSignal().Connect( this, &ExampleController::Create );
  68  *   }
  69  *
  70  *   void Create( Application& application )
  71  *   {
  72  *     // Create Dali components...
  73  *   }
  74  *  ...
  75  * private:
  76  *   Application& mApplication;
  77  * };
  78  *
  79  * int main (int argc, char **argv)
  80  * {
  81  *   Application app = Application::New(&argc, &argv);
  82  *   ExampleController example( app );
  83  *   app.MainLoop();
  84  * }
  85  * @endcode
  86  *
  87  * If required, you can also connect class member functions to a signal:
  88  *
  89  * @code
  90  * MyApplication app;
  91  * app.ResumeSignal().Connect(&app, &MyApplication::Resume);
  92  * @endcode
  93  *
  94  * This class accepts command line arguments as well. The following options are supported:
  95  *
  96  * @code
  97  *     --no-vsync       Disable VSync on Render
  98  *  -w|--width          Stage Width
  99  *  -h|--height         Stage Height
 100  *  -d|--dpi            Emulated DPI
 101  *     --help           Help
 102  * @endcode
 103  *
 104  * When the above options are found, they are stripped from argv, and argc is updated appropriately.
 105  * @SINCE_1_0.0
 106  */
 107 class DALI_IMPORT_API Application : public BaseHandle
 108 {
 109 public:
 110
 111   typedef Signal< void (Application&) > AppSignalType;  ///< Application lifecycle signal and system signal callback type @SINCE_1_0.0
 112   typedef Signal< void (Application&, void *) > AppControlSignalType; ///< Application control signal callback type @SINCE_1_0.0
 113
 114   /**
 115    * @brief Decides whether a Dali application window is opaque or transparent.
 116    * @SINCE_1_0.0
 117    */
 118   enum WINDOW_MODE
 119   {
 120     OPAQUE = 0,       ///< The window will be opaque @SINCE_1_0.0
 121     TRANSPARENT = 1   ///< The window transparency will match the alpha value set in Dali::Stage::SetBackgroundcolor() @SINCE_1_0.0
 122   };
 123
 124 public:
 125
 126   /**
 127    * @brief This is the constructor for applications without an argument list.
 128    * @SINCE_1_0.0
 129    * @PRIVLEVEL_PUBLIC
 130    * @PRIVILEGE_DISPLAY
 131    */
 132   static Application New();
 133
 134   /**
 135    * @brief This is the constructor for applications.
 136    *
 137    * @SINCE_1_0.0
 138    * @PRIVLEVEL_PUBLIC
 139    * @PRIVILEGE_DISPLAY
 140    * @param[in,out]  argc        A pointer to the number of arguments
 141    * @param[in,out]  argv        A pointer the the argument list
 142    */
 143   static Application New( int* argc, char **argv[] );
 144
 145   /**
 146    * @brief This is the constructor for applications with a name
 147    *
 148    * @SINCE_1_0.0
 149    * @PRIVLEVEL_PUBLIC
 150    * @PRIVILEGE_DISPLAY
 151    * @param[in,out]  argc        A pointer to the number of arguments
 152    * @param[in,out]  argv        A pointer the the argument list
 153    * @param[in]      stylesheet  The path to user defined theme file
 154    * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
 155    */
 156   static Application New( int* argc, char **argv[], const std::string& stylesheet );
 157
 158   /**
 159    * @brief This is the constructor for applications with a name
 160    *
 161    * @SINCE_1_0.0
 162    * @PRIVLEVEL_PUBLIC
 163    * @PRIVILEGE_DISPLAY
 164    * @param[in,out]  argc        A pointer to the number of arguments
 165    * @param[in,out]  argv        A pointer the the argument list
 166    * @param[in]      stylesheet  The path to user defined theme file
 167    * @param[in]      windowMode  A member of WINDOW_MODE
 168    * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
 169    */
 170   static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
 171
 172   /**
 173    * @brief Construct an empty handle
 174    * @SINCE_1_0.0
 175    */
 176   Application();
 177
 178   /**
 179    * @brief Copy Constructor
 180    * @SINCE_1_0.0
 181    */
 182   Application( const Application& application );
 183
 184   /**
 185    * @brief Assignment operator
 186    * @SINCE_1_0.0
 187    */
 188   Application& operator=( const Application& applicaton );
 189
 190   /**
 191    * @brief Destructor
 192    *
 193    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 194    * @SINCE_1_0.0
 195    */
 196   ~Application();
 197
 198 public:
 199   /**
 200    * @brief This starts the application.
 201    *
 202    * Choosing this form of main loop indicates that the default
 203    * application configuration of APPLICATION_HANDLES_CONTEXT_LOSS is used. On platforms where
 204    * context loss can occur, the application is responsible for tearing down and re-loading UI.
 205    * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
 206    * @SINCE_1_0.0
 207    */
 208   void MainLoop();
 209
 210   /**
 211    * @brief This starts the application, and allows the app to choose a different configuration.
 212    *
 213    * If the application plans on using the ReplaceSurface or ReplaceWindow API, then this will
 214    * trigger context loss & regain.
 215    * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
 216    * @SINCE_1_0.0
 217    */
 218   void MainLoop(Configuration::ContextLoss configuration);
 219
 220   /**
 221    * @brief This lowers the application to bottom without actually quitting it
 222    * @SINCE_1_0.0
 223    */
 224   void Lower();
 225
 226   /**
 227    * @brief This quits the application.  Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
 228    * @SINCE_1_0.0
 229    */
 230   void Quit();
 231
 232   /**
 233    * @brief Ensures that the function passed in is called from the main loop when it is idle.
 234    * @SINCE_1_0.0
 235    * @param[in]  callback  The function to call.
 236    * @return true if added successfully, false otherwise
 237    *
 238    * @note Function must be called from main event thread only
 239    *
 240    * A callback of the following type may be used:
 241    * @code
 242    *   void MyFunction();
 243    * @endcode
 244    *
 245    * @note Ownership of the callback is passed onto this class.
 246    */
 247   bool AddIdle( CallbackBase* callback );
 248
 249   /**
 250    * @brief Retrieves the window used by the Application class.
 251    *
 252    * The application writer can use the window to change indicator and orientation
 253    * properties.
 254    * @SINCE_1_0.0
 255    * @return A handle to the window
 256    */
 257   Window GetWindow();
 258
 259   /**
 260    * @brief Replace the current window.
 261    *
 262    * This will force context loss.
 263    * If you plan on using this API in your application, then you should configure
 264    * it to prevent discard behaviour when handling the Init signal.
 265    * @SINCE_1_0.0
 266    * @param[in] windowPosition The position and size parameters of the new window
 267    * @param[in] name The name of the new window
 268    */
 269   void ReplaceWindow(PositionSize windowPosition, const std::string& name);
 270
 271 public: // Stereoscopy
 272
 273   /**
 274    * @brief Set the viewing mode for the application.
 275    * @SINCE_1_0.0
 276    * @param[in] viewMode The new viewing mode.
 277    */
 278   void SetViewMode( ViewMode viewMode );
 279
 280   /**
 281    * @brief Get the current viewing mode.
 282    * @SINCE_1_0.0
 283    * @return The current viewing mode.
 284    */
 285   ViewMode GetViewMode() const;
 286
 287   /**
 288    * @brief Set the stereo base (eye separation) for Stereoscopic 3D
 289    *
 290    * The stereo base is the distance in millimetres between the eyes. Typical values are
 291    * between 50mm and 70mm. The default value is 65mm.
 292    * @SINCE_1_0.0
 293    * @remarks SetStereoBase() is supported in mobile applications only.
 294    * @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
 295    */
 296   void SetStereoBase( float stereoBase );
 297
 298   /**
 299    * @brief Get the stereo base (eye separation) for Stereoscopic 3D
 300    *
 301    * @SINCE_1_0.0
 302    * @remarks GetStereoBase() is supported in mobile applications only.
 303    * @return The stereo base (eye separation) for Stereoscopic 3D
 304    */
 305   float GetStereoBase() const;
 306
 307 public:  // Signals
 308
 309   /**
 310    * @brief The user should connect to this signal to determine when they should initialise
 311    * their application.
 312    * @SINCE_1_0.0
 313    */
 314   AppSignalType& InitSignal();
 315
 316   /**
 317    * @brief The user should connect to this signal to determine when they should terminate
 318    * their application
 319    * @SINCE_1_0.0
 320    */
 321   AppSignalType& TerminateSignal();
 322
 323   /**
 324    * @brief The user should connect to this signal if they need to perform any special
 325    * activities when the application is about to be paused.
 326    * @SINCE_1_0.0
 327    */
 328   AppSignalType& PauseSignal();
 329
 330   /**
 331    * @brief The user should connect to this signal if they need to perform any special
 332    * activities when the application has resumed.
 333    * @SINCE_1_0.0
 334    */
 335   AppSignalType& ResumeSignal();
 336
 337   /**
 338    * @brief This signal is sent when the system requires the user to reinitialise itself.
 339    * @SINCE_1_0.0
 340    */
 341   AppSignalType& ResetSignal();
 342
 343   /**
 344    * @brief This signal is emitted when the window the application is rendering on is resized.
 345    * @SINCE_1_0.0
 346    */
 347   AppSignalType& ResizeSignal();
 348
 349   /**
 350   * @brief This signal is emitted when another application sends a launch request to the application.
 351   *
 352   * When the application is launched, this signal is emitted after the main loop of the application starts up.
 353   * The passed parameter describes the launch request and contains the information about why the application is launched.
 354   * @SINCE_1_0.0
 355   */
 356   AppControlSignalType& AppControlSignal();
 357
 358   /**
 359    * @brief This signal is emitted when the language is changed on the device.
 360    * @SINCE_1_0.0
 361    */
 362   AppSignalType& LanguageChangedSignal();
 363
 364   /**
 365   * @brief This signal is emitted when the region of the device is changed.
 366   * @SINCE_1_0.0
 367   */
 368   AppSignalType& RegionChangedSignal();
 369
 370   /**
 371   * @brief This signal is emitted when the battery level of the device is low.
 372   * @SINCE_1_0.0
 373   */
 374   AppSignalType& BatteryLowSignal();
 375
 376   /**
 377   * @brief This signal is emitted when the memory level of the device is low.
 378   * @SINCE_1_0.0
 379   */
 380   AppSignalType& MemoryLowSignal();
 381
 382 public: // Not intended for application developers
 383   /**
 384    * @internal
 385    * @brief Internal constructor
 386    * @SINCE_1_0.0
 387    */
 388   explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
 389 };
 390
 391 /**
 392  * @}
 393  */
 394 } // namespace Dali
 395
 396 #endif // __DALI_APPLICATION_H__