1 #ifndef __DALI_APPLICATION_H__
2 #define __DALI_APPLICATION_H__
5 * Copyright (c) 2014 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"
30 #include "style-monitor.h"
31 #include "device-layout.h"
37 namespace Internal DALI_INTERNAL
46 * An Application class object should be created by every application
47 * that wishes to use Dali. It provides a means for initialising the
48 * resources required by the Dali::Core.
50 * The Application class emits several signals which the user can
51 * connect to. The user should not create any Dali objects in the main
52 * function and instead should connect to the Init signal of the
53 * Application and create the Dali objects in the connected callback.
55 * Applications should follow the example below:
58 * void CreateProgram(Application app)
60 * // Create Dali components...
61 * // Can instantiate here, if required
64 * int main (int argc, char **argv)
66 * Application app = Application::New(&argc, &argv);
67 * app.InitSignal().Connect(&CreateProgram);
72 * If required, you can also connect class member functions to a signal:
76 * app.ResumeSignal().Connect(&app, &MyApplication::Resume);
79 * This class accepts command line arguments as well. The following options are supported:
82 * --no-vsync Disable VSync on Render
83 * -w|--width Stage Width
84 * -h|--height Stage Height
85 * -d|--dpi Emulated DPI
89 * When the above options are found, they are stripped from argv, and argc is updated appropriately.
91 class DALI_IMPORT_API Application : public BaseHandle
95 typedef Signal< void (Application&) > AppSignalType;
96 typedef Signal< void (Application&, void *) > AppControlSignalType;
99 * Decides whether a Dali application window is opaque or transparent.
103 OPAQUE = 0, ///< The window will be opaque
104 TRANSPARENT = 1 ///< The window transparency will match the alpha value set in Dali::Stage::SetBackgroundcolor()
110 * This is the constructor for applications without an argument list.
112 * @note The default base layout (DeviceLayout::DEFAULT_BASE_LAYOUT) will be used with this constructor.
114 static Application New();
117 * This is the constructor for applications.
119 * @param[in,out] argc A pointer to the number of arguments
120 * @param[in,out] argv A pointer the the argument list
122 * @note The default base layout (DeviceLayout::DEFAULT_BASE_LAYOUT) will be used with this constructor.
123 * @note Supported options are stripped from argv, and argc is updated appropriately.
125 static Application New( int* argc, char **argv[] );
128 * This is the constructor for applications with a name
130 * @param[in,out] argc A pointer to the number of arguments
131 * @param[in,out] argv A pointer the the argument list
132 * @param[in] name A name of application
134 * @note The default base layout (DeviceLayout::DEFAULT_BASE_LAYOUT) will be used with this constructor.
135 * @note Supported options are stripped from argv, and argc is updated appropriately.
137 static Application New( int* argc, char **argv[], const std::string& name );
140 * This is the constructor for applications with a name, and also require a
141 * transparent top-level window
143 * @param[in,out] argc A pointer to the number of arguments
144 * @param[in,out] argv A pointer the the argument list
145 * @param[in] name A name of application
146 * @param[in] windowMode A member of WINDOW_MODE
148 * @note The default base layout (DeviceLayout::DEFAULT_BASE_LAYOUT) will be used with this constructor.
149 * @note Supported options are stripped from argv, and argc is updated appropriately.
151 static Application New( int* argc, char **argv[], const std::string& name, WINDOW_MODE windowMode );
154 * This is the constructor for applications when a layout for the application is specified.
156 * @param[in,out] argc A pointer to the number of arguments
157 * @param[in,out] argv A pointer the the argument list
158 * @param[in] baseLayout The base layout that the application has been written for
160 * @note Supported options are stripped from argv, and argc is updated appropriately.
162 static Application New( int* argc, char **argv[], const DeviceLayout& baseLayout );
165 * This is the constructor for applications with a name and when a layout for the application is specified.
167 * @param[in,out] argc A pointer to the number of arguments
168 * @param[in,out] argv A pointer the the argument list
169 * @param[in] name A name of application
170 * @param[in] baseLayout The base layout that the application has been written for
172 * @note Supported options are stripped from argv, and argc is updated appropriately.
174 static Application New( int* argc, char **argv[], const std::string& name, const DeviceLayout& baseLayout );
177 * Construct an empty handle
184 Application( const Application& application );
187 * Assignment operator
189 Application& operator=( const Application& applicaton );
194 * This is non-virtual since derived Handle types must not contain data or virtual methods.
200 * This starts the application. Choosing this form of main loop indicates that the default
201 * application configuration of APPLICATION_HANDLES_CONTEXT_LOSS is used. On platforms where
202 * context loss can occur, the application is responsible for tearing down and re-loading UI.
203 * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
208 * This starts the application, and allows the app to choose a different configuration.
209 * If the application plans on using the ReplaceSurface or ReplaceWindow API, then this will
210 * trigger context loss & regain.
211 * The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
213 void MainLoop(Configuration::ContextLoss configuration);
216 * This lowers the application to bottom without actually quitting it
221 * This quits the application. Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
226 * This returns a handle to the Orientation object used by Application which allows
227 * the user to determine the orientation of the device and connect to a
228 * signal emitted whenever the orientation changes.
229 * @return A handle to the Orientation object used by the Application
231 Orientation GetOrientation();
234 * Ensures that the function passed in is called from the main loop when it is idle.
236 * A callback of the following type may be used:
241 * @param[in] callback The function to call.
242 * @return true if added successfully, false otherwise
244 * @note Ownership of the callback is passed onto this class.
246 bool AddIdle( CallbackBase* callback );
249 * Retrieves the window used by the Application class.
250 * The application writer can use the window to change indicator and orientation
252 * @return A handle to the window
257 * Replace the current window.
258 * This will force context loss.
259 * If you plan on using this API in your application, then you should configure
260 * it to prevent discard behaviour when handling the Init signal.
261 * @param[in] windowPosition The position and size parameters of the new window
262 * @param[in] name The name of the new window
264 void ReplaceWindow(PositionSize windowPosition, const std::string& name);
266 public: // Stereoscopy
269 * Set the viewing mode for the application.
270 * @param[in] viewMode The new viewing mode.
272 void SetViewMode( ViewMode viewMode );
275 * Get the current viewing mode.
276 * @return The current viewing mode.
278 ViewMode GetViewMode() const;
281 * Set the stereo base (eye separation) for Stereoscopic 3D
283 * @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
285 void SetStereoBase( float stereoBase );
288 * Get the stereo base (eye separation) for Stereoscopic 3D
290 * @return The stereo base (eye separation) for Stereoscopic 3D
292 float GetStereoBase() const;
297 * The user should connect to this signal to determine when they should initialise
300 AppSignalType& InitSignal();
303 * The user should connect to this signal to determine when they should terminate
306 AppSignalType& TerminateSignal();
309 * The user should connect to this signal if they need to perform any special
310 * activities when the application is about to be paused.
312 AppSignalType& PauseSignal();
315 * The user should connect to this signal if they need to perform any special
316 * activities when the application has resumed.
318 AppSignalType& ResumeSignal();
321 * This signal is sent when the system requires the user to reinitialise itself.
323 AppSignalType& ResetSignal();
326 * This signal is emitted when the window the application is rendering on is resized.
328 AppSignalType& ResizeSignal();
331 * This signal is emitted when another application sends a launch request to the application.
332 * When the application is launched, this signal is emitted after the main loop of the application starts up.
333 * The passed parameter describes the launch request and contains the information about why the application is launched.
335 AppControlSignalType& AppControlSignal();
338 * This signal is emitted when the language is changed on the device.
340 AppSignalType& LanguageChangedSignal();
343 * This signal is emitted when the region of the device is changed.
345 AppSignalType& RegionChangedSignal();
348 * This signal is emitted when the battery level of the device is low.
350 AppSignalType& BatteryLowSignal();
353 * This signal is emitted when the memory level of the device is low.
355 AppSignalType& MemoryLowSignal();
358 public: // Not intended for application developers
360 * Internal constructor
362 explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
367 #endif // __DALI_APPLICATION_H__