2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 using System.ComponentModel;
20 using System.Diagnostics.CodeAnalysis;
21 using System.Threading;
22 using System.Reflection;
23 using Tizen.Applications;
24 using Tizen.Applications.CoreBackend;
31 /// Represents an application that have a UI screen. The NUIApplication class has a default stage.
33 /// <since_tizen> 3 </since_tizen>
34 public class NUIApplication : CoreApplication
37 /// The instance of ResourceManager.
39 private static System.Resources.ResourceManager resourceManager = null;
40 private static string currentLoadedXaml = null;
45 private bool borderEnabled = false;
46 private IBorderInterface borderInterface = null;
49 /// Xaml loaded delegate.
51 [EditorBrowsable(EditorBrowsableState.Never)]
52 public delegate void XamlLoadedHandler(string xamlName);
54 static NUIApplication()
56 Registry.Instance.SavedApplicationThread = Thread.CurrentThread;
60 /// The default constructor.
62 /// <since_tizen> 3 </since_tizen>
63 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
64 public NUIApplication() : base(new NUICoreBackend())
69 /// The constructor with window size and position.
71 /// <param name="windowSize">The window size.</param>
72 /// <param name="windowPosition">The window position.</param>
73 /// <since_tizen> 5 </since_tizen>
74 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
75 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
76 [EditorBrowsable(EditorBrowsableState.Never)]
77 public NUIApplication(Size2D windowSize, Position2D windowPosition) : base(new NUICoreBackend("", NUIApplication.WindowMode.Opaque, windowSize, windowPosition))
82 /// The constructor with a stylesheet.
84 /// <param name="styleSheet">The styleSheet url.</param>
85 /// <since_tizen> 3 </since_tizen>
86 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
87 public NUIApplication(string styleSheet) : base(new NUICoreBackend(styleSheet))
92 /// The constructor with a stylesheet, window size, and position.
94 /// <param name="styleSheet">The styleSheet URL.</param>
95 /// <param name="windowSize">The window size.</param>
96 /// <param name="windowPosition">The window position.</param>
97 /// <since_tizen> 5 </since_tizen>
98 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
99 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
100 [EditorBrowsable(EditorBrowsableState.Never)]
101 public NUIApplication(string styleSheet, Size2D windowSize, Position2D windowPosition) : base(new NUICoreBackend(styleSheet, WindowMode.Opaque, windowSize, windowPosition))
106 /// The constructor with a stylesheet and window mode.
108 /// <param name="styleSheet">The styleSheet url.</param>
109 /// <param name="windowMode">The windowMode.</param>
110 /// <since_tizen> 3 </since_tizen>
111 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
112 public NUIApplication(string styleSheet, WindowMode windowMode) : base(new NUICoreBackend(styleSheet, windowMode))
117 /// The constructor with a stylesheet, window mode, window size, and position.
119 /// <param name="styleSheet">The styleSheet URL.</param>
120 /// <param name="windowMode">The windowMode.</param>
121 /// <param name="windowSize">The window size.</param>
122 /// <param name="windowPosition">The window position.</param>
123 /// <since_tizen> 5 </since_tizen>
124 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
125 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
126 [EditorBrowsable(EditorBrowsableState.Never)]
127 public NUIApplication(string styleSheet, WindowMode windowMode, Size2D windowSize, Position2D windowPosition) : base(new NUICoreBackend(styleSheet, windowMode, windowSize, windowPosition))
132 /// Internal inhouse constructor with Graphics Backend Type
134 /// <param name="backend"></param>
135 /// <param name="windowMode"></param>
136 /// <param name="windowSize"></param>
137 /// <param name="windowPosition"></param>
138 /// <param name="styleSheet"></param>
139 /// InhouseAPI, this could be opened in NextTizen
140 [Obsolete("Do not use! This will be deprecated!")]
141 [EditorBrowsable(EditorBrowsableState.Never)]
142 public NUIApplication(Graphics.BackendType backend, WindowMode windowMode = WindowMode.Opaque, Size2D windowSize = null, Position2D windowPosition = null, string styleSheet = "") : base(new NUICoreBackend(styleSheet, windowMode, windowSize, windowPosition))
144 //windowMode and styleSheet will be added later. currently it's not working as expected.
145 Graphics.Backend = backend;
146 Tizen.Log.Error("NUI", "Plaese DO NOT set graphical backend type with this constructor! This will give no effect!");
150 /// The constructor with theme option.
152 /// <param name="option">The theme option.</param>
153 [EditorBrowsable(EditorBrowsableState.Never)]
154 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
155 public NUIApplication(ThemeOptions option) : base(new NUICoreBackend())
157 ApplyThemeOption(option);
161 /// The constructor with window size and position and theme option.
163 /// <param name="windowSize">The window size.</param>
164 /// <param name="windowPosition">The window position.</param>
165 /// <param name="option">The theme option.</param>
166 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
167 [EditorBrowsable(EditorBrowsableState.Never)]
168 public NUIApplication(Size2D windowSize, Position2D windowPosition, ThemeOptions option) : base(new NUICoreBackend("", NUIApplication.WindowMode.Opaque, windowSize, windowPosition))
170 ApplyThemeOption(option);
174 /// The constructor with a stylesheet, window mode and default window type.
175 /// It is the only way to create an IME window.
177 /// <param name="styleSheet">The styleSheet URL.</param>
178 /// <param name="windowMode">The windowMode.</param>
179 /// <param name="type">The default window type.</param>
180 /// <since_tizen> 9 </since_tizen>
181 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
182 public NUIApplication(string styleSheet, WindowMode windowMode, WindowType type) : base(new NUICoreBackend(styleSheet, windowMode, type))
184 ExternalThemeManager.Initialize();
188 /// The constructor with a stylesheet, size, position, boderInterface and window mode
190 /// <param name="styleSheet">The styleSheet URL.</param>
191 /// <param name="windowSize">The window size.</param>
192 /// <param name="windowPosition">The window position.</param>
193 /// <param name="borderInterface"><see cref="Tizen.NUI.IBorderInterface"/>If borderInterface is null, defaultBorder is enabled.</param>
194 /// <param name="windowMode">The windowMode.</param>
195 [EditorBrowsable(EditorBrowsableState.Never)]
196 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
197 public NUIApplication(string styleSheet, Size2D windowSize, Position2D windowPosition, IBorderInterface borderInterface, WindowMode windowMode = WindowMode.Opaque) : base(new NUICoreBackend(styleSheet, windowMode, windowSize, windowPosition))
199 EnableBorder(borderInterface);
203 /// The constructor with theme option and borderInterface.
205 /// <param name="option">The theme option.</param>
206 /// <param name="borderInterface"><see cref="Tizen.NUI.IBorderInterface"/>If borderInterface is null, defaultBorder is enabled.</param>
207 [EditorBrowsable(EditorBrowsableState.Never)]
208 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
209 public NUIApplication(ThemeOptions option, IBorderInterface borderInterface) : base(new NUICoreBackend())
211 EnableBorder(borderInterface);
212 ApplyThemeOption(option);
216 /// The constructor with window size, position, theme option and borderInterface.
218 /// <param name="windowSize">The window size.</param>
219 /// <param name="windowPosition">The window position.</param>
220 /// <param name="option">The theme option.</param>
221 /// <param name="borderInterface"><see cref="Tizen.NUI.IBorderInterface"/>If borderInterface is null, defaultBorder is enabled.</param>
222 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
223 [EditorBrowsable(EditorBrowsableState.Never)]
224 public NUIApplication(Size2D windowSize, Position2D windowPosition, ThemeOptions option, IBorderInterface borderInterface) : base(new NUICoreBackend("", NUIApplication.WindowMode.Opaque, windowSize, windowPosition))
226 EnableBorder(borderInterface);
227 ApplyThemeOption(option);
231 /// The constructor with a stylesheet, window mode, coretask
234 /// There is the UI thread feature.
235 /// UI thread is an additional thread that an Application object creates. The thread is for UI events.
236 /// To enable the UI Thread, you have to pass CoreTask object using this contructor.
237 /// When the UI thread feature is enabled, The methods of CoreTask are emitted on the main thread,
238 /// and the NUIApplication's events are emitted on the UI thread.
239 /// If you want to handle windows or actors in cases like when the memory level of the device is low, you have to use the NUIApplication events, not the CoreTask methods.
240 /// The CoreTask is not for handling GUI.
241 /// Callbacks of the all events in NUIApplication except the CoreTask are emitted on the UI thread.
243 /// <param name="styleSheet">The styleSheet URL.</param>
244 /// <param name="windowMode">The windowMode.</param>
245 /// <param name="task">True If app creates a UI Thread</param>
246 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
247 [EditorBrowsable(EditorBrowsableState.Never)]
248 public NUIApplication(string styleSheet, WindowMode windowMode, CoreTask task) : base(new NUICoreBackend(styleSheet, windowMode), task)
253 /// The constructor with a stylesheet, window mode, window size, position, coretask
255 /// <param name="styleSheet">The styleSheet URL.</param>
256 /// <param name="windowMode">The windowMode.</param>
257 /// <param name="windowSize">The window size.</param>
258 /// <param name="windowPosition">The window position.</param>
259 /// <param name="task">True If app creates a UI Thread</param>
260 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
261 [EditorBrowsable(EditorBrowsableState.Never)]
262 public NUIApplication(string styleSheet, WindowMode windowMode, Size2D windowSize, Position2D windowPosition, CoreTask task) : base(new NUICoreBackend(styleSheet, windowMode, windowSize, windowPosition), task)
267 /// The constructor with a ThemeOptions, WindowData
269 /// <param name="option">The theme option.</param>
270 /// <param name="windowData">The default window data</param>
271 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")]
272 [EditorBrowsable(EditorBrowsableState.Never)]
273 public NUIApplication(ThemeOptions option, WindowData windowData) : base(new NUICoreBackend(windowData))
275 if (windowData.BorderInterface != null)
277 EnableBorder(windowData.BorderInterface);
279 ApplyThemeOption(option);
283 /// Occurs whenever the application is resumed.
285 /// <since_tizen> 4 </since_tizen>
286 public event EventHandler Resumed;
289 /// Occurs whenever the application is paused.
291 /// <since_tizen> 4 </since_tizen>
292 public event EventHandler Paused;
295 /// Xaml loaded event.
297 [EditorBrowsable(EditorBrowsableState.Never)]
298 public static event XamlLoadedHandler XamlLoaded;
301 /// Enumeration for deciding whether a NUI application window is opaque or transparent.
303 /// <since_tizen> 3 </since_tizen>
304 public enum WindowMode
309 /// <since_tizen> 3 </since_tizen>
314 /// <since_tizen> 3 </since_tizen>
319 /// Enumeration for theme options of the NUIApplication.
322 [EditorBrowsable(EditorBrowsableState.Never)]
323 public enum ThemeOptions : int
326 /// No option specified.
328 [EditorBrowsable(EditorBrowsableState.Never)]
332 /// Enable platform theme.
333 /// When this option is on, all views in the NUIApplication is affected by platform theme (e.g. light/dark).
335 [EditorBrowsable(EditorBrowsableState.Never)]
336 PlatformThemeEnabled = 1 << 0,
339 /// Sets the default value of View.ThemeChangeSensitive.
340 /// when this option is on, all views are made sensitive on theme changing by default.
342 [EditorBrowsable(EditorBrowsableState.Never)]
343 ThemeChangeSensitive = 1 << 1,
347 /// Current loaded xaml's full name.
349 [EditorBrowsable(EditorBrowsableState.Never)]
350 public static string CurrentLoadedXaml
354 return currentLoadedXaml;
358 if (currentLoadedXaml != value)
360 currentLoadedXaml = value;
361 XamlLoaded?.Invoke(value);
367 /// ResourceManager to handle multilingual.
369 /// <since_tizen> 4 </since_tizen>
370 public static System.Resources.ResourceManager MultilingualResourceManager
374 return resourceManager;
378 resourceManager = value;
383 /// Gets the window instance.
385 /// <since_tizen> 3 </since_tizen>
386 [Obsolete("Do not use! This will be deprecated!")]
387 [EditorBrowsable(EditorBrowsableState.Never)]
392 return GetDefaultWindow();
397 /// Gets the Application Id.
399 /// <since_tizen> 6 </since_tizen>
400 [EditorBrowsable(EditorBrowsableState.Never)]
405 return Tizen.Applications.Application.Current.ApplicationInfo.ApplicationId;
410 /// Gets the default window.
412 /// <returns>The default Window.</returns>
413 /// <since_tizen> 6 </since_tizen>
414 // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
415 [EditorBrowsable(EditorBrowsableState.Never)]
416 public static Window GetDefaultWindow()
418 return Window.Instance;
421 internal Application ApplicationHandle
425 return ((NUICoreBackend)this.Backend).ApplicationHandle;
430 /// Register the assembly to XAML.
432 /// <since_tizen> 5 </since_tizen>
433 public static void RegisterAssembly(Assembly assembly)
435 XamlParser.s_assemblies.Add(assembly);
439 /// Runs the NUIApplication.
441 /// <param name="args">Arguments from commandline.</param>
442 /// <since_tizen> 4 </since_tizen>
443 public override void Run(string[] args)
445 Backend.AddEventHandler(EventType.PreCreated, OnPreCreate);
446 Backend.AddEventHandler(EventType.Resumed, OnResume);
447 Backend.AddEventHandler(EventType.Paused, OnPause);
452 /// Exits the NUIApplication.
454 /// <since_tizen> 4 </since_tizen>
455 public override void Exit()
461 /// Ensures that the function passed in is called from the main loop when it is idle.
463 /// <param name="func">The function to call</param>
464 /// <returns>true if added successfully, false otherwise</returns>
465 /// <since_tizen> 4 </since_tizen>
466 public bool AddIdle(System.Delegate func)
468 return ((NUICoreBackend)this.Backend).AddIdle(func);
472 /// Flush render/update thread messages synchronously.
475 /// This function will relayout forcibily.
476 /// This function is used for advanced developer. It will make main-thread overhead if you call this function frequencely.
478 // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
479 [EditorBrowsable(EditorBrowsableState.Never)]
480 public void FlushUpdateMessages()
482 ApplicationHandle.FlushUpdateMessages();
486 /// Sets the number of frames per render.
488 /// <param name="numberOfVSyncsPerRender">The number of vsyncs between successive renders.</param>
490 /// Suggest this is a power of two:
491 /// 1 - render each vsync frame.
492 /// 2 - render every other vsync frame.
493 /// 4 - render every fourth vsync frame.
494 /// 8 - render every eighth vsync frame. <br />
495 /// For example, if an application runs on 60 FPS and SetRenderRefreshRate(2) is called, the frames per second will be changed to 30.
497 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
498 [EditorBrowsable(EditorBrowsableState.Never)]
499 public static void SetRenderRefreshRate(uint numberOfVSyncsPerRender)
501 Adaptor.Instance.SetRenderRefreshRate(numberOfVSyncsPerRender);
505 /// Gets the screen size
507 /// <returns>Screen size</returns>
508 [EditorBrowsable(EditorBrowsableState.Never)]
509 static public Size GetScreenSize()
511 var ret = new Size(Interop.Application.GetScreenSize(), true);
512 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
517 /// Overrides this method if you want to handle behavior.
519 /// <since_tizen> 3 </since_tizen>
520 protected override void OnLocaleChanged(LocaleChangedEventArgs e)
522 base.OnLocaleChanged(e);
526 /// Overrides this method if you want to handle behavior.
528 /// <since_tizen> 3 </since_tizen>
529 protected override void OnLowBattery(LowBatteryEventArgs e)
531 base.OnLowBattery(e);
535 /// Overrides this method if you want to handle behavior.
537 /// <since_tizen> 3 </since_tizen>
538 protected override void OnLowMemory(LowMemoryEventArgs e)
544 /// Overrides this method if you want to handle behavior.
546 /// <since_tizen> 3 </since_tizen>
547 protected override void OnRegionFormatChanged(RegionFormatChangedEventArgs e)
549 base.OnRegionFormatChanged(e);
553 /// This method is to handle behavior when the device orientation is changed.
555 /// When device is rotated to ccw or cw, this event occurs.
556 /// In addition, this event is different to window orientation changed event.
557 /// The window orientation event is for per a window and occurs when some flags should be set before.
559 /// <param name="e">The device orientation changed event argument</param>
560 [EditorBrowsable(EditorBrowsableState.Never)]
561 protected override void OnDeviceOrientationChanged(DeviceOrientationEventArgs e)
563 base.OnDeviceOrientationChanged(e);
567 /// Overrides this method if you want to handle behavior.
569 /// <since_tizen> 3 </since_tizen>
570 protected override void OnTerminate()
576 /// Overrides this method if you want to handle behavior.
578 /// <since_tizen> 3 </since_tizen>
579 protected virtual void OnPause()
581 Paused?.Invoke(this, EventArgs.Empty);
585 /// Overrides this method if you want to handle behavior.
587 /// <since_tizen> 3 </since_tizen>
588 protected virtual void OnResume()
590 Resumed?.Invoke(this, EventArgs.Empty);
594 /// Overrides this method if you want to handle behavior.
596 /// <since_tizen> 3 </since_tizen>
597 protected virtual void OnPreCreate()
599 Tizen.Tracer.Begin("[NUI] OnPreCreate()");
601 if (borderEnabled && GetDefaultWindow() != null)
603 GetDefaultWindow().EnableBorder(borderInterface, new Window.BorderCloseDelegate(Exit));
610 /// Overrides this method if you want to handle behavior.
612 /// <since_tizen> 3 </since_tizen>
613 protected override void OnAppControlReceived(AppControlReceivedEventArgs e)
615 if (e != null && e.ReceivedAppControl != null)
617 Log.Info("NUI", "OnAppControlReceived() is called! ApplicationId=" + e.ReceivedAppControl.ApplicationId);
618 Log.Info("NUI", "CallerApplicationId=" + e.ReceivedAppControl.CallerApplicationId + " IsReplyRequest=" + e.ReceivedAppControl.IsReplyRequest);
620 base.OnAppControlReceived(e);
624 /// Overrides this method if you want to handle behavior.
626 /// <since_tizen> 3 </since_tizen>
627 protected override void OnCreate()
629 Tizen.Tracer.Begin("[NUI] OnCreate()");
637 /// This is used to improve application launch performance.
639 [EditorBrowsable(EditorBrowsableState.Never)]
640 static public void Preload()
642 Interop.Application.PreInitialize();
644 // Initialize some static utility
645 var disposalbeQueue = DisposeQueue.Instance;
646 var registry = Registry.Instance;
648 // Initialize some BaseComponent static variables now
649 BaseComponents.View.Preload();
650 BaseComponents.ImageView.Preload();
651 BaseComponents.TextLabel.Preload();
652 BaseComponents.TextEditor.Preload();
653 BaseComponents.TextField.Preload();
654 Disposable.Preload();
656 // Initialize exception tasks. It must be called end of Preload()
657 NDalicPINVOKE.Preload();
663 /// Check if it is loaded as dotnet-loader-nui.
665 static internal bool IsPreload { get; set; }
667 private void ApplyThemeOption(ThemeOptions option)
669 if ((option & ThemeOptions.PlatformThemeEnabled) != 0)
671 ThemeManager.PlatformThemeEnabled = true;
674 if ((option & ThemeOptions.ThemeChangeSensitive) != 0)
676 ThemeManager.ApplicationThemeChangeSensitive = true;
680 private void EnableBorder(IBorderInterface borderInterface)
682 borderEnabled = true;
683 this.borderInterface = borderInterface;
688 /// Graphics Backend Type.
690 [SuppressMessage("Microsoft.Design", "CA1052:StaticHolderTypesShouldBeStaticOrNotInheritable")]
691 [EditorBrowsable(EditorBrowsableState.Never)]
692 [Obsolete("Do not use! This will be deprecated!")]
693 public class Graphics
696 /// Graphics Backend Type.
698 public enum BackendType
701 /// The GLES backend.
705 /// The Vulkan backend.
711 /// The backend used by the NUIApplication.
713 [EditorBrowsable(EditorBrowsableState.Never)]
714 internal static BackendType Backend = BackendType.Gles;
716 internal const string GlesCSharpBinder = NDalicPINVOKE.Lib;
717 internal const string VulkanCSharpBinder = "libdali-csharp-binder-vk.so";