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>
29 #include "application-configuration.h"
35 namespace Internal DALI_INTERNAL
44 * An Application class object should be created by every application
45 * that wishes to use Dali. It provides a means for initialising the
46 * resources required by the Dali::Core.
48 * The Application class emits several signals which the user can
49 * connect to. The user should not create any Dali objects in the main
50 * function and instead should connect to the Init signal of the
51 * Application and create the Dali objects in the connected callback.
53 * Applications should follow the example below:
56 * void CreateProgram(Application app)
58 * // Create Dali components...
59 * // Can instantiate here, if required
62 * int main (int argc, char **argv)
64 * Application app = Application::New(&argc, &argv);
65 * app.InitSignal().Connect(&CreateProgram);
70 * If required, you can also connect class member functions to a signal:
74 * app.ResumeSignal().Connect(&app, &MyApplication::Resume);
77 * This class accepts command line arguments as well. The following options are supported:
80 * --no-vsync Disable VSync on Render
81 * -w|--width Stage Width
82 * -h|--height Stage Height
83 * -d|--dpi Emulated DPI
87 * When the above options are found, they are stripped from argv, and argc is updated appropriately.
89 class DALI_IMPORT_API Application : public BaseHandle
93 typedef Signal< void (Application&) > AppSignalType;
94 typedef Signal< void (Application&, void *) > AppControlSignalType;
97 * Decides whether a Dali application window is opaque or transparent.
101 OPAQUE = 0, ///< The window will be opaque
102 TRANSPARENT = 1 ///< The window transparency will match the alpha value set in Dali::Stage::SetBackgroundcolor()
108 * This is the constructor for applications without an argument list.
110 static Application New();
113 * This is the constructor for applications.
115 * @param[in,out] argc A pointer to the number of arguments
116 * @param[in,out] argv A pointer the the argument list
118 static Application New( int* argc, char **argv[] );
121 * This is the constructor for applications with a name
123 * @param[in,out] argc A pointer to the number of arguments
124 * @param[in,out] argv A pointer the the argument list
125 * @param[in] stylesheet The path to user defined theme file
127 static Application New( int* argc, char **argv[], const std::string& stylesheet );
130 * This is the constructor for applications with a name
132 * @param[in,out] argc A pointer to the number of arguments
133 * @param[in,out] argv A pointer the the argument list
134 * @param[in] stylesheet The path to user defined theme file
135 * @param[in] windowMode A member of WINDOW_MODE
137 static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
140 * Construct an empty handle
147 Application( const Application& application );
150 * Assignment operator
152 Application& operator=( const Application& applicaton );
157 * This is non-virtual since derived Handle types must not contain data or virtual methods.
163 * This starts the application. Choosing this form of main loop indicates that the default
164 * application configuration of APPLICATION_HANDLES_CONTEXT_LOSS is used. On platforms where
165 * context loss can occur, the application is responsible for tearing down and re-loading UI.
166 * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
171 * This starts the application, and allows the app to choose a different configuration.
172 * If the application plans on using the ReplaceSurface or ReplaceWindow API, then this will
173 * trigger context loss & regain.
174 * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
176 void MainLoop(Configuration::ContextLoss configuration);
179 * This lowers the application to bottom without actually quitting it
184 * This quits the application. Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
189 * Ensures that the function passed in is called from the main loop when it is idle.
190 * @note Function must be called from main event thread only
192 * A callback of the following type may be used:
197 * @param[in] callback The function to call.
198 * @return true if added successfully, false otherwise
200 * @note Ownership of the callback is passed onto this class.
202 bool AddIdle( CallbackBase* callback );
205 * Retrieves the window used by the Application class.
206 * The application writer can use the window to change indicator and orientation
208 * @return A handle to the window
213 * Replace the current window.
214 * This will force context loss.
215 * If you plan on using this API in your application, then you should configure
216 * it to prevent discard behaviour when handling the Init signal.
217 * @param[in] windowPosition The position and size parameters of the new window
218 * @param[in] name The name of the new window
220 void ReplaceWindow(PositionSize windowPosition, const std::string& name);
222 public: // Stereoscopy
225 * Set the viewing mode for the application.
226 * @param[in] viewMode The new viewing mode.
228 void SetViewMode( ViewMode viewMode );
231 * Get the current viewing mode.
232 * @return The current viewing mode.
234 ViewMode GetViewMode() const;
237 * Set the stereo base (eye separation) for Stereoscopic 3D
239 * @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
241 void SetStereoBase( float stereoBase );
244 * Get the stereo base (eye separation) for Stereoscopic 3D
246 * @return The stereo base (eye separation) for Stereoscopic 3D
248 float GetStereoBase() const;
253 * The user should connect to this signal to determine when they should initialise
256 AppSignalType& InitSignal();
259 * The user should connect to this signal to determine when they should terminate
262 AppSignalType& TerminateSignal();
265 * The user should connect to this signal if they need to perform any special
266 * activities when the application is about to be paused.
268 AppSignalType& PauseSignal();
271 * The user should connect to this signal if they need to perform any special
272 * activities when the application has resumed.
274 AppSignalType& ResumeSignal();
277 * This signal is sent when the system requires the user to reinitialise itself.
279 AppSignalType& ResetSignal();
282 * This signal is emitted when the window the application is rendering on is resized.
284 AppSignalType& ResizeSignal();
287 * This signal is emitted when another application sends a launch request to the application.
288 * When the application is launched, this signal is emitted after the main loop of the application starts up.
289 * The passed parameter describes the launch request and contains the information about why the application is launched.
291 AppControlSignalType& AppControlSignal();
294 * This signal is emitted when the language is changed on the device.
296 AppSignalType& LanguageChangedSignal();
299 * This signal is emitted when the region of the device is changed.
301 AppSignalType& RegionChangedSignal();
304 * This signal is emitted when the battery level of the device is low.
306 AppSignalType& BatteryLowSignal();
309 * This signal is emitted when the memory level of the device is low.
311 AppSignalType& MemoryLowSignal();
313 public: // Not intended for application developers
315 * Internal constructor
317 explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
322 #endif // __DALI_APPLICATION_H__