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 // INTERNAL INCLUDES
  28 #include "application-configuration.h"
  29 #include "device-status.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 initializing 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 (DeviceStatus::Battery::Status) > LowBatterySignalType; ///< Application device signal type @SINCE_1_2.62
 112   typedef Signal< void (DeviceStatus::Memory::Status) > LowMemorySignalType;   ///< Application device signal type @SINCE_1_2.62
 113   typedef Signal< void (Application&) > AppSignalType;  ///< Application lifecycle signal and system signal callback type @SINCE_1_0.0
 114   typedef Signal< void (Application&, void *) > AppControlSignalType; ///< Application control signal callback type @SINCE_1_0.0
 115
 116   /**
 117    * @brief Enumeration for deciding whether a Dali application window is opaque or transparent.
 118    * @SINCE_1_0.0
 119    */
 120   enum WINDOW_MODE
 121   {
 122     OPAQUE = 0,       ///< The window will be opaque @SINCE_1_0.0
 123     TRANSPARENT = 1   ///< The window transparency will match the alpha value set in Dali::Stage::SetBackgroundcolor() @SINCE_1_0.0
 124   };
 125
 126 public:
 127
 128   /**
 129    * @brief This is the constructor for applications without an argument list.
 130    * @SINCE_1_0.0
 131    * @PRIVLEVEL_PUBLIC
 132    * @PRIVILEGE_DISPLAY
 133    * @return A handle to the Application
 134    */
 135   static Application New();
 136
 137   /**
 138    * @brief This is the constructor for applications.
 139    *
 140    * @SINCE_1_0.0
 141    * @PRIVLEVEL_PUBLIC
 142    * @PRIVILEGE_DISPLAY
 143    * @param[in,out]  argc        A pointer to the number of arguments
 144    * @param[in,out]  argv        A pointer to the argument list
 145    * @return A handle to the Application
 146    */
 147   static Application New( int* argc, char **argv[] );
 148
 149   /**
 150    * @brief This is the constructor for applications with a name.
 151    *
 152    * @SINCE_1_0.0
 153    * @PRIVLEVEL_PUBLIC
 154    * @PRIVILEGE_DISPLAY
 155    * @param[in,out]  argc        A pointer to the number of arguments
 156    * @param[in,out]  argv        A pointer to the argument list
 157    * @param[in]      stylesheet  The path to user defined theme file
 158    * @return A handle to the Application
 159    * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
 160    */
 161   static Application New( int* argc, char **argv[], const std::string& stylesheet );
 162
 163   /**
 164    * @brief This is the constructor for applications with a name.
 165    *
 166    * @SINCE_1_0.0
 167    * @PRIVLEVEL_PUBLIC
 168    * @PRIVILEGE_DISPLAY
 169    * @param[in,out]  argc        A pointer to the number of arguments
 170    * @param[in,out]  argv        A pointer to the argument list
 171    * @param[in]      stylesheet  The path to user defined theme file
 172    * @param[in]      windowMode  A member of WINDOW_MODE
 173    * @return A handle to the Application
 174    * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
 175    */
 176   static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
 177
 178   /**
 179    * @brief This is the constructor for applications.
 180    *
 181    * @SINCE_1_2.60
 182    * @PRIVLEVEL_PUBLIC
 183    * @PRIVILEGE_DISPLAY
 184    * @param[in,out]  argc         A pointer to the number of arguments
 185    * @param[in,out]  argv         A pointer to the argument list
 186    * @param[in]      stylesheet   The path to user defined theme file
 187    * @param[in]      windowMode   A member of WINDOW_MODE
 188    * @param[in]      positionSize A position and a size of the window
 189    * @return A handle to the Application
 190    * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
 191    */
 192   static Application New( int* argc, char **argv[], const std::string& stylesheet, Application::WINDOW_MODE windowMode, PositionSize positionSize );
 193
 194   /**
 195    * @brief Constructs an empty handle.
 196    * @SINCE_1_0.0
 197    */
 198   Application();
 199
 200   /**
 201    * @brief Copy Constructor.
 202    * @SINCE_1_0.0
 203    * @param[in] application Handle to an object
 204    */
 205   Application( const Application& application );
 206
 207   /**
 208    * @brief Assignment operator.
 209    * @SINCE_1_0.0
 210    * @param[in] application Handle to an object
 211    * @return A reference to this
 212    */
 213   Application& operator=( const Application& application );
 214
 215   /**
 216    * @brief Destructor.
 217    *
 218    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 219    * @SINCE_1_0.0
 220    */
 221   ~Application();
 222
 223 public:
 224   /**
 225    * @brief This starts the application.
 226    *
 227    * Choosing this form of main loop indicates that the default
 228    * application configuration of APPLICATION_HANDLES_CONTEXT_LOSS is used. On platforms where
 229    * context loss can occur, the application is responsible for tearing down and re-loading UI.
 230    * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
 231    * @SINCE_1_0.0
 232    */
 233   void MainLoop();
 234
 235   /**
 236    * @brief This starts the application, and allows the app to choose a different configuration.
 237    *
 238    * If the application plans on using the ReplaceSurface or ReplaceWindow API, then this will
 239    * trigger context loss & regain.
 240    * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
 241    * @SINCE_1_0.0
 242    * @param[in] configuration The context loss configuration
 243    */
 244   void MainLoop(Configuration::ContextLoss configuration);
 245
 246   /**
 247    * @brief This lowers the application to bottom without actually quitting it.
 248    * @SINCE_1_0.0
 249    */
 250   void Lower();
 251
 252   /**
 253    * @brief This quits the application.  Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
 254    * @SINCE_1_0.0
 255    */
 256   void Quit();
 257
 258   /**
 259    * @brief Ensures that the function passed in is called from the main loop when it is idle.
 260    * @SINCE_1_0.0
 261    * @param[in] callback The function to call
 262    * @return @c true if added successfully, @c false otherwise
 263    *
 264    * @note Function must be called from main event thread only
 265    *
 266    * A callback of the following type may be used:
 267    * @code
 268    *   void MyFunction();
 269    * @endcode
 270    *
 271    * @note Ownership of the callback is passed onto this class.
 272    */
 273   bool AddIdle( CallbackBase* callback );
 274
 275   /**
 276    * @brief Retrieves the window used by the Application class.
 277    *
 278    * The application writer can use the window to change indicator and orientation
 279    * properties.
 280    * @SINCE_1_0.0
 281    * @return A handle to the window
 282    */
 283   Window GetWindow();
 284
 285   /**
 286    * @brief Replaces the current window.
 287    *
 288    * This will force context loss.
 289    * If you plan on using this API in your application, then you should configure
 290    * it to prevent discard behavior when handling the Init signal.
 291    * @SINCE_1_0.0
 292    * @param[in] windowPosition The position and size parameters of the new window
 293    * @param[in] name The name of the new window
 294    */
 295   void ReplaceWindow(PositionSize windowPosition, const std::string& name);
 296
 297   /**
 298    * @brief Get path application resources are stored at
 299    *
 300    * @SINCE_1_2.2
 301    * @return the full path of the resources
 302    */
 303   static std::string GetResourcePath();
 304
 305   /**
 306    * @brief This is used to get region information from device.
 307    *
 308    * @SINCE_1_2.62
 309    * @return Region information
 310    */
 311   std::string GetRegion() const;
 312
 313   /**
 314    * @brief This is used to get language information from device.
 315    *
 316    * @SINCE_1_2.62
 317    * @return Language information
 318    */
 319   std::string GetLanguage() const;
 320
 321 public: // Stereoscopy
 322
 323   /**
 324    * @brief Sets the viewing mode for the application.
 325    * @SINCE_1_0.0
 326    * @param[in] viewMode The new viewing mode
 327    */
 328   void SetViewMode( ViewMode viewMode );
 329
 330   /**
 331    * @brief Gets the current viewing mode.
 332    * @SINCE_1_0.0
 333    * @return The current viewing mode
 334    */
 335   ViewMode GetViewMode() const;
 336
 337   /**
 338    * @brief Sets the stereo base (eye separation) for Stereoscopic 3D.
 339    *
 340    * The stereo base is the distance in millimetres between the eyes. Typical values are
 341    * between 50mm and 70mm. The default value is 65mm.
 342    * @SINCE_1_0.0
 343    * @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
 344    */
 345   void SetStereoBase( float stereoBase );
 346
 347   /**
 348    * @brief Gets the stereo base (eye separation) for Stereoscopic 3D.
 349    *
 350    * @SINCE_1_0.0
 351    * @return The stereo base (eye separation) for Stereoscopic 3D
 352    */
 353   float GetStereoBase() const;
 354
 355 public:  // Signals
 356
 357   /**
 358    * @brief The user should connect to this signal to determine when they should initialize
 359    * their application.
 360    * @SINCE_1_0.0
 361    * @return The signal to connect to
 362    */
 363   AppSignalType& InitSignal();
 364
 365   /**
 366    * @brief The user should connect to this signal to determine when they should terminate
 367    * their application.
 368    * @SINCE_1_0.0
 369    * @return The signal to connect to
 370    */
 371   AppSignalType& TerminateSignal();
 372
 373   /**
 374    * @brief The user should connect to this signal if they need to perform any special
 375    * activities when the application is about to be paused.
 376    * @SINCE_1_0.0
 377    * @return The signal to connect to
 378    */
 379   AppSignalType& PauseSignal();
 380
 381   /**
 382    * @brief The user should connect to this signal if they need to perform any special
 383    * activities when the application has resumed.
 384    * @SINCE_1_0.0
 385    * @return The signal to connect to
 386    */
 387   AppSignalType& ResumeSignal();
 388
 389   /**
 390    * @brief This signal is sent when the system requires the user to reinitialize itself.
 391    * @SINCE_1_0.0
 392    * @return The signal to connect to
 393    */
 394   AppSignalType& ResetSignal();
 395
 396   /**
 397    * @DEPRECATED_1_1.43 Use Window::ResizedSignal() instead.
 398    * @brief This signal is emitted when the window application rendering on is resized.
 399    * @SINCE_1_0.0
 400    * @return The signal to connect to
 401    */
 402   AppSignalType& ResizeSignal() DALI_DEPRECATED_API;
 403
 404   /**
 405   * @brief This signal is emitted when another application sends a launch request to the application.
 406   *
 407   * When the application is launched, this signal is emitted after the main loop of the application starts up.
 408   * The passed parameter describes the launch request and contains the information about why the application is launched.
 409   * @SINCE_1_0.0
 410   * @return The signal to connect to
 411   */
 412   AppControlSignalType& AppControlSignal();
 413
 414   /**
 415    * @brief This signal is emitted when the language is changed on the device.
 416    * @SINCE_1_0.0
 417    * @return The signal to connect to
 418    */
 419   AppSignalType& LanguageChangedSignal();
 420
 421   /**
 422   * @brief This signal is emitted when the region of the device is changed.
 423   * @SINCE_1_0.0
 424   * @return The signal to connect to
 425   */
 426   AppSignalType& RegionChangedSignal();
 427
 428   /**
 429   * @DEPRECATED_1_2.62 Use LowBatterySignal() instead.
 430   * @brief This signal is emitted when the battery level of the device is low.
 431   * @SINCE_1_0.0
 432   * @return The signal to connect to
 433   */
 434   AppSignalType& BatteryLowSignal() DALI_DEPRECATED_API;
 435
 436   /**
 437   * @DEPRECATED_1_2.62 Use LowMemorySignal() instead.
 438   * @brief This signal is emitted when the memory level of the device is low.
 439   * @SINCE_1_0.0
 440   * @return The signal to connect to
 441   */
 442   AppSignalType& MemoryLowSignal() DALI_DEPRECATED_API;
 443
 444   /**
 445    * @brief This signal is emitted when the battery level of the device is low.
 446    * @SINCE_1_2.62
 447    * @return The signal to connect to
 448    */
 449   LowBatterySignalType& LowBatterySignal();
 450
 451   /**
 452    * @brief This signal is emitted when the memory level of the device is low.
 453    * @SINCE_1_2.62
 454    * @return The signal to connect to
 455    */
 456   LowMemorySignalType& LowMemorySignal();
 457
 458 public: // Not intended for application developers
 459   /// @cond internal
 460   /**
 461    * @brief Internal constructor.
 462    * @SINCE_1_0.0
 463    */
 464   explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
 465   /// @endcond
 466 };
 467
 468 /**
 469  * @}
 470  */
 471 } // namespace Dali
 472
 473 #endif // __DALI_APPLICATION_H__