/// <summary>
/// This class represents a NUIGadget controlled lifecycles.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public abstract class NUIGadget
{
/// Initializes the gadget.
/// </summary>
/// /// <param name="type">The type of the NUIGadget.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public NUIGadget(NUIGadgetType type)
{
Type = type;
/// <summary>
/// Gets the class representing information of the current gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public NUIGadgetInfo NUIGadgetInfo
{
internal set;
/// <summary>
/// Gets the type.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public NUIGadgetType Type
{
internal set;
/// <summary>
/// Gets the class name.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public string ClassName
{
internal set;
/// <summary>
/// Gets the main view.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public View MainView
{
internal set;
/// <summary>
/// Gets the lifecycle state.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public NUIGadgetLifecycleState State
{
internal set;
/// If 'base.OnCreate()' is not called, the event 'NUIGadgetLifecycleChanged' with the 'NUIGadgetLifecycleState.Created' state will not be emitted.
/// </summary>
/// <returns>The main view object.</returns>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual Tizen.NUI.BaseComponents.View OnCreate()
{
State = NUIGadgetLifecycleState.Created;
/// Overrides this method if want to handle behavior when the gadget receives the appcontrol message.
/// </summary>
/// <param name="e">The appcontrol received event argument.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnAppControlReceived(AppControlReceivedEventArgs e)
{
}
/// Overrides this method if want to handle behavior when the gadget is destroyed.
/// If 'base.OnDestroy()' is not called. the event 'NUIGadgetLifecycleChanged' with the 'NUIGadgetLifecycleState.Destroyed' state will not be emitted.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnDestroy()
{
State = NUIGadgetLifecycleState.Destroyed;
/// Overrides this method if want to handle behavior when the gadget is paused.
/// If 'base.OnPause()' is not called. the event 'NUIGadgetLifecycleChanged' with the 'NUIGadgetLifecycleState.Paused' state will not be emitted.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnPause()
{
State = NUIGadgetLifecycleState.Paused;
/// Overrides this method if want to handle behavior when the gadget is resumed.
/// If 'base.OnResume()' is not called. the event 'NUIGadgetLifecycleChanged' with the 'NUIGadgetLifecycleState.Resumed' state will not be emitted.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnResume()
{
State = NUIGadgetLifecycleState.Resumed;
/// Overrides this method if want to handle behavior when the system language is changed.
/// </summary>
/// <param name="e">The locale changed event argument.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnLocaleChanged(LocaleChangedEventArgs e)
{
}
/// Overrides this method if want to handle behavior when the system battery is low.
/// </summary>
/// <param name="e">The low batter event argument.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnLowBattery(LowBatteryEventArgs e)
{
}
/// Overrides this method if want to handle behavior when the system memory is low.
/// </summary>
/// <param name="e">The low memory event argument.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnLowMemory(LowMemoryEventArgs e)
{
}
/// Overrides this method if want to handle behavior when the region format is changed.
/// </summary>
/// <param name="e">The region format changed event argument.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnRegionFormatChanged(RegionFormatChangedEventArgs e)
{
}
/// Overrides this method if want to handle behavior when the device orientation is changed.
/// </summary>
/// <param name="e">The device orientation changed event argument.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
protected virtual void OnDeviceOrientationChanged(DeviceOrientationEventArgs e)
{
}
/// <summary>
/// Finishes the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public void Finish()
{
Pause();
/// <summary>
/// This class provides properties to get information the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public class NUIGadgetInfo
{
/// <summary>
/// Gets the package ID of the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public string PackageId { get; private set; }
/// <summary>
/// Gets the resource type of the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public string ResourceType { get; private set; }
/// <summary>
/// Gets the resource version of the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public string ResourceVersion { get; private set; }
/// <summary>
/// Gets the resource path of the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public string ResourcePath
{
get
/// <summary>
/// Gets the executable file of the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public string ExecutableFile { get; internal set; }
/// <summary>
/// Gets the metadata of the gadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public IDictionary<string, string> Metadata { get; private set; }
internal static NUIGadgetInfo CreateNUIGadgetInfo(string packageId)
/// <summary>
/// Arguments for the event raised when the NUIGadget lifecycle is changed.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public class NUIGadgetLifecycleChangedEventArgs : EventArgs
{
/// <summary>
/// The NUIGadget object.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public NUIGadget Gadget { get; internal set; }
/// <summary>
/// The state of the NUIGadget lifecycle.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public NUIGadgetLifecycleState State { get; internal set; }
}
}
/// <summary>
/// Enumeration for the lifecycle state of the NUIGadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public enum NUIGadgetLifecycleState
{
/// The initialized state.
/// This state is set when the gadget is initialized. The constructor of the NUIGadget is called.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
Initialized = 0,
/// <summary>
/// The created state.
/// This state is set when the gadget is created. The 'OnCreate()' method of the NUIGadget is called.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
Created = 1,
/// <summary>
/// The resumed state.
/// This state is set when the gadget is resumed. The 'OnResume()' method of the NUIGadget is called.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
Resumed = 2,
/// <summary>
/// The paused state.
/// This state is set when the gadget is paused. The 'OnPause()' method of the NUIGadget is called.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
Paused = 3,
/// <summary>
/// The destroyed state.
/// This state is set when the gadget is destroyed. The 'OnDestroy()' method of the NUIGadget is called.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
Destroyed = 4,
}
}
/// <summary>
/// This class has the methods and events of the NUIGadgetManager.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public static class NUIGadgetManager
{
/// <summary>
/// Occurs when the lifecycle of the NUIGadget is changed.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public static event EventHandler<NUIGadgetLifecycleChangedEventArgs> NUIGadgetLifecycleChanged;
private static void OnNUIGadgetLifecycleChanged(object sender, NUIGadgetLifecycleChangedEventArgs args)
/// <returns>The NUIGadget object.</returns>
/// <exception cref="ArgumentException">Thrown when failed because of a invalid argument.</exception>
/// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public static NUIGadget Add(string resourceType, string className)
{
if (!_gadgetInfos.TryGetValue(resourceType, out NUIGadgetInfo info))
/// Gets the information of the running NUIGadgets.
/// </summary>
/// <returns>The NUIGadget list.</returns>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public static IEnumerable<NUIGadget> GetGadgets()
{
return _gadgets;
/// Removes the NUIGadget from a NUIGadgetManager.
/// </summary>
/// <param name="gadget">The NUIGadget object.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public static void Remove(NUIGadget gadget)
{
if (gadget == null || !_gadgets.Contains(gadget))
/// <summary>
/// Removes all NUIGadget from a NUIGadgetManager.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public static void RemoveAll()
{
for (int i = _gadgets.Count - 1; i >= 0; i--)
/// Resumes the running NUIGadget.
/// </summary>
/// <param name="gadget">The NUIGadget object.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public static void Resume(NUIGadget gadget)
{
if (!_gadgets.Contains(gadget))
/// Pauses the running NUIGadget.
/// </summary>
/// <param name="gadget">The NUIGadget object.</param>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
public static void Pause(NUIGadget gadget)
{
if (!_gadgets.Contains(gadget))
/// <param name="appControl">The appcontrol object.</param>
/// <exception cref="ArgumentException">Thrown when failed because of a invalid argument.</exception>
/// <exception cref="ArgumentNullException">Thrown when failed because the argument is null.</exception>
+ /// <since_tizen> 10 </since_tizen>
public static void SendAppControl(NUIGadget gadget, AppControl appControl)
{
if (gadget == null)
/// <summary>
/// Enumeration for the type of the NUIGadget.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public enum NUIGadgetType
{
/// <summary>
/// The normal type.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
Normal = 0,
/// <summary>
/// The popup type.
/// </summary>
- /// <since_tizen> 11 </since_tizen>
+ /// <since_tizen> 10 </since_tizen>
Popup = 1,
}
}