1 #ifndef __DALI_APPLICATION_H__
2 #define __DALI_APPLICATION_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
28 #include <dali/public-api/adaptor-framework/application-configuration.h>
29 #include <dali/public-api/adaptor-framework/device-status.h>
30 #include <dali/public-api/adaptor-framework/window.h>
35 * @addtogroup dali_adaptor_framework
39 namespace Internal DALI_INTERNAL
47 * @brief An Application class object should be created by every application
48 * that wishes to use Dali.
50 * It provides a means for initializing the
51 * resources required by the Dali::Core.
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.
58 * Applications should follow the example below:
61 * class ExampleController: public ConnectionTracker
64 * ExampleController( Application& application )
65 * : mApplication( application )
67 * mApplication.InitSignal().Connect( this, &ExampleController::Create );
70 * void Create( Application& application )
72 * // Create Dali components...
76 * Application& mApplication;
79 * int main (int argc, char **argv)
81 * Application app = Application::New(&argc, &argv);
82 * ExampleController example( app );
87 * If required, you can also connect class member functions to a signal:
91 * app.ResumeSignal().Connect(&app, &MyApplication::Resume);
94 * This class accepts command line arguments as well. The following options are supported:
97 * --no-vsync Disable VSync on Render
98 * -w|--width Stage Width
99 * -h|--height Stage Height
100 * -d|--dpi Emulated DPI
104 * When the above options are found, they are stripped from argv, and argc is updated appropriately.
107 class DALI_IMPORT_API Application : public BaseHandle
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
117 * @brief Enumeration for deciding whether a Dali application window is opaque or transparent.
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
129 * @brief This is the constructor for applications without an argument list.
133 * @return A handle to the Application
135 static Application New();
138 * @brief This is the constructor for applications.
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
147 static Application New( int* argc, char **argv[] );
150 * @brief This is the constructor for applications with a name.
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.
161 static Application New( int* argc, char **argv[], const std::string& stylesheet );
164 * @brief This is the constructor for applications with a name.
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.
176 static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
179 * @brief This is the constructor for applications.
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.
192 static Application New( int* argc, char **argv[], const std::string& stylesheet, Application::WINDOW_MODE windowMode, PositionSize positionSize );
195 * @brief Constructs an empty handle.
201 * @brief Copy Constructor.
203 * @param[in] application Handle to an object
205 Application( const Application& application );
208 * @brief Assignment operator.
210 * @param[in] application Handle to an object
211 * @return A reference to this
213 Application& operator=( const Application& application );
218 * This is non-virtual since derived Handle types must not contain data or virtual methods.
225 * @brief This starts the application.
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.
236 * @brief This starts the application, and allows the app to choose a different configuration.
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.
242 * @param[in] configuration The context loss configuration
244 void MainLoop(Configuration::ContextLoss configuration);
247 * @brief This lowers the application to bottom without actually quitting it.
253 * @brief This quits the application. Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
259 * @brief Ensures that the function passed in is called from the main loop when it is idle.
261 * @param[in] callback The function to call
262 * @return @c true if added successfully, @c false otherwise
264 * @note Function must be called from main event thread only
266 * A callback of the following type may be used:
271 * @note Ownership of the callback is passed onto this class.
273 bool AddIdle( CallbackBase* callback );
276 * @brief Retrieves the window used by the Application class.
278 * The application writer can use the window to change indicator and orientation
281 * @return A handle to the window
286 * @brief Replaces the current window.
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.
292 * @param[in] windowPosition The position and size parameters of the new window
293 * @param[in] name The name of the new window
295 void ReplaceWindow(PositionSize windowPosition, const std::string& name);
298 * @brief Get path application resources are stored at
301 * @return the full path of the resources
303 static std::string GetResourcePath();
306 * @brief This is used to get region information from device.
309 * @return Region information
311 std::string GetRegion() const;
314 * @brief This is used to get language information from device.
317 * @return Language information
319 std::string GetLanguage() const;
321 public: // Stereoscopy
324 * @brief Sets the viewing mode for the application.
326 * @param[in] viewMode The new viewing mode
328 void SetViewMode( ViewMode viewMode );
331 * @brief Gets the current viewing mode.
333 * @return The current viewing mode
335 ViewMode GetViewMode() const;
338 * @brief Sets the stereo base (eye separation) for Stereoscopic 3D.
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.
343 * @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
345 void SetStereoBase( float stereoBase );
348 * @brief Gets the stereo base (eye separation) for Stereoscopic 3D.
351 * @return The stereo base (eye separation) for Stereoscopic 3D
353 float GetStereoBase() const;
358 * @brief The user should connect to this signal to determine when they should initialize
361 * @return The signal to connect to
363 AppSignalType& InitSignal();
366 * @brief The user should connect to this signal to determine when they should terminate
369 * @return The signal to connect to
371 AppSignalType& TerminateSignal();
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.
377 * @return The signal to connect to
379 AppSignalType& PauseSignal();
382 * @brief The user should connect to this signal if they need to perform any special
383 * activities when the application has resumed.
385 * @return The signal to connect to
387 AppSignalType& ResumeSignal();
390 * @brief This signal is sent when the system requires the user to reinitialize itself.
392 * @return The signal to connect to
394 AppSignalType& ResetSignal();
397 * @DEPRECATED_1_1.43 Use Window::ResizedSignal() instead.
398 * @brief This signal is emitted when the window application rendering on is resized.
400 * @return The signal to connect to
402 AppSignalType& ResizeSignal() DALI_DEPRECATED_API;
405 * @brief This signal is emitted when another application sends a launch request to the application.
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.
410 * @return The signal to connect to
412 AppControlSignalType& AppControlSignal();
415 * @brief This signal is emitted when the language is changed on the device.
417 * @return The signal to connect to
419 AppSignalType& LanguageChangedSignal();
422 * @brief This signal is emitted when the region of the device is changed.
424 * @return The signal to connect to
426 AppSignalType& RegionChangedSignal();
429 * @DEPRECATED_1_2.62 Use LowBatterySignal() instead.
430 * @brief This signal is emitted when the battery level of the device is low.
432 * @return The signal to connect to
434 AppSignalType& BatteryLowSignal() DALI_DEPRECATED_API;
437 * @DEPRECATED_1_2.62 Use LowMemorySignal() instead.
438 * @brief This signal is emitted when the memory level of the device is low.
440 * @return The signal to connect to
442 AppSignalType& MemoryLowSignal() DALI_DEPRECATED_API;
445 * @brief This signal is emitted when the battery level of the device is low.
447 * @return The signal to connect to
449 LowBatterySignalType& LowBatterySignal();
452 * @brief This signal is emitted when the memory level of the device is low.
454 * @return The signal to connect to
456 LowMemorySignalType& LowMemorySignal();
458 public: // Not intended for application developers
461 * @brief Internal constructor.
464 explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
473 #endif // __DALI_APPLICATION_H__