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