1 #ifndef DALI_APPLICATION_H
2 #define DALI_APPLICATION_H
5 * Copyright (c) 2020 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/object/base-handle.h>
23 #include <dali/public-api/signals/callback.h>
26 #include <dali/public-api/adaptor-framework/device-status.h>
27 #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 * -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 );
215 * @brief Move constructor.
218 * @param[in] rhs A reference to the moved handle
220 Application( Application&& rhs );
223 * @brief Move assignment operator.
226 * @param[in] rhs A reference to the moved handle
227 * @return A reference to this handle
229 Application& operator=( Application&& rhs );
234 * This is non-virtual since derived Handle types must not contain data or virtual methods.
241 * @brief This starts the application.
243 * On platforms where context loss can occur, the application is responsible for tearing down and
244 * re-loading UI. The application should listen to Stage::ContextLostSignal and
245 * Stage::ContextRegainedSignal.
252 * @brief This lowers the application to bottom without actually quitting it.
258 * @brief This quits the application. Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
264 * @brief Ensures that the function passed in is called from the main loop when it is idle.
266 * @param[in] callback The function to call
267 * @return @c true if added successfully, @c false otherwise
269 * @note Function must be called from main event thread only
271 * A callback of the following type may be used:
275 * This callback will be deleted once it is called.
277 * @note Ownership of the callback is passed onto this class.
279 bool AddIdle( CallbackBase* callback );
282 * @brief Retrieves the main window used by the Application class.
284 * The application writer can use the window to change indicator and orientation
287 * @return A handle to the window
292 * @brief Get path application resources are stored at
295 * @return the full path of the resources
297 static std::string GetResourcePath();
300 * @brief This is used to get region information from device.
303 * @return Region information
305 std::string GetRegion() const;
308 * @brief This is used to get language information from device.
311 * @return Language information
313 std::string GetLanguage() const;
316 * @brief Gets the Object registry.
319 * @return The object registry
320 * @note This will only be a valid handle after the InitSignal has been emitted.
322 ObjectRegistry GetObjectRegistry() const;
327 * @brief The user should connect to this signal to determine when they should initialize
330 * @return The signal to connect to
332 AppSignalType& InitSignal();
335 * @brief The user should connect to this signal to determine when they should terminate
338 * @return The signal to connect to
340 AppSignalType& TerminateSignal();
343 * @brief The user should connect to this signal if they need to perform any special
344 * activities when the application is about to be paused.
346 * @return The signal to connect to
348 AppSignalType& PauseSignal();
351 * @brief The user should connect to this signal if they need to perform any special
352 * activities when the application has resumed.
354 * @return The signal to connect to
356 AppSignalType& ResumeSignal();
359 * @brief This signal is sent when the system requires the user to reinitialize itself.
361 * @return The signal to connect to
363 AppSignalType& ResetSignal();
366 * @brief This signal is emitted when another application sends a launch request to the application.
368 * When the application is launched, this signal is emitted after the main loop of the application starts up.
369 * The passed parameter describes the launch request and contains the information about why the application is launched.
371 * @return The signal to connect to
373 AppControlSignalType& AppControlSignal();
376 * @brief This signal is emitted when the language is changed on the device.
378 * @return The signal to connect to
380 AppSignalType& LanguageChangedSignal();
383 * @brief This signal is emitted when the region of the device is changed.
385 * @return The signal to connect to
387 AppSignalType& RegionChangedSignal();
390 * @brief This signal is emitted when the battery level of the device is low.
392 * @return The signal to connect to
394 LowBatterySignalType& LowBatterySignal();
397 * @brief This signal is emitted when the memory level of the device is low.
399 * @return The signal to connect to
401 LowMemorySignalType& LowMemorySignal();
403 public: // Not intended for application developers
406 * @brief Internal constructor.
409 explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
418 #endif // DALI_APPLICATION_H