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