1 #ifndef DALI_APPLICATION_H
2 #define DALI_APPLICATION_H
5 * Copyright (c) 2018 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.
22 #include <dali/public-api/common/view-mode.h>
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/signals/callback.h>
27 #include <dali/public-api/adaptor-framework/application-configuration.h>
28 #include <dali/public-api/adaptor-framework/device-status.h>
29 #include <dali/public-api/adaptor-framework/window.h>
34 * @addtogroup dali_adaptor_framework
38 namespace Internal DALI_INTERNAL
46 * @brief An Application class object should be created by every application
47 * that wishes to use Dali.
49 * It provides a means for initializing the
50 * resources required by the Dali::Core.
52 * The Application class emits several signals which the user can
53 * connect to. The user should not create any Dali objects in the main
54 * function and instead should connect to the Init signal of the
55 * Application and create the Dali objects in the connected callback.
57 * Applications should follow the example below:
60 * class ExampleController: public ConnectionTracker
63 * ExampleController( Application& application )
64 * : mApplication( application )
66 * mApplication.InitSignal().Connect( this, &ExampleController::Create );
69 * void Create( Application& application )
71 * // Create Dali components...
75 * Application& mApplication;
78 * int main (int argc, char **argv)
80 * Application app = Application::New(&argc, &argv);
81 * ExampleController example( app );
86 * If required, you can also connect class member functions to a signal:
90 * app.ResumeSignal().Connect(&app, &MyApplication::Resume);
93 * This class accepts command line arguments as well. The following options are supported:
96 * --no-vsync Disable VSync on Render
97 * -w|--width Stage Width
98 * -h|--height Stage Height
99 * -d|--dpi Emulated DPI
103 * When the above options are found, they are stripped from argv, and argc is updated appropriately.
106 class DALI_ADAPTOR_API Application : public BaseHandle
110 typedef Signal< void (DeviceStatus::Battery::Status) > LowBatterySignalType; ///< Application device signal type @SINCE_1_2.62
111 typedef Signal< void (DeviceStatus::Memory::Status) > LowMemorySignalType; ///< Application device signal type @SINCE_1_2.62
112 typedef Signal< void (Application&) > AppSignalType; ///< Application lifecycle signal and system signal callback type @SINCE_1_0.0
113 typedef Signal< void (Application&, void *) > AppControlSignalType; ///< Application control signal callback type @SINCE_1_0.0
116 * @brief Enumeration for deciding whether a Dali application window is opaque or transparent.
121 OPAQUE = 0, ///< The window will be opaque @SINCE_1_0.0
122 TRANSPARENT = 1 ///< The window transparency will match the alpha value set in Dali::Stage::SetBackgroundcolor() @SINCE_1_0.0
128 * @brief This is the constructor for applications without an argument list.
132 * @return A handle to the Application
134 static Application New();
137 * @brief This is the constructor for applications.
142 * @param[in,out] argc A pointer to the number of arguments
143 * @param[in,out] argv A pointer to the argument list
144 * @return A handle to the Application
146 static Application New( int* argc, char **argv[] );
149 * @brief This is the constructor for applications with a name.
154 * @param[in,out] argc A pointer to the number of arguments
155 * @param[in,out] argv A pointer to the argument list
156 * @param[in] stylesheet The path to user defined theme file
157 * @return A handle to the Application
158 * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
160 static Application New( int* argc, char **argv[], const std::string& stylesheet );
163 * @brief This is the constructor for applications with a name.
168 * @param[in,out] argc A pointer to the number of arguments
169 * @param[in,out] argv A pointer to the argument list
170 * @param[in] stylesheet The path to user defined theme file
171 * @param[in] windowMode A member of WINDOW_MODE
172 * @return A handle to the Application
173 * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
175 static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
178 * @brief This is the constructor for applications.
183 * @param[in,out] argc A pointer to the number of arguments
184 * @param[in,out] argv A pointer to the argument list
185 * @param[in] stylesheet The path to user defined theme file
186 * @param[in] windowMode A member of WINDOW_MODE
187 * @param[in] positionSize A position and a size of the window
188 * @return A handle to the Application
189 * @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
191 static Application New( int* argc, char **argv[], const std::string& stylesheet, Application::WINDOW_MODE windowMode, PositionSize positionSize );
194 * @brief Constructs an empty handle.
200 * @brief Copy Constructor.
202 * @param[in] application Handle to an object
204 Application( const Application& application );
207 * @brief Assignment operator.
209 * @param[in] application Handle to an object
210 * @return A reference to this
212 Application& operator=( const Application& application );
217 * This is non-virtual since derived Handle types must not contain data or virtual methods.
224 * @brief This starts the application.
226 * Choosing this form of main loop indicates that the default
227 * application configuration of APPLICATION_HANDLES_CONTEXT_LOSS is used. On platforms where
228 * context loss can occur, the application is responsible for tearing down and re-loading UI.
229 * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
235 * @brief This starts the application, and allows the app to choose a different configuration.
237 * If the application plans on using the ReplaceSurface or ReplaceWindow API, then this will
238 * trigger context loss & regain.
239 * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
241 * @param[in] configuration The context loss configuration
243 void MainLoop(Configuration::ContextLoss configuration);
246 * @brief This lowers the application to bottom without actually quitting it.
252 * @brief This quits the application. Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
258 * @brief Ensures that the function passed in is called from the main loop when it is idle.
260 * @param[in] callback The function to call
261 * @return @c true if added successfully, @c false otherwise
263 * @note Function must be called from main event thread only
265 * A callback of the following type may be used:
269 * This callback will be deleted once it is called.
271 * @note Ownership of the callback is passed onto this class.
273 bool AddIdle( CallbackBase* callback );
276 * @brief Retrieves the main 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
287 * @brief Replaces the current window.
289 * This will force context loss.
290 * If you plan on using this API in your application, then you should configure
291 * it to prevent discard behavior when handling the Init signal.
293 * @param[in] windowPosition The position and size parameters of the new window
294 * @param[in] name The name of the new window
296 void ReplaceWindow(PositionSize windowPosition, const std::string& name) DALI_DEPRECATED_API;
299 * @brief Get path application resources are stored at
302 * @return the full path of the resources
304 static std::string GetResourcePath();
307 * @brief This is used to get region information from device.
310 * @return Region information
312 std::string GetRegion() const;
315 * @brief This is used to get language information from device.
318 * @return Language information
320 std::string GetLanguage() const;
322 public: // Stereoscopy
326 * @brief Sets the viewing mode for the application.
328 * @param[in] viewMode The new viewing mode
330 void SetViewMode( ViewMode viewMode );
334 * @brief Gets the current viewing mode.
336 * @return The current viewing mode
338 ViewMode GetViewMode() const;
342 * @brief Sets the stereo base (eye separation) for Stereoscopic 3D.
344 * The stereo base is the distance in millimetres between the eyes. Typical values are
345 * between 50mm and 70mm. The default value is 65mm.
347 * @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
349 void SetStereoBase( float stereoBase );
353 * @brief Gets the stereo base (eye separation) for Stereoscopic 3D.
356 * @return The stereo base (eye separation) for Stereoscopic 3D
358 float GetStereoBase() const;
363 * @brief The user should connect to this signal to determine when they should initialize
366 * @return The signal to connect to
368 AppSignalType& InitSignal();
371 * @brief The user should connect to this signal to determine when they should terminate
374 * @return The signal to connect to
376 AppSignalType& TerminateSignal();
379 * @brief The user should connect to this signal if they need to perform any special
380 * activities when the application is about to be paused.
382 * @return The signal to connect to
384 AppSignalType& PauseSignal();
387 * @brief The user should connect to this signal if they need to perform any special
388 * activities when the application has resumed.
390 * @return The signal to connect to
392 AppSignalType& ResumeSignal();
395 * @brief This signal is sent when the system requires the user to reinitialize itself.
397 * @return The signal to connect to
399 AppSignalType& ResetSignal();
402 * @DEPRECATED_1_2.62 Use Window::ResizedSignal() instead.
403 * @brief This signal is emitted when the window application rendering on is resized.
405 * @return The signal to connect to
407 AppSignalType& ResizeSignal() DALI_DEPRECATED_API;
410 * @brief This signal is emitted when another application sends a launch request to the application.
412 * When the application is launched, this signal is emitted after the main loop of the application starts up.
413 * The passed parameter describes the launch request and contains the information about why the application is launched.
415 * @return The signal to connect to
417 AppControlSignalType& AppControlSignal();
420 * @brief This signal is emitted when the language is changed on the device.
422 * @return The signal to connect to
424 AppSignalType& LanguageChangedSignal();
427 * @brief This signal is emitted when the region of the device is changed.
429 * @return The signal to connect to
431 AppSignalType& RegionChangedSignal();
434 * @DEPRECATED_1_2.62 Use LowBatterySignal() instead.
435 * @brief This signal is emitted when the battery level of the device is low.
437 * @return The signal to connect to
439 AppSignalType& BatteryLowSignal() DALI_DEPRECATED_API;
442 * @DEPRECATED_1_2.62 Use LowMemorySignal() instead.
443 * @brief This signal is emitted when the memory level of the device is low.
445 * @return The signal to connect to
447 AppSignalType& MemoryLowSignal() DALI_DEPRECATED_API;
450 * @brief This signal is emitted when the battery level of the device is low.
452 * @return The signal to connect to
454 LowBatterySignalType& LowBatterySignal();
457 * @brief This signal is emitted when the memory level of the device is low.
459 * @return The signal to connect to
461 LowMemorySignalType& LowMemorySignal();
463 public: // Not intended for application developers
466 * @brief Internal constructor.
469 explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
478 #endif // DALI_APPLICATION_H