diff --git a/packaging/csapi-tizenfx.spec b/packaging/csapi-tizenfx.spec index 903a755efdd..59e9ae34386 100644 --- a/packaging/csapi-tizenfx.spec +++ b/packaging/csapi-tizenfx.spec @@ -1,7 +1,7 @@ # Auto-generated from csapi-tizenfx.spec.in by makespec.sh %define TIZEN_NET_API_VERSION 12 -%define TIZEN_NET_RPM_VERSION 12.0.0.999+nui22340 +%define TIZEN_NET_RPM_VERSION 12.0.0.999+nui22342 %define TIZEN_NET_NUGET_VERSION 12.0.0.99999 %define DOTNET_ASSEMBLY_PATH /usr/share/dotnet.tizen/framework diff --git a/packaging/version.txt b/packaging/version.txt index 818836a7c24..159e7781971 100755 --- a/packaging/version.txt +++ b/packaging/version.txt @@ -6,4 +6,4 @@ RPM_VERSION=12.0.0.999 NUGET_VERSION=12.0.0.99999 # RPM Version Suffix -RPM_VERSION_SUFFIX=nui22340 +RPM_VERSION_SUFFIX=nui22342 diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs b/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs index c7a4f1acabc..6378e4b5ba8 100644 --- a/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs +++ b/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications /// The class containing common properties of the Badge. /// /// 3 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class Badge { private int count = 0; @@ -34,6 +35,7 @@ public class Badge /// Count value /// True if it should be displayed /// Thrown when failed because of invalid argument + [Obsolete("Deprecated since API12. Will be removed in API14.")] public Badge(string appId, int count = 1, bool visible = true) { if (IsNegativeNumber(count)) @@ -50,6 +52,7 @@ public Badge(string appId, int count = 1, bool visible = true) /// /// 3 /// Thrown when set negative number + [Obsolete("Deprecated since API12. Will be removed in API14.")] public int Count { get @@ -71,12 +74,14 @@ public int Count /// Property for the application ID of the badge. /// /// 3 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string AppId { get; set; } /// /// Property for display visibility. True if the badge display visible, otherwise false.. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public bool Visible{ get; set; } private bool IsNegativeNumber(int number) diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs index 093f40f65f8..7a2e4f11f5e 100755 --- a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs +++ b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications /// The class for badge operation. /// /// 3 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static class BadgeControl { private static event EventHandler s_changed; @@ -37,6 +38,7 @@ public static class BadgeControl /// Thrown in case of failed conditions. /// Thrown when an application does not have the privilege to access. /// Thrown when Badge is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static event EventHandler Changed { add @@ -88,6 +90,7 @@ public static event EventHandler Changed /// Thrown when an application does not have the privilege to access. /// Thrown in case of failed conditions. /// Thrown when Badge is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static Badge Find(string appId) { uint count; @@ -119,6 +122,7 @@ public static Badge Find(string appId) /// Thrown when an application does not have the privilege to access. /// Thrown in case of failed conditions. /// Thrown when Badge is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Remove(string appId) { BadgeError err = Interop.Badge.Remove(appId); @@ -139,6 +143,7 @@ public static void Remove(string appId) /// Thrown when an application does not have the privilege to access. /// Thrown in case of failed conditions. /// Thrown when Badge is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Remove(Badge badge) { if (badge == null) @@ -160,6 +165,7 @@ public static void Remove(Badge badge) /// Thrown when an application does not have the privilege to access. /// Thrown in case of failed conditions. /// Thrown when Badge is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Add(Badge badge) { if (badge == null) @@ -195,6 +201,7 @@ public static void Add(Badge badge) /// Thrown when an application does not have the privilege to access. /// Thrown in case of failed conditions. /// Thrown when Badge is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Update(Badge badge) { if (badge == null) @@ -225,6 +232,7 @@ public static void Update(Badge badge) /// Thrown when an application does not have the privilege to access. /// Thrown in case of failed conditions. /// Thrown when Badge is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static IEnumerable GetBadges() { IList list = new List(); diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs index c0b8d0ff1da..c20c0add80a 100755 --- a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs +++ b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications /// The class for event arguments of the badge event. /// /// 3 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class BadgeEventArgs : EventArgs { internal BadgeEventArgs() @@ -32,6 +33,7 @@ internal BadgeEventArgs() /// Enumeration for the badge action. /// /// 3 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public enum Action : int { /// @@ -54,12 +56,14 @@ public enum Action : int /// The property for the badge object. /// /// 3 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public Badge Badge { get; internal set; } /// /// The property for the action value. /// /// 3 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public Action Reason { get; internal set; } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Parcel.cs b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Parcel.cs index 9923019a73a..ce0aada91db 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Parcel.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Parcel.cs @@ -156,10 +156,10 @@ public class Parcel : IDisposable private ParcelHeader _header; /// - /// Constructor for this class. + /// Constructs a new instance of the Parcel class. /// - /// If it's false, the parcel object does not have the header. - /// Thrown when an internal IO error occurs. + /// Determines whether the created parcel object includes a header or not. + /// Thrown when an internal I/O error occurs during the construction process. /// 11 public Parcel(bool withHeader) { @@ -188,10 +188,10 @@ public Parcel() : this(true) } /// - /// Constructor with port object. + /// Creates a new parcel object from a specified port object. /// - /// Port object. - /// Thrown when an internal IO error occurs. + /// The port object to create a parcel from. + /// An internal IO error occurred while creating the parcel. /// 5 public Parcel(Port port) { @@ -203,10 +203,10 @@ public Parcel(Port port) } /// - /// Constructor with the raw bytes. + /// Constructs a new Parcel object from the specified raw bytes. /// - /// The raw bytes. - /// Thrown when an internal IO error occurs. + /// An array of bytes that represents the content of the parcel. + /// Thrown if an invalid argument is passed in or an internal I/O error occurs. /// 9 public Parcel(byte[] bytes) { @@ -218,10 +218,10 @@ public Parcel(byte[] bytes) } /// - /// Gets the raw bytes of the parcel. + /// Converts the current parcel into its raw bytes representation. /// - /// The raw bytes of the parcel. - /// Thrown when an internal IO error occurs. + /// An array of bytes containing the contents of the parcel. + /// Thrown if an internal I/O error occurs during conversion. /// 9 public byte[] ToBytes() { @@ -234,9 +234,9 @@ public byte[] ToBytes() } /// - /// Sends parcel data through the port. + /// Sends parcel data through the specified port. /// - /// The RPC port object for writing data. + /// The RPC port object for writing data. /// Thrown when an internal IO error occurs. /// 5 public void Send(Port p) @@ -249,9 +249,9 @@ public void Send(Port p) } /// - /// Writes a byte value into parcel object. + /// Writes a single byte value into the parcel object. /// - /// byte data. + /// The byte value to be written into the parcel object. /// 5 public void WriteByte(byte b) { @@ -261,7 +261,7 @@ public void WriteByte(byte b) /// /// Writes a short value into parcel object. /// - /// short data. + /// The short data to write. /// 5 public void WriteShort(short b) { @@ -269,9 +269,23 @@ public void WriteShort(short b) } /// - /// Writes an int value into parcel object. - /// - /// int data. + /// Writes an integer value into the parcel object. + /// + /// The integer value to write. + /// + /// Here's an example showing how to write an integer value into a parcel object: + /// + /// + /// // Create a new parcel object + /// Parcel parcel = new Parcel(); + /// + /// // Write an integer value into the parcel object + /// parcel.WriteInt(42); + /// + /// // Do something else with the parcel object... + /// ... + /// + /// /// 5 public void WriteInt(int b) { @@ -279,9 +293,9 @@ public void WriteInt(int b) } /// - /// Writes a long value into parcel object. + /// Writes a long value into the parcel object. /// - /// long data. + /// The long data to write. /// 5 public void WriteLong(long b) { @@ -289,9 +303,9 @@ public void WriteLong(long b) } /// - /// Writes a float value into parcel object. + /// Writes a float value into the parcel object. /// - /// float data. + /// The float data to write into the parcel object. /// 5 public void WriteFloat(float b) { @@ -299,9 +313,9 @@ public void WriteFloat(float b) } /// - /// Writes a double value into parcel object. + /// Writes a double value into the parcel object. /// - /// double data. + /// The double data to write. /// 5 public void WriteDouble(double b) { @@ -309,9 +323,9 @@ public void WriteDouble(double b) } /// - /// Writes a string value into parcel object. + /// Writes a string value into the parcel object. /// - /// string data. + /// The string data to be written into the parcel object. /// 5 public void WriteString(string b) { @@ -319,9 +333,9 @@ public void WriteString(string b) } /// - /// Writes a bool value into parcel object. + /// Writes a boolean value into the parcel object. /// - /// bool data. + /// The boolean value to write. /// 5 public void WriteBool(bool b) { @@ -329,9 +343,9 @@ public void WriteBool(bool b) } /// - /// Writes a Bundle data into parcel object. + /// Writes a Bundle data into the parcel object. /// - /// Bundle data. + /// The Bundle object to write. /// 5 public void WriteBundle(Bundle b) { @@ -344,9 +358,9 @@ public void WriteBundle(Bundle b) } /// - /// Writes a count of an array into parcel object. + /// Writes a count of an array into the parcel object. /// - /// Array count. + /// The number of elements in the array. /// 5 public void WriteArrayCount(int cnt) { @@ -354,9 +368,9 @@ public void WriteArrayCount(int cnt) } /// - /// Reads a byte value from parcel object. + /// Reads a byte value from the parcel object. /// - /// byte data. + /// The byte value. /// 5 public byte ReadByte() { @@ -365,9 +379,9 @@ public byte ReadByte() } /// - /// Reads a short value from parcel object. + /// Reads a short value from the parcel object. /// - /// short data. + /// The short data. /// 5 public short ReadShort() { @@ -376,9 +390,9 @@ public short ReadShort() } /// - /// Reads an int value from parcel object. + /// Reads an integer value from the parcel object. /// - /// int data. + /// The integer data. /// 5 public int ReadInt() { @@ -387,9 +401,9 @@ public int ReadInt() } /// - /// Reads a long value from parcel object. + /// Reads a long value from the parcel object. /// - /// long data. + /// The long data. /// 5 public long ReadLong() { @@ -398,9 +412,9 @@ public long ReadLong() } /// - /// Reads a float value from parcel object. + /// Reads a float value from the parcel object. /// - /// float data. + /// The float data. /// 5 public float ReadFloat() { @@ -409,9 +423,9 @@ public float ReadFloat() } /// - /// Reads a double value from parcel object. + /// Reads a double value from the parcel object. /// - /// double data. + /// The double data. /// 5 public double ReadDouble() { @@ -420,9 +434,9 @@ public double ReadDouble() } /// - /// Reads a string value from parcel object. + /// Reads a string value from the parcel object. /// - /// string data. + /// The string data. /// 5 public string ReadString() { @@ -431,9 +445,9 @@ public string ReadString() } /// - /// Reads a bool value from parcel object. + /// Reads a boolean value from the parcel object. /// - /// bool data. + /// The boolean data. /// 5 public bool ReadBool() { @@ -442,9 +456,9 @@ public bool ReadBool() } /// - /// Reads a Bundle value from parcel object. + /// Reads a Bundle value from the parcel object. /// - /// Bundle data. + /// The Bundle data. /// 5 public Bundle ReadBundle() { @@ -460,9 +474,9 @@ public Bundle ReadBundle() } /// - /// Reads a count of an array from parcel object. + /// Reads a count of an array from a parcel object. /// - /// Array count. + /// The number of elements in the array. /// 5 public int ReadArrayCount() { @@ -471,9 +485,9 @@ public int ReadArrayCount() } /// - /// Writes bytes into parcel object. + /// Writes bytes into the parcel object. /// - /// Array of bytes. + /// An array of bytes containing the data to be written. /// 5 public void Write(byte[] bytes) { @@ -486,10 +500,10 @@ public void Write(byte[] bytes) } /// - /// Reads bytes from parcel object. + /// Reads bytes from the parcel object. /// - /// Bytes to read. - /// Array of bytes. + /// The number of bytes to read. + /// An array of bytes that were read from the parcel. /// 5 public byte[] Read(int size) { diff --git a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Port.cs b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Port.cs index f8261902ae5..5518b86fae5 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Port.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/Port.cs @@ -21,7 +21,7 @@ namespace Tizen.Applications.RPCPort { /// - /// The class that proxy and stub can use to communicate with each other. + /// A class used by proxies and stubs to communicate with each other. /// /// 5 public class Port diff --git a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/ProxyBase.cs b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/ProxyBase.cs index 3206c52f240..038dbdd1c3b 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/ProxyBase.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/ProxyBase.cs @@ -19,7 +19,7 @@ namespace Tizen.Applications.RPCPort { /// - /// Abstract class for creating a proxy class for RPC. + /// Base class for creating a proxy class for remote procedure calls. /// /// 5 public abstract class ProxyBase : IDisposable @@ -45,9 +45,9 @@ public abstract class ProxyBase : IDisposable protected Port CallbackPort { get; private set; } /// - /// Constructor for this class. + /// Creates a new instance of the ProxyBase class. /// - /// Thrown when internal IO error occurs. + /// Thrown when an internal I/O error occurs during initialization. /// 5 public ProxyBase() { @@ -64,13 +64,17 @@ public ProxyBase() } /// - /// Connects to port. + /// Establishes a connection to the specified application through the named remote procedure call (RPC) port. /// - /// The target stub app ID. - /// The name of the RPC port. - /// Thrown when not available app ID is used. - /// Thrown when an internal IO error occurs. - /// Thrown when the permission is denied. + /// + /// By calling this method, you can establish a connection between two applications using the specified RPC port. It requires the target application ID and the name of the desired RPC port. + /// If the connection cannot be established due to invalid arguments or insufficient privileges, appropriate exceptions are thrown accordingly. + /// + /// The ID of the target application to connect to. + /// The name of the RPC port to use for the connection. + /// Thrown if the specified application ID does not exist. + /// Thrown in case of an internal input/output error during the connection process. + /// Thrown when the required privileges are missing or access is otherwise restricted. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch /// 5 @@ -89,13 +93,13 @@ protected void Connect(string appid, string port) } /// - /// Connects to port synchronously. + /// Establishes a connection to the specified application synchronously through the named remote procedure call (RPC) port. /// - /// The target stub app ID. - /// The name of the RPC port. - /// Thrown when not available app ID is used. - /// Thrown when an internal IO error occurs. - /// Thrown when the permission is denied. + /// The ID of the target application to connect to. + /// The name of the RPC port to use for the connection. + /// Thrown if the specified application ID does not exist. + /// Thrown in case of an internal input/output error during the connection process. + /// Thrown when the required privileges are missing or access is otherwise restricted. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch /// 8 @@ -114,11 +118,17 @@ protected void ConnectSync(string appid, string port) } /// - /// Gets a port. + /// Retrieves a port based on its type. /// - /// The type of port. - /// Port object. - /// Thrown when an internal IO error occurs. + /// The specific type of port to retrieve. + /// An object representing the requested port. + /// Thrown if an internal I/O error occurs while retrieving the port. + /// + /// To get a main port: + /// + /// Port mainPort = GetPort(Port.Type.Main); + /// + /// /// 5 protected Port GetPort(Port.Type t) { @@ -137,8 +147,8 @@ protected Port GetPort(Port.Type t) /// /// Abstract method for receiving connected event. /// - /// The target stub app ID. - /// The name of the RPC port. + /// The target stub application ID. + /// The name of the Remote Procedure Call (RPC) port. /// Port object for reading and writing. /// 5 protected abstract void OnConnectedEvent(string endPoint, string portName, Port port); @@ -146,24 +156,24 @@ protected Port GetPort(Port.Type t) /// /// Abstract method for receiving disconnected event. /// - /// The target stub app ID. - /// The name of the port. + /// The target stub application ID.. + /// The name of the Remote Procedure Call (RPC) port. /// 5 protected abstract void OnDisconnectedEvent(string endPoint, string portName); /// /// Abstract method called when the proxy receives data from stub. /// - /// The target stub app ID. - /// The name of the RPC port. + /// The target stub application ID.. + /// The name of the Remote Procedure Call (RPC) port. /// 5 protected abstract void OnReceivedEvent(string endPoint, string portName); /// /// Abstract method for receiving rejected event. /// - /// The target stub app ID. - /// The name of the RPC port. + /// The target stub application ID.. + /// The name of the Remote Procedure Call (RPC) port. /// 5 protected abstract void OnRejectedEvent(string endPoint, string portName); diff --git a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/StubBase.cs b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/StubBase.cs index 8e9c13a80ca..43272dee33e 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/StubBase.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.RPCPort/StubBase.cs @@ -19,8 +19,13 @@ namespace Tizen.Applications.RPCPort { /// - /// Abstract class for creating a stub class for RPC. + /// Base class for creating stubs in RPC. /// + /// + /// This class provides a base implementation for creating stubs that are used in Remote Procedure Call (RPC). By extending this class, you can easily implement your own stubs for specific interfaces. + /// The StubBase class handles common functionality such as managing the connection state and handling incoming requests from clients. It also provides methods for sending responses back to the client after processing the request. + /// To create a stub for a specific interface, you need to extend the StubBase class and override its virtual methods according to the requirements of the interface. + /// /// 5 public abstract class StubBase : IDisposable { @@ -36,10 +41,18 @@ public abstract class StubBase : IDisposable public string PortName { get; } /// - /// Constructor for this class. + /// Constructs a new instance of the StubBase class. /// /// The name of the port that wants to listen. /// Thrown when an internal IO error occurs. + /// + /// Here's an example showing how to construct a new instance of the StubBase class: + /// + /// + /// // Create a new instance of the StubBase class + /// var stubBase = new StubBase("MyPort"); + /// + /// /// 5 public StubBase(string portName) { @@ -55,9 +68,13 @@ public StubBase(string portName) } /// - /// Listens to the requests for connections. + /// Starts listening to incoming connection requests on the specified port. /// - /// Thrown when an internal IO error occurs. + /// + /// This method enables your application to listen for incoming connection requests from other applications. + /// It is typically called after setting up the necessary network infrastructure such as creating a server socket and specifying a listening port. + /// + /// Thrown when an internal IO error occurs during the listening process. /// 5 protected void Listen() { @@ -87,9 +104,9 @@ protected void AddPrivilege(string privilege) } /// - /// Sets a trusted proxy to the stub. + /// Sets whether the stub allows only trusted proxies or not. /// - /// Whether stub allows only trusted proxy or not. + /// Indicates if the stub allows only trusted proxies or not. /// 5 protected void SetTrusted(bool trusted) { @@ -97,13 +114,13 @@ protected void SetTrusted(bool trusted) } /// - /// Gets s port. + /// Retrieves a port based on its type and the connected instance. /// - /// The type of port. - /// The ID of the instance, which is connected. - /// Port object. - /// Thrown when invalid instance is used. - /// Thrown when an internal IO error occurs. + /// The type of port to retrieve. + /// The ID of the instance that the port is connected to. + /// The requested port. + /// Thrown if an invalid instance ID is passed. + /// Thrown in case of an internal I/O error. /// 5 protected Port GetPort(Port.Type t, string instance) { @@ -123,7 +140,7 @@ protected Port GetPort(Port.Type t, string instance) /// /// Abstract method for receiving connected event. /// - /// The target proxy app ID. + /// The target proxy applicstion ID. /// The information about the request. /// 5 protected abstract void OnConnectedEvent(string sender, string instance); @@ -131,7 +148,7 @@ protected Port GetPort(Port.Type t, string instance) /// /// Abstract method for receiving disconnected event. /// - /// The target proxy app ID. + /// The target proxy applicstion ID. /// The information about the request. /// 5 protected abstract void OnDisconnectedEvent(string sender, string instance); @@ -139,7 +156,7 @@ protected Port GetPort(Port.Type t, string instance) /// /// Abstract method called when the stub receives data from proxy. /// - /// The target proxy app ID. + /// The target proxy applicstion ID. /// The information about the request. /// Port object for reading and writing. /// true to continue receiving data, otherwise false to disconnect from the port. diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationComponentType.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationComponentType.cs index c5e9838b2cb..015a3e99941 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationComponentType.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationComponentType.cs @@ -23,27 +23,27 @@ namespace Tizen.Applications public enum ApplicationComponentType { /// - /// Component type is ui application. + /// The user interface (UI) application component type. /// UIApplication = 0, /// - /// Component type is service application. + /// The service application component type. /// ServiceApplication, /// - /// Component type is widget application. + /// The widget application component type. /// WidgetApplication, /// - /// Component type is watch application. + /// The watch application component type. /// WatchApplication, /// - /// Component type is component-based application. + /// The component-based application component type. /// /// 7 ComponentBasedApplication, diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs index b65c4412048..106d9b0ee90 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs @@ -25,7 +25,7 @@ namespace Tizen.Applications public class ApplicationLaunchedEventArgs : EventArgs { /// - /// The information of the application. + /// Gets the current running context of the application. /// /// 3 public ApplicationRunningContext ApplicationRunningContext { get; internal set; } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs index 21abc91d8c5..904594a832a 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs @@ -43,6 +43,9 @@ public static class ApplicationManager /// /// Occurs whenever the installed application is enabled. /// + /// + /// This event is raised whenever the installed application is enabled. It provides information about the application that was enabled through the arguments passed in the event handler. + /// /// 3 public static event EventHandler ApplicationEnabled { @@ -74,6 +77,10 @@ public static event EventHandler ApplicationEnabled /// /// Occurs whenever the installed application is disabled. /// + /// + /// This event is raised whenever the user disables an installed application through the Settings menu. + /// The event handler receives an argument of type ApplicationDisabledEventArgs which contains information about the disabled application. + /// /// 3 public static event EventHandler ApplicationDisabled { @@ -105,6 +112,10 @@ public static event EventHandler ApplicationDisabl /// /// Occurs whenever the installed applications get launched. /// + /// + /// This event provides information about the application that was just launched, including its package ID, version, and other details. + /// It is useful for tracking and monitoring application launches in order to gather statistics or perform certain actions based on specific conditions. + /// /// 3 public static event EventHandler ApplicationLaunched { @@ -133,9 +144,13 @@ public static event EventHandler ApplicationLaunch } } + /// /// Occurs whenever the installed applications get terminated. /// + /// + /// This event is raised whenever any application gets terminated on the device. It provides information about the terminated application through the arguments passed in the event handler. + /// /// 3 public static event EventHandler ApplicationTerminated { @@ -165,9 +180,24 @@ public static event EventHandler ApplicationTerm } /// - /// Gets the information of the installed applications asynchronously. + /// Asynchronously retrieves information about the installed applications. /// - /// The installed application info list. + /// An asynchronous task that returns a list containing information about the installed applications. + /// + /// By calling this method, you can retrieve details about all the applications currently installed on the device. The returned list contains ApplicationInfo objects, which provide various properties such as package ID, version, and icon. + /// + /// + /// To get the information of the installed applications, you can call the following code snippet: + /// + /// + /// var listApp = await ApplicationManager.GetInstalledApplicationsAsync(); + /// Assert.IsNotEmpty(_listApp, "The list of installed app should not be empty."); + /// foreach (ApplicationInfo instapp in _listApp) + /// { + /// Console.WriteLine(instapp.ApplicationId); + /// } + /// + /// /// 3 public static async Task> GetInstalledApplicationsAsync() { @@ -238,10 +268,25 @@ public static void TerminateBackgroundApplication(ApplicationRunningContext app) } /// - /// Gets the information of the installed applications with the ApplicationInfoFilter asynchronously. + /// Retrieves the information about installed applications that match the specified filter criteria in an asynchronous manner. /// - /// Key-value pairs for filtering. - /// The installed application info list. + /// + /// By specifying the desired filter criteria through the argument, you can retrieve only those applications that meet these conditions. The returned result will contain a list of ApplicationInfo objects representing the matched applications. + /// + /// An ApplicationInfoFilter containing the desired filter criteria. + /// An IEnumerable<ApplicationInfo> containing the information of the installed applications that match the specified filter. + /// + /// The following code snippet demonstrates how to obtain the information of all installed applications: + /// + /// var filter = new ApplicationInfoFilter(); + /// filter.Filter.Add(ApplicationInfoFilter.Keys.Id, "org.exmaple.hello"); + /// var apps = await GetInstalledApplicationsAsync(filter); + /// foreach (var app in apps) + /// { + /// Console.WriteLine(app.ApplicationId); + /// } + /// + /// /// 3 public static async Task> GetInstalledApplicationsAsync(ApplicationInfoFilter filter) { @@ -285,10 +330,27 @@ public static async Task> GetInstalledApplicationsA } /// - /// Gets the information of the installed applications with the ApplicationInfoMetadataFilter asynchronously. + /// Asynchronously retrieves the information about installed applications filtered by the specified criteria in the form of ApplicationInfoMetadataFilter. /// - /// Key-value pairs for filtering. - /// The installed application info list. + /// + /// By providing the filter argument, you can specify various conditions such as package names, types, visibility status, etc., which will help narrow down the search results to only those that match the desired criteria. + /// The returned result is a list of ApplicationInfo objects containing detailed information about each matched application. + /// + /// A dictionary of key-value pairs used to define the specific filtering criteria. + /// An enumerable collection of ApplicationInfo objects representing the installed applications that meet the specified filtering criteria. + /// + /// To retrieve all visible applications: + /// + /// + /// var filter = new ApplicationInfoMetadataFilter(); + /// filter.Filter.Add("http://tizen.org/metadata/test-id", "org.exmaple.hello"); + /// var apps = await GetInstalledApplicationsAsync(filter); + /// foreach (var app in apps) + /// { + /// Console.WriteLine(app.ApplicationId); + /// } + /// + /// /// 3 public static async Task> GetInstalledApplicationsAsync(ApplicationInfoMetadataFilter filter) { @@ -332,9 +394,22 @@ public static async Task> GetInstalledApplicationsA } /// - /// Gets the information of the running applications asynchronously. + /// Asynchronously retrieves the information about currently running applications. /// - /// The application running context list. + /// An enumerable list containing details about the running applications. + /// + /// This method provides an efficient way to gather information about all the active apps on the device without blocking the current thread. It returns a task which can be awaited in order to obtain the desired result. + /// + /// + /// Here's an example demonstrating how to retrieve the running applications and display their IDs: + /// + /// await ApplicationManager.GetRunningApplicationsAsync().ContinueWith((task) => { + /// foreach (var app in task.Result) { + /// Console.WriteLine(app.ApplicationId); + /// } + /// }); + /// + /// /// 3 public static async Task> GetRunningApplicationsAsync() { @@ -371,9 +446,26 @@ public static async Task> GetRunningAppli } /// - /// Gets the information of the running applications including subapp asynchronously. + /// Asynchronously retrieves the information about all currently running applications, including subapps. /// - /// The application running context list. + /// An enumerable list containing details about the running applications. + /// + /// This method provides access to the current state of all active applications on the device, allowing you to gather information such as their IDs, types, and states. + /// By utilizing this functionality, developers can gain insights into the overall system activity and make informed decisions based on the available data. + /// + /// + /// Here is an example that demonstrates how to utilize the GetAllRunningApplicationsAsync method in order to obtain information about the currently running applications: + /// + /// // Initiate the call to get all running applications + /// IEnumerable<ApplicationRunningContext> runningApps = await GetAllRunningApplicationsAsync(); + /// + /// // Iterate through the obtained list of running apps + /// foreach (var app in runningApps) + /// { + /// Console.WriteLine($"Id: {app.ApplicationId}"); + /// } + /// + /// /// 3 public static async Task> GetAllRunningApplicationsAsync() { @@ -410,10 +502,25 @@ public static async Task> GetAllRunningAp } /// - /// Gets the information of the specified application with the application ID. + /// Retrieves the information of the specified application by its application ID. /// - /// Application ID. - /// The application info. + /// The ID of the target application. + /// An object containing detailed information about the requested application. + /// + /// This function enables you to obtain specific information about an application based on its application ID. + /// It returns an object that contains various attributes such as the package name, version, icon URL, etc., which are associated with the identified application. + /// If the specified application does not exist in the system, an error message will be thrown indicating that the requested application could not be found. + /// + /// + /// The following code snippet demonstrates how to retrieve the details of an application with the ID "org.example.app": + /// + /// // Retrieve the application details + /// ApplicationInfo appInfo = ApplicationManager.GetInstalledApplication("org.example.app"); + /// + /// // Print the package ID of the retrieved application + /// Console.WriteLine($"Package ID: {appInfo.PackageId}"); + /// + /// /// 3 public static ApplicationInfo GetInstalledApplication(string applicationId) { @@ -428,11 +535,26 @@ public static ApplicationInfo GetInstalledApplication(string applicationId) } /// - /// Returns if the specified application is running or not. + /// Determines whether the specified application is currently running. /// - /// The application ID. - /// Returns true if the given application is running, otherwise false. - /// Thrown when the given parameter is invalid. + /// The unique identifier of the application to check. + /// True if the application identified by the given ID is currently running, otherwise False. + /// Thrown when the provided argument is invalid or missing. + /// + /// The following code snippet demonstrates how to determine if a specific application is currently running: + /// + /// + /// string applicationId = "org.example.app"; + /// if (ApplicationManager.IsRunning(applicationId)) + /// { + /// Console.WriteLine("The application with ID '{0}' is currently running.", applicationId); + /// } + /// else + /// { + /// Console.WriteLine("The application with ID '{0}' is not currently running.", applicationId); + /// } + /// + /// /// 3 public static bool IsRunning(string applicationId) { @@ -446,11 +568,24 @@ public static bool IsRunning(string applicationId) } /// - /// Returns the application id. + /// Retrieves the application ID based on the specified process ID. /// - /// The application pid. - /// Returns the application id. - /// Thrown when the given parameter is invalid. + /// + /// By providing the process ID as input, this function enables you to obtain the corresponding application ID. + /// It ensures that the correct application is identified even if multiple applications are running simultaneously. + /// + /// The process ID of the target application. + /// The application ID associated with the given process ID. + /// If the argument passed in is not valid. + /// + /// The following code snippet demonstrates how to retrieve the application ID by calling the GetAppId() function: + /// + /// + /// int processId = 12345; // Replace with actual process ID + /// string appId = GetAppId(processId); + /// Console.WriteLine($"Application ID: {appId}"); + /// + /// /// 6 public static string GetAppId(int processId) { diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs index e93d5709368..80a8ae32f50 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs @@ -21,8 +21,12 @@ namespace Tizen.Applications { /// - /// This class provides methods and properties to get information of the application. + /// This class provides methods and properties to retrieve information about the currently running application context. /// + /// + /// The ApplicationRunningContext class enables you to obtain various details related to the current execution environment such as the application ID, process id, and user data directory. + /// It also offers functionality to check if the current application is in foreground or background mode. + /// /// 3 public class ApplicationRunningContext : IDisposable { @@ -37,12 +41,24 @@ internal ApplicationRunningContext(IntPtr contextHandle) } /// - /// A constructor of ApplicationRunningContext that takes the application ID. + /// Constructs an ApplicationRunningContext object from the specified application ID. /// - /// Application ID. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "application not exist" error or the system error. - /// Thrown when failed because of out of memory. + /// The ID of the application. + /// + /// The constructor creates a new instance of the ApplicationRunningContext class by passing in the application ID. + /// It throws exceptions if any errors occur during initialization, such as invalid arguments, non-existent applications, system errors, or out of memory conditions. + /// + /// + /// Here's an example demonstrating how to construct an ApplicationRunningContext object using the constructor: + /// + /// + /// // Define the application ID + /// const string APP_ID = "org.example.app"; + /// + /// // Instantiate the ApplicationRunningContext class with the application ID + /// var context = new ApplicationRunningContext(APP_ID); + /// + /// /// 3 public ApplicationRunningContext(string applicationId) { @@ -99,7 +115,7 @@ public ApplicationRunningContext(string applicationId, string instanceId) } /// - /// Destructor of the class. + /// Destroys the current application running context. /// ~ApplicationRunningContext() { diff --git a/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs b/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs index 61960542db2..1bcfe009212 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs @@ -39,10 +39,15 @@ public class Bundle : IDisposable private readonly HashSet _keys; /// - /// The bundle constructor. + /// Creates a new instance of the Bundle class. /// + /// + /// This constructor initializes a new instance of the Bundle class. It does not perform any specific actions by itself but provides a starting point for creating and managing bundles of data. + /// /// Thrown when out of memory. /// + /// Here's an example showing how to create a new instance of the Bundle class: + /// /// /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// @@ -56,10 +61,10 @@ public Bundle() } /// - /// The bundle constructor. + /// Creates a new instance of the Bundle class from the specified SafeBundleHandle. /// - /// The SafeBundleHandle instance. - /// Thrown when the handle is null or invalid. + /// The SafeBundleHandle instance that represents the bundle. + /// Thrown if the handle argument is null or invalid. /// 3 public Bundle(SafeBundleHandle handle) { diff --git a/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs b/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs index 916c7392a26..1e04fc155cc 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs @@ -28,8 +28,11 @@ namespace Tizen.Applications { /// - /// This class represents an application controlled lifecycles by the backend system. + /// The CoreApplication class provides functionality to manage application lifecycle events that are controlled by the backend system. /// + /// + /// By inheriting from the Application class, CoreApplication enables developers to handle various application states such as creating and terminating. It also allows them to define their own event handlers for these states. + /// /// 3 public class CoreApplication : Application { @@ -38,9 +41,14 @@ public class CoreApplication : Application private bool _disposedValue = false; /// - /// Initializes the CoreApplication class. + /// Initializes the CoreApplication class by providing a specific implementation of the ICoreBackend interface. /// - /// The backend instance implementing ICoreBacked interface. + /// An instance of the desired implementation of the ICoreBackend interface. + /// + /// The CoreApplication class provides access to various features and functionalities related to application management. + /// By initializing the CoreApplication class with a specific implementation of the ICoreBackend interface, developers can customize the behavior and functionality of their applications based on their requirements. + /// It enables them to extend the capabilities of the default CoreApplication class and tailor it according to their needs. + /// /// 3 public CoreApplication(ICoreBackend backend) { @@ -169,8 +177,9 @@ public override void Exit() } /// - /// Overrides this method if want to handle behavior when the application is launched. - /// If base.OnCreated() is not called, the event 'Created' will not be emitted. + /// Overrides this method if you want to handle specific behavior when the application is created. + /// Calling base.OnCreate() ensures that the default implementation is executed before any custom code in this method. + /// If base.OnCreate() is not called, the event 'Created' will not be emitted. /// /// 3 protected virtual void OnCreate() @@ -195,8 +204,8 @@ protected virtual void OnCreate() } /// - /// Overrides this method if want to handle behavior when the application is terminated. - /// If base.OnTerminate() is not called, the event 'Terminated' will not be emitted. + /// Override this method to define specific actions that occur when the application terminates. + /// Calling base.OnTerminate() ensures that the default termination process takes place and the 'Terminated' event is emitted. /// /// 3 protected virtual void OnTerminate() @@ -205,10 +214,10 @@ protected virtual void OnTerminate() } /// - /// Overrides this method if want to handle behavior when the application receives the appcontrol message. - /// If base.OnAppControlReceived() is not called, the event 'AppControlReceived' will not be emitted. + /// Override this method to customize the behavior when the application receives the appcontrol message. + /// If base.OnAppControlReceived() is not called, the event 'AppControlReceived' will not be triggered. /// - /// + /// The arguments passed in the appcontrol message /// 3 protected virtual void OnAppControlReceived(AppControlReceivedEventArgs e) { @@ -222,8 +231,8 @@ protected virtual void OnAppControlReceived(AppControlReceivedEventArgs e) } /// - /// Overrides this method if want to handle behavior when the system memory is low. - /// If base.OnLowMemory() is not called, the event 'LowMemory' will not be emitted. + /// Override this method to handle behavior when the system memory is low. + /// Calling base.OnLowMemory() ensures that the 'LowMemory' event is emitted. /// /// The low memory event argument /// 3 @@ -243,10 +252,10 @@ protected virtual void OnLowMemory(LowMemoryEventArgs e) } /// - /// Overrides this method if want to handle behavior when the system battery is low. - /// If base.OnLowBattery() is not called, the event 'LowBattery' will not be emitted. + /// Override this method to handle the behavior when the system battery level drops. + /// If base.OnLowBattery() is not called, the LowBattery event will not be raised. /// - /// The low battery event argument + /// The arguments for the low battery event /// 3 protected virtual void OnLowBattery(LowBatteryEventArgs e) { @@ -260,10 +269,10 @@ protected virtual void OnLowBattery(LowBatteryEventArgs e) } /// - /// Overrides this method if want to handle behavior when the system language is changed. - /// If base.OnLocaleChanged() is not called, the event 'LocaleChanged' will not be emitted. + /// Override this method to handle changes in the system language. + /// If base.OnLocaleChanged() is not called, the LocaleChanged event will not be triggered. /// - /// The locale changed event argument + /// The arguments passed with the LocaleChanged event /// 3 protected virtual void OnLocaleChanged(LocaleChangedEventArgs e) { @@ -282,10 +291,10 @@ protected virtual void OnLocaleChanged(LocaleChangedEventArgs e) } /// - /// Overrides this method if want to handle behavior when the region format is changed. - /// If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. + /// Override this method to handle changes in the region format. + /// Make sure to call base.OnRegionFormatChanged() to ensure that the RegionFormatChanged event is raised. /// - /// The region format changed event argument + /// The region format changed event arguments /// 3 protected virtual void OnRegionFormatChanged(RegionFormatChangedEventArgs e) { @@ -304,10 +313,10 @@ protected virtual void OnRegionFormatChanged(RegionFormatChangedEventArgs e) } /// - /// Overrides this method if want to handle behavior when the device orientation is changed. - /// If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. + /// Override this method to define specific behavior when the device orientation changes. + /// If base.OnDeviceOrientationChanged() is not called, the 'DeviceOrientationChanged' event will not be raised. /// - /// The device orientation changed event argument + /// The arguments for the device orientation change event /// 3 protected virtual void OnDeviceOrientationChanged(DeviceOrientationEventArgs e) { @@ -315,10 +324,10 @@ protected virtual void OnDeviceOrientationChanged(DeviceOrientationEventArgs e) } /// - /// Override this method if you want to handle behavior when the time zone is changed. - /// If base.OnTimeZoneChanged() is not called, the event "TimeZoneChanged" will not be emitted. + /// Override this method to handle changes in the current time zone. + /// Calling base.OnTimeZoneChanged() ensures that the TimeZoneChanged event is triggered. /// - /// The time zone changed event argument + /// The arguments containing details about the time zone change /// 11 protected virtual void OnTimeZoneChanged(TimeZoneChangedEventArgs e) { diff --git a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs index 16805c4b013..f0b6ebfb90a 100755 --- a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs +++ b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs @@ -20,7 +20,8 @@ namespace Tizen.Applications.ComponentBased { /// - /// This class provides methods and properties to get information of the component. + /// Provides methods and properties to retrieve information about a component in a Tizen application. + /// This class encapsulates details such as component ID, application ID, and other attributes. /// /// 6 public class ComponentInfo : IDisposable @@ -41,13 +42,13 @@ internal ComponentInfo(IntPtr infoHandle) } /// - /// A constructor of ComponentInfo that takes the component ID. + /// Initializes a new instance of the class with the specified component ID. /// - /// Component ID. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied.> + /// The ID of the component. + /// Thrown when the component ID is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied. /// http://tizen.org/privilege/packagemanager.info /// 6 public ComponentInfo(string componentId) @@ -63,7 +64,7 @@ public ComponentInfo(string componentId) } /// - /// Destructor of the class. + /// Finalizes an instance of the class. /// ~ComponentInfo() { @@ -71,7 +72,7 @@ public ComponentInfo(string componentId) } /// - /// Gets the component ID. + /// Gets the ID of the component. /// /// 6 public string ComponentId @@ -94,7 +95,7 @@ public string ComponentId } /// - /// Gets the application ID of the component. + /// Gets the application ID associated with the component. /// /// 6 public string ApplicationId @@ -132,7 +133,7 @@ public ComponentType ComponentType } /// - /// Checks whether the icon of the component should be displayed or not. + /// Checks whether the icon of the component should be displayed. /// /// 6 public bool IsIconDisplayed @@ -151,7 +152,7 @@ public bool IsIconDisplayed } /// - /// Checks whether the component should be managed by task-manager or not. + /// Checks whether the component is managed by the task manager. /// /// 6 public bool IsManagedByTaskManager @@ -170,7 +171,7 @@ public bool IsManagedByTaskManager } /// - /// Gets the absolute path of the icon image. + /// Gets the absolute path of the component's icon image. /// /// 6 public string IconPath @@ -207,11 +208,11 @@ public string Label } /// - /// Gets the localized label of the component for the given locale. + /// Gets the localized label of the component for a specified locale. /// - /// Locale. - /// The format of locale is language and country code. (available value: "[2-letter lowercase language code (ISO 639-1)]-[2-letter lowercase country code (ISO 3166-alpha-2)]") - /// The localized label. + /// The locale in the format of language and country code (e.g., "en-US"). + /// Available values are in the format "[2-letter lowercase language code (ISO 639-1)]-[2-letter lowercase country code (ISO 3166-alpha-2)]". + /// The localized label corresponding to the specified locale. /// 6 public string GetLocalizedLabel(string locale) { @@ -226,7 +227,7 @@ public string GetLocalizedLabel(string locale) } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases all resources used by the class. /// /// 6 public void Dispose() @@ -236,7 +237,7 @@ public void Dispose() } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases resources used by the class. /// /// Disposing /// 6 diff --git a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs index 4824e6f4e4b..890c8080fc0 100755 --- a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs +++ b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs @@ -29,15 +29,18 @@ namespace Tizen.Applications.ComponentBased public static class ComponentManager { private const string LogTag = "Tizen.Applications"; - + /// - /// Gets the information of the installed components asynchronously. + /// Asynchronously retrieves a list of installed components. /// - /// The installed component info list. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// + /// A task that represents the asynchronous operation. + /// The task result contains an of the installed component information. + /// + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to access the component information. /// http://tizen.org/privilege/packagemanager.info /// 6 public static async Task> GetInstalledComponentsAsync() @@ -74,13 +77,16 @@ public static async Task> GetInstalledComponentsAsync } /// - /// Gets the information of the running components asynchronously. + /// Asynchronously retrieves a list of currently running components. /// - /// The component running context list. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// + /// A task that represents the asynchronous operation. + /// The task result contains an of the running components. + /// + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to access the running components. /// http://tizen.org/privilege/packagemanager.info /// 6 public static async Task> GetRunningComponentsAsync() @@ -117,14 +123,16 @@ public static async Task> GetRunningCompone } /// - /// Checks whether the component is running or not. + /// Checks if a specified component is currently running. /// - /// Component ID. - /// Returns true if the component is running, otherwise false. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// The unique identifier of the component. + /// + /// True if the component is running; otherwise, false. + /// + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to access the component status. /// http://tizen.org/privilege/packagemanager.info /// 6 public static bool IsRunning(string componentId) @@ -139,17 +147,17 @@ public static bool IsRunning(string componentId) } /// - /// Terminates the component if it is running in the background. + /// Requests to terminate a specified component that is running in the background. /// - /// Component ID - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// The context of the running component to terminate. + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to terminate the component. /// http://tizen.org/privilege/appmanager.kill.bgapp /// - /// This function returns after it just sends a request for terminating a background component. - /// Platform will decide if the target component could be terminated or not according to the state of the target component. + /// This method sends a request to terminate a background component. + /// The platform determines if the target component can be terminated based on its current state. /// /// 6 public static void TerminateBackgroundComponent(ComponentRunningContext context) diff --git a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs index 4932922087c..0c366ec1c6e 100755 --- a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs +++ b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs @@ -23,7 +23,8 @@ namespace Tizen.Applications.ComponentBased { /// - /// This class provides methods and properties to get information of the running component. + /// Represents the context of a running component, providing methods and properties + /// to retrieve information about the component's state and behavior. /// /// 6 public class ComponentRunningContext : IDisposable @@ -39,13 +40,14 @@ internal ComponentRunningContext(IntPtr contextHandle) } /// - /// A constructor of ComponentRunningContext that takes the component ID. + /// Initializes a new instance of the class + /// with a specified component ID, retrieving the context handle associated with it. /// - /// Component ID. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// The ID of the component. + /// Thrown when the component ID is invalid. + /// Thrown when the component does not exist or a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to access the component. /// http://tizen.org/privilege/packagemanager.info /// 6 public ComponentRunningContext(string componentId) @@ -61,7 +63,7 @@ public ComponentRunningContext(string componentId) } /// - /// Destructor of the class. + /// Finalizes an instance of the class. /// ~ComponentRunningContext() { @@ -69,7 +71,7 @@ public ComponentRunningContext(string componentId) } /// - /// Enumeration for the component state. + /// Represents the possible states of a component. /// /// 6 public enum ComponentState @@ -108,6 +110,7 @@ public enum ComponentState /// /// Gets the ID of the component. /// + /// The component ID as a string. /// 6 public string ComponentId { @@ -129,7 +132,7 @@ public string ComponentId } /// - /// Gets the application ID of the component. + /// Gets the application ID associated with the component. /// /// 6 public string ApplicationId @@ -146,7 +149,7 @@ public string ApplicationId return appId; } } - + /// /// Gets the instance ID of the component. /// @@ -167,7 +170,7 @@ public string InstanceId } /// - /// Gets the state of the component. + /// Gets the current state of the component. /// /// 6 public ComponentState State @@ -186,8 +189,9 @@ public ComponentState State } /// - /// Checks whether the component is terminated or not. + /// Checks whether the component has been terminated. /// + /// true if the component is terminated; otherwise, false. /// 6 public bool IsTerminated { @@ -205,8 +209,9 @@ public bool IsTerminated } /// - /// Checks whether the component is running as sub component of the group. + /// Checks whether the component is running as a sub-component of a group. /// + /// true if the component is a sub-component; otherwise, false. /// 6 public bool IsSubComponent { @@ -224,12 +229,12 @@ public bool IsSubComponent } /// - /// Resumes the running component. + /// Resumes the execution of the running component. /// - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// Thrown when the argument is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to resume the component. /// http://tizen.org/privilege/appmanager.launch /// 6 public void Resume() @@ -237,17 +242,17 @@ public void Resume() Interop.ComponentManager.ErrorCode err = Interop.ComponentManager.ComponentManagerResumeComponent(_contextHandle); if (err != Interop.ComponentManager.ErrorCode.None) { - throw ComponentManager.ComponentManagerErrorFactory.GetException(err, "Failed to Send the resume request."); + throw ComponentManager.ComponentManagerErrorFactory.GetException(err, "Failed to send the resume request."); } } /// - /// Pauses the running component. + /// Pauses the execution of the running component. /// - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// Thrown when the argument is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to pause the component. /// http://tizen.org/privilege/appmanager.launch /// 6 [EditorBrowsable(EditorBrowsableState.Never)] @@ -261,12 +266,12 @@ public void Pause() } /// - /// Terminates the running component. + /// Terminates the execution of the running component. /// - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// Thrown when the argument is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to terminate the component. /// http://tizen.org/privilege/appmanager.launch /// 6 [EditorBrowsable(EditorBrowsableState.Never)] @@ -280,7 +285,7 @@ public void Terminate() } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases all resources used by the class. /// /// 6 public void Dispose() @@ -290,9 +295,9 @@ public void Dispose() } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases all resources used by the class. /// - /// Disposing + /// true to release managed resources; otherwise, false. /// 6 private void Dispose(bool disposing) { diff --git a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentPort.cs b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentPort.cs index e62d82f764f..a0f70d1dec6 100755 --- a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentPort.cs +++ b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentPort.cs @@ -43,12 +43,12 @@ public class ComponentPort : IDisposable private static int _requestId = 0; /// - /// Constructor for this class. + /// Constructs a new instance of this class. /// /// Thrown when the argument is invalid. /// Thrown when the memory is insufficient. /// Thrown when because of I/O error. - /// The name of the port. + /// The name of the port to connect to. /// 9 public ComponentPort(string portName) { @@ -77,7 +77,7 @@ public string PortName /// Adds a privilege to the port object. /// /// Thrown when the argument is invalid. - /// privilege data + /// Privilege data specifying the access rights to be granted. /// 9 public void AddPrivilege(string privilege) { @@ -157,8 +157,8 @@ public static Task WaitForPort(string endpoint) /// /// /// This method runs a main loop until Cancel() is called. - /// The code in the next line will not run until Cancel() is called. - /// To avoid blocking the main thread, it's recommended to use the ComponentTask class. + /// The code in the next line will not execute until Cancel() is called. + /// To prevent blocking the main thread, consider using the ComponentTask class instead. /// /// /// @@ -182,15 +182,19 @@ public void Cancel() } /// - /// Sends the request data. + /// Sends the request data to the specified endpoint. /// + /// + /// This method sends the serialized request data to the specified endpoint. + /// If the timeout value is not set (-1), the default timeout will be used. + /// /// Thrown when the argument is invalid. /// Thrown when the memory is insufficient. /// Thrown when permission is denied. /// Thrown when because of I/O error. - /// The name of the endpoint - /// The timeout in milliseconds, -1 to use the default timeout - /// The serializable data to send + /// The name of the endpoint to which the request is sent. + /// The timeout in milliseconds, -1 to use the default timeout. + /// The serializable data to send. /// 9 public void Send(string endpoint, int timeout, object request) { @@ -222,10 +226,10 @@ public void Send(string endpoint, int timeout, object request) /// Thrown when the memory is insufficient. /// Thrown when permission is denied. /// Thrown when because of I/O error. - /// The name of the endpoint - /// The timeout in milliseconds, -1 to use the default timeout - /// The serializable data to send - /// The received serializable data + /// The name of the endpoint to which the request is sent. + /// The timeout in milliseconds, -1 to use the default timeout. + /// The serializable data to send. + /// The received serializable data. /// 9 public object SendAndReceive(string endpoint, int timeout, object request) { @@ -264,11 +268,11 @@ public object SendAndReceive(string endpoint, int timeout, object request) /// Thrown when the memory is insufficient. /// Thrown when permission is denied. /// Thrown when because of I/O error. - /// The name of the endpoint - /// The timeout in milliseconds, -1 to use the default timeout - /// The serializable data to send - /// The received serializable data - /// /// 9 + /// The name of the endpoint to which the request is sent. + /// The timeout in milliseconds, -1 to use the default timeout. + /// The serializable data to send. + /// The received serializable data. + /// 9 public Task SendAndReceiveAsync(string endpoint, int timeout, object request) { try @@ -285,7 +289,7 @@ public Task SendAndReceiveAsync(string endpoint, int timeout, object req /// Occurs whenever the request is received. /// /// - /// If the reply is requested, RequestEventArgs.Request should be set. + /// The event handler receives a RequestEventArgs argument that contains information about the request. If the reply is requested, RequestEventArgs.Request should be set. /// /// 9 public event EventHandler RequestReceived; @@ -422,7 +426,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Finalizer of the class ComponentPort. + /// Finalizes an instance of the class ComponentPort. /// /// 9 ~ComponentPort() @@ -433,7 +437,7 @@ protected virtual void Dispose(bool disposing) /// /// Releases all the resources used by the class ComponentPort. /// - /// 9 > + /// 9 public void Dispose() { Dispose(disposing: true); diff --git a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentTask.cs b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentTask.cs index 2134be10a4b..9d5bb6c1754 100755 --- a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentTask.cs +++ b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/ComponentTask.cs @@ -59,10 +59,10 @@ private void OnThread() /// /// Starts the task. - /// - /// This method calls ComponentPort.WaitForEvent() in the thread. - /// /// + /// + /// This method calls in the thread. + /// /// 9 public void Start() { @@ -81,7 +81,7 @@ public void Start() /// Stops the task. /// /// - /// This method calls ComponentPort.Cancel() before stopping the thread. + /// This method calls before stopping the thread. /// /// 9 public void Stop() diff --git a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/Parcel.cs b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/Parcel.cs index 4f2db8ac6a0..ac10b5e9ef3 100755 --- a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/Parcel.cs +++ b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/Parcel.cs @@ -86,7 +86,7 @@ protected virtual void Dispose(bool disposing) } /// - /// Finalizer of the class Parcel. + /// Finalizes an instance of the Parcel class. /// /// 9 ~Parcel() @@ -97,7 +97,7 @@ protected virtual void Dispose(bool disposing) /// /// Releases all the resources used by the class parcel. /// - /// 9 > + /// 9 public void Dispose() { Dispose(disposing: true); @@ -123,4 +123,4 @@ internal static Exception GetException(Interop.Parcel.ErrorCode err, string mess } } } -} \ No newline at end of file +} diff --git a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/RequestEventArgs.cs b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/RequestEventArgs.cs index 652c9b1577a..c93086ee17b 100755 --- a/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/RequestEventArgs.cs +++ b/src/Tizen.Applications.ComponentBased.Port/Tizen.Applications.ComponentBased.Port/RequestEventArgs.cs @@ -19,7 +19,7 @@ namespace Tizen.Applications.ComponentBased { /// - /// Arguments for the event raised when the request is received. + /// The arguments for the event raised when the request is received. /// /// 9 public class RequestEventArgs : EventArgs diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs index 1940a3ff776..52b9ecbdce3 100755 --- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs +++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs @@ -21,11 +21,11 @@ namespace Tizen.Applications.ComponentBased.Common { /// - /// This is a base-component class. - /// It provides common functions of FrameComponent and ServiceComponent. + /// Represents the base class for components, providing common functionalities for both FrameComponent and ServiceComponent. /// /// - /// This class cannot be registered by ComponentBased applications. + /// This class cannot be registered directly by ComponentBased applications. + /// It serves as a base class to be inherited by other components. /// /// 6 public abstract class BaseComponent @@ -75,26 +75,26 @@ public abstract class BaseComponent public event EventHandler TimeZoneChanged; /// - /// A component instance ID. + /// Gets the unique instance ID of the component. /// It will be created after OnCreate method is invoked. /// /// 6 public string Id { get; private set; } /// - /// A component ID + /// Gets the ID of the component. /// /// 6 public string ComponentId { get; private set; } /// - /// Parent object + /// Gets the parent application object to which the component belongs. /// /// 6 public ComponentBasedApplication Parent { get; private set; } /// - /// Finish current component + /// Finishes the current component. /// /// 6 public void Finish() @@ -128,18 +128,18 @@ internal void Bind(IntPtr handle, string compId, string instanceId, ComponentBas } /// - /// Overrides this method if want to handle behavior to restore the previous status. + /// Override this method to handle restoring the previous state of the component. /// - /// Contents. It can be used only in the callback. To use outside, make a copy. + /// A bundle containing the saved state of the component. It can only be used within the callback. To use it outside, create a copy. /// 6 public virtual void OnRestoreContents(Bundle c) { } /// - /// Overrides this method if want to handle behavior to save current status. + /// Override this method to handle saving the current state of the component. /// - /// Contents. It can be used only in the callback. To use outside, make a copy. + /// A bundle containing the current state of the component. It can only be used within the callback. To use it outside, create a copy. /// 6 public virtual void OnSaveContent(Bundle c) { @@ -181,17 +181,18 @@ internal void OnTimeZoneChangedCallback(string timeZone, string timeZoneId) } /// - /// Sends the launch request asynchronously. + /// Sends a launch request asynchronously. /// /// - /// To use group mode, you must use this function instead of SendLaunchRequestAsync(). + /// Use this method to send a launch request with group mode enabled. + /// If group mode is not required, you can use SendLaunchRequestAsync() instead. /// - /// appcontrol object - /// The callback function to be called when the reply is delivered. - /// A task with the result of the launch request. + /// The AppControl object representing the request details. + /// The callback function to be invoked when the reply is received. + /// A task representing the result of the launch request. /// Thrown when failed because of the argument is invalid. - /// Thrown when fail to set component information to the AppControl. - /// Thrown when the application to run is not found. + /// Thrown when there is a failure in setting the component information in the AppControl. + /// Thrown when the target application is not found. /// Thrown when the launch request is rejected. /// http://tizen.org/privilege/appmanager.launch /// 6 diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs index 8b6cf709f15..da36a7fad81 100755 --- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs +++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs @@ -20,8 +20,13 @@ namespace Tizen.Applications.ComponentBased.Common { /// - /// The class for supporting multi-components based application model. + /// Represents the base class for a multi-component based application. + /// This class allows the creation and management of multiple application components, such as Frame, Service, and Widget components. /// + /// + /// This abstract class provides the core structure for applications that consist of multiple components. + /// Each component has its own lifecycle, and the framework handles these lifecycles independently. + /// /// 6 public abstract class ComponentBasedApplication : Application { @@ -30,12 +35,24 @@ public abstract class ComponentBasedApplication : Application private Interop.CBApplication.CBAppLifecycleCallbacks _callbacks; /// - /// Initializes the ComponentBasedApplicationBase class. + /// Initializes a new instance of the class with the specified component type information. /// - /// The component type information. - /// The key should be a class type of FrameComponent or SubComponent subclass. - /// The value should be a component id which is declared in tizen-manifest.xml. - /// + /// A dictionary where the key is the component class type (FrameComponent, ServiceComponent or WidgetComponent subclass), + /// and the value is the component ID defined in the tizen-manifest.xml file. + /// + /// This constructor sets up the necessary callbacks for the application lifecycle and registers the provided components. + /// + /// + /// + /// IDictionary<Type, string> components = new Dictionary<Type, string>() + /// { + /// { typeof(MyFrameComponent), "frameComponentId" }, + /// { typeof(MyServiceComponent), "serviceComponentId" } + /// }; + /// ComponentBasedApplication app = new MyApplication(components); + /// app.Run(args); + /// + /// /// 6 public ComponentBasedApplication(IDictionary typeInfo) { @@ -53,11 +70,19 @@ public ComponentBasedApplication(IDictionary typeInfo) } /// - /// Registers a component. + /// Registers a component with the specified type and ID. /// - /// Class type - /// Component ID - /// Thrown when component type is already added or not sub-class of FrameComponent or ServiceComponent + /// The type of the component to register. Must be a subclass of FrameComponent, ServiceComponent, or WidgetComponent. + /// The ID of the component, defined in the tizen-manifest.xml file. + /// Thrown when the component type is already registered or not sub-class of FrameComponent, ServiceComponent or WidgetComponent. + /// + /// This method ensures that only valid component types are registered. The component ID must be unique. + /// + /// + /// + /// app.RegisterComponent(typeof(MyFrameComponent), "frameComponentId"); + /// + /// /// 6 public void RegisterComponent(Type compType, string compId) { @@ -98,8 +123,13 @@ public void RegisterComponent(Type compType, string compId) /// /// Runs the application's main loop. /// - /// Arguments from commandline. + /// The arguments passed from the command line. /// Thrown when component type is already added to the component. + /// + /// + /// app.Run(args); + /// + /// /// 6 public override void Run(string[] args) { @@ -121,7 +151,7 @@ public override void Run(string[] args) } /// - /// Exits the main loop of the application. + /// Exits the application's main loop. /// /// 6 public override void Exit() @@ -166,31 +196,43 @@ private void OnFinishedNative(IntPtr data) } /// - /// This method will be called before running main-loop + /// Called before the main loop starts. /// - /// + /// The arguments passed from the command line. + /// + /// Override this method to handle any initialization logic before the application enters the main event loop. + /// /// 6 protected virtual void OnInit(string[] args) { } /// - /// This method will be called after exiting main-loop + /// Called after the main loop exits. /// + /// + /// Override this method to handle any cleanup logic after the application has finished running. + /// /// 6 protected virtual void OnFinished() { } /// - /// This method will be called to start main-loop + /// Called to start the main loop of the application. /// + /// + /// This is an abstract method that must be implemented by derived classes to define the behavior when the application starts. + /// /// 6 protected abstract void OnRun(); /// - /// This method will be called to exit main-loop + /// Called to exit the main loop of the application. /// + /// + /// Override this method to handle any logic needed before the application exits. + /// /// 6 protected virtual void OnExit() { diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs index d3b166492dd..5a378791aa5 100644 --- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs +++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs @@ -19,15 +19,19 @@ namespace Tizen.Applications.ComponentBased.Common { /// - /// The class for showing UI module + /// Represents a base class for UI components in the component-based application model. + /// This class provides methods for handling the lifecycle and state of UI components. /// /// 6 public abstract class FrameComponent : BaseComponent { /// - /// Gets the display status of a component. + /// Gets the current display status of the component. /// - /// Thrown when component type is already added to the component. + /// + /// The current of the component. + /// + /// Thrown when the display status cannot be retrieved. /// 6 public DisplayStatus DisplayStatus { @@ -43,31 +47,36 @@ public DisplayStatus DisplayStatus } /// - /// Overrides this method to handle behavior when the component is launched. + /// Called when the component is launched. Override this method to implement custom launch behavior. /// - /// True if a service component is successfully created + /// + /// true if the service component is successfully created; otherwise, false. + /// /// 6 public abstract bool OnCreate(); /// - /// Overrides this method to create window. It will be called before OnCreate method. + /// Called to create the window for the component. Override this method to provide a custom window. + /// This method will be called before method. /// - /// Window object to use + /// + /// An object that represents the created window. + /// /// 6 public abstract IWindowInfo CreateWindowInfo(); /// - /// Overrides this method if want to handle behavior when the component receives the appcontrol message. + /// Called when the component receives an app control message. Override this method to handle app control messages. /// - /// appcontrol object - /// True if it was restarted + /// The object containing the app control data. + /// true if the component was restarted; otherwise, false. /// 6 public virtual void OnStart(AppControl appControl, bool restarted) { } /// - /// Overrides this method if you want to handle the behavior when the component is resumed. + /// Called when the component is resumed. Override this method to handle resume behavior. /// /// 6 public virtual void OnResume() @@ -75,7 +84,7 @@ public virtual void OnResume() } /// - /// Overrides this method if you want to handle the behavior when the component is paused. + /// Called when the component is paused. Override this method to handle pause behavior. /// /// 6 public virtual void OnPause() @@ -83,7 +92,7 @@ public virtual void OnPause() } /// - /// Overrides this method if you want to handle the behavior when the component is stopped. + /// Called when the component is stopped. Override this method to handle stop behavior. /// /// 6 public virtual void OnStop() @@ -91,7 +100,7 @@ public virtual void OnStop() } /// - /// Overrides this method if want to handle behavior when the component is destroyed. + /// Called when the component is destroyed. Override this method to handle destruction behavior. /// /// 6 public virtual void OnDestroy() diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs index 6dc04f2c3b5..3d95badcdc5 100755 --- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs +++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs @@ -19,29 +19,33 @@ namespace Tizen.Applications.ComponentBased.Common { /// - /// The class for showing service module + /// Represents a base class for service components in the component-based application model. + /// This class provides methods for handling the lifecycle and state of service components. /// /// 6 public abstract class ServiceComponent : BaseComponent { /// - /// Overrides this method to handle behavior when the component is created. + /// Called when the service component is created. Override this method to implement custom creation behavior. /// - /// True if a service component is successfully created + /// + /// true if the service component is successfully created; otherwise, false. + /// + /// 6 public abstract bool OnCreate(); /// - /// Overrides this method if want to handle behavior when the component receives the start command message. + /// Called when the service component receives a start command message. Override this method to handle start command behavior. /// - /// appcontrol object - /// True if it was restarted + /// The object containing the app control data. + /// true if the component was restarted; otherwise, false. /// 6 public virtual void OnStartCommand(AppControl appControl, bool restarted) { } /// - /// Overrides this method if want to handle behavior when the component is destroyed. + /// Called when the service component is destroyed. Override this method to handle destruction behavior. /// /// 6 public virtual void OnDestroy() @@ -49,3 +53,4 @@ public virtual void OnDestroy() } } } + diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs index 6f69360135a..a4e83f00b2f 100644 --- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs +++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs @@ -19,41 +19,47 @@ namespace Tizen.Applications.ComponentBased.Common { /// - /// The class for showing UI module + /// Represents a base class for widget components in the component-based application model. + /// This class provides methods for handling the lifecycle and state of widget components. /// /// 9 public abstract class WidgetComponent : BaseComponent { - /// - /// Override this method to handle behavior when the component is launched. + /// Called when the widget component is created. Override this method to implement custom creation behavior. /// - /// The width of the widget component instance - /// The height of the widget component instance - /// True if a service component is successfully created + /// The width of the widget component instance. + /// The height of the widget component instance. + /// + /// true if the widget component is successfully created; otherwise, false. + /// /// 9 public abstract bool OnCreate(int width, int height); /// - /// Override this method to create window. It will be called before OnCreate method. + /// Called to create the window for the widget. This method will be called before the method. /// - /// The width of the widget window - /// The height of the widget window - /// Window object to use + /// The width of the widget window. + /// The height of the widget window. + /// + /// An object representing the window to use. + /// /// 9 public abstract IWindowProxy CreateWindowInfo(int width, int height); /// - /// Overrid this method if want to handle behavior when the component is started. + /// Called when the widget component is started. Override this method to handle start behavior. /// - /// True if it was restarted + /// + /// true if the component was restarted; otherwise, false. + /// /// 9 public virtual void OnStart(bool restarted) { } /// - /// Override this method if you want to handle the behavior when the component is resumed. + /// Called when the widget component is resumed. Override this method to handle resume behavior. /// /// 9 public virtual void OnResume() @@ -61,7 +67,7 @@ public virtual void OnResume() } /// - /// Override this method if you want to handle the behavior when the component is paused. + /// Called when the widget component is paused. Override this method to handle pause behavior. /// /// 9 public virtual void OnPause() @@ -69,7 +75,7 @@ public virtual void OnPause() } /// - /// Override this method if you want to handle the behavior when the component is stopped. + /// Called when the widget component is stopped. Override this method to handle stop behavior. /// /// 9 public virtual void OnStop() @@ -77,9 +83,11 @@ public virtual void OnStop() } /// - /// Override this method if want to handle behavior when the component is destroyed. + /// Called when the widget component is destroyed. Override this method to handle destruction behavior. /// - /// True if the instance is permanent + /// + /// true if the instance is permanent; otherwise, false. + /// /// 9 public virtual void OnDestroy(bool permanent) { diff --git a/src/Tizen.Applications.Notification/Interop/Interop.Notification.cs b/src/Tizen.Applications.Notification/Interop/Interop.Notification.cs index 44e6f7e6e19..46988c4ce1d 100644 --- a/src/Tizen.Applications.Notification/Interop/Interop.Notification.cs +++ b/src/Tizen.Applications.Notification/Interop/Interop.Notification.cs @@ -238,6 +238,21 @@ internal static class Notification [DllImport(Libraries.Notification, EntryPoint = "notification_get_check_box")] internal static extern NotificationError GetCheckBox(NotificationSafeHandle handle, out bool flag, out bool checkedValue); + /* apis for do not disturb app */ + internal delegate void DisturbCallback(IntPtr userData); + + [DllImport(Libraries.Notification, EntryPoint = "notification_register_do_not_disturb_app")] + internal static extern NotificationError RegisterDndApp(DisturbCallback cb, IntPtr userData); + + [DllImport(Libraries.Notification, EntryPoint = "notification_unregister_do_not_disturb_app")] + internal static extern NotificationError UnRegisterDndApp(); + + [DllImport(Libraries.Notification, EntryPoint = "notification_set_pairing_type")] + internal static extern NotificationError SetPairingType(NotificationSafeHandle handle, bool pairing); + + [DllImport(Libraries.Notification, EntryPoint = "notification_get_pairing_type")] + internal static extern NotificationError GetPairingType(NotificationSafeHandle handle, out bool pairing); + internal static NotificationError GetText(NotificationSafeHandle handle, NotificationText type, out string text) { NotificationError ret; diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs index 019ea0a9a7e..dbe43211294 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs @@ -212,6 +212,9 @@ public int Count [EditorBrowsable(EditorBrowsableState.Never)] public bool CheckedValue { get; set; } = false; + [EditorBrowsable(EditorBrowsableState.Never)] + public bool PairingType { get; set; } = false; + /// /// Gets or sets NotificationSafeHandle. /// @@ -525,7 +528,7 @@ internal Notification Build() Bundle bundle = new Bundle(new SafeBundleHandle(extension, false)); foreach (string key in bundle.Keys) { - if (key.StartsWith("_NOTIFICATION_EXTENSION_EVENT_")) + if (key.StartsWith("_NOTIFICATION_EXTENSION_EVENT_") || key.StartsWith("_NOTIFICATION_TYPE_PAIRING_")) continue; SafeBundleHandle sbh; diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationBinder.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationBinder.cs index b847e6917a3..750914b164e 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationBinder.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationBinder.cs @@ -62,6 +62,11 @@ internal static void BindObject(Notification notification) { Interop.Notification.SetCheckBox(notification.Handle, notification.CheckBox, notification.CheckedValue); } + + if (notification.PairingType == true) + { + Interop.Notification.SetPairingType(notification.Handle, notification.PairingType); + } } internal static void BindSafeHandle(Notification notification) @@ -91,6 +96,7 @@ internal static void BindSafeHandle(Notification notification) BindSafeHandleTag(notification); BindSafeHandleAction(notification); BindSafeHandleCheckBox(notification); + BindSafeHandlePairingType(notification); } private static void BindNotificationSafeHandle(Notification notification) @@ -250,5 +256,18 @@ private static void BindSafeHandleCheckBox(Notification notification) notification.CheckBox = checkbox; notification.CheckedValue = checkedValue; } + + private static void BindSafeHandlePairingType(Notification notification) + { + NotificationError ret; + bool pairingType= false; + + ret = Interop.Notification.GetPairingType(notification.Handle, out pairingType); + if (ret != NotificationError.None) { + Log.Error(Notification.LogTag, "Failed to get paring type info"); + } + + notification.PairingType = pairingType; + } } } diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs index aadca4ec6b9..2474f7b97a0 100644 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs @@ -29,6 +29,10 @@ public static class NotificationManager private static Interop.Notification.ResponseEventCallback responseEventCallback; + // for disturb app + private static event EventHandler ResponseDisturbHandler; + private static Interop.Notification.DisturbCallback disturbCallback; + private static void ResponseEventCallback(IntPtr ptr, int type, IntPtr userData) { IntPtr cloned; @@ -48,6 +52,12 @@ private static void ResponseEventCallback(IntPtr ptr, int type, IntPtr userData) ResponseEventHandler?.Invoke(null, eventArgs); } + // for disturb app + private static void DisturbCallback(IntPtr userData) + { + ResponseDisturbHandler?.Invoke(null, EventArgs.Empty); + } + /// /// The event handler for receiving a response event from the notification viewers /// @@ -559,5 +569,56 @@ public static Notification MakeNotification(NotificationSafeHandle handle) return notification; } + + /// + /// The event handler to get + /// + /// 12 + [EditorBrowsable(EditorBrowsableState.Never)] + public static event EventHandler DisturbReceived + { + add + { + if (disturbCallback == null) + { + disturbCallback = new Interop.Notification.DisturbCallback(DisturbCallback); + } + + ResponseDisturbHandler += value; + } + + remove + { + if (ResponseDisturbHandler != null && ResponseDisturbHandler.GetInvocationList().Length > 0) + { + NotificationError ret = Interop.Notification.UnRegisterDndApp(); + if (ret != NotificationError.None) + { + throw NotificationErrorFactory.GetException(ret, "register do not disturb app failed"); + } + + ResponseDisturbHandler -= value; + } + } + } + + /// + /// Register do not disturb app + /// + /// 12 + [EditorBrowsable(EditorBrowsableState.Never)] + public static void RegisterDoNotDisturbApp() + { + if (ResponseDisturbHandler != null && ResponseDisturbHandler.GetInvocationList().Length > 0) + { + NotificationError ret = Interop.Notification.RegisterDndApp(disturbCallback, IntPtr.Zero); + if (ret != NotificationError.None) + { + throw NotificationErrorFactory.GetException(ret, "register do not disturb app failed"); + } + } else { + throw NotificationErrorFactory.GetException(NotificationError.InvalidOperation, "Disturb callback not exist"); + } + } } } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs index 7fb9d7238cc..1156f866b10 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs @@ -172,7 +172,7 @@ internal static NotificationEventArgs BindObject(IntPtr notification, bool data) Bundle bundle = new Bundle(new SafeBundleHandle(extension, false)); foreach (string key in bundle.Keys) { - if (key.StartsWith("_NOTIFICATION_EXTENSION_EVENT_")) + if (key.StartsWith("_NOTIFICATION_EXTENSION_EVENT_") || key.StartsWith("_NOTIFICATION_TYPE_PAIRING_")) continue; SafeBundleHandle sbh; diff --git a/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs b/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs index fd5bbc4ef61..99b9280fa22 100755 --- a/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs +++ b/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs @@ -21,8 +21,8 @@ namespace Tizen.Applications { /// - /// The preference class provides APIs to store and retrieve an application specific data/preference. A preference is saved in the form of a key-value pair. - /// Keys are always text strings and the value can be any one of the four types: integer, double, string, and boolean. + /// The Preference class provides methods to store and retrieve application specific data/preferences. Preferences are stored in the form of key-value pairs. + /// Key names must be text strings while values can be integers, doubles, strings, or booleans. /// /// 3 public static class Preference @@ -136,6 +136,9 @@ public static WeakReference GetEventContext(string key) /// True if the key exists in the preference, otherwise false. /// Thrown if the key is an invalid parameter. /// Thrown when the method failed due to an internal I/O error. + /// + /// This method checks if the specified key exists in the preferences. It returns true if the key exists, and false if not. The key argument should be a valid parameter. An ArgumentException will be thrown if the key is invalid. Additionally, an IOException may be thrown if the method fails due to an internal input/output error. + /// /// /// /// Preference.Set("active_user", "Joe"); @@ -166,18 +169,18 @@ public static bool Contains(string key) /// /// /// If the key already exists in the preference, the old value will be overwritten with a new value. - /// Data types for supported values are: integer, double, string, and bool. + /// Supported value data types include integers, doubles, strings, and booleans. /// /// The name of the key to create/modify. /// The value corresponding to the key. /// Thrown if the key is an invalid parameter. - /// Thrown when the method failed due to an internal I/O error. + /// Thrown when the method fails due to an internal I/O error. /// /// /// Preference.Set("Option_enabled", true); /// Preference.Set("active_user", "Joe"); /// Preference.Set("default_volume", 10); - /// Preference.Set("brightness", "0.6"); + /// Preference.Set("brightness", 0.6); /// /// /// 3 @@ -362,7 +365,7 @@ private static void DisallowChangeNotifications(string key) } /// - /// The class manages event handlers of the preference keys. The class enables having event handlers for individual preference keys. + /// The class manages event handlers of the preference keys. It provides functionality to have event handlers for individual preference keys. /// /// 3 public class EventContext @@ -377,14 +380,20 @@ internal EventContext(string key) /// /// Occurs whenever there is a change in the value of a preference key. /// + /// + /// This event is raised whenever the value of a preference key changes. It provides information about the changed key through the PreferenceChangedEventArgs argument. + /// The Changed event can be used to keep track of any modifications made to preferences during runtime. + /// /// Thrown when the key does not exist or when there is an invalid parameter. /// Thrown when the bundle instance has been disposed. /// + /// In this example, we show how to handle the Changed event by printing out the key that was modified. We also demonstrate how to subscribe and unsubscribe from the event. /// /// private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e) /// { /// Console.WriteLine("key {0}", e.Key); /// } + /// /// Preference.EventContext context = null; /// Preference.GetEventContext("active_user").TryGetTarget(out context); /// if(context != null) diff --git a/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs b/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs index cb3db24bbfa..e4b12ded3f4 100755 --- a/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs +++ b/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs @@ -19,7 +19,7 @@ namespace Tizen.Applications { /// - /// This class is an event argument of the PreferenceChanged event. + /// This class represents the event arguments for the PreferenceChanged event. /// /// 3 public class PreferenceChangedEventArgs : EventArgs diff --git a/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs b/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs index 91babc5fe9e..428225acd86 100755 --- a/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs +++ b/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs @@ -48,6 +48,9 @@ public override void Run(string[] args) /// /// Exits the main loop of the application without restarting. /// + /// + /// This function terminates the current execution of the application by exiting its main loop. It does not trigger the app restart request. + /// /// 10 [EditorBrowsable(EditorBrowsableState.Never)] public void ExitWithoutRestarting() diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut.csproj b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut.csproj old mode 100644 new mode 100755 diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs index 5a344c372ba..c4e52328b5e 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs @@ -16,16 +16,20 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class that contains the shortcut information. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class HomeShortcutInfo : ShortcutInfo { /// /// Gets or sets the specific information delivered to the viewer for creating a shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string Uri { get; set; } = string.Empty; } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs index e735cfd1827..0fd5adfb431 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs @@ -16,10 +16,13 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// Enumeration for the sizes of the shortcut widget. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public enum ShortcutWidgetSize { /// @@ -96,6 +99,7 @@ public enum ShortcutWidgetSize /// /// Enumeration for the shortcut types. /// + [Obsolete("Deprecated since API12. Will be removed in API14.")] internal enum ShortcutType { /// diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs index 5d95b2f4b87..3351c2224f1 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs @@ -16,28 +16,34 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class to get the information of the shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class ShortcutInfo { /// /// Gets or sets the name of the created shortcut icon. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string ShortcutName { get; set; } = string.Empty; /// /// Gets or sets the absolute path of an icon file for this shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string IconPath { get; set; } = string.Empty; /// /// Gets or sets a value indicating whether to allow or not allow duplication. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public bool IsAllowDuplicate { get; set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs index 5d3fd7ba0ac..f2be8aa5338 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications.Shortcut /// This class provides some functions to add or delete a shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static class ShortcutManager { private const string LogTag = "Tizen.Applications.Shortcut"; @@ -38,6 +39,7 @@ public static class ShortcutManager /// Thrown when the shortcut is not supported. /// Thrown in case of out of memory. /// Thrown in case of any internal error. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Add(HomeShortcutInfo shortcut) { Interop.Shortcut.ErrorCode err = Interop.Shortcut.ErrorCode.None; @@ -79,6 +81,7 @@ public static void Add(HomeShortcutInfo shortcut) /// Thrown when the shortcut is not supported. /// Thrown in case of out of memory. /// Thrown in case of any internal error. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Add(WidgetShortcutInfo shortcut) { Interop.Shortcut.ErrorCode err = Interop.Shortcut.ErrorCode.None; @@ -114,6 +117,7 @@ public static void Add(WidgetShortcutInfo shortcut) /// Thrown when the shortcut is not supported. /// Thrown in case of out of memory. /// Thrown in case of any internal error. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Delete(string shortcutName) { Interop.Shortcut.ErrorCode err = Interop.Shortcut.ErrorCode.None; @@ -149,6 +153,7 @@ public static void Delete(string shortcutName) /// Thrown when the shortcut is not supported. /// Thrown in case of out of memory. /// Thrown in case of any internal error. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void Delete(ShortcutInfo shortcut) { if (shortcut == null) diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs index 1e0d6052574..549944844ea 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs @@ -16,28 +16,34 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class that contains the information about the widget. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class WidgetShortcutInfo : ShortcutInfo { /// /// Gets or sets the widget ID. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string WidgetId { get; set; } = string.Empty; /// /// Gets or sets the size of the widget. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public ShortcutWidgetSize WidgetSize { get; set; } /// /// Gets or sets the update period in seconds. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public double Period { get; set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs index df1fe96c846..0e41bd067a8 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs @@ -16,22 +16,27 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class that contains the shortcut information. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class HomeShortcutAddedInfo : ShortcutAddedInfo { /// /// Gets the name of the application. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string AppId { get; internal set; } /// /// Gets the specific information for creating a new shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string Uri { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs index 6eced613f5a..63955c6c881 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs @@ -16,28 +16,34 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class for getting the information of the shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class ShortcutAddedInfo { /// /// Gets the name of the created shortcut icon. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string ShortcutName { get; internal set; } /// /// Gets the absolute path of an icon file for this shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string IconPath { get; internal set; } /// /// Gets a value indicating whether to allow or not to allow duplication. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public bool IsAllowDuplicate { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs index dec0ec750d7..aa4ddb675c8 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs @@ -16,22 +16,27 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class for getting the information of the shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class ShortcutDeletedInfo { /// /// Gets the name of the package. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string AppId { get; internal set; } /// /// Gets the name of the created shortcut icon. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string ShortcutName { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs index 34d72ef7497..a0a18eb32d2 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs @@ -16,10 +16,13 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// Enumeration for values of the shortcut response types. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public enum ShortcutError { /// diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs index 7e6c57a16a7..7e3e16dfb40 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs @@ -26,6 +26,7 @@ namespace Tizen.Applications.Shortcut /// Object that contains the shortcut information to add. /// The result of handling a shortcut add request. /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public delegate ShortcutError ShortcutAdded(ShortcutAddedInfo args); /// @@ -34,12 +35,14 @@ namespace Tizen.Applications.Shortcut /// Object that contains the shortcut information to delete. /// The result of handling a shortcut delete request. /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public delegate ShortcutError ShortcutDeleted(ShortcutDeletedInfo args); /// /// This class provides a way to register the callback function for the shortcut add and delete events. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static class ShortcutEventManager { private static Interop.Shortcut.AddCallback shortcutAddCallback; @@ -67,6 +70,7 @@ public static class ShortcutEventManager /// Thrown when the shortcut is not supported. /// Thrown in case of out of memory. /// Thrown in case of any internal error. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void RegisterEventHandler(ShortcutAdded addedEvent) { if (shortcutAddCallback == null) @@ -103,6 +107,7 @@ public static void RegisterEventHandler(ShortcutAdded addedEvent) /// Thrown when the shortcut is not supported. /// Thrown in case of out of memory. /// Thrown in case of any internal error. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void RegisterEventHandler(ShortcutDeleted deletedEvent) { if (shortcutDeleteCallback == null) @@ -134,6 +139,7 @@ public static void RegisterEventHandler(ShortcutDeleted deletedEvent) /// Thrown when an argument is invalid. /// Thrown in case the permission is denied. /// Thrown when the shortcut is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void UnregisterEventHandler(ShortcutAdded addedEvent) { if (shortcutAdded != null && shortcutAdded.Equals(addedEvent)) @@ -168,6 +174,7 @@ public static void UnregisterEventHandler(ShortcutAdded addedEvent) /// Thrown when an argument is invalid. /// Thrown in case the permission is denied. /// Thrown when the shortcut is not supported. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static void UnregisterEventHandler(ShortcutDeleted deletedEvent) { if (shortcutDeleted != null && shortcutDeleted.Equals(deletedEvent)) @@ -205,6 +212,7 @@ public static void UnregisterEventHandler(ShortcutDeleted deletedEvent) /// Thrown when the shortcut is not supported. /// Thrown in case of out of memory. /// Thrown in case of any internal error. + [Obsolete("Deprecated since API12. Will be removed in API14.")] public static IEnumerable GetTemplateList(string appId) { shortcutTemplates.Clear(); diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs index 0645e1457be..1b073d33e84 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs @@ -16,40 +16,48 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class that contains the preset list of the shortcut template from the installed package. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class ShortcutTemplate { /// /// Gets the application ID. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string AppId { get; internal set; } /// /// Gets the name of the created shortcut icon. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string ShortcutName { get; internal set; } /// /// Gets the absolute path of an icon file for this shortcut. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string IconPath { get; internal set; } /// /// Gets the user data. A property of the shortcut element in the manifest file. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string ExtraKey { get; internal set; } /// /// Gets the user data. A property of the shortcut element in the manifest file. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string ExtraData { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs index 39892e72178..06e58fb28a8 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs @@ -16,28 +16,34 @@ namespace Tizen.Applications.Shortcut { + using System; + /// /// A class that contains the information about the widget. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public class WidgetShortcutAddedInfo : ShortcutAddedInfo { /// /// Gets the widget ID. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public string WidgetId { get; internal set; } /// /// Gets the size of the widget. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public ShortcutWidgetSize WidgetSize { get; internal set; } /// /// Gets the update period in seconds. /// /// 4 + [Obsolete("Deprecated since API12. Will be removed in API14.")] public double Period { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs b/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs index 7fb0608a95b..948096e9410 100755 --- a/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs +++ b/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs @@ -23,7 +23,7 @@ namespace Tizen.Applications { /// - /// Represents an application that has an UI screen. The events for resuming and pausing are provided. + /// Represents an application that has an UI screen. It provides events for handling resume and pause actions. /// /// 3 public class CoreUIApplication : CoreApplication @@ -32,7 +32,7 @@ public class CoreUIApplication : CoreApplication /// Initializes the CoreUIApplication class. /// /// - /// The default backend for the UI application will be used. + /// By calling this constructor, the default backend for the UI application will be used. /// /// 3 #pragma warning disable CA2000 @@ -45,9 +45,9 @@ public CoreUIApplication() : base(new UICoreBackend()) /// Initializes the CoreUIApplication class. /// /// - /// If you want to change the backend, use this constructor. + /// This constructor is called if you need to modify the default behavior by providing a custom implementation of the ICoreBackend interface. By passing in your own backend instance, you can customize the application's functionality according to your requirements. /// - /// The backend instance implementing the ICoreBacked interface. + /// The custom implementation of the ICoreBackend interface that provides customized functionalities. /// 3 public CoreUIApplication(ICoreBackend backend) : base(backend) { @@ -91,7 +91,7 @@ public override void Run(string[] args) } /// - /// Overrides this method if you want to handle the behavior before calling OnCreate(). + /// Overrides this method if you want to handle any specific actions before calling the OnCreate() method. /// /// 3 protected virtual void OnPreCreate() @@ -99,8 +99,8 @@ protected virtual void OnPreCreate() } /// - /// Overrides this method if you want to handle the behavior when the application is resumed. - /// If base.OnResume() is not called, the event 'Resumed' will not be emitted. + /// Override this method to define the behavior when the application is resumed. + /// Calling base.OnResume() is required in order for the Resumed event to be raised. /// /// 3 protected virtual void OnResume() @@ -109,8 +109,8 @@ protected virtual void OnResume() } /// - /// Overrides this method if you want to handle the behavior when the application is paused. - /// If base.OnPause() is not called, the event 'Paused' will not be emitted. + /// Override this method to define the behavior when the application is paused. + /// Calling base.OnPause() is required in order for the Paused event to be raised. /// /// 3 protected virtual void OnPause() @@ -122,7 +122,7 @@ protected virtual void OnPause() /// Gets the window position of the application. /// /// The window position. - /// Thrown when there is no window position. + /// Thrown if there is no valid window position available. /// 11 public WindowPosition GetWindowPosition() { diff --git a/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs b/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs index 02e45a37ab7..16d0a332501 100644 --- a/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs +++ b/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs @@ -32,10 +32,11 @@ namespace Tizen.Content.MimeType public static class MimeUtil { /// - /// Gets the MIME type for the given file extension. - /// The MIME type is 'application/octet-stream' if the given file extension is not associated with specific file formats. + /// Retrieves the MIME type for the specified file extension. + /// If no specific file format is associated with the given file extension, the default MIME type 'application/octet-stream' is returned. /// - /// The file extension. + /// The file extension for which the MIME type needs to be retrieved. + /// The MIME type for the specified file extension. /// /// /// string mimeType = MimeUtil.GetMimeType("png"); @@ -54,19 +55,22 @@ public static string GetMimeType(string fileExtension) } /// - /// Gets the file extensions for the given MIME type. + /// Retrieves the file extensions associated with the specified MIME type. /// - /// - /// If successful, returns the list of file extension strings for the given MIME type. - /// The array of file extension is without the leading dot ('.'). - /// - /// The MIME type. + /// + /// By calling this function with a specific MIME type argument, you can obtain a list of file extensions related to that MIME type. + /// These file extensions are returned without the leading period ('.') character. + /// + /// The MIME type for which you want to retrieve the associated file extensions. + /// An enumerable collection of file extension strings for the specified MIME type. /// + /// In the following code snippet, we demonstrate how to utilize the GetFileExtension method by retrieving the file extensions associated with the video/mpeg MIME type: + /// /// - /// var extColl = MimeUtil.GetFileExtension("video/mpeg"); - /// foreach ( string obj in extColl ) + /// var fileExtensions = MimeUtil.GetFileExtension("video/mpeg"); + /// foreach (var extension in fileExtensions) /// { - /// Console.WriteLine(obj); + /// Console.WriteLine(extension); /// } /// /// diff --git a/src/Tizen.Core/Tizen.Core/Channel.cs b/src/Tizen.Core/Tizen.Core/Channel.cs index 0079e83e7e7..e1727a642cf 100644 --- a/src/Tizen.Core/Tizen.Core/Channel.cs +++ b/src/Tizen.Core/Tizen.Core/Channel.cs @@ -21,28 +21,39 @@ namespace Tizen.Core /// /// The class for managing communication channels between tasks of Tizen Core. /// + /// + /// Channels are essential in inter-task communications because they provide a reliable way to exchange messages and data. + /// By creating a channel, you can establish a connection between two tasks that need to communicate with each other. + /// Once created, both tasks can send and receive messages through the channel. + /// It's important to note that channels have a limited capacity, so make sure to handle message overflows appropriately. + /// Additionally, remember to close the channel once it's no longer needed to avoid resource leaks. + /// /// 12 public class Channel : IDisposable { private bool _disposed = false; /// - /// Constructor for creating a new channel with a sender and a receiver. + /// Creates a new channel with a sender and a receiver. /// + /// + /// This constructor initializes a new channel that enables communication between a sender and a receiver. + /// It throws exceptions if any errors occur during initialization due to insufficient memory or invalid operations. + /// /// Thrown when out of memory. /// Thrown when failed because of an invalid operation. /// + /// In the following code snippet, we attempt to initialize a new channel by calling the constructor. + /// However, if there is not enough memory available, an OutOfMemoryException is thrown. We handle this exception by displaying a message in the console. /// - /// /// try /// { - /// var channel = new Channel(); + /// var channel = new Channel(); /// } /// catch (OutOfMemoryException) /// { - /// Console.WriteLine("Exception occurs"); + /// Console.WriteLine("Exception occurs"); /// } - /// /// /// /// 12 @@ -55,7 +66,7 @@ public Channel() } /// - /// Finalizer of the class Channel. + /// Finalizes an instance of the Channel class. /// ~Channel() { @@ -65,12 +76,21 @@ public Channel() /// /// Gets the channel sender instance. /// + /// + /// This property provides access to the channel sender instance that can be used to send messages through the specified channel. + /// It ensures that only one sender instance per channel exists in order to avoid any conflicts during message transmission. + /// /// 12 public ChannelSender Sender { get; private set; } /// - /// Gets the channel receiver instance. + /// Gets the channel receiver instance. /// + /// + /// This property provides access to the channel receiver instance that handles incoming messages from other applications. + /// By utilizing this instance, you can subscribe to specific channels and receive notifications accordingly. + /// It is crucial to understand the concept of channels in order to effectively utilize this feature. For more details on channels, refer to the official documentation. + /// /// 12 public ChannelReceiver Receiver { get; private set; } diff --git a/src/Tizen.Core/Tizen.Core/ChannelObject.cs b/src/Tizen.Core/Tizen.Core/ChannelObject.cs index a721c60018b..eff18ba1fb7 100644 --- a/src/Tizen.Core/Tizen.Core/ChannelObject.cs +++ b/src/Tizen.Core/Tizen.Core/ChannelObject.cs @@ -24,6 +24,11 @@ namespace Tizen.Core /// /// Represents a channel object used for inter-task communication. /// + /// + /// A channel object provides a mechanism for tasks to communicate with each other in a process. It allows sending messages between tasks without any race conditions. + /// To create a channel object, call the static method 'Create'. Once created, you can send and receive messages through the channel by calling the respective methods on the channel object. + /// When you are done using the channel object, remember to dispose it properly to avoid resource leaks. + /// /// 12 public class ChannelObject : IDisposable { @@ -40,6 +45,10 @@ public class ChannelObject : IDisposable /// The data object. /// Thrown when out of memory. /// Thrown when failed because of an invalid operation. + /// + /// This constructor creates a new channel object with the specified ID and data. It throws an OutOfMemoryException if there isn't enough memory available to allocate the object. + /// Additionally, it may throw an InvalidOperationException if the operation fails due to an invalid condition. + /// /// /// /// @@ -68,7 +77,7 @@ internal ChannelObject(IntPtr handle) } /// - /// Finalizer of the class ChannelObject. + /// Finalizes an instance of the ChannelObject class. /// ~ChannelObject() { @@ -135,7 +144,8 @@ public object Data /// Gets the name of the sender task. /// /// 12 - public string Sender { + public string Sender + { get { Interop.LibTizenCore.TizenCoreChannel.ObjectGetSenderTaskName(_handle, out IntPtr taskName); diff --git a/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs b/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs index 4c5fdf13eb4..64bf33459ef 100644 --- a/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs +++ b/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs @@ -19,7 +19,7 @@ namespace Tizen.Core { /// - /// Arguments for the event raised when an object has been received through a channel. + /// Represents the arguments for the event raised when an object has been received through a channel. /// /// 12 public class ChannelReceivedEventArgs : System.EventArgs diff --git a/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs b/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs index c8169954131..0c6ae5c6b1b 100644 --- a/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs +++ b/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs @@ -35,7 +35,7 @@ internal ChannelReceiver(IntPtr handle) } /// - /// Finalizer of the class ChannelReceiver. + /// Finalizes an instance of the ChannelReceiver class. /// ~ChannelReceiver() { @@ -43,7 +43,7 @@ internal ChannelReceiver(IntPtr handle) } /// - /// Occurrs whenever the channel object is received in the main loop of the task. + /// Occurs whenever a channel object is received in the main loop of the task. /// /// /// The registered event handler will be invoked when the channel receiver is added to the specific task. @@ -53,8 +53,8 @@ internal ChannelReceiver(IntPtr handle) /// /// var channel = new Channel(); /// var receiver = channel.Receiver; - /// receiver.Received += (s, e) => { - /// Console.WriteLine("OnChannelObjectReceived. Message = {}", (string)e.Data); + /// receiver.Received += (sender, args) => { + /// Console.WriteLine("OnChannelObjectReceived. Message = {0}", (string)args.Data); /// }; /// /// @@ -63,17 +63,23 @@ internal ChannelReceiver(IntPtr handle) public event EventHandler Received; /// - /// Receives the channel object from the sender asynchronously. + /// Asynchronously receives the channel object from the sender. /// /// The received channel object. + /// Thrown when out of memory. + /// Thrown when failed due to an invalid operation. /// /// /// /// var channel = new Channel(); /// var task = TizenCore.Find("Test"); /// task.Send(async () => { - /// var channelObject = await channel.Receiver.Receive(); - /// Console.WriteLine("Message = {}", (string)channelObject.Data); + /// try { + /// var channelObject = await channel.Receiver.Receive(); + /// Console.WriteLine("Message = {}", (string)channelObject.Data); + /// } catch (Exception e) { + /// Console.Error.WriteLine("Failed to receive message: {0}", e.ToString()); + /// } /// }); /// /// @@ -84,7 +90,14 @@ public async Task Receive() return await System.Threading.Tasks.Task.Run(() => { Interop.LibTizenCore.ErrorCode error = Interop.LibTizenCore.TizenCoreChannel.ReceiverReceive(Handle, out IntPtr channelObject); - TCoreErrorFactory.CheckAndThrownException(error, "Failed to receive channel object"); + if (error != Interop.LibTizenCore.ErrorCode.None) + { + if (error == Interop.LibTizenCore.ErrorCode.InvalidParameter) + { + error = Interop.LibTizenCore.ErrorCode.InvalidContext; + } + TCoreErrorFactory.CheckAndThrownException(error, "Failed to receive channel object"); + } return new ChannelObject(channelObject); }).ConfigureAwait(false); } diff --git a/src/Tizen.Core/Tizen.Core/ChannelSender.cs b/src/Tizen.Core/Tizen.Core/ChannelSender.cs index 45be966a802..1156d9ec49e 100644 --- a/src/Tizen.Core/Tizen.Core/ChannelSender.cs +++ b/src/Tizen.Core/Tizen.Core/ChannelSender.cs @@ -19,7 +19,7 @@ namespace Tizen.Core { /// - /// Represents the channel sender used for inter-task communication. + /// Represents the channel sender used for inter-task communication. It provides methods to send messages between tasks in order to facilitate task coordination. /// /// 12 public class ChannelSender : IDisposable @@ -32,7 +32,7 @@ internal ChannelSender(IntPtr handle) } /// - /// Finalizer of the class ChannelSender. + /// Finalizes an instance of the ChannelSender class. /// ~ChannelSender() { @@ -44,6 +44,8 @@ internal ChannelSender(IntPtr handle) /// /// The channel object instance. /// Thrown when the argument is null. + /// Thrown when the argument is invalid. + /// Thrown when failed because of an invalid operation. /// /// It's important to call the Dispose() method on the passed channel object to release resources. /// @@ -68,8 +70,16 @@ public void Send(ChannelObject channelObject) throw new ArgumentNullException(nameof(channelObject)); } + if (channelObject.Handle == IntPtr.Zero) + { + throw new ArgumentException("Invalid argument"); + } + Interop.LibTizenCore.ErrorCode error = Interop.LibTizenCore.TizenCoreChannel.SenderSend(Handle, channelObject.Handle); - TCoreErrorFactory.CheckAndThrownException(error, "Failed to send channel object"); + if (error != Interop.LibTizenCore.ErrorCode.None) + { + throw new InvalidOperationException("Failed to send channel object"); + } channelObject.IsUsed = true; } @@ -77,7 +87,7 @@ public void Send(ChannelObject channelObject) /// Creates and returns a copy of the channel sender object. /// /// A newly created channel sender instance. - /// Thrown when the argument is invalid. + /// Thrown when failed because of an invalid operation. /// Thrown when out of memory. /// /// @@ -92,6 +102,10 @@ public void Send(ChannelObject channelObject) public ChannelSender Clone() { Interop.LibTizenCore.ErrorCode error = Interop.LibTizenCore.TizenCoreChannel.SenderClone(Handle, out IntPtr clonedHandle); + if (error == Interop.LibTizenCore.ErrorCode.InvalidParameter) + { + error = Interop.LibTizenCore.ErrorCode.InvalidContext; + } TCoreErrorFactory.CheckAndThrownException(error, "Failed to clone channel sender"); return new ChannelSender(clonedHandle); diff --git a/src/Tizen.Core/Tizen.Core/Event.cs b/src/Tizen.Core/Tizen.Core/Event.cs index 21755d97df4..f705845e561 100644 --- a/src/Tizen.Core/Tizen.Core/Event.cs +++ b/src/Tizen.Core/Tizen.Core/Event.cs @@ -19,8 +19,13 @@ namespace Tizen.Core { /// - /// Represents the event using for broadcasting events. + /// Represents the event used for broadcasting events. /// + /// + /// This class provides functionality for managing events that are broadcasted across multiple components in an application. + /// It enables communication between different parts of the code without resorting to direct references or global variables. + /// By implementing the IDisposable interface, it ensures proper resource management and prevents memory leaks. + /// /// 12 #pragma warning disable CA1716 public class Event : IDisposable @@ -33,13 +38,16 @@ public class Event : IDisposable /// /// Constructor for creating a new event instance. /// + /// + /// This constructor initializes a new event instance. It may throw exceptions if there are any issues during initialization such as running out of memory or performing an invalid operation. + /// /// Thrown when out of memory. /// Thrown when failed because of an invalid operation. /// + /// Here's an example showing how to create a new event instance: /// - /// + /// Create a new event instance /// var coreEvent = new Event(); - /// /// /// /// 12 @@ -57,7 +65,7 @@ public Event() } /// - /// Finalizer of the class Event. + /// Finalizes an instance of the Event class. /// ~Event() { diff --git a/src/Tizen.Core/Tizen.Core/EventObject.cs b/src/Tizen.Core/Tizen.Core/EventObject.cs index 9012bc9094a..22d2ff5af07 100644 --- a/src/Tizen.Core/Tizen.Core/EventObject.cs +++ b/src/Tizen.Core/Tizen.Core/EventObject.cs @@ -70,7 +70,7 @@ internal EventObject(IntPtr handle) } /// - /// Finalizer of the class EventObject. + /// Finalizes an instance of the EventObject class. /// ~EventObject() { diff --git a/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs b/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs index fb561bbd686..93d91914d81 100644 --- a/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs +++ b/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs @@ -19,7 +19,7 @@ namespace Tizen.Core { /// - /// Arguments for the event raised when the event data is received. + /// Represents the arguments passed to the event handler when the event data is received. /// /// 12 public class EventReceivedEventArgs : System.EventArgs diff --git a/src/Tizen.Core/Tizen.Core/Task.cs b/src/Tizen.Core/Tizen.Core/Task.cs index 40ed62cea8e..a6796b368fb 100644 --- a/src/Tizen.Core/Tizen.Core/Task.cs +++ b/src/Tizen.Core/Tizen.Core/Task.cs @@ -43,16 +43,16 @@ public class Task : IDisposable private static int _id = 1; /// - /// Initializes the Task class. + /// Initializes the Task class with the specified ID. /// - /// The ID of the task. + /// The unique identifier for the task. /// Thrown when the is invalid or a Task with that ID already exists. /// Thrown when out of memory. /// Thrown when failed because of an invalid operation. /// - /// The constructor throws an exception when the id already exists. - /// By default, the task creates a thread. However, if the is "main", a thread is not created. - /// The 'main' task will be operated in the main thread. + /// The constructor throws an exception when the ID already exists. + /// By default, the task creates a separate thread. However, if the is set to "main", no separate thread is created. + /// In such case, the 'main' task will operate on the main application thread instead. /// /// /// @@ -87,13 +87,12 @@ internal Task(IntPtr handle) Dispose(false); } - /// /// Posts an action to be executed later. /// /// The action callback to post. /// Thrown when the action argument is null. - /// Thrown when failed because of the instance is invalid. + /// Thrown when failed because of an invalid operation. /// Thrown when out of memory. /// /// The action callback will be executed by the main loop of the task. @@ -127,7 +126,14 @@ public void Post(Action action) } _actionkMap[id] = action; Interop.LibTizenCore.ErrorCode error = Interop.LibTizenCore.TizenCore.AddIdleJob(_handle, NativeActionCallback, (IntPtr)id, out IntPtr handle); - TCoreErrorFactory.CheckAndThrownException(error, "Failed to add idle job"); + if (error != Interop.LibTizenCore.ErrorCode.None) + { + if (error == Interop.LibTizenCore.ErrorCode.InvalidParameter) + { + error = Interop.LibTizenCore.ErrorCode.InvalidContext; + } + TCoreErrorFactory.CheckAndThrownException(error, "Failed to add idle job"); + } } /// @@ -135,7 +141,7 @@ public void Post(Action action) /// /// The task to post. /// Thrown when the task argument is null. - /// Thrown when failed because of the instance is invalid. + /// Thrown when failed because of an invalid operation. /// Thrown when out of memory. /// /// The task will be stored in the internal map using its unique identifier. @@ -178,6 +184,10 @@ public void Post(Func task) if (error != Interop.LibTizenCore.ErrorCode.None) { _taskMap.TryRemove(id, out var _); + if (error == Interop.LibTizenCore.ErrorCode.InvalidParameter) + { + error = Interop.LibTizenCore.ErrorCode.InvalidContext; + } TCoreErrorFactory.CheckAndThrownException(error, "Failed to add idle job"); } } @@ -189,7 +199,7 @@ public void Post(Func task) /// The recurring timer callback function which returns whether or not to continue triggering the timer. /// The registered timer ID to be used with . /// Thrown when the callback argument is null. - /// Thrown when failed because of the instance is invalid. + /// Thrown when failed because of an invalid operation. /// Thrown when out of memory. /// /// The callback function will be called every time the specified interval elapses. It should return true to keep the timer running, otherwise the timer will be stopped. @@ -227,7 +237,7 @@ public int AddTimer(uint interval, Func callback) if (error != Interop.LibTizenCore.ErrorCode.None) { _timerMap.TryRemove(id, out var _); - TCoreErrorFactory.CheckAndThrownException(error, "Failed to add a timer"); + throw new InvalidOperationException("Failed to add timer"); } timerSource.Handle = handle; @@ -272,11 +282,14 @@ public void RemoveTimer(int id) /// /// Adds a channel receiver to a main loop of the task. /// - /// The channel receiver instance. + /// The channel receiver instance that needs to be added. /// Thrown when the argument is null. /// Thrown when the argument is invalid. + /// Thrown when failed because of an invalid operation. /// Thrown when out of memory. /// + /// In the following code snippet, we create a channel, find or spawn a task named "ReceivingTask", and then add the channel receiver to the task's main loop by calling the 'AddChannelReceiver' method. + /// /// /// /// var channel = new Channel(); @@ -296,7 +309,12 @@ public void AddChannelReceiver(ChannelReceiver receiver) if (receiver.Handle == IntPtr.Zero) { - throw new ArgumentException("The receiver is already added"); + if (receiver.Source != IntPtr.Zero) + { + throw new ArgumentException("The receiver is already added"); + } + + throw new ArgumentException("Invalid argument"); } int id; @@ -313,6 +331,10 @@ public void AddChannelReceiver(ChannelReceiver receiver) if (error != Interop.LibTizenCore.ErrorCode.None) { _channelMap.TryRemove(id, out var _); + if (error == Interop.LibTizenCore.ErrorCode.InvalidParameter) + { + error = Interop.LibTizenCore.ErrorCode.InvalidContext; + } TCoreErrorFactory.CheckAndThrownException(error, "Failed to add a channel to the task"); } @@ -376,6 +398,7 @@ public void RemoveChannelReceiver(ChannelReceiver receiver) /// The event instance. /// Thrown when the argument is null. /// Thrown when the argument is invalid. + /// Thrown when failed because of an invalid operation. /// Thrown when out of memory. /// /// This method allows you to associate an event with a specific task. By adding an event to a task's main loop, other threads can utilize this event to communicate with the task. @@ -403,6 +426,11 @@ public void AddEvent(Event coreEvent) throw new ArgumentNullException(nameof(coreEvent)); } + if (coreEvent.Handle == IntPtr.Zero) + { + throw new ArgumentException("Invalid argument"); + } + if (coreEvent.Source != IntPtr.Zero) { throw new ArgumentException("The event is already added"); @@ -425,6 +453,10 @@ public void AddEvent(Event coreEvent) if (error != Interop.LibTizenCore.ErrorCode.None) { _eventMap.TryRemove(id, out var _); + if (error == Interop.LibTizenCore.ErrorCode.InvalidParameter) + { + error = Interop.LibTizenCore.ErrorCode.InvalidContext; + } TCoreErrorFactory.CheckAndThrownException(error, "Failed to add an event to the task"); } @@ -483,9 +515,10 @@ public void RemoveEvent(Event coreEvent) /// Emits the event object to all registered event handlers of the task. /// It's similar to Event.Emit(), but EmitAllEvent() sends the event object to every event handler of the task while Event.Emit() sends the event object only to the target event's event handler. /// - /// The event object instance. + /// The event object instance to be sent. /// Thrown when the argument is null. /// Thrown when the argument is invalid. + /// Thrown when failed because of an invalid operation. /// /// /// @@ -507,8 +540,17 @@ public void EmitEvent(EventObject eventObject) throw new ArgumentNullException(nameof(eventObject)); } + if (eventObject.Handle == IntPtr.Zero) + { + throw new ArgumentException("Invalid argument"); + } + Interop.LibTizenCore.ErrorCode error = Interop.LibTizenCore.TizenCore.EmitEvent(_handle, eventObject.Handle); - TCoreErrorFactory.CheckAndThrownException(error, "Failed to emit event"); + if (error != Interop.LibTizenCore.ErrorCode.None) + { + throw new InvalidOperationException("Failed to emit event"); + } + eventObject.Handle = IntPtr.Zero; } @@ -632,27 +674,30 @@ public bool Running { /// /// Runs the main loop of the task. /// - /// Thrown when the unmanaged handle is invalid. /// Thrown when failed because of an invalid operation. /// + /// Here's an example that demonstrates how to create a Core Task and run its main loop: /// - /// + /// // Create a Core Task named "Runner" /// var coreTask = new TCoreTask("Runner"); - /// coreTask.Run(); /// + /// // Start the main loop of the task + /// coreTask.Run(); /// /// /// 12 public void Run() { Interop.LibTizenCore.ErrorCode error = Interop.LibTizenCore.TizenCore.TaskRun(_handle); - TCoreErrorFactory.CheckAndThrownException(error, "Failed to run task"); + if (error != Interop.LibTizenCore.ErrorCode.None) + { + throw new InvalidOperationException("Failed to run task"); + } } /// /// Quits the main loop of the task. /// - /// Thrown when the unmanaged handle is invalid. /// Thrown when failed because of an invalid operation. /// /// This function can be called from any thread. @@ -676,7 +721,10 @@ public void Run() public void Quit() { Interop.LibTizenCore.ErrorCode error = Interop.LibTizenCore.TizenCore.TaskQuit(_handle); - TCoreErrorFactory.CheckAndThrownException(error, "Failed to quit task"); + if (error != Interop.LibTizenCore.ErrorCode.None) + { + throw new InvalidOperationException("Failed to quit task"); + } } /// diff --git a/src/Tizen.Log/Tizen/Log.cs b/src/Tizen.Log/Tizen/Log.cs index 1e1c645c1c1..eddd5ecb799 100755 --- a/src/Tizen.Log/Tizen/Log.cs +++ b/src/Tizen.Log/Tizen/Log.cs @@ -157,7 +157,7 @@ public class Log { private static char[] sep = { '\\', '/' }; /// - /// Prints a log message with the VERBOSE priority. + /// Prints a regular log message with the VERBOSE priority. /// /// 3 /// The tag name of the log message. @@ -171,7 +171,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f } /// - /// Prints a log message with the DEBUG priority. + /// Prints a regular log message with the DEBUG priority. /// /// 3 /// The tag name of the log message. @@ -185,7 +185,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil } /// - /// Prints a log message with the INFO priority. + /// Prints a regular log message with the INFO priority. /// /// 3 /// The tag name of the log message. @@ -199,7 +199,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file } /// - /// Prints a log message with the WARNING priority. + /// Prints a regular log message with the WARNING priority. /// /// 3 /// The tag name of the log message. @@ -213,7 +213,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file } /// - /// Prints a log message with the ERROR priority. + /// Prints a regular log message with the ERROR priority. /// /// 3 /// The tag name of the log message. @@ -227,7 +227,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil } /// - /// Prints a log message with the FATAL priority. + /// Prints a regular log message with the FATAL priority. /// /// 3 /// The tag name of the log message. @@ -248,6 +248,7 @@ static unsafe void Print(Interop.Dlog.LogPriority priority, string tag, string m /// /// Provides methods to print log messages to the Tizen logging system. + /// Sends "internal" logs, which end up in a different Dlog buffer than regular logs. /// /// 3 [EditorBrowsable(EditorBrowsableState.Never)] @@ -255,7 +256,7 @@ public class InternalLog { private static char[] sep = { '\\', '/' }; /// - /// Prints a log message with the VERBOSE priority. + /// Prints an internal log message with the VERBOSE priority. /// /// 3 /// The tag name of the log message. @@ -270,7 +271,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f } /// - /// Prints a log message with the DEBUG priority. + /// Prints an internal log message with the DEBUG priority. /// /// 3 /// The tag name of the log message. @@ -284,7 +285,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil } /// - /// Prints a log message with the INFO priority. + /// Prints an internal log message with the INFO priority. /// /// 3 /// The tag name of the log message. @@ -298,7 +299,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file } /// - /// Prints a log message with the WARNING priority. + /// Prints an internal log message with the WARNING priority. /// /// 3 /// The tag name of the log message. @@ -312,7 +313,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file } /// - /// Prints a log message with the ERROR priority. + /// Prints an internal log message with the ERROR priority. /// /// 3 /// The tag name of the log message. @@ -326,7 +327,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil } /// - /// Prints a log message with the FATAL priority. + /// Prints an internal log message with the FATAL priority. /// /// 3 /// The tag name of the log message. @@ -347,6 +348,7 @@ static unsafe void Print(Interop.Dlog.LogID log_id, Interop.Dlog.LogPriority pri /// /// Provides methods to print log messages to the Tizen logging system. + /// Sends "secure" logs, which have extra safety not to appear on release builds. /// /// 3 [EditorBrowsable(EditorBrowsableState.Never)] @@ -354,7 +356,7 @@ public class SecureLog { private static char[] sep = { '\\', '/' }; /// - /// Prints a log message with the VERBOSE priority. + /// Prints a secure log message with the VERBOSE priority. /// /// 3 /// The tag name of the log message. @@ -369,7 +371,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f } /// - /// Prints a log message with the DEBUG priority. + /// Prints a secure log message with the DEBUG priority. /// /// 3 /// The tag name of the log message. @@ -383,7 +385,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil } /// - /// Prints a log message with the INFO priority. + /// Prints a secure log message with the INFO priority. /// /// 3 /// The tag name of the log message. @@ -397,7 +399,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file } /// - /// Prints a log message with the WARNING priority. + /// Prints a secure log message with the WARNING priority. /// /// 3 /// The tag name of the log message. @@ -411,7 +413,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file } /// - /// Prints a log message with the ERROR priority. + /// Prints a secure log message with the ERROR priority. /// /// 3 /// The tag name of the log message. @@ -425,7 +427,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil } /// - /// Prints a log message with the FATAL priority. + /// Prints a secure log message with the FATAL priority. /// /// 3 /// The tag name of the log message. diff --git a/src/Tizen.Multimedia.AudioIO/Interop/Interop.WavPlayer.cs b/src/Tizen.Multimedia.AudioIO/Interop/Interop.WavPlayer.cs index 0712ee1c430..7c7299690e5 100644 --- a/src/Tizen.Multimedia.AudioIO/Interop/Interop.WavPlayer.cs +++ b/src/Tizen.Multimedia.AudioIO/Interop/Interop.WavPlayer.cs @@ -29,6 +29,10 @@ internal static partial class WavPlayer internal static extern WavPlayerError Start(string filePath, AudioStreamPolicyHandle streamInfoHandle, WavPlayerCompletedCallback completedCallback, IntPtr userData, out int id); + [DllImport(Libraries.WavPlayer, EntryPoint = "wav_player_start_loop")] + internal static extern WavPlayerError StartLoop(string filePath, AudioStreamPolicyHandle streamInfoHandle, uint count, + WavPlayerCompletedCallback completedCallback, IntPtr userData, out int id); + [DllImport(Libraries.WavPlayer, EntryPoint = "wav_player_stop")] internal static extern WavPlayerError Stop(int id); } diff --git a/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs b/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs index 5c159d5cbff..3dcfb24c26e 100644 --- a/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs +++ b/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs @@ -15,6 +15,7 @@ */ using System; +using System.ComponentModel; using System.IO; using System.Threading; using System.Threading.Tasks; @@ -85,20 +86,62 @@ public static Task StartAsync(string path, AudioStreamPolicy streamPolicy, } return cancellationToken.IsCancellationRequested ? Task.FromCanceled(cancellationToken) : - StartAsyncCore(path, streamPolicy, cancellationToken); + StartAsyncCore(path, streamPolicy, 1, cancellationToken); } - private static async Task StartAsyncCore(string path, AudioStreamPolicy streamPolicy, + /// + /// Plays a wav file based on the specified with given repetition number. + /// + /// If loopCount is 0, it means infinite loops + /// A task that represents the asynchronous operation. + /// A file path to play. + /// A . + /// A number of repetitions. + /// A cancellation token which can be used to stop. + /// + /// is null. + /// -or- + /// is null. + /// + /// An internal error occurs. + /// does not exists. + /// The format of is not supported. + /// has already been disposed of. + [EditorBrowsable(EditorBrowsableState.Never)] + public static Task StartAsync(string path, AudioStreamPolicy streamPolicy, uint loopCount, + CancellationToken cancellationToken) + { + if (path == null) + { + throw new ArgumentNullException(nameof(path)); + } + + if (streamPolicy == null) + { + throw new ArgumentNullException(nameof(streamPolicy)); + } + + if (File.Exists(path) == false) + { + throw new FileNotFoundException("File does not exists.", path); + } + + return cancellationToken.IsCancellationRequested ? Task.FromCanceled(cancellationToken) : + StartAsyncCore(path, streamPolicy, loopCount, cancellationToken); + } + + private static async Task StartAsyncCore(string path, AudioStreamPolicy streamPolicy, uint loopCount, CancellationToken cancellationToken) { + int id = 0; var tcs = new TaskCompletionSource(); Native.WavPlayerCompletedCallback cb = (id_, _) => tcs.TrySetResult(true); using (var cbKeeper = ObjectKeeper.Get(cb)) { - Native.Start(path, streamPolicy.Handle, cb, IntPtr.Zero, out var id). - Validate("Failed to play."); + Native.StartLoop(path, streamPolicy.Handle, loopCount, cb, IntPtr.Zero, out id). + Validate("Failed to play with loop."); using (RegisterCancellationAction(tcs, cancellationToken, id)) { diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs index b24188e5788..aa66f1f0fa8 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs @@ -93,7 +93,7 @@ internal AdaptiveVariants(Player player) } /// - /// Sets the maximum limit of the streaming variant. + /// Sets the maximum limit of adaptive streaming variants. /// /// The has already been disposed of. /// @@ -119,7 +119,7 @@ public void SetMaxLimit(int bandwidth, int width = -1, int height = -1) } /// - /// Gets the maximum limit of the streaming variant. + /// Gets the maximum limit of the adaptive streaming variant. /// /// The containing the variant information. /// The has already been disposed of. @@ -136,7 +136,7 @@ public VariantInfo GetMaxLimit() } /// - /// Retrieves all the available adaptive variants. + /// Retrieves all the available adaptive streaming variants. /// /// /// It returns a list contained all the available adaptive variants. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs index 17a00850c7e..1f0ac187777 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs @@ -32,7 +32,7 @@ internal AudioDataDecodedEventArgs(MediaPacket packet) } /// - /// Gets the packet containing the decoded frame. + /// Gets the media packet containing the audio decoded frame. /// /// 6 public MediaPacket Packet { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs index 9815506a3b1..66b670207e4 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs @@ -98,7 +98,7 @@ public void Clear() } /// - /// Gets the number of items. + /// Gets the number of equalizer bands available. /// /// If audio offload is enabled by calling . (Since tizen 6.0) /// -or-
@@ -148,7 +148,7 @@ public Range BandLevelRange } /// - /// Gets the value whether the AudioEffect is available or not. + /// Gets the value indicating whether the AudioEffect is available or not. /// /// This function returns the availability of the . /// It could be unavailable depending on the platform capabilities.
diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs index e25c20ea83a..cf474668a61 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs @@ -50,7 +50,7 @@ internal void CheckDisabled() } /// - /// Enables or disables the audio offload. + /// Gets or sets whether the audio offload is enabled. /// /// The value indicating whether or not audio offload is enabled. The default value is false. /// The player lets the hardware decode and render the sound if the audio offload is enabled. @@ -103,7 +103,7 @@ public bool IsEnabled } /// - /// Get a state whether or not the audio offload is activated. + /// Get a value indication whether or not the audio offload is activated. /// /// The value indicating whether or not AudioOffload is activated. /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs index d5c7e5406bb..b359aa05f49 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs @@ -85,7 +85,7 @@ public int Level /// - /// Gets the frequency in dB. + /// Gets the frequency in dB of the equalizer band. /// /// /// If audio offload is enabled by calling . (Since tizen 6.0) @@ -105,7 +105,7 @@ public int Frequency } /// - /// Gets the frequency range in dB. + /// Gets the frequency range in dB of the equalizer band. /// /// /// If audio offload is enabled by calling . (Since tizen 6.0) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs index 0ad90e3ff76..c2d47dafdcb 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs @@ -33,7 +33,7 @@ public sealed class MediaBufferSource : MediaSource private byte[] _buffer; /// - /// Initializes a new instance of the MediaBufferSource class with an allocated buffer. + /// Initializes a new instance of the MediaBufferSource class with the specified buffer length. /// /// The value indicating the size of the buffer. /// @@ -54,7 +54,7 @@ public MediaBufferSource(int length) } /// - /// Initializes a new instance of the MediaBufferSource class from the buffer. + /// Initializes a new instance of the MediaBufferSource class with the specified buffer. /// /// The source array to be copied into the buffer. /// is null. @@ -65,7 +65,7 @@ public MediaBufferSource(byte[] buffer) : this(buffer, buffer == null ? 0 : buff //TODO remove default parameter. /// - /// Initializes a new instance of the MediaBufferSource class from the buffer + /// Initializes a new instance of the MediaBufferSource class with buffer, length, and optional offset. /// with the specified length and the specified offset. /// /// The source array to be copied into the buffer. @@ -141,4 +141,3 @@ internal override void OnAttached(Player player) } } } - diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs index dd48e886b80..468a41dfb67 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs @@ -36,7 +36,7 @@ public MediaStreamBufferStatusChangedEventArgs(MediaStreamBufferStatus status) } /// - /// Gets the status. + /// Gets the current buffer status. /// /// 3 public MediaStreamBufferStatus Status { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs index c8d19defb14..602e7e9156e 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs @@ -59,10 +59,10 @@ internal MediaStreamConfiguration(MediaStreamSource owner, StreamType streamType public event EventHandler SeekingOccurred; /// - /// Gets or sets the max size of the buffer. + /// Gets or sets the maximum size of the buffer for media stream. /// - /// The max size of the buffer. The default is 200000. - /// If the buffer level overflows the max size, will be raised with . + /// The maximum size of the buffer in bytes. The default is 200000. + /// If the buffer level overflows the maximum size, will be raised with . /// The is not assigned to a player. /// is zero. /// @@ -95,7 +95,7 @@ public ulong BufferMaxSize } /// - /// Gets or sets the minimum threshold of the buffer. + /// Gets or sets the minimum threshold of the media stream buffer. /// /// The minimum threshold of the buffer in percentage. The default is zero. /// If the buffer level drops below the threshold value, will be raised with . diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs index e033ed9f6e8..7de8cc98790 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs @@ -35,8 +35,14 @@ public MediaStreamSeekingOccurredEventArgs(ulong offset) } /// - /// Gets the offset. + /// Gets the next new play position as a result of seeking operation. /// + /// + /// The next playback position after SetPlayPositionAsync could be a little bit different with its input position.
+ /// So user should push the next media data using this time offset in nanoseconds. + /// + /// + /// /// 3 public ulong Offset { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs index 0bee6d10c89..ea57faa6d78 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs @@ -37,7 +37,7 @@ public sealed class MediaStreamSource : MediaSource private static List _supportedVideoFormats; /// - /// Gets all supported audio types. + /// Gets the supported audio types of the media stream source. /// /// 3 public static IEnumerable SupportedAudioTypes @@ -50,7 +50,7 @@ public static IEnumerable SupportedAudioTypes } /// - /// Gets all supported video types. + /// Gets the supported video types of the media stream source. /// /// 3 public static IEnumerable SupportedVideoTypes @@ -214,7 +214,7 @@ public MediaStreamSource(VideoMediaFormat videoMediaFormat) public MediaStreamConfiguration VideoConfiguration { get; } /// - /// Pushes elementary stream to decode audio or video. + /// Pushes elementary stream to decode audio or video packet. /// /// This source must be set as a source to a player and the player must be in the , /// , or state. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs index 240b7a37f03..415a8f17f96 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs @@ -20,7 +20,7 @@ namespace Tizen.Multimedia { /// - /// Represents a media source with a uri. + /// Represents a media source with a URI. /// /// /// The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from a network. @@ -31,9 +31,10 @@ namespace Tizen.Multimedia /// 3 public sealed class MediaUriSource : MediaSource { - // TODO consider using Uri class. + // TODO consider using URI class. /// - /// Initializes a new instance of the MediaUriSource class with the specified uri. + /// Initializes a new instance of the MediaUriSource class with the specified URI. + /// /// The uri string. /// For HTTP or RSTP, uri should start with "http://" or "rtsp://". /// The default protocol is "file://". @@ -57,4 +58,3 @@ internal override void OnAttached(Player player) } } } - diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs index 47475e7a858..679ab19ddac 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs @@ -35,7 +35,7 @@ public PlaybackInterruptedEventArgs(PlaybackInterruptionReason reason) } /// - /// Gets the reason. + /// Gets the reason for the playback interruption. /// /// 3 public PlaybackInterruptionReason Reason { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs index 1b5d2f3939a..e60b994b413 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs @@ -193,7 +193,7 @@ public PlayerBufferingTime BufferingTime #endregion /// - /// Gets the state of the player. + /// Gets the current state of the player. /// /// The current state of the player. /// The player has already been disposed of. @@ -258,7 +258,7 @@ public AudioLatencyMode AudioLatencyMode } /// - /// Gets or sets the looping state. + /// Gets or sets a value indicationg whether the media source is played in a loop. /// /// true if the playback is looping; otherwise, false. The default value is false. /// The player has already been disposed of. @@ -286,7 +286,7 @@ public bool IsLooping private PlayerDisplaySettings _displaySettings; /// - /// Gets the display settings. + /// Gets the display settings of the player. /// /// A that specifies the display settings. /// 3 @@ -314,7 +314,7 @@ private void ReplaceDisplay(Display newDisplay) } /// - /// Gets or sets the display. + /// Gets or sets the display of the player. /// /// A that specifies the display. /// @@ -387,7 +387,7 @@ PlayerErrorCode IDisplayable.ApplyEcoreWindow(IntPtr windowHand private PlayerTrackInfo _audioTrack; /// - /// Gets the track info for the audio. + /// Gets the audio track information of the player. /// /// A for audio. /// 3 @@ -406,7 +406,7 @@ public PlayerTrackInfo AudioTrackInfo private PlayerTrackInfo _subtitleTrackInfo; /// - /// Gets the track info for the subtitle. + /// Gets the sutitle track information of the player. /// /// A for the subtitle. /// 3 @@ -425,7 +425,7 @@ public PlayerTrackInfo SubtitleTrackInfo private StreamInfo _streamInfo; /// - /// Gets the stream information. + /// Gets the stream information of the player. /// /// A for this player. /// 3 @@ -444,7 +444,7 @@ public StreamInfo StreamInfo private AudioEffect _audioEffect; /// - /// Gets the audio effect. + /// Gets the audio effect of the player. /// /// http://tizen.org/feature/multimedia.custom_audio_effect /// The required feature is not supported. @@ -463,7 +463,7 @@ public AudioEffect AudioEffect } /// - /// Gets or sets the mute state. + /// Gets or sets a value indicationg whether the audio output of the player is muted. /// /// true if the player is muted; otherwise, false. /// The player has already been disposed of. @@ -486,7 +486,7 @@ public bool Muted } /// - /// Gets or sets the current volume. + /// Gets or sets the current volume of the player. /// /// Valid volume range is from 0 to 1.0, inclusive. /// The player has already been disposed of. @@ -520,7 +520,7 @@ public float Volume } /// - /// Gets or sets the audio-only state. + /// Gets or sets a value indicating whether the player is in audio only mode. /// /// true if the playback is audio-only mode; otherwise, false. The default value is false. /// The must be in the , @@ -547,7 +547,7 @@ public bool IsAudioOnly } /// - /// Gets or sets the player's replaygain state. + /// Gets or sets a value indicating whether the replay gain is enabled. /// /// If the replaygain status is true, replaygain is applied (if contents has a replaygain tag); /// otherwise, the replaygain is not affected by tag and properties. @@ -585,8 +585,7 @@ public bool ReplayGain } /// - /// Enables or disables controlling the pitch of audio. - /// Gets the status of controlling the pitch of audio. + /// Gets or sets a value indicating whether the audio pitch control is enabled. /// /// The value indicating whether or not AudioPitch is enabled. The default is false. /// This function is used for audio content only. @@ -628,7 +627,7 @@ public bool AudioPitchEnabled } /// - /// Gets or sets the pitch of audio. + /// Gets or sets the pitch of the audio. /// /// The audio stream pitch value. The default is 1. /// Enabling pitch control could increase the CPU usage on some devices. @@ -783,7 +782,7 @@ public CodecType VideoCodecType private SphericalVideo _sphericalVideo; /// - /// Gets the spherical video settings. + /// Gets the spherical video porperties of the player. /// /// 5 public SphericalVideo SphericalVideo @@ -802,7 +801,7 @@ public SphericalVideo SphericalVideo private AdaptiveVariants _adaptiveVariants; /// - /// Gets the adaptive variants settings. + /// Gets the adaptive variants of the player. /// /// 5 public AdaptiveVariants AdaptiveVariants @@ -821,7 +820,7 @@ public AdaptiveVariants AdaptiveVariants private AudioOffload _audioOffload; /// - /// Gets the setting for audio offload. + /// Gets the audio offload settings of the player. /// /// 6 public AudioOffload AudioOffload diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs index 3b3e2c2e105..0ec788b05e1 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs @@ -184,7 +184,7 @@ internal void ValidateNotDisposed() #region Methods /// - /// Gets the streaming download progress. + /// Gets the download progress of the streaming contents. /// /// The containing current download progress. /// The player must be in the , , @@ -211,7 +211,7 @@ public DownloadProgress GetDownloadProgress() } /// - /// Sets the subtitle path for playback. + /// Sets the subtitle file path for playback. /// /// The absolute path of the subtitle file, it can be NULL in the state. /// Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. @@ -247,7 +247,7 @@ public void SetSubtitle(string path) } /// - /// Removes the subtitle path. + /// Clears the the subtitle path of the media player. /// /// The player must be in the state. /// The player has already been disposed of. @@ -262,7 +262,7 @@ public void ClearSubtitle() } /// - /// Sets the offset for the subtitle. + /// Sets the seek offset for the subtitle. /// /// The value indicating a desired offset in milliseconds. /// The player must be in the or state. @@ -410,7 +410,7 @@ public virtual async Task PrepareAsync(CancellationToken cancellationToken) } /// - /// Unprepares the player. + /// Unprepares the media player. /// /// /// The most recently used source is reset and is no longer associated with the player. Playback is no longer possible. @@ -450,7 +450,7 @@ protected virtual void OnUnprepared() } /// - /// Starts or resumes playback. + /// Starts or resumes playing the media content. /// /// /// Sound can be mixed with other sounds if you don't control the stream focus using .
@@ -505,7 +505,7 @@ public virtual void Stop() } /// - /// Pauses the player. + /// Pauses playing the media content. /// /// /// The player must be in the state. @@ -570,7 +570,7 @@ public void SetSource(MediaSource source) } /// - /// Captures a video frame, asynchronously. + /// Captures the current frame of the video being played, asynchronously. /// /// A task that represents the asynchronous capture operation. /// http://tizen.org/feature/multimedia.raw_video @@ -607,7 +607,7 @@ public async Task CaptureVideoAsync() } /// - /// Gets the play position in milliseconds. + /// Gets the current playback position in milliseconds of the media. /// /// The current position in milliseconds. /// The player must be in the , , @@ -673,7 +673,7 @@ private async Task SetPlayPosition(long position, bool accurate, bool nanosecond } /// - /// Sets the seek position for playback, asynchronously. + /// Sets the playback position in milliseconds of the player, asynchronously. /// /// The value indicating a desired position in milliseconds. /// The value indicating whether the operation performs with accuracy. @@ -701,7 +701,7 @@ public async Task SetPlayPositionAsync(int position, bool accurate) } /// - /// Gets the play position in nanoseconds. + /// Gets the current playback position in nanoseconds of the media. /// /// The current position in nanoseconds. /// The player must be in the , , @@ -725,7 +725,7 @@ public long GetPlayPositionNanoseconds() } /// - /// Sets the seek position in nanoseconds for playback, asynchronously. + /// Sets the playback position in nanoseconds of the player, asynchronously. /// /// The value indicating a desired position in nanoseconds. /// The value indicating whether the operation performs with accuracy. @@ -753,7 +753,7 @@ public async Task SetPlayPositionNanosecondsAsync(long position, bool accurate) } /// - /// Sets the playback rate. + /// Sets the playback rate of the player. /// /// The value for the playback rate. Valid range is -5.0 to 5.0, inclusive. /// @@ -793,7 +793,7 @@ public void SetPlaybackRate(float rate) } /// - /// Applies the audio stream policy. + /// Applies the specified audio stream policy to the player. /// /// The to apply. /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs index 38b8a947a24..b8c889befc0 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs @@ -53,7 +53,7 @@ protected PlayerDisplaySettings(Player player) protected Player Player { get; } /// - /// Gets or sets the . + /// Gets or sets the of the player. /// /// /// Operation failed; internal error. @@ -134,7 +134,7 @@ public Rotation Rotation } /// - /// Sets the roi(region of interest). + /// Sets the ROI(Region Of Interest) for the video display. /// /// The region. /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs index 137fc1a5865..27378e44466 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs @@ -38,7 +38,7 @@ public enum PlayerError InternalError = ErrorCode.InvalidOperation, /// - /// No space. + /// No space on the device. /// NoSpaceOnDevice = PlayerErrorCode.NoSpaceOnDevice, @@ -269,32 +269,32 @@ public enum PlaybackInterruptionReason public enum StreamMetadataKey { /// - /// Album. + /// The album name of the media content /// Album, /// - /// Artists. + /// The artist(s) of the media content. /// Artist, /// - /// Author. + /// The author(s) of the media content. /// Author, /// - /// Genre. + /// The genre(s) of the media content. /// Genre, /// - /// Title. + /// The title of the media content. /// Title, /// - /// Year. + /// The year of the media content. /// Year } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs index f3ee00a62ab..b46489e700f 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs @@ -30,7 +30,7 @@ internal SubtitleUpdatedEventArgs(uint duration, string text) } /// - /// Gets the duration of the updated subtitle. + /// Gets the duration in milliseconds of the updated subtitle. /// /// 3 public uint Duration { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs index 89e97d2c5ca..cb978a69cc4 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs @@ -32,7 +32,7 @@ internal VideoFrameDecodedEventArgs(MediaPacket packet) } /// - /// Gets the packet containing the decoded frame. + /// Gets the media packet containing the decoded frame. /// /// 3 public MediaPacket Packet { get; } diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaCameraSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaCameraSource.cs index 50a34111a76..2efc12409cb 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaCameraSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaCameraSource.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Represents a camera source. + /// Represents a media source that makes video data using camera device internally. /// /// The camera privilege(http://tizen.org/privilege/camera) is required. /// @@ -36,7 +36,7 @@ public sealed class MediaCameraSource : MediaSource public MediaCameraSource() : base(MediaType.Video) {} /// - /// Gets or sets the camera device id. + /// Gets or sets the camera device id that identifies each camera device. /// /// A value that specifies the camera device id. /// MediaSource is not attached yet. diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaCustomSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaCustomSource.cs index 4f42fd930f1..112beb5a5d3 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaCustomSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaCustomSource.cs @@ -22,8 +22,11 @@ namespace Tizen.Multimedia.Remoting { /// - /// Represents a audio, video custom source. + /// Represents a media source that makes audio, video data internally. /// + /// + /// This supports the product infrastructure and is not intended to be used directly from application code. + /// /// /// /// 9 diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaFileSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaFileSource.cs index 40e6ea36f08..4cc04bb1b7b 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaFileSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaFileSource.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Represents a media source with contents read from a file. + /// Represents a media source that reads media data from a file. /// /// /// Depending on where the source file is located either the media storage privilege (http://tizen.org/privilege/mediastorage) is required or
diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaMicrophoneSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaMicrophoneSource.cs index 8823ef89ef1..7c0cf06f7ef 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaMicrophoneSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaMicrophoneSource.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Represents a microphone source. + /// Represents a media source that makes audio data using microphone. /// /// The recorder privilege(http://tizen.org/privilege/recorder) is required. /// diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaNullSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaNullSource.cs index cdd1d34c45f..586aede9c94 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaNullSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaNullSource.cs @@ -21,7 +21,9 @@ namespace Tizen.Multimedia.Remoting { - /// Represents a null source. + /// + /// Represents a media source that only receives media streams from peer. + /// /// /// If you add this source, WebRTC only receives media stream.
/// is set by default. @@ -84,7 +86,7 @@ public void SetTransceiverCodec(MediaType type, TransceiverCodec codec) } /// - /// Retrieves the supported transceiver codecs. + /// Retrieves the supported transceiver codecs for receiving media stream. /// /// The media type. /// The supported transceiver codecs. diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketBufferStatusChangedEventArgs.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketBufferStatusChangedEventArgs.cs index 2f293e478b7..50a93a2cf95 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketBufferStatusChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketBufferStatusChangedEventArgs.cs @@ -31,14 +31,14 @@ internal MediaPacketBufferStatusChangedEventArgs(uint sourceId, MediaPacketBuffe } /// - /// Gets the source ID. + /// Gets the source ID of media packet. /// /// The source ID. /// 9 public uint SourceId { get; } /// - /// Gets the media packet buffer status. + /// Gets the media packet buffer status that indicates underrun or overflow. /// /// The media packet buffer status. /// 9 diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSource.cs index 09fea0058ed..8f31f186b2c 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSource.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Represents a media packet source. + /// Represents a media source that wraps media data into MediaPacket. /// /// /// diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSourceConfiguration.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSourceConfiguration.cs index d411a01fad1..3e0edbded23 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSourceConfiguration.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaPacketSourceConfiguration.cs @@ -20,7 +20,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Provides means to configure properties and handle events for . + /// Provides means to configure properties and handle event for . /// /// /// 9 @@ -35,7 +35,7 @@ internal MediaPacketSourceConfiguration(MediaPacketSource owner) } /// - /// Occurs when the buffer underruns or overflows. + /// Occurs when the status of buffer is underruns or overflows. /// /// The event handler will be executed on an internal thread. /// 9 diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaScreenSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaScreenSource.cs index 391a13a5aa3..ad51dfb8fe0 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaScreenSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaScreenSource.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Represents a screen source. + /// Represents a media source to share screen data. /// /// /// MediaScreenSource is not allowed to be used by third-party applications due to the security reasons. (Since Tizen 7.0) diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaStreamTrack.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaStreamTrack.cs index be62bebf236..fcd12909121 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaStreamTrack.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaStreamTrack.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Provides the ability to control audio/video track. + /// Provides the ability to control audio or video track from peer. /// /// 9 public sealed class MediaStreamTrack : IDisplayable @@ -38,7 +38,7 @@ internal MediaStreamTrack(WebRTC webRtc, MediaType type, uint trackId) } /// - /// Gets the the of media stream track. + /// Gets the type of media stream track. /// /// /// 9 @@ -55,7 +55,7 @@ private void ReplaceDisplay(Display newDisplay) } /// - /// Gets or sets the display to show remote video. + /// Gets or sets the display to show video data from peer. /// /// A that specifies the display. /// diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/MediaTestSource.cs b/src/Tizen.Multimedia.Remoting/WebRTC/MediaTestSource.cs index d3226b83c7d..a7c514770db 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/MediaTestSource.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/MediaTestSource.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Represents an audio or a video test source. + /// Represents a media source that makes test audio or video stream. /// /// /// diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTC.cs b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTC.cs index 0590d0f0faa..a6d3ce2857e 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTC.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTC.cs @@ -129,7 +129,7 @@ internal void ValidateNotDisposed() #endregion /// - /// Starts the WebRTC. + /// Starts the WebRTC with specific media source. /// /// /// The WebRTC must be in the state.
@@ -150,7 +150,7 @@ public void Start() } /// - /// Starts the WebRTC asynchronously. + /// Starts the WebRTC asynchronously with specific media source. /// /// /// The WebRTC must be in the state.
@@ -228,7 +228,7 @@ public void Stop() } /// - /// Creates SDP offer asynchronously to start a new WebRTC connection to a remote peer. + /// Creates SDP(Session Description Protocol) offer asynchronously to start a new WebRTC connection to a remote peer. /// /// /// The WebRTC must be in the or (Since API Level 12) @@ -267,7 +267,7 @@ public async Task CreateOfferAsync() } /// - /// Creates SDP answer asynchronously with option to an offer received from a remote peer. + /// Creates SDP(Session Description Protocol) answer asynchronously with option to an offer received from a remote peer. /// /// /// The WebRTC must be in the or (Since API Level 12) @@ -354,7 +354,7 @@ public string GetLocalDescription() } /// - /// Sets the session description of the remote peer's current offer or answer. + /// Sets the offer or answer session description from the current remote peer. /// /// /// The WebRTC must be in the or (Since API Level 12) @@ -378,7 +378,7 @@ public void SetRemoteDescription(string description) } /// - /// Gets the session description of the remote peer's current offer or answer. + /// Gets the offer or answer session description from the current remote peer. /// /// The remote session description string /// The WebRTC has already been disposed. @@ -445,7 +445,7 @@ public void AddIceCandidates(IEnumerable iceCandidates) } /// - /// Adds media source. + /// Adds media source to the current WebRTC. /// /// /// This method does not throw state exception anymore(Since API Level 12). It can be called in any state.
@@ -491,7 +491,7 @@ public void AddSource(MediaSource source) } /// - /// Adds media sources. + /// Adds media sources from the current WebRTC. /// /// /// This method does not throw state exception anymore(Since API Level 12). It can be called in any state.
@@ -538,7 +538,7 @@ public void AddSources(params MediaSource[] sources) } /// - /// Removes media source. + /// Removes media source from the current WebRTC. /// /// /// This method does not throw state exception anymore(Since API Level 12). It can be called in any state.
@@ -571,7 +571,7 @@ public void RemoveSource(MediaSource source) } /// - /// Removes media sources. + /// Removes media sources from the current WebRTC. /// /// /// This method does not throw state exception anymore(Since API Level 12). It can be called in any state.
@@ -598,7 +598,7 @@ public void RemoveSources(params MediaSource[] sources) } /// - /// Sets a turn server. + /// Sets a turn server for signalling with remote peer which cannot be connected directly. /// /// The is null. /// The WebRTC has already been disposed. @@ -617,7 +617,7 @@ public void SetTurnServer(string turnServer) } /// - /// Sets turn servers. + /// Sets turn servers for signalling with remote peer which cannot be connected directly. /// /// The one of is null. /// The WebRTC has already been disposed. diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.Events.cs b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.Events.cs index b998669d962..d6cb3c03155 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.Events.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.Events.cs @@ -136,13 +136,18 @@ public event EventHandler ErrorOccurred /// /// Occurs when the buffered data amount is lower than .
- /// If is not set, this event will not be raised. + /// If is not set, this event will not be registered. /// /// 10 public event EventHandler BufferedAmountLow { add { + if (!_bufferThreshold.HasValue) + { + return; + } + if (_bufferedAmountLowThresholdOccurred == null) { RegisterDataChannelBufferedAmountLowThresholdCallback(); @@ -151,6 +156,11 @@ public event EventHandler BufferedAmountLow } remove { + if (!_bufferThreshold.HasValue) + { + return; + } + _bufferedAmountLowThresholdOccurred -= value; if (_bufferedAmountLowThresholdOccurred == null) { @@ -229,16 +239,12 @@ private void UnregisterDataChannelErrorOccurredCallback() private void RegisterDataChannelBufferedAmountLowThresholdCallback() { - if (_webRtcDataChannelBufferedAmountLowThresholdCallback == null) + _webRtcDataChannelBufferedAmountLowThresholdCallback = (dataChannelHanel, _) => { - _webRtcDataChannelBufferedAmountLowThresholdCallback = (dataChannelHanel, _) => - { - _bufferedAmountLowThresholdOccurred?.Invoke(this, new EventArgs()); - }; - } + _bufferedAmountLowThresholdOccurred?.Invoke(this, new EventArgs()); + }; - NativeDataChannel.SetBufferedAmountLowThresholdCb(_handle, _bufferThreshold.Value, - _webRtcDataChannelBufferedAmountLowThresholdCallback). + NativeDataChannel.SetBufferedAmountLowThresholdCb(_handle, _bufferThreshold.Value, _webRtcDataChannelBufferedAmountLowThresholdCallback). ThrowIfFailed("Failed to set buffered amount low threshold callback."); } diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.cs b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.cs index fcb1dc7de8e..21a77d49ea9 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannel.cs @@ -161,8 +161,6 @@ public uint BufferedAmountLowThreshold ValidateNotDisposed(); _bufferThreshold = value; - - RegisterDataChannelBufferedAmountLowThresholdCallback(); } } diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannelErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannelErrorOccurredEventArgs.cs index ddae8b4d3e0..8963ea7c93f 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannelErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCDataChannelErrorOccurredEventArgs.cs @@ -30,7 +30,7 @@ internal WebRTCDataChannelErrorOccurredEventArgs(WebRTCError error) } /// - /// Gets the error. + /// Gets the error of data channel. /// /// The error. /// 9 diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCEnums.cs b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCEnums.cs index 24796c35b57..61cafb38f2a 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCEnums.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCEnums.cs @@ -20,7 +20,7 @@ namespace Tizen.Multimedia.Remoting { /// - /// Specifies errors. + /// Specifies WebRTC errors. /// /// /// @@ -361,7 +361,7 @@ public enum IceTransportPolicy } /// - /// Specifies the display type. + /// Specifies the display mode that indicates the way of displaying video data. /// /// 9 public enum WebRTCDisplayMode @@ -383,7 +383,8 @@ public enum WebRTCDisplayMode } /// - /// Specifies the bundle policy. + /// Specifies the bundle policy that affects which media tracks are negotiated if the remote endpoint is not bundle-aware, + /// and what ICE candidates are gathered. /// /// /// The details of bundle policy enum is described in https://www.w3.org/TR/webrtc/#rtcbundlepolicy-enum. diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCFrameEncodedEventArgs.cs b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCFrameEncodedEventArgs.cs index 455009c5154..aea9583b980 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCFrameEncodedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCFrameEncodedEventArgs.cs @@ -31,7 +31,7 @@ internal WebRTCFrameEncodedEventArgs(MediaStreamTrack track, MediaPacket packet) } /// - /// Gets the track information. + /// Gets the information of media stream track from remote peer. /// /// The media type. /// 9 diff --git a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCTrackAddedEventArgs.cs b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCTrackAddedEventArgs.cs index e95c70eb113..dce812cca78 100755 --- a/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCTrackAddedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/WebRTC/WebRTCTrackAddedEventArgs.cs @@ -30,7 +30,7 @@ internal WebRTCTrackAddedEventArgs(MediaStreamTrack track) } /// - /// Gets the media type. + /// Gets the media stream track from reemote peer. /// /// The media type. /// 9 diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadget.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadget.cs index 6a766047b51..2f48cca2ee2 100755 --- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadget.cs +++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadget.cs @@ -22,8 +22,13 @@ namespace Tizen.NUI { /// - /// This class represents a NUIGadget controlled lifecycles. + /// Represents a NUIGadget controlled lifecycle. /// + /// + /// This class provides functionality related to managing the lifecycle of a NUIGadget. + /// It enables developers to handle events such as initialization, activation, deactivation, and destruction of the gadget. + /// By implementing this class, developers can define their own behavior for these events and customize the lifecycle of their gadgets accordingly. + /// /// 10 [EditorBrowsable(EditorBrowsableState.Never)] public abstract class NUIGadget @@ -31,7 +36,11 @@ public abstract class NUIGadget /// /// Initializes the gadget. /// - /// /// The type of the NUIGadget. + /// The type of the NUIGadget. + /// + /// This constructor initializes a new instance of the NUIGadget class based on the specified type. + /// It is important to provide the correct type argument in order to ensure proper functionality and compatibility with other components. + /// /// 10 public NUIGadget(NUIGadgetType type) { @@ -44,7 +53,11 @@ public NUIGadget(NUIGadgetType type) /// /// Gets the class representing information of the current gadget. /// - /// This property is set before the OnCreate() is called, after the instance has been created. + /// + /// This property is set before the OnCreate() is called, after the instance has been created. + /// It provides details about the current gadget such as its ID, name, version, and other relevant information. + /// By accessing this property, developers can retrieve the necessary information about the gadget they are working on. + /// /// 10 public NUIGadgetInfo NUIGadgetInfo { @@ -53,7 +66,7 @@ public NUIGadgetInfo NUIGadgetInfo } /// - /// Gets the type. + /// Gets the type of the NUI gadget. /// /// 10 public NUIGadgetType Type @@ -65,7 +78,10 @@ public NUIGadgetType Type /// /// Gets the class name. /// - /// This property is set before the OnCreate() is called, after the instance has been created. + /// + /// This property is set before the OnCreate() is called, after the instance has been created. + /// It provides access to the name of the class that was used to create the current instance. + /// /// 10 public string ClassName { @@ -74,7 +90,7 @@ public string ClassName } /// - /// Gets the main view. + /// Gets the main view of the NUI gadget.. /// /// 10 public View MainView @@ -84,7 +100,7 @@ public View MainView } /// - /// Gets the lifecycle state. + /// Gets the current lifecycle state of the gadget. /// /// 10 public NUIGadgetLifecycleState State @@ -96,7 +112,11 @@ public NUIGadgetLifecycleState State /// /// Gets the resource manager. /// - /// This property is set before the OnCreate() is called, after the instance has been created. + /// This property is set before the OnCreate() is called, after the instance has been created. + /// It provides access to various resources such as images, sounds, and fonts that can be used in your application. + /// By utilizing the resource manager, you can easily manage and retrieve these resources without having to manually handle their loading and unloading. + /// Additionally, the resource manager ensures efficient memory management by automatically handling the caching and recycling of resources. + /// /// 10 public NUIGadgetResourceManager NUIGadgetResourceManager { @@ -172,8 +192,8 @@ private void NotifyLifecycleChanged() } /// - /// Overrides this method if want to handle behavior when the gedget is started. - /// If 'base.OnCreate()' is not called, the event 'NUIGadgetLifecycleChanged' with the 'NUIGadgetLifecycleState.Created' state will not be emitted. + /// Override this method to define the behavior when the gadget is created. + /// Calling 'base.OnCreate()' is necessary in order to emit the 'NUIGadgetLifecycleChanged' event with the 'NUIGadgetLifecycleState.Created' state. /// /// The main view object. /// 10 @@ -187,15 +207,19 @@ protected virtual Tizen.NUI.BaseComponents.View OnCreate() /// /// Overrides this method if want to handle behavior when the gadget receives the appcontrol message. /// - /// The appcontrol received event argument. + /// + /// This method provides a way to customize the response when the gadget receives an appcontrol message. + /// By overriding this method in your derived class, you can define specific actions based on the incoming arguments. + /// + /// The appcontrol received event argument containing details about the received message. /// 10 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. + /// Override this method to handle the behavior when the gadget is destroyed. + /// If 'base.OnDestroy()' is not called, the 'NUIGadgetLifecycleChanged' event with the 'NUIGadgetLifecycleState.Destroyed' state will not be emitted. /// /// 10 protected virtual void OnDestroy() diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs index 9946fe8caad..206bf788be7 100644 --- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs +++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs @@ -15,6 +15,7 @@ */ using System; +using System.ComponentModel; using System.IO; using System.Reflection; using System.Runtime.Loader; @@ -35,16 +36,21 @@ protected override Assembly Load(AssemblyName name) } } - internal class NUIGadgetAssembly + /// + /// Represents a class that provides access to the methods and properties of the NUIGadgetAssembly. + /// + /// 10 + [EditorBrowsable(EditorBrowsableState.Never)] + public class NUIGadgetAssembly { private static readonly object _assemblyLock = new object(); private readonly string _assemblyPath; private WeakReference _assemblyRef; private Assembly _assembly = null; - public NUIGadgetAssembly(string assemblyPath) { _assemblyPath = assemblyPath; } + internal NUIGadgetAssembly(string assemblyPath) { _assemblyPath = assemblyPath; } - public void Load() + internal void Load() { lock (_assemblyLock) { @@ -65,9 +71,9 @@ public void Load() } } - public bool IsLoaded { get { return _assembly != null; } } + internal bool IsLoaded { get { return _assembly != null; } } - public NUIGadget CreateInstance(string className) + internal NUIGadget CreateInstance(string className) { lock (_assemblyLock) { @@ -75,7 +81,13 @@ public NUIGadget CreateInstance(string className) } } - public void Unload() + /// + /// Property indicating whether the weak reference to the gadget assembly is still alive. + /// + /// 12 + public bool IsAlive { get { return _assemblyRef.IsAlive; } } + + internal void Unload() { lock (_assemblyLock) { diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs index d25f5200717..c28aaa88a19 100755 --- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs +++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI { /// - /// This class provides properties to get information the gadget. + /// This class provides properties to retrieve information the gadget. /// /// 10 [EditorBrowsable(EditorBrowsableState.Never)] @@ -87,7 +87,11 @@ public string ResourcePath internal Assembly Assembly { get; set; } - internal NUIGadgetAssembly NUIGadgetAssembly { get; set; } + /// + /// Gets the assembly of the gadget. + /// + /// 12 + public NUIGadgetAssembly NUIGadgetAssembly { get; set; } internal static NUIGadgetInfo CreateNUIGadgetInfo(string packageId) { diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetLifecycleChangedEventArgs.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetLifecycleChangedEventArgs.cs index 2db245cd121..9c9e063f757 100755 --- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetLifecycleChangedEventArgs.cs +++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetLifecycleChangedEventArgs.cs @@ -20,20 +20,20 @@ namespace Tizen.NUI { /// - /// Arguments for the event raised when the NUIGadget lifecycle is changed. + /// Event arguments for the NUIGadget lifecycle change event. /// /// 10 [EditorBrowsable(EditorBrowsableState.Never)] public class NUIGadgetLifecycleChangedEventArgs : EventArgs { /// - /// The NUIGadget object. + /// Gets the NUIGadget object that triggered the event. /// /// 10 public NUIGadget Gadget { get; internal set; } /// - /// The state of the NUIGadget lifecycle. + /// Gets the current state of the NUIGadget lifecycle. /// /// 10 public NUIGadgetLifecycleState State { get; internal set; } diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs index 05aa1746632..e7e277d33df 100755 --- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs +++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs @@ -31,7 +31,7 @@ namespace Tizen.NUI { /// - /// This class has the methods and events of the NUIGadgetManager. + /// The NUIGadgetManager provides methods and events related to managing gadgets in the NUI. /// /// 10 [EditorBrowsable(EditorBrowsableState.Never)] @@ -109,6 +109,10 @@ private static void OnDeviceOrientationChanged(object sender, DeviceOrientationE /// /// Occurs when the lifecycle of the NUIGadget is changed. /// + /// + /// This event is raised when the state of the NUIGadget changes. + /// It provides information about the current state through the NUIGadgetLifecycleChangedEventArgs argument. + /// /// 10 public static event EventHandler NUIGadgetLifecycleChanged; @@ -137,6 +141,10 @@ private static NUIGadgetInfo Find(string resourceType) /// Loads an assembly of the NUIGadget. /// /// The resource type of the NUIGadget package. + /// + /// This method loads an assembly of the NUIGadget based on the specified resource type. + /// It throws an ArgumentException if the argument is invalid, or an InvalidOperationException if the operation fails due to any reason. + /// /// Thrown when failed because of a invalid argument. /// Thrown when failed because of an invalid operation. /// 10 @@ -149,9 +157,9 @@ public static void Load(string resourceType) /// Loads an assembly of the NUIGadget. /// /// The resource type of the NUIGadget package. - /// The flag if ture, use a default load context. Otherwise, use a new load context. - /// Thrown when failed because of a invalid argument. - /// Thrown when failed because of an invalid operation. + /// Indicates whether to use a default load context or not. + /// Thrown when failed due to an invalid argument. + /// Thrown when failed due to an invalid operation. /// 10 public static void Load(string resourceType, bool useDefaultContext) { @@ -165,10 +173,23 @@ public static void Load(string resourceType, bool useDefaultContext) } /// - /// Unloads the loaded assembly of the NUIGadget. + /// Unloads the specified NUIGadget assembly from memory. /// - /// The resource type of the NUIGadget package. - /// Thrown when failed because of a invalid argument. + /// + /// To use this method properly, the assembly of the gadget must be loaded using Load() with the custom context. + /// + /// The resource type of the NUIGadget package to unload. + /// Thrown when the argument passed is not valid. + /// + /// + /// /// Load an assembly of the NUIGadget. + /// NUIGadgetManager.Load("org.tizen.appfw.gadget.NetworkSetting", false); + /// /// NUIGadgetManager.Add("org.tizen.appfw.gadget.NetworkSetting", "NetworkSettingGadget", false); + /// + /// /// Unload the loaded assembly + /// NUIGadgetManager.Unload("org.tizen.appfw.gadget.NetworkSetting"); + /// + /// /// 10 public static void Unload(string resourceType) { @@ -193,7 +214,6 @@ private static void Unload(NUIGadgetInfo info) if (info.NUIGadgetAssembly != null && info.NUIGadgetAssembly.IsLoaded) { info.NUIGadgetAssembly.Unload(); - info.NUIGadgetAssembly = null; } } } @@ -221,7 +241,7 @@ private static void Load(NUIGadgetInfo info, bool useDefaultContext) } else { - if (info.NUIGadgetAssembly == null) + if (info.NUIGadgetAssembly == null || !info.NUIGadgetAssembly.IsLoaded) { Log.Warn("NUIGadgetAssembly.Load(): " + info.ResourcePath + info.ExecutableFile + " ++"); info.NUIGadgetAssembly = new NUIGadgetAssembly(info.ResourcePath + info.ExecutableFile); @@ -258,6 +278,9 @@ public static NUIGadget Add(string resourceType, string className) /// /// Adds a NUIGadget to the NUIGadgetManager. /// + /// + /// To use Unload() method, the useDefaultContext must be'false'. + /// /// The resource type of the NUIGadget package. /// The class name of the NUIGadget. /// The flag it true, use a default context. Otherwise, use a new load context. @@ -295,9 +318,9 @@ public static NUIGadget Add(string resourceType, string className, bool useDefau } /// - /// Gets the instance of the running NUIGadgets. + /// Retrieves the instances of currently running NUIGadgets. /// - /// The NUIGadget list. + /// An enumerable list containing all the active NUIGadgets. /// 10 public static IEnumerable GetGadgets() { @@ -305,14 +328,14 @@ public static IEnumerable GetGadgets() } /// - /// Gets the information of the available NUIGadgets. + /// Retrieves information about available NUIGadgets. /// /// - /// This method only returns the available gadget informations, not all installed gadget informations. - /// The resource package of the NUIGadget can set the allowed packages using "allowed-package". - /// When executing an application, the platform mounts the resource package into the resource path of the application. + /// This method provides details on gadgets that are currently accessible rather than listing all installed gadgets. + /// A NUIGadget's resource package may specify which applications have access through the "allowed-packages" setting. + /// During execution, the platform mounts the resource package in the application's resources directory. /// - /// The NUIGadgetInfo list. + /// An enumerable list of NUIGadgetInfo objects. /// 10 public static IEnumerable GetGadgetInfos() { @@ -320,9 +343,15 @@ public static IEnumerable GetGadgetInfos() } /// - /// Removes the NUIGadget from the NUIGadgetManager. + /// Removes the specified NUIGadget from the NUIGadgetManager. /// - /// The NUIGadget object. + /// The NUIGadget object that needs to be removed. + /// + /// This method allows you to remove a specific NUIGadget from the NUIGadgetManager. + /// By passing the NUIGadget object as an argument, you can ensure that only the desired gadget is removed. + /// It is important to note that once a gadget is removed, any references to it become invalid. + /// Therefore, it is crucial to handle the removal process carefully to avoid any potential issues. + /// /// 10 public static void Remove(NUIGadget gadget) { @@ -346,6 +375,10 @@ public static void Remove(NUIGadget gadget) /// /// Removes all NUIGadgets from the NUIGadgetManager. /// + /// + /// This method is called to remove all NUIGadgets that are currently registered in the NUIGadgetManager. + /// It ensures that no more NUIGadgets exist after calling this method. + /// /// 10 public static void RemoveAll() { @@ -356,12 +389,33 @@ public static void RemoveAll() } /// - /// Resumes the running NUIGadget. + /// Resumes the execution of the specified NUIGadget. /// - /// The NUIGadget object. + /// + /// By calling this method, you can resume the execution of the currently suspended NUIGadget. + /// It takes the NUIGadget object as an argument which represents the target gadget that needs to be resumed. + /// + /// The NUIGadget object whose execution needs to be resumed. + /// Thrown if the 'gadget' argument is null. + /// + /// To resume the execution of a specific NUIGadget named 'MyGadget', you can call the following code snippet: + /// + /// + /// // Get the reference to the NUIGadget object + /// NUIGadget MyGadget = ...; + /// + /// // Resume its execution + /// GadgetResume(MyGadget); + /// + /// /// 10 public static void Resume(NUIGadget gadget) { + if (gadget == null) + { + throw new ArgumentNullException(nameof(gadget)); + } + if (!_gadgets.Contains(gadget)) { return; @@ -375,12 +429,21 @@ public static void Resume(NUIGadget gadget) } /// - /// Pauses the running NUIGadget. + /// Pauses the execution of the specified NUIGadget. /// - /// The NUIGadget object. + /// + /// Calling this method pauses the currently executing NUIGadget. It does not affect any other gadgets that may be running simultaneously. + /// + /// The NUIGadget object whose execution needs to be paused. + /// Thrown if the argument 'gadget' is null. /// 10 public static void Pause(NUIGadget gadget) { + if (gadget == null) + { + throw new ArgumentNullException(nameof(gadget)); + } + if (!_gadgets.Contains(gadget)) { return; @@ -394,12 +457,12 @@ public static void Pause(NUIGadget gadget) } /// - /// Sends the appcontrol to the running NUIGadget. + /// Sends the specified application control to the currently running NUIGadget. /// - /// The NUIGadget object. - /// The appcontrol object. - /// Thrown when failed because of a invalid argument. - /// Thrown when failed because the argument is null. + /// The NUIGadget object that will receive the app control. + /// The app control object containing the desired arguments and actions. + /// Thrown if any of the arguments are invalid or missing. + /// Thrown if either 'gadget' or 'appControl' is null. /// 10 public static void SendAppControl(NUIGadget gadget, AppControl appControl) { diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetResourceManager.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetResourceManager.cs index d99a2c382e8..6f20fba2bfc 100755 --- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetResourceManager.cs +++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetResourceManager.cs @@ -25,7 +25,7 @@ namespace Tizen.NUI { /// - /// This class has the methods of the NUIGadgetResourceManager. + /// Manages resources related to NUI gadgets. /// /// 10 [EditorBrowsable(EditorBrowsableState.Never)] @@ -40,8 +40,8 @@ public class NUIGadgetResourceManager /// Initializes the resource manager of the gadget. /// /// The information of the gadget. - /// Thrown when failed because of a invalid argument. - /// 11 + /// Thrown when the argument is not valid. + /// 10 public NUIGadgetResourceManager(NUIGadgetInfo info) { if (info == null) @@ -57,9 +57,9 @@ public NUIGadgetResourceManager(NUIGadgetInfo info) /// /// Initializes the resource manager of the gadget. /// - /// The path of the resource - /// The file name of the resource. - /// The class name of the resource. + /// The path where the resources are located. + /// The name of the DLL containing the resources. + /// The name of the class that represents the resources. /// 10 public NUIGadgetResourceManager(string resourcePath, string resourceDll, string resourceClassName) { @@ -69,10 +69,26 @@ public NUIGadgetResourceManager(string resourcePath, string resourceDll, string } /// - /// Get the value of the specified string resource. + /// Retrieves the value of the specified string resource. /// - /// The name of the resource to retrieve. - /// The value of the resource, or null if name cannot be found in a resource set. + /// The unique identifier for the string resource to retrieve. + /// The value of the requested string resource, or null if no matching resource could be found. + /// + /// This function allows you to access localized string resources by providing their names. + /// It returns the actual value of the requested resource, which can then be displayed to users or used elsewhere in your application logic. + /// If the specified resource does not exist or cannot be found, the function will return null instead. + /// + /// + /// Here's an example demonstrating how to retrieve a string resource named "greeting" from the current context: + /// + /// + /// // Retrieve the greeting message + /// string greetingMessage = GetString("greeting"); + /// + /// // Display the greeting message to the user + /// Console.WriteLine(greetingMessage); + /// + /// /// 10 public string GetString(string name) { @@ -80,12 +96,16 @@ public string GetString(string name) } /// - /// Gets the return value of the string resource localized for the specified culture. + /// Retrieves the localized string resource for the specified culture. /// - /// The name of the resource to retrieve. - /// An object that represents the culture for which the resource is localied. - /// The value of the resource localied for the specified culture, or null if name cannot be found in a resource set. - /// Thrown when failed because of a invalid argument. + /// + /// This method enables you to obtain a localized version of a specific string resource based on the provided culture. + /// It returns the desired resource value or null if the requested resource cannot be found in the resource set. + /// + /// The name of the resource to fetch. + /// An object representing the culture for which the resource needs to be localized. + /// The localized string resource for the specified culture, or null if the resource cannot be found. + /// Thrown when an invalid argument causes failure. /// 10 public string GetString(string name, CultureInfo cultureInfo) { diff --git a/src/Tizen.NUI.Scene3D/src/public/Controls/SceneView.cs b/src/Tizen.NUI.Scene3D/src/public/Controls/SceneView.cs index e0086234e0a..d7a72f20558 100755 --- a/src/Tizen.NUI.Scene3D/src/public/Controls/SceneView.cs +++ b/src/Tizen.NUI.Scene3D/src/public/Controls/SceneView.cs @@ -446,7 +446,7 @@ public Camera GetCamera(uint index) { // We found matched NUI camera. Reduce cPtr reference count. HandleRef handle = new HandleRef(this, cPtr); - Interop.Camera.DeleteCameraProperty(handle); + Interop.Camera.DeleteCamera(handle); handle = new HandleRef(null, IntPtr.Zero); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -472,7 +472,7 @@ public Camera GetCamera(string name) { // We found matched NUI camera. Reduce cPtr reference count. HandleRef handle = new HandleRef(this, cPtr); - Interop.Camera.DeleteCameraProperty(handle); + Interop.Camera.DeleteCamera(handle); handle = new HandleRef(null, IntPtr.Zero); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -569,7 +569,7 @@ public Camera GetSelectedCamera() { // We found matched NUI camera. Reduce cPtr reference count. HandleRef handle = new HandleRef(this, cPtr); - Interop.Camera.DeleteCameraProperty(handle); + Interop.Camera.DeleteCamera(handle); handle = new HandleRef(null, IntPtr.Zero); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); diff --git a/src/Tizen.NUI/src/internal/Interop/Interop.VisualFactory.cs b/src/Tizen.NUI/src/internal/Interop/Interop.VisualFactory.cs index 988953bf5b7..0be09007246 100755 --- a/src/Tizen.NUI/src/internal/Interop/Interop.VisualFactory.cs +++ b/src/Tizen.NUI/src/internal/Interop/Interop.VisualFactory.cs @@ -31,6 +31,9 @@ internal static partial class VisualFactory [global::System.Runtime.InteropServices.DllImport(NDalicPINVOKE.Lib, EntryPoint = "CSharp_Dali_VisualFactory_CreateVisual__SWIG_0")] public static extern global::System.IntPtr CreateVisual(global::System.Runtime.InteropServices.HandleRef jarg1, global::System.Runtime.InteropServices.HandleRef jarg2); + [global::System.Runtime.InteropServices.DllImport(NDalicPINVOKE.Lib, EntryPoint = "CSharp_Dali_VisualFactory_AddPrecompileShader")] + public static extern bool AddPrecompileShader(global::System.Runtime.InteropServices.HandleRef jarg1, global::System.Runtime.InteropServices.HandleRef jarg2); + [global::System.Runtime.InteropServices.DllImport(NDalicPINVOKE.Lib, EntryPoint = "CSharp_Dali_VisualFactory_UsePreCompiledShader")] public static extern void UsePreCompiledShader(global::System.Runtime.InteropServices.HandleRef jarg1); } diff --git a/src/Tizen.NUI/src/internal/Interop/Interop.Window.cs b/src/Tizen.NUI/src/internal/Interop/Interop.Window.cs index 19d41f90abd..9caff4253d3 100755 --- a/src/Tizen.NUI/src/internal/Interop/Interop.Window.cs +++ b/src/Tizen.NUI/src/internal/Interop/Interop.Window.cs @@ -385,6 +385,13 @@ internal static partial class Window [return: global::System.Runtime.InteropServices.MarshalAs(global::System.Runtime.InteropServices.UnmanagedType.U1)] public static extern bool IsAlwaysOnTop(global::System.Runtime.InteropServices.HandleRef window); + [global::System.Runtime.InteropServices.DllImport(NDalicPINVOKE.Lib, EntryPoint = "CSharp_Dali_Window_SetBottom")] + public static extern void SetBottom(global::System.Runtime.InteropServices.HandleRef window, bool enable); + + [global::System.Runtime.InteropServices.DllImport(NDalicPINVOKE.Lib, EntryPoint = "CSharp_Dali_Window_IsBottom")] + [return: global::System.Runtime.InteropServices.MarshalAs(global::System.Runtime.InteropServices.UnmanagedType.U1)] + public static extern bool IsBottom(global::System.Runtime.InteropServices.HandleRef window); + [global::System.Runtime.InteropServices.DllImport(NDalicPINVOKE.Lib, EntryPoint = "CSharp_Dali_Window_RelativeMotionGrab")] [return: global::System.Runtime.InteropServices.MarshalAs(global::System.Runtime.InteropServices.UnmanagedType.U1)] public static extern bool RelativeMotionGrab(global::System.Runtime.InteropServices.HandleRef window, uint boundary); diff --git a/src/Tizen.NUI/src/public/Animation/Path.cs b/src/Tizen.NUI/src/public/Animation/Path.cs index 44f760bcf95..6c84cddbd98 100755 --- a/src/Tizen.NUI/src/public/Animation/Path.cs +++ b/src/Tizen.NUI/src/public/Animation/Path.cs @@ -21,14 +21,14 @@ namespace Tizen.NUI { /// - /// A 3D parametric curve.
- /// Paths can be used to animate the position and orientation of actors.
+ /// A 3D parametric curve. + /// Paths can be used to animate the position and orientation of views. /// /// 3 public class Path : BaseHandle { /// - /// Creates an initialized path handle. + /// The default constructor. Creates an initialized path handle. /// /// 3 public Path() : this(Interop.Path.New(), true) @@ -41,7 +41,8 @@ internal Path(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryO } /// - /// Enumeration for the Points. + /// Gets or sets the array of points defining the path. + /// The property value is a PropertyArray containing the points that define the path. /// /// 3 public PropertyArray Points @@ -63,7 +64,8 @@ public PropertyArray Points } /// - /// Enumeration for the ControlPoints. + /// Gets or sets the control points of the path. + /// The property value represents the array of control points defining the path. /// /// 3 public PropertyArray ControlPoints @@ -96,7 +98,7 @@ public void AddPoint(Position point) } /// - /// Adds a control point. + /// Adds a control point to the path. /// /// The new control point to be added. /// 3 @@ -139,6 +141,7 @@ public void Sample(float progress, Vector3 position, Vector3 tangent) /// An accessor for the interpolation points. /// /// The index of the interpolation point. + /// The interpolation point at the specified index. /// 3 public Vector3 GetPoint(uint index) { @@ -151,6 +154,7 @@ public Vector3 GetPoint(uint index) /// An accessor for the control points. /// /// The index of the control point. + /// The control point at the specified index. /// 3 public Vector3 GetControlPoint(uint index) { diff --git a/src/Tizen.NUI/src/public/Animation/TransitionOptions.cs b/src/Tizen.NUI/src/public/Animation/TransitionOptions.cs index 7436842619a..8c0e9152923 100755 --- a/src/Tizen.NUI/src/public/Animation/TransitionOptions.cs +++ b/src/Tizen.NUI/src/public/Animation/TransitionOptions.cs @@ -58,9 +58,9 @@ public TransitionOptions() /// /// Hidden API (Inhouse API). - /// Dispose. + /// Releases unmanaged and optionally managed resources. /// - /// + /// true to release both managed and unmanaged resources. false to release only unmanaged resources. [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.NUI/src/public/Application/NUIApplication.cs b/src/Tizen.NUI/src/public/Application/NUIApplication.cs index 44e2ebe7df8..e7fb82753b1 100755 --- a/src/Tizen.NUI/src/public/Application/NUIApplication.cs +++ b/src/Tizen.NUI/src/public/Application/NUIApplication.cs @@ -70,7 +70,8 @@ static NUIApplication() } /// - /// The default constructor. + /// Initializes a new instance of the class. + /// This is the default constructor that initializes the NUI application using the NUICoreBackend. /// /// 3 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")] @@ -84,8 +85,7 @@ public NUIApplication() : base(new NUICoreBackend()) /// /// The window size. /// The window position. - /// 5 - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened in the future after ACR done. Before ACR, need to be hidden as inhouse API. [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")] [EditorBrowsable(EditorBrowsableState.Never)] public NUIApplication(Size2D windowSize, Position2D windowPosition) : base(new NUICoreBackend("", NUIApplication.WindowMode.Opaque, windowSize, windowPosition)) @@ -95,8 +95,9 @@ public NUIApplication(Size2D windowSize, Position2D windowPosition) : base(new N /// /// The constructor with a stylesheet. + /// This constructor initializes a new instance of the Tizen.NUI.NUIApplication class with the specified stylesheet. /// - /// The styleSheet url. + /// The URL of the stylesheet to apply to the application. /// 3 [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")] public NUIApplication(string styleSheet) : base(new NUICoreBackend(styleSheet)) @@ -110,8 +111,7 @@ public NUIApplication(string styleSheet) : base(new NUICoreBackend(styleSheet)) /// The styleSheet URL. /// The window size. /// The window position. - /// 5 - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened in the future after ACR done. Before ACR, need to be hidden as inhouse API. [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")] [EditorBrowsable(EditorBrowsableState.Never)] public NUIApplication(string styleSheet, Size2D windowSize, Position2D windowPosition) : base(new NUICoreBackend(styleSheet, WindowMode.Opaque, windowSize, windowPosition)) @@ -121,6 +121,7 @@ public NUIApplication(string styleSheet, Size2D windowSize, Position2D windowPos /// /// The constructor with a stylesheet and window mode. + /// This constructor initializes the NUIApplication with a specified stylesheet and window mode. /// /// The styleSheet url. /// The windowMode. @@ -138,8 +139,7 @@ public NUIApplication(string styleSheet, WindowMode windowMode) : base(new NUICo /// The windowMode. /// The window size. /// The window position. - /// 5 - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened in the future after ACR done. Before ACR, need to be hidden as inhouse API. [SuppressMessage("Microsoft.Design", "CA2000: Dispose objects before losing scope", Justification = "NUICoreBackend is disposed in the base class when the application is terminated")] [EditorBrowsable(EditorBrowsableState.Never)] public NUIApplication(string styleSheet, WindowMode windowMode, Size2D windowSize, Position2D windowPosition) : base(new NUICoreBackend(styleSheet, windowMode, windowSize, windowPosition)) @@ -309,14 +309,39 @@ public NUIApplication(ThemeOptions option, WindowData windowData) : base(new NUI } /// - /// Occurs whenever the application is resumed. + /// The Resumed event handler. + /// This event is triggered when the application resumes from being paused or stopped. + /// It can be used to perform actions that need to be executed when the application becomes active again. /// + /// + /// + /// NUIApplication app = new NUIApplication(); + /// app.Resumed += OnAppResumed; + /// + /// void OnAppResumed(object sender, EventArgs e) + /// { + /// // Perform actions when the application is resumed + /// } + /// + /// /// 4 public event EventHandler Resumed; /// - /// Occurs whenever the application is paused. + /// The event handler that gets called when the application is paused. + /// This event is triggered when the application transitions to a paused state. /// + /// + /// + /// NUIApplication app = new NUIApplication(); + /// app.Paused += OnAppPaused; + /// + /// void OnAppPaused(object sender, EventArgs e) + /// { + /// // Perform actions when the application is paused + /// } + /// + /// /// 4 public event EventHandler Paused; @@ -393,7 +418,7 @@ public static string CurrentLoadedXaml } /// - /// ResourceManager to handle multilingual. + /// The MultilingualResourceManager property provides access to a System.Resources.ResourceManager instance that can be used to manage resources for different languages. /// /// 4 public static System.Resources.ResourceManager MultilingualResourceManager @@ -470,8 +495,9 @@ internal Application ApplicationHandle } /// - /// Register the assembly to XAML. + /// Registers the specified assembly to XAML, allowing types within the assembly to be used in XAML files. /// + /// The assembly to register. /// 5 public static void RegisterAssembly(Assembly assembly) { @@ -479,9 +505,18 @@ public static void RegisterAssembly(Assembly assembly) } /// - /// Runs the NUIApplication. + /// This method starts the main loop of the application, allowing it to receive events and run its lifecycle. /// - /// Arguments from commandline. + /// Arguments from commandline. These arguments can be used to customize the application behavior at startup. + /// + /// + /// static void Main(string[] args) + /// { + /// NUIApplication app = new NUIApplication(); + /// app.Run(args); + /// } + /// + /// /// 4 public override void Run(string[] args) { @@ -493,6 +528,7 @@ public override void Run(string[] args) /// /// Exits the NUIApplication. + /// This method causes the application to terminate gracefully. /// /// 4 public override void Exit() @@ -557,8 +593,10 @@ static public Size GetScreenSize() } /// + /// The OnLocaleChanged method is called when the system locale settings have changed. /// Overrides this method if you want to handle behavior. /// + /// The event arguments containing the new locale information. /// 3 protected override void OnLocaleChanged(LocaleChangedEventArgs e) { @@ -566,8 +604,10 @@ protected override void OnLocaleChanged(LocaleChangedEventArgs e) } /// + /// The OnLowBattery method is called when the system is under Low Battery status. /// Overrides this method if you want to handle behavior. /// + /// The event arguments containing the battery status. /// 3 protected override void OnLowBattery(LowBatteryEventArgs e) { @@ -575,8 +615,10 @@ protected override void OnLowBattery(LowBatteryEventArgs e) } /// + /// The OnLowMemory method is called when the system is under Low Memory status. /// Overrides this method if you want to handle behavior. /// + /// The event arguments containing low memory status information. /// 3 protected override void OnLowMemory(LowMemoryEventArgs e) { @@ -584,8 +626,11 @@ protected override void OnLowMemory(LowMemoryEventArgs e) } /// + /// This method is called when the system's region format settings have changed. + /// It provides an opportunity to handle any necessary adjustments or updates based on the new region format. /// Overrides this method if you want to handle behavior. /// + /// The event arguments containing information about the region format change. /// 3 protected override void OnRegionFormatChanged(RegionFormatChangedEventArgs e) { @@ -594,7 +639,6 @@ protected override void OnRegionFormatChanged(RegionFormatChangedEventArgs e) /// /// This method is to handle behavior when the device orientation is changed. - /// /// When device is rotated to ccw or cw, this event occurs. /// In addition, this event is different to window orientation changed event. /// The window orientation event is for per a window and occurs when some flags should be set before. @@ -607,6 +651,7 @@ protected override void OnDeviceOrientationChanged(DeviceOrientationEventArgs e) } /// + /// This method is called when the application is terminated. /// Overrides this method if you want to handle behavior. /// /// 3 @@ -617,7 +662,7 @@ protected override void OnTerminate() } /// - /// Overrides this method if you want to handle behavior. + /// Overrides this method if you want to handle behavior when the application is paused. /// /// 3 protected virtual void OnPause() @@ -627,7 +672,7 @@ protected virtual void OnPause() } /// - /// Overrides this method if you want to handle behavior. + /// Overrides this method if you want to handle behavior when the application is resumed. /// /// 3 protected virtual void OnResume() @@ -637,7 +682,8 @@ protected virtual void OnResume() } /// - /// Overrides this method if you want to handle behavior. + /// Overrides this method if you want to handle behavior before the application is created. + /// This method is guaranteed to be called before is called. /// /// 3 protected virtual void OnPreCreate() @@ -653,8 +699,9 @@ protected virtual void OnPreCreate() } /// - /// Overrides this method if you want to handle behavior. + /// This method is overridden to handle the application control event received. /// + /// The event arguments containing the received application control. /// 3 protected override void OnAppControlReceived(AppControlReceivedEventArgs e) { @@ -667,7 +714,9 @@ protected override void OnAppControlReceived(AppControlReceivedEventArgs e) } /// - /// Overrides this method if you want to handle behavior. + /// The OnCreate method of NUIApplication class. + /// This method is called when the application is created. + /// Override this method to handle custom initialization logic. /// /// 3 protected override void OnCreate() diff --git a/src/Tizen.NUI/src/public/Application/NUIWidgetApplication.cs b/src/Tizen.NUI/src/public/Application/NUIWidgetApplication.cs index 612fabefcfc..f8a352a2b56 100755 --- a/src/Tizen.NUI/src/public/Application/NUIWidgetApplication.cs +++ b/src/Tizen.NUI/src/public/Application/NUIWidgetApplication.cs @@ -115,7 +115,8 @@ internal WidgetApplication ApplicationHandle } /// - /// Run NUIWidgetApplication. + /// Runs the NUI widget application. + /// This method starts the main loop of the application. /// /// Arguments from commandline. /// 4 @@ -126,8 +127,12 @@ public override void Run(string[] args) } /// - /// Exit NUIWidgetApplication. + /// The Exit method of NUIWidgetApplication. /// + /// + /// Note that calling this method will terminate the entire application. + /// Ensure that all necessary cleanup operations are performed before calling this method. + /// /// 4 public override void Exit() { @@ -150,8 +155,9 @@ public void FlushUpdateMessages() } /// - /// Overrides this method if want to handle OnLocaleChanged behavior. + /// Override this method to implement custom behavior when the system locale changes. /// + /// The event arguments containing the new locale information. /// 4 protected override void OnLocaleChanged(LocaleChangedEventArgs e) { @@ -160,8 +166,10 @@ protected override void OnLocaleChanged(LocaleChangedEventArgs e) } /// - /// Overrides this method if want to handle OnLowBattery behavior. + /// The OnLowBattery method is called when the device's battery level is low. + /// This method can be overridden to implement custom behavior when the device's battery level is low. /// + /// The event arguments containing the battery status. /// 4 protected override void OnLowBattery(LowBatteryEventArgs e) { @@ -170,8 +178,10 @@ protected override void OnLowBattery(LowBatteryEventArgs e) } /// + /// This method is called when the system is running low on memory. /// Overrides this method if want to handle OnLowMemory behavior. /// + /// The event arguments containing the memory status. /// 4 protected override void OnLowMemory(LowMemoryEventArgs e) { @@ -180,8 +190,9 @@ protected override void OnLowMemory(LowMemoryEventArgs e) } /// - /// Overrides this method if want to handle OnRegionFormatChanged behavior. + /// This method can be overridden to implement custom behavior when the region format changes. /// + /// The event arguments containing information about the region format change. /// 4 protected override void OnRegionFormatChanged(RegionFormatChangedEventArgs e) { @@ -191,7 +202,6 @@ protected override void OnRegionFormatChanged(RegionFormatChangedEventArgs e) /// /// This method is to handle behavior when the device orientation is changed. - /// /// When device is rotated to ccw or cw, this event occurs. /// In addition, this event is different to window orientation changed event. /// The window orientation event is for per a window and occurs when some flags should be set before. @@ -205,7 +215,8 @@ protected override void OnDeviceOrientationChanged(DeviceOrientationEventArgs e) } /// - /// Overrides this method if want to handle OnTerminate behavior. + /// This method is called when the application is terminated. + /// This method is overridden to perform custom actions when the application terminates. /// /// 4 protected override void OnTerminate() @@ -215,7 +226,8 @@ protected override void OnTerminate() } /// - /// Overrides this method if want to handle OnPreCreate behavior. + /// Overrides this method if you want to handle behavior before the application is created. + /// This method is guaranteed to be called before is called. /// /// 4 protected virtual void OnPreCreate() @@ -224,7 +236,8 @@ protected virtual void OnPreCreate() } /// - /// Overrides this method if want to handle OnCreate behavior. + /// This method is called when the application is created. + /// Override this method to handle custom initialization logic. /// /// 4 protected override void OnCreate() diff --git a/src/Tizen.NUI/src/public/ApplicationAnimation/ApplicationTransitionManager.cs b/src/Tizen.NUI/src/public/ApplicationAnimation/ApplicationTransitionManager.cs index c2fb041634b..a443685d4ff 100755 --- a/src/Tizen.NUI/src/public/ApplicationAnimation/ApplicationTransitionManager.cs +++ b/src/Tizen.NUI/src/public/ApplicationAnimation/ApplicationTransitionManager.cs @@ -39,6 +39,7 @@ public class ApplicationTransitionManager : IDisposable /// /// ApplicationTransitionManager Instance for singleton /// + [EditorBrowsable(EditorBrowsableState.Never)] public static ApplicationTransitionManager Instance { get diff --git a/src/Tizen.NUI/src/public/BaseComponents/CameraView.cs b/src/Tizen.NUI/src/public/BaseComponents/CameraView.cs index 84f85ff96f6..43a6fcf1c03 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/CameraView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/CameraView.cs @@ -26,10 +26,20 @@ namespace Tizen.NUI.BaseComponents /// 9 public class CameraView : View { + /// + /// Enumeration for specifying the display type of the CameraView. + /// /// 9 public enum DisplayType { + /// + /// The camera view will be displayed using hardware overlay. + /// Window = 0, // HW overlay + + /// + /// The camera view will be displayed using texture stream. + /// Image // texture stream }; diff --git a/src/Tizen.NUI/src/public/BaseComponents/CustomView.cs b/src/Tizen.NUI/src/public/BaseComponents/CustomView.cs index 73939b6f5c7..43030022b12 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/CustomView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/CustomView.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI.BaseComponents /// 3 public class CustomView : ViewWrapper { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty FocusNavigationSupportProperty = null; internal static void SetInternalFocusNavigationSupportProperty(BindableObject bindable, object oldValue, object newValue) @@ -43,7 +43,7 @@ internal static object GetInternalFocusNavigationSupportProperty(BindableObject return customView.IsKeyboardNavigationSupported(); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty FocusGroupProperty = null; internal static void SetInternalFocusGroupProperty(BindableObject bindable, object oldValue, object newValue) diff --git a/src/Tizen.NUI/src/public/BaseComponents/ImageView.cs b/src/Tizen.NUI/src/public/BaseComponents/ImageView.cs index dd8fbde624b..8297bb9cf3a 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/ImageView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/ImageView.cs @@ -125,6 +125,7 @@ private static string ConvertResourceUrl(ref string value) ImageVisualProperty.AlphaMaskURL, ImageVisualProperty.CropToMask, Visual.Property.VisualFittingMode, + ImageVisualProperty.SamplingMode, ImageVisualProperty.DesiredWidth, ImageVisualProperty.DesiredHeight, ImageVisualProperty.ReleasePolicy, @@ -1288,6 +1289,32 @@ private FittingModeType InternalFittingMode } } + /// + /// Gets or sets filtering options used when resizing images to the sample original pixels.
+ /// If not supplied, the default is SamplingModeType.BoxThenLinear.
+ /// For normal quad images only.
+ /// Optional. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public SamplingModeType SamplingMode + { + get + { + int ret = (int)SamplingModeType.BoxThenLinear; + + using PropertyValue samplingMode = GetCachedImageVisualProperty(ImageVisualProperty.SamplingMode); + samplingMode?.Get(out ret); + + return (SamplingModeType)ret; + } + set + { + using PropertyValue setValue = new PropertyValue((int)value); + UpdateImage(ImageVisualProperty.SamplingMode, setValue); + NotifyPropertyChanged(); + } + } + /// /// This method allows users to configure the blending of two images(previous and currnet) using alpha values. /// diff --git a/src/Tizen.NUI/src/public/BaseComponents/LottieAnimationView.cs b/src/Tizen.NUI/src/public/BaseComponents/LottieAnimationView.cs index 3af4bd70e91..7467bac35fb 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/LottieAnimationView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/LottieAnimationView.cs @@ -326,7 +326,8 @@ private string InternalURL } /// - /// Gets the playing state + /// Gets the playing state of the LottieAnimationView. + /// This property returns the current play state of the LottieAnimationView. /// /// 7 public PlayStateType PlayState @@ -556,7 +557,8 @@ private int InternalLoopCount } /// - /// Sets or gets the stop behavior. + /// Sets or gets the stop behavior of the LottieAnimationView. + /// This property determines how the animation behaves when it stops. /// /// 7 public StopBehaviorType StopBehavior @@ -859,7 +861,8 @@ public void SetMinMaxFrame(int minFrame, int maxFrame) } /// - /// Play Animation. + /// Plays the Lottie animation. + /// This method starts the playback of the Lottie animation. /// /// 7 public new void Play() @@ -871,7 +874,8 @@ public void SetMinMaxFrame(int minFrame, int maxFrame) } /// - /// Pause Animation. + /// Pauses the Lottie animation. + /// This method pauses the animation without resetting its progress. /// /// 7 public new void Pause() @@ -883,7 +887,8 @@ public void SetMinMaxFrame(int minFrame, int maxFrame) } /// - /// Stop Animation. + /// Stops the Lottie animation. + /// This method stops the currently playing Lottie animation. /// /// 7 public new void Stop() @@ -1194,7 +1199,7 @@ protected override void MergeCachedImageVisualProperty(PropertyMap map) #region Event, Enum, Struct, ETC /// - /// Animation finished event. + /// The event handler for the animation finished event. /// /// 7 public event EventHandler Finished diff --git a/src/Tizen.NUI/src/public/BaseComponents/Style/Selector.cs b/src/Tizen.NUI/src/public/BaseComponents/Style/Selector.cs index d54b9ba34c5..bc0772b14f1 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/Style/Selector.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/Style/Selector.cs @@ -53,6 +53,7 @@ public static implicit operator Selector(T value) /// /// Create an empty selector. + /// This constructor returns an empty selector object which can be used to define various selectors for different states and conditions. /// /// 9 public Selector() @@ -149,9 +150,9 @@ public T DisabledFocused set => Add(ControlState.DisabledFocused, value); } /// - /// SelectedFocused State. + /// Gets or sets the value associated with the SelectedFocused state. /// - /// This is for XAML. Do not ACR this. + /// This property is intended for internal use within XAML files and should not be subject to ACR. public T SelectedFocused { get => GetSafely(x => x.State == ControlState.SelectedFocused); @@ -311,7 +312,7 @@ public void CopyTo(SelectorItem[] items, int startIndex) /// /// Returns an enumerator that iterates through the collection. /// - /// An enumerator that can be used to iterate through the collection. + /// An enumerator that can be used to iterate through the collection. [EditorBrowsable(EditorBrowsableState.Never)] public IEnumerator> GetEnumerator() { @@ -332,9 +333,10 @@ System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() /// Get value by State. /// It will traverse from the first item to find proper fit when there is no perfect state match. /// + /// The state to query for the value. + /// The output parameter to store the resulting value if found. /// Thrown when state is null. - /// 6 - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. /// True if the selector has a given state value, false otherwise. [EditorBrowsable(EditorBrowsableState.Never)] public bool GetValue(ControlState state, out T result) @@ -390,7 +392,10 @@ public void Clear() SelectorItems.Clear(); } - /// + /// + /// Converts the Selector object to its string representation. + /// + /// A string that represents the current selector. [EditorBrowsable(EditorBrowsableState.Never)] public override string ToString() { @@ -408,8 +413,8 @@ public override string ToString() /// Clone itself. /// If type T implements ICloneable, it calls Clone() method to clone values, otherwise use operator=. /// - /// 6 - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// A new Selector T instance that is a clone of the current selector. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Selector Clone() { @@ -466,6 +471,8 @@ private bool EqualsItem(T a, T b) /// /// Determines whether the specified object is equal to the current object. /// + /// The object to compare with the current object. + /// true if the specified object is equal to the current object; otherwise, false. /// 9 public override bool Equals(object other) { @@ -497,6 +504,7 @@ public override bool Equals(object other) /// /// Serves as the default hash function. /// + /// An integer value that specifies the hash code for this instance. [EditorBrowsable(EditorBrowsableState.Never)] public override int GetHashCode() { diff --git a/src/Tizen.NUI/src/public/BaseComponents/Style/ViewStyle.cs b/src/Tizen.NUI/src/public/BaseComponents/Style/ViewStyle.cs index d7a0b61640d..b1fc21ddd17 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/Style/ViewStyle.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/Style/ViewStyle.cs @@ -23,6 +23,7 @@ namespace Tizen.NUI.BaseComponents { /// /// The base class of style attributes for a view. + /// This class provides a base for defining styles that can be applied to views. /// /// 9 public partial class ViewStyle : BindableObject, IDisposable @@ -69,11 +70,12 @@ static ViewStyle() { } /// /// Create an empty style instance. + /// This constructor initializes an empty style object for a view. /// /// 9 public ViewStyle() { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public ViewStyle(ViewStyle viewAttributes) { @@ -102,7 +104,7 @@ public Selector BackgroundImage set => SetValue(BackgroundImageProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool? Focusable { @@ -133,7 +135,7 @@ public bool? FocusableInTouch set => SetValue(FocusableInTouchProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [Obsolete("This has been deprecated. Use Size instead.")] [EditorBrowsable(EditorBrowsableState.Never)] public Size2D Size2D @@ -144,6 +146,8 @@ public Size2D Size2D /// /// Defines view's opacity value. + /// This property allows you to specify different opacity values for various states of the view, + /// such as normal, pressed, focused, etc. /// /// 9 public Selector Opacity @@ -156,7 +160,7 @@ public Selector Opacity set => SetValue(OpacityProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [Obsolete("This has been deprecated. Use Position instead.")] [EditorBrowsable(EditorBrowsableState.Never)] public Position2D Position2D @@ -232,7 +236,7 @@ public Position Position set => SetValue(PositionProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public float? PositionX { @@ -240,7 +244,7 @@ public float? PositionX set => SetValue(PositionXProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public float? PositionY { @@ -248,7 +252,7 @@ public float? PositionY set => SetValue(PositionYProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Rotation Orientation { @@ -256,7 +260,7 @@ public Rotation Orientation set => SetValue(OrientationProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public DrawModeType? DrawMode { @@ -296,7 +300,7 @@ public ResizePolicyType? HeightResizePolicy set => SetValue(HeightResizePolicyProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool? WidthForHeight { @@ -304,7 +308,7 @@ public bool? WidthForHeight set => SetValue(WidthForHeightProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool? HeightForWidth { @@ -342,7 +346,7 @@ public Size2D MaximumSize set => SetValue(MaximumSizeProperty, value); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public ClippingModeType? ClippingMode { @@ -396,7 +400,7 @@ public Selector Color } /// View BackgroundBorder - /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Selector BackgroundImageBorder { @@ -551,7 +555,8 @@ public ViewStyle Clone() } /// - /// Release instance. + /// Releases all resources used by the ViewStyle instance. + /// The Dispose method releases all resources used by the ViewStyle instance. /// /// 9 public void Dispose() @@ -600,9 +605,9 @@ public override void CopyFrom(BindableObject other) } /// - /// Release instance. + /// Releases unmanaged and optionally managed resources. /// - /// If it true, the method has been called by a user's code. Otherwise the method has been called by the finalizer. + /// If it true, the method has been called by a user's code to release both managed and unmanaged resources. Otherwise the method has been called by the finalizer to release only unmanaged resources. /// 9 protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.NUI/src/public/BaseComponents/TableView.cs b/src/Tizen.NUI/src/public/BaseComponents/TableView.cs index 5c923034a59..72c86b0b77d 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TableView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TableView.cs @@ -275,7 +275,8 @@ public int Columns } } /// - /// Padding between cells. + /// Gets or sets the padding between cells in the TableView. + /// The padding vector specifying the horizontal and vertical padding. /// /// 3 public Vector2 CellPadding @@ -306,7 +307,7 @@ public Vector2 CellPadding } /// - /// The number of layout rows. + /// This property allows setting the number of rows in the table view layout, which can affect how child views are arranged within the table. /// /// 3 public PropertyMap LayoutRows @@ -337,7 +338,7 @@ public PropertyMap LayoutRows } /// - /// The number of layout columns. + /// Gets or sets the number of layout columns. /// /// 3 public PropertyMap LayoutColumns @@ -747,6 +748,7 @@ public CellPosition(uint rowIndex) : this(Interop.TableView.NewTableViewCellPosi /// /// The default constructor. + /// Initializes the cell position with default values. /// /// 3 public CellPosition() : this(Interop.TableView.NewTableViewCellPosition(), true) @@ -780,7 +782,7 @@ public uint rowIndex } /// - /// The index or position of a row. + /// Gets or sets the index or position of a row. /// /// 5 public uint RowIndex @@ -795,7 +797,7 @@ public uint RowIndex /// - /// The index of a column. + /// Gets or sets the index of a column. /// /// 3 [Obsolete("Do not use this, that will be deprecated. Use ColumnIndex instead.")] @@ -816,7 +818,7 @@ public uint columnIndex } /// - /// The index or position of a column. + /// Gets or sets the index or position of a column. /// /// 5 public uint ColumnIndex @@ -851,7 +853,7 @@ public uint rowSpan } /// - /// The span of a row. + /// Gets or sets the span of a row. /// /// 5 public uint RowSpan @@ -865,7 +867,7 @@ public uint RowSpan } /// - /// The span of a column. + /// Gets or sets the span of a column. /// /// 3 [Obsolete("Do not use this, that will be deprecated. Use ColumnSpan instead.")] @@ -886,7 +888,7 @@ public uint columnSpan } /// - /// The span of a column. + /// Gets or sets the span of a column. /// /// 5 public uint ColumnSpan diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextConstants.cs b/src/Tizen.NUI/src/public/BaseComponents/TextConstants.cs index 85b0b0d0c3d..bcd69f4e9a9 100644 --- a/src/Tizen.NUI/src/public/BaseComponents/TextConstants.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextConstants.cs @@ -416,6 +416,20 @@ public struct Outline : IEquatable [EditorBrowsable(EditorBrowsableState.Never)] public float? Width { get; set; } + /// + /// The offset in pixels of the offset (if null, the default value is 0, 0).
+ /// If not provided then the offset is not enabled.
+ /// + [EditorBrowsable(EditorBrowsableState.Never)] + public Vector2? Offset { get; set; } + + /// + /// The radius of blurring effect applied to the outline of the text. A higher value results in a more blurred outline.
+ /// If not specified, the default value is 0 which means no blurring effect will be applied.
+ /// + [EditorBrowsable(EditorBrowsableState.Never)] + public float? BlurRadius { get; set; } + /// /// Determines whether the specified object is equal to the current object. /// @@ -430,7 +444,7 @@ public struct Outline : IEquatable /// The Outline to compare with the current Outline. /// true if equal Outline, else false. [EditorBrowsable(EditorBrowsableState.Never)] - public bool Equals(Outline other) => Color == other.Color && Width == other.Width; + public bool Equals(Outline other) => Color == other.Color && Width == other.Width && Offset == other.Offset && BlurRadius == other.BlurRadius; /// /// The == operator. diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs index b54f67d9668..de14c9b91f9 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs @@ -219,6 +219,7 @@ static TextEditor() /// /// Creates the TextEditor control. + /// This returns a handle to the TextEditor control. /// /// 3 public TextEditor() : this(Interop.TextEditor.New(ThemeManager.GetStyle(defaultStyleName) == null ? false : true), true) @@ -931,7 +932,7 @@ public float CursorBlinkDuration } /// - /// The CursorWidth property. + /// Gets or sets the width of the cursor. /// /// 3 public int CursorWidth @@ -2497,7 +2498,7 @@ public float PixelSize } /// - /// The line count of the text. + /// Gets the line count of the text. /// /// 3 public int LineCount @@ -3558,7 +3559,7 @@ public InputMethodContext GetInputMethodContext() } /// - /// Select the whole text. + /// Selects the entire text within the TextEditor control. /// /// 9 public void SelectWholeText() @@ -3812,7 +3813,12 @@ public bool RemoveBackInset /// /// Dispose. + /// Releases unmanaged and optionally managed resources. /// + /// + /// When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources. + /// + /// Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources. /// 3 protected override void Dispose(DisposeTypes type) { diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextEditorBindableProperty.cs b/src/Tizen.NUI/src/public/BaseComponents/TextEditorBindableProperty.cs index 9a107f486b9..04a1c8918d4 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextEditorBindableProperty.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextEditorBindableProperty.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI.BaseComponents /// 3 public partial class TextEditor { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty TextProperty = null; @@ -49,7 +49,7 @@ internal static object GetInternalTextProperty(BindableObject bindable) return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.TEXT); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty TextColorProperty = null; @@ -75,7 +75,7 @@ internal static object GetInternalTextColorProperty(BindableObject bindable) return textEditor.internalTextColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty FontFamilyProperty = null; @@ -94,7 +94,7 @@ internal static object GetInternalFontFamilyProperty(BindableObject bindable) return textEditor.InternalFontFamily; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty FontStyleProperty = null; @@ -115,7 +115,7 @@ internal static object GetInternalFontStyleProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PointSizeProperty = null; @@ -136,7 +136,7 @@ internal static object GetInternalPointSizeProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.PointSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty HorizontalAlignmentProperty = null; @@ -181,7 +181,7 @@ internal static object GetInternalVerticalAlignmentProperty(BindableObject binda return temp.GetValueByDescription(); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ScrollThresholdProperty = null; @@ -202,7 +202,7 @@ internal static object GetInternalScrollThresholdProperty(BindableObject bindabl return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.ScrollThreshold); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ScrollSpeedProperty = null; @@ -223,7 +223,7 @@ internal static object GetInternalScrollSpeedProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.ScrollSpeed); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PrimaryCursorColorProperty = null; @@ -249,7 +249,7 @@ internal static object GetInternalPrimaryCursorColorProperty(BindableObject bind return textEditor.internalPrimaryCursorColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SecondaryCursorColorProperty = null; @@ -275,7 +275,7 @@ internal static object GetInternalSecondaryCursorColorProperty(BindableObject bi return textEditor.internalSecondaryCursorColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableCursorBlinkProperty = null; @@ -296,7 +296,7 @@ internal static object GetInternalEnableCursorBlinkProperty(BindableObject binda return Object.InternalGetPropertyBool(textEditor.SwigCPtr, TextEditor.Property.EnableCursorBlink); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty CursorBlinkIntervalProperty = null; @@ -317,7 +317,7 @@ internal static object GetInternalCursorBlinkIntervalProperty(BindableObject bin return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.CursorBlinkInterval); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty CursorBlinkDurationProperty = null; @@ -338,7 +338,7 @@ internal static object GetInternalCursorBlinkDurationProperty(BindableObject bin return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.CursorBlinkDuration); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty CursorWidthProperty = null; @@ -359,7 +359,7 @@ internal static object GetInternalCursorWidthProperty(BindableObject bindable) return Object.InternalGetPropertyInt(textEditor.SwigCPtr, TextEditor.Property.CursorWidth); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty GrabHandleImageProperty = null; @@ -380,7 +380,7 @@ internal static object GetInternalGrabHandleImageProperty(BindableObject bindabl return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.GrabHandleImage); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty GrabHandlePressedImageProperty = null; @@ -421,7 +421,7 @@ internal static object GetInternalSelectionPopupStyleProperty(BindableObject bin return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleImageLeftProperty = null; @@ -442,7 +442,7 @@ internal static object GetInternalSelectionHandleImageLeftProperty(BindableObjec return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleImageRightProperty = null; @@ -463,7 +463,7 @@ internal static object GetInternalSelectionHandleImageRightProperty(BindableObje return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandlePressedImageLeftProperty = null; @@ -484,7 +484,7 @@ internal static object GetInternalSelectionHandlePressedImageLeftProperty(Bindab return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandlePressedImageRightProperty = null; @@ -505,7 +505,7 @@ internal static object GetInternalSelectionHandlePressedImageRightProperty(Binda return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleMarkerImageLeftProperty = null; @@ -526,7 +526,7 @@ internal static object GetInternalSelectionHandleMarkerImageLeftProperty(Bindabl return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleMarkerImageRightProperty = null; @@ -547,7 +547,7 @@ internal static object GetInternalSelectionHandleMarkerImageRightProperty(Bindab return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHighlightColorProperty = null; @@ -573,7 +573,7 @@ internal static object GetInternalSelectionHighlightColorProperty(BindableObject return textEditor.internalSelectionHighlightColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty DecorationBoundingBoxProperty = null; @@ -594,7 +594,7 @@ internal static object GetInternalDecorationBoundingBoxProperty(BindableObject b return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableMarkupProperty = null; @@ -615,7 +615,7 @@ internal static object GetInternalEnableMarkupProperty(BindableObject bindable) return Object.InternalGetPropertyBool(textEditor.SwigCPtr, TextEditor.Property.EnableMarkup); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputColorProperty = null; @@ -641,7 +641,7 @@ internal static object GetInternalInputColorProperty(BindableObject bindable) return textEditor.internalInputColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputFontFamilyProperty = null; @@ -662,7 +662,7 @@ internal static object GetInternalInputFontFamilyProperty(BindableObject bindabl return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.InputFontFamily); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputFontStyleProperty = null; @@ -683,7 +683,7 @@ internal static object GetInternalInputFontStyleProperty(BindableObject bindable return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputPointSizeProperty = null; @@ -704,7 +704,7 @@ internal static object GetInternalInputPointSizeProperty(BindableObject bindable return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.InputPointSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty LineSpacingProperty = null; @@ -725,7 +725,7 @@ internal static object GetInternalLineSpacingProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.LineSpacing); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputLineSpacingProperty = null; @@ -766,7 +766,7 @@ internal static object GetInternalRelativeLineHeightProperty(BindableObject bind return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.RelativeLineHeight); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty UnderlineProperty = null; @@ -787,7 +787,7 @@ internal static object GetInternalUnderlineProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputUnderlineProperty = null; @@ -809,7 +809,7 @@ internal static object GetInternalInputUnderlineProperty(BindableObject bindable } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ShadowProperty = null; @@ -830,7 +830,7 @@ internal static object GetInternalShadowProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputShadowProperty = null; @@ -851,7 +851,7 @@ internal static object GetInternalInputShadowProperty(BindableObject bindable) return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.InputShadow); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EmbossProperty = null; @@ -872,7 +872,7 @@ internal static object GetInternalEmbossProperty(BindableObject bindable) return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.EMBOSS); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputEmbossProperty = null; @@ -893,7 +893,7 @@ internal static object GetInternalInputEmbossProperty(BindableObject bindable) return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.InputEmboss); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty OutlineProperty = null; @@ -914,7 +914,7 @@ internal static object GetInternalOutlineProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputOutlineProperty = null; @@ -935,7 +935,7 @@ internal static object GetInternalInputOutlineProperty(BindableObject bindable) return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.InputOutline); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SmoothScrollProperty = null; @@ -956,7 +956,7 @@ internal static object GetInternalSmoothScrollProperty(BindableObject bindable) return Object.InternalGetPropertyBool(textEditor.SwigCPtr, TextEditor.Property.SmoothScroll); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SmoothScrollDurationProperty = null; @@ -977,7 +977,7 @@ internal static object GetInternalSmoothScrollDurationProperty(BindableObject bi return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.SmoothScrollDuration); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableScrollBarProperty = null; @@ -998,7 +998,7 @@ internal static object GetInternalEnableScrollBarProperty(BindableObject bindabl return Object.InternalGetPropertyBool(textEditor.SwigCPtr, TextEditor.Property.EnableScrollBar); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ScrollBarShowDurationProperty = null; @@ -1019,7 +1019,7 @@ internal static object GetInternalScrollBarShowDurationProperty(BindableObject b return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.ScrollBarShowDuration); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ScrollBarFadeDurationProperty = null; @@ -1040,7 +1040,7 @@ internal static object GetInternalScrollBarFadeDurationProperty(BindableObject b return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.ScrollBarFadeDuration); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PixelSizeProperty = null; @@ -1061,7 +1061,7 @@ internal static object GetInternalPixelSizeProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textEditor.SwigCPtr, TextEditor.Property.PixelSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PlaceholderTextProperty = null; @@ -1082,7 +1082,7 @@ internal static object GetInternalPlaceholderTextProperty(BindableObject bindabl return Object.InternalGetPropertyString(textEditor.SwigCPtr, TextEditor.Property.PlaceholderText); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PlaceholderTextColorProperty = null; @@ -1108,7 +1108,7 @@ internal static object GetInternalPlaceholderTextColorProperty(BindableObject bi return textEditor.internalPlaceholderTextColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableSelectionProperty = null; @@ -1129,7 +1129,7 @@ internal static object GetInternalEnableSelectionProperty(BindableObject bindabl return Object.InternalGetPropertyBool(textEditor.SwigCPtr, TextEditor.Property.EnableSelection); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PlaceholderProperty = null; @@ -1150,7 +1150,7 @@ internal static object GetInternalPlaceholderProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty LineWrapModeProperty = null; @@ -1171,7 +1171,7 @@ internal static object GetInternalLineWrapModeProperty(BindableObject bindable) return Object.InternalGetPropertyInt(textEditor.SwigCPtr, TextEditor.Property.LineWrapMode); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableShiftSelectionProperty = null; @@ -1193,7 +1193,7 @@ internal static object GetInternalEnableShiftSelectionProperty(BindableObject bi return Object.InternalGetPropertyBool(textEditor.SwigCPtr, TextEditor.Property.EnableShiftSelection); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty MatchSystemLanguageDirectionProperty = null; diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextEditorEvent.cs b/src/Tizen.NUI/src/public/BaseComponents/TextEditorEvent.cs index 8a37327e047..dea6e2d8563 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextEditorEvent.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextEditorEvent.cs @@ -163,7 +163,7 @@ public event EventHandler CursorPositionChanged /// /// The MaxLengthReached event. /// - /// This will be public opened in tizen_6.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandler MaxLengthReached { @@ -552,7 +552,7 @@ public ScrollState ScrollState /// /// The MaxLengthReached event arguments. /// - /// This will be public opened in tizen_6.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class MaxLengthReachedEventArgs : EventArgs { @@ -561,7 +561,7 @@ public class MaxLengthReachedEventArgs : EventArgs /// /// TextEditor. /// - /// This will be public opened in tizen_6.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public TextEditor TextEditor { diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextField.cs b/src/Tizen.NUI/src/public/BaseComponents/TextField.cs index 364d59ab829..638115f9838 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextField.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextField.cs @@ -286,7 +286,7 @@ public TextField() : this(Interop.TextField.New(ThemeManager.GetStyle(defaultSty /// Creates the TextField with setting the status of shown or hidden. /// /// false : Not displayed (hidden), true : displayed (shown) - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public TextField(bool shown) : this(Interop.TextField.New(ThemeManager.GetStyle(defaultStyleName) == null ? false : true), true) { @@ -1301,7 +1301,7 @@ public float CursorBlinkDuration } /// - /// The CursorWidth property. + /// Gets or sets the width of the cursor. /// /// 3 public int CursorWidth @@ -2860,7 +2860,7 @@ public bool EnableSelection /// Enables the grab handles for text selection.
/// The default value is true, which means the grab handles are enabled by default.
/// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public bool EnableGrabHandle { @@ -2894,7 +2894,7 @@ public bool EnableGrabHandle /// Enables the grab handle popup for text selection.
/// The default value is true, which means the grab handle popup is enabled by default.
/// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public bool EnableGrabHandlePopup { @@ -2986,7 +2986,7 @@ public int SelectedTextEnd /// /// Enable editing in text control. /// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public bool EnableEditing { @@ -3491,7 +3491,7 @@ public bool Ellipsis /// /// Enables selection of the text using the Shift key. /// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public bool EnableShiftSelection { @@ -3680,7 +3680,7 @@ public InputMethodContext GetInputMethodContext() } /// - /// Select the whole text. + /// Selects the entire text within the TextField. /// /// 9 public void SelectWholeText() @@ -3800,7 +3800,12 @@ public bool RemoveBackInset /// /// Dispose. + /// Releases unmanaged and optionally managed resources. /// + /// + /// When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources. + /// + /// Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources. /// 3 protected override void Dispose(DisposeTypes type) { diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextFieldBindableProperty.cs b/src/Tizen.NUI/src/public/BaseComponents/TextFieldBindableProperty.cs index 2fab5e69c3c..20ff6ad6f2c 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextFieldBindableProperty.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextFieldBindableProperty.cs @@ -83,7 +83,7 @@ internal static object GetInternalTranslatablePlaceholderTextFocusedProperty(Bin return textField.translatablePlaceholderTextFocused; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty TextProperty = null; internal static void SetInternalTextProperty(BindableObject bindable, object oldValue, object newValue) @@ -104,7 +104,7 @@ internal static object GetInternalTextProperty(BindableObject bindable) return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.TEXT); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PlaceholderTextProperty = null; internal static void SetInternalPlaceholderTextProperty(BindableObject bindable, object oldValue, object newValue) @@ -123,7 +123,7 @@ internal static object GetInternalPlaceholderTextProperty(BindableObject bindabl return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.PlaceholderText); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PlaceholderTextFocusedProperty = null; internal static void SetInternalPlaceholderTextFocusedProperty(BindableObject bindable, object oldValue, object newValue) @@ -142,7 +142,7 @@ internal static object GetInternalPlaceholderTextFocusedProperty(BindableObject return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.PlaceholderTextFocused); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty FontFamilyProperty = null; internal static void SetInternalFontFamilyProperty(BindableObject bindable, object oldValue, object newValue) @@ -159,7 +159,7 @@ internal static object GetInternalFontFamilyProperty(BindableObject bindable) return textField.InternalFontFamily; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty FontStyleProperty = null; internal static void SetInternalFontStyleProperty(BindableObject bindable, object oldValue, object newValue) @@ -178,7 +178,7 @@ internal static object GetInternalFontStyleProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PointSizeProperty = null; internal static void SetInternalPointSizeProperty(BindableObject bindable, object oldValue, object newValue) @@ -197,7 +197,7 @@ internal static object GetInternalPointSizeProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textField.SwigCPtr, TextField.Property.PointSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty MaxLengthProperty = null; internal static void SetInternalMaxLengthProperty(BindableObject bindable, object oldValue, object newValue) @@ -216,7 +216,7 @@ internal static object GetInternalMaxLengthProperty(BindableObject bindable) return Object.InternalGetPropertyInt(textField.SwigCPtr, TextField.Property.MaxLength); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ExceedPolicyProperty = null; internal static void SetInternalExceedPolicyProperty(BindableObject bindable, object oldValue, object newValue) @@ -235,7 +235,7 @@ internal static object GetInternalExceedPolicyProperty(BindableObject bindable) return Object.InternalGetPropertyInt(textField.SwigCPtr, TextField.Property.ExceedPolicy); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty HorizontalAlignmentProperty = null; internal static void SetInternalHorizontalAlignmentProperty(BindableObject bindable, object oldValue, object newValue) @@ -256,7 +256,7 @@ internal static object GetInternalHorizontalAlignmentProperty(BindableObject bin return temp.GetValueByDescription(); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty VerticalAlignmentProperty = null; internal static void SetInternalVerticalAlignmentProperty(BindableObject bindable, object oldValue, object newValue) @@ -277,7 +277,7 @@ internal static object GetInternalVerticalAlignmentProperty(BindableObject binda return temp.GetValueByDescription(); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty TextColorProperty = null; internal static void SetInternalTextColorProperty(BindableObject bindable, object oldValue, object newValue) @@ -301,7 +301,7 @@ internal static object GetInternalTextColorProperty(BindableObject bindable) return textField.internalTextColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PlaceholderTextColorProperty = null; internal static void SetInternalPlaceholderTextColorProperty(BindableObject bindable, object oldValue, object newValue) @@ -363,7 +363,7 @@ internal static object GetInternalEnableGrabHandlePopupProperty(BindableObject b return Object.InternalGetPropertyBool(textField.SwigCPtr, TextField.Property.EnableGrabHandlePopup); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PrimaryCursorColorProperty = null; internal static void SetInternalPrimaryCursorColorProperty(BindableObject bindable, object oldValue, object newValue) @@ -387,7 +387,7 @@ internal static object GetInternalPrimaryCursorColorProperty(BindableObject bind return textField.internalPrimaryCursorColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SecondaryCursorColorProperty = null; internal static void SetInternalSecondaryCursorColorProperty(BindableObject bindable, object oldValue, object newValue) @@ -411,7 +411,7 @@ internal static object GetInternalSecondaryCursorColorProperty(BindableObject bi return textField.internalSecondaryCursorColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableCursorBlinkProperty = null; internal static void SetInternalEnableCursorBlinkProperty(BindableObject bindable, object oldValue, object newValue) @@ -430,7 +430,7 @@ internal static object GetInternalEnableCursorBlinkProperty(BindableObject binda return Object.InternalGetPropertyBool(textField.SwigCPtr, TextField.Property.EnableCursorBlink); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty CursorBlinkIntervalProperty = null; internal static void SetInternalCursorBlinkIntervalProperty(BindableObject bindable, object oldValue, object newValue) @@ -449,7 +449,7 @@ internal static object GetInternalCursorBlinkIntervalProperty(BindableObject bin return Object.InternalGetPropertyFloat(textField.SwigCPtr, TextField.Property.CursorBlinkInterval); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty CursorBlinkDurationProperty = null; internal static void SetInternalCursorBlinkDurationProperty(BindableObject bindable, object oldValue, object newValue) @@ -468,7 +468,7 @@ internal static object GetInternalCursorBlinkDurationProperty(BindableObject bin return Object.InternalGetPropertyFloat(textField.SwigCPtr, TextField.Property.CursorBlinkDuration); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty CursorWidthProperty = null; internal static void SetInternalCursorWidthProperty(BindableObject bindable, object oldValue, object newValue) @@ -487,7 +487,7 @@ internal static object GetInternalCursorWidthProperty(BindableObject bindable) return Object.InternalGetPropertyInt(textField.SwigCPtr, TextField.Property.CursorWidth); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty GrabHandleImageProperty = null; internal static void SetInternalGrabHandleImageProperty(BindableObject bindable, object oldValue, object newValue) @@ -506,7 +506,7 @@ internal static object GetInternalGrabHandleImageProperty(BindableObject bindabl return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.GrabHandleImage); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty GrabHandlePressedImageProperty = null; internal static void SetInternalGrabHandlePressedImageProperty(BindableObject bindable, object oldValue, object newValue) @@ -525,7 +525,7 @@ internal static object GetInternalGrabHandlePressedImageProperty(BindableObject return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.GrabHandlePressedImage); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ScrollThresholdProperty = null; internal static void SetInternalScrollThresholdProperty(BindableObject bindable, object oldValue, object newValue) @@ -544,7 +544,7 @@ internal static object GetInternalScrollThresholdProperty(BindableObject bindabl return Object.InternalGetPropertyFloat(textField.SwigCPtr, TextField.Property.ScrollThreshold); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ScrollSpeedProperty = null; internal static void SetInternalScrollSpeedProperty(BindableObject bindable, object oldValue, object newValue) @@ -581,7 +581,7 @@ internal static object GetInternalSelectionPopupStyleProperty(BindableObject bin return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleImageLeftProperty = null; internal static void SetInternalSelectionHandleImageLeftProperty(BindableObject bindable, object oldValue, object newValue) @@ -600,7 +600,7 @@ internal static object GetInternalSelectionHandleImageLeftProperty(BindableObjec return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleImageRightProperty = null; internal static void SetInternalSelectionHandleImageRightProperty(BindableObject bindable, object oldValue, object newValue) @@ -619,7 +619,7 @@ internal static object GetInternalSelectionHandleImageRightProperty(BindableObje return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandlePressedImageLeftProperty = null; internal static void SetInternalSelectionHandlePressedImageLeftProperty(BindableObject bindable, object oldValue, object newValue) @@ -638,7 +638,7 @@ internal static object GetInternalSelectionHandlePressedImageLeftProperty(Bindab return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandlePressedImageRightProperty = null; internal static void SetInternalSelectionHandlePressedImageRightProperty(BindableObject bindable, object oldValue, object newValue) @@ -657,7 +657,7 @@ internal static object GetInternalSelectionHandlePressedImageRightProperty(Binda return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleMarkerImageLeftProperty = null; internal static void SetInternalSelectionHandleMarkerImageLeftProperty(BindableObject bindable, object oldValue, object newValue) @@ -676,7 +676,7 @@ internal static object GetInternalSelectionHandleMarkerImageLeftProperty(Bindabl return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHandleMarkerImageRightProperty = null; internal static void SetInternalSelectionHandleMarkerImageRightProperty(BindableObject bindable, object oldValue, object newValue) @@ -695,7 +695,7 @@ internal static object GetInternalSelectionHandleMarkerImageRightProperty(Bindab return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty SelectionHighlightColorProperty = null; internal static void SetInternalSelectionHighlightColorProperty(BindableObject bindable, object oldValue, object newValue) @@ -719,7 +719,7 @@ internal static object GetInternalSelectionHighlightColorProperty(BindableObject return textField.internalSelectionHighlightColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty DecorationBoundingBoxProperty = null; internal static void SetInternalDecorationBoundingBoxProperty(BindableObject bindable, object oldValue, object newValue) @@ -738,7 +738,7 @@ internal static object GetInternalDecorationBoundingBoxProperty(BindableObject b return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputMethodSettingsProperty = null; internal static void SetInternalInputMethodSettingsProperty(BindableObject bindable, object oldValue, object newValue) @@ -757,7 +757,7 @@ internal static object GetInternalInputMethodSettingsProperty(BindableObject bin return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputColorProperty = null; internal static void SetInternalInputColorProperty(BindableObject bindable, object oldValue, object newValue) @@ -781,7 +781,7 @@ internal static object GetInternalInputColorProperty(BindableObject bindable) return textField.internalInputColor; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableMarkupProperty = null; internal static void SetInternalEnableMarkupProperty(BindableObject bindable, object oldValue, object newValue) @@ -800,7 +800,7 @@ internal static object GetInternalEnableMarkupProperty(BindableObject bindable) return Object.InternalGetPropertyBool(textField.SwigCPtr, TextField.Property.EnableMarkup); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputFontFamilyProperty = null; internal static void SetInternalInputFontFamilyProperty(BindableObject bindable, object oldValue, object newValue) @@ -819,7 +819,7 @@ internal static object GetInternalInputFontFamilyProperty(BindableObject bindabl return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.InputFontFamily); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputFontStyleProperty = null; internal static void SetInternalInputFontStyleProperty(BindableObject bindable, object oldValue, object newValue) @@ -838,7 +838,7 @@ internal static object GetInternalInputFontStyleProperty(BindableObject bindable return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputPointSizeProperty = null; internal static void SetInternalInputPointSizeProperty(BindableObject bindable, object oldValue, object newValue) @@ -857,7 +857,7 @@ internal static object GetInternalInputPointSizeProperty(BindableObject bindable return Object.InternalGetPropertyFloat(textField.SwigCPtr, TextField.Property.InputPointSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty UnderlineProperty = null; internal static void SetInternalUnderlineProperty(BindableObject bindable, object oldValue, object newValue) @@ -876,7 +876,7 @@ internal static object GetInternalUnderlineProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputUnderlineProperty = null; internal static void SetInternalInputUnderlineProperty(BindableObject bindable, object oldValue, object newValue) @@ -895,7 +895,7 @@ internal static object GetInternalInputUnderlineProperty(BindableObject bindable return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.InputUnderline); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ShadowProperty = null; internal static void SetInternalShadowProperty(BindableObject bindable, object oldValue, object newValue) @@ -914,7 +914,7 @@ internal static object GetInternalShadowProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputShadowProperty = null; internal static void SetInternalInputShadowProperty(BindableObject bindable, object oldValue, object newValue) @@ -933,7 +933,7 @@ internal static object GetInternalInputShadowProperty(BindableObject bindable) return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.InputShadow); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EmbossProperty = null; internal static void SetInternalEmbossProperty(BindableObject bindable, object oldValue, object newValue) @@ -952,7 +952,7 @@ internal static object GetInternalEmbossProperty(BindableObject bindable) return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.EMBOSS); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputEmbossProperty = null; internal static void SetInternalInputEmbossProperty(BindableObject bindable, object oldValue, object newValue) @@ -971,7 +971,7 @@ internal static object GetInternalInputEmbossProperty(BindableObject bindable) return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.InputEmboss); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty OutlineProperty = null; internal static void SetInternalOutlineProperty(BindableObject bindable, object oldValue, object newValue) @@ -990,7 +990,7 @@ internal static object GetInternalOutlineProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty InputOutlineProperty = null; internal static void SetInternalInputOutlineProperty(BindableObject bindable, object oldValue, object newValue) @@ -1009,7 +1009,7 @@ internal static object GetInternalInputOutlineProperty(BindableObject bindable) return Object.InternalGetPropertyString(textField.SwigCPtr, TextField.Property.InputOutline); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty HiddenInputSettingsProperty = null; internal static void SetInternalHiddenInputSettingsProperty(BindableObject bindable, object oldValue, object newValue) @@ -1028,7 +1028,7 @@ internal static object GetInternalHiddenInputSettingsProperty(BindableObject bin return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PixelSizeProperty = null; internal static void SetInternalPixelSizeProperty(BindableObject bindable, object oldValue, object newValue) @@ -1047,7 +1047,7 @@ internal static object GetInternalPixelSizeProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textField.SwigCPtr, TextField.Property.PixelSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableSelectionProperty = null; internal static void SetInternalEnableSelectionProperty(BindableObject bindable, object oldValue, object newValue) @@ -1066,7 +1066,7 @@ internal static object GetInternalEnableSelectionProperty(BindableObject bindabl return Object.InternalGetPropertyBool(textField.SwigCPtr, TextField.Property.EnableSelection); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PlaceholderProperty = null; internal static void SetInternalPlaceholderProperty(BindableObject bindable, object oldValue, object newValue) @@ -1085,7 +1085,7 @@ internal static object GetInternalPlaceholderProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EllipsisProperty = null; internal static void SetInternalEllipsisProperty(BindableObject bindable, object oldValue, object newValue) @@ -1123,7 +1123,7 @@ internal static object GetInternalEllipsisPositionProperty(BindableObject bindab return Object.InternalGetPropertyInt(textField.SwigCPtr, TextField.Property.EllipsisPosition); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableShiftSelectionProperty = null; internal static void SetInternalEnableShiftSelectionProperty(BindableObject bindable, object oldValue, object newValue) @@ -1142,7 +1142,7 @@ internal static object GetInternalEnableShiftSelectionProperty(BindableObject bi return Object.InternalGetPropertyBool(textField.SwigCPtr, TextField.Property.EnableShiftSelection); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty MatchSystemLanguageDirectionProperty = null; internal static void SetInternalMatchSystemLanguageDirectionProperty(BindableObject bindable, object oldValue, object newValue) diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextFieldEvent.cs b/src/Tizen.NUI/src/public/BaseComponents/TextFieldEvent.cs index 2999f1f8e83..54ad326ffbe 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextFieldEvent.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextFieldEvent.cs @@ -74,7 +74,7 @@ public partial class TextField private bool invokeTextChanged = true; /// - /// The TextChanged event. + /// The TextChanged event is triggered whenever the text in the TextField changes. /// /// 3 public event EventHandler TextChanged @@ -124,7 +124,7 @@ public event EventHandler CursorPositionChanged } /// - /// The MaxLengthReached event. + /// The MaxLengthReached event is triggered when the text entered in the TextField exceeds its maximum allowed length. /// /// 3 public event EventHandler MaxLengthReached @@ -429,7 +429,7 @@ public class TextChangedEventArgs : EventArgs private TextField textField; /// - /// TextField. + /// Gets or sets TextField. /// /// 3 public TextField TextField @@ -454,7 +454,7 @@ public class MaxLengthReachedEventArgs : EventArgs private TextField textField; /// - /// TextField. + /// Gets or sets TextField. /// /// 3 public TextField TextField diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs b/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs index 186470e773c..d1e033ecd49 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs @@ -256,7 +256,7 @@ public TextLabel() : this(Interop.TextLabel.New(ThemeManager.GetStyle(defaultSty if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public TextLabel(TextLabelStyle viewStyle) : this(Interop.TextLabel.New(ThemeManager.GetStyle(defaultStyleName) == null ? false : true), true, viewStyle) { @@ -266,7 +266,7 @@ public TextLabel(TextLabelStyle viewStyle) : this(Interop.TextLabel.New(ThemeMan /// Creates the TextLabel with setting the status of shown or hidden. /// /// false : Not displayed (hidden), true : displayed (shown) - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public TextLabel(bool shown) : this(Interop.TextLabel.New(ThemeManager.GetStyle(defaultStyleName) == null ? false : true), true) { @@ -290,7 +290,7 @@ public TextLabel(string text) : this(Interop.TextLabel.New(text, ThemeManager.Ge /// /// The text to display /// false : Not displayed (hidden), true : displayed (shown) - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public TextLabel(string text, bool shown) : this(Interop.TextLabel.New(text, ThemeManager.GetStyle(defaultStyleName) == null ? false : true), true) { @@ -1966,7 +1966,7 @@ public AutoScrollStopMode AutoScrollStopMode } /// - /// The line count of the text. + /// Gets the line count of the text. /// /// 3 public int LineCount @@ -2017,7 +2017,7 @@ public LineWrapMode LineWrapMode /// /// The direction of the text such as left to right or right to left. /// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public TextDirection TextDirection { @@ -2035,7 +2035,7 @@ public TextDirection TextDirection /// /// The vertical line alignment of the text. /// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public VerticalLineAlignment VerticalLineAlignment { @@ -2106,7 +2106,7 @@ public bool MatchSystemLanguageDirection /// fontSize (string)The size type of font, You can choose between "pointSize" or "pixelSize". (the default value is "pointSize") /// /// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1721: Property names should not match get methods")] public PropertyMap TextFit @@ -2295,7 +2295,7 @@ public TextFitArray GetTextFitArray() /// The height of the line in points.
/// If the font size is larger than the line size, it works with the font size.
/// - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public float MinLineSize { diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextLabelBindableProperty.cs b/src/Tizen.NUI/src/public/BaseComponents/TextLabelBindableProperty.cs index 7fa40904c24..1f34d22c221 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextLabelBindableProperty.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextLabelBindableProperty.cs @@ -53,7 +53,7 @@ internal static object GetInternalTranslatableTextProperty(BindableObject bindab return textLabel.translatableText; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty TextProperty = null; internal static void SetInternalTextProperty(BindableObject bindable, object oldValue, object newValue) @@ -78,7 +78,7 @@ internal static object GetInternalTextProperty(BindableObject bindable) return textLabel.textIsEmpty ? "" : Object.InternalGetPropertyString(textLabel.SwigCPtr, TextLabel.Property.TEXT); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty FontFamilyProperty = null; internal static void SetInternalFontFamilyProperty(BindableObject bindable, object oldValue, object newValue) @@ -101,7 +101,7 @@ internal static object GetInternalFontFamilyProperty(BindableObject bindable) return textLabel.InternalFontFamily; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty FontStyleProperty = null; internal static void SetInternalFontStyleProperty(BindableObject bindable, object oldValue, object newValue) @@ -121,7 +121,7 @@ internal static object GetInternalFontStyleProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PointSizeProperty = null; internal static void SetInternalPointSizeProperty(BindableObject bindable, object oldValue, object newValue) @@ -145,7 +145,7 @@ internal static object GetInternalPointSizeProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textLabel.SwigCPtr, TextLabel.Property.PointSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty MultiLineProperty = null; internal static void SetInternalMultiLineProperty(BindableObject bindable, object oldValue, object newValue) @@ -165,7 +165,7 @@ internal static object GetInternalMultiLineProperty(BindableObject bindable) return Object.InternalGetPropertyBool(textLabel.SwigCPtr, TextLabel.Property.MultiLine); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty HorizontalAlignmentProperty = null; internal static void SetInternalHorizontalAlignmentProperty(BindableObject bindable, object oldValue, object newValue) @@ -202,7 +202,7 @@ internal static object GetInternalHorizontalAlignmentProperty(BindableObject bin } } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty VerticalAlignmentProperty = null; internal static void SetInternalVerticalAlignmentProperty(BindableObject bindable, object oldValue, object newValue) @@ -239,7 +239,7 @@ internal static object GetInternalVerticalAlignmentProperty(BindableObject binda } } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty TextColorProperty = null; internal static void SetInternalTextColorProperty(BindableObject bindable, object oldValue, object newValue) @@ -352,7 +352,7 @@ internal static object GetInternalRemoveBackInsetProperty(BindableObject bindabl return Object.InternalGetPropertyBool(textLabel.SwigCPtr, TextLabel.Property.RemoveBackInset); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableMarkupProperty = null; internal static void SetInternalEnableMarkupProperty(BindableObject bindable, object oldValue, object newValue) @@ -371,7 +371,7 @@ internal static object GetInternalEnableMarkupProperty(BindableObject bindable) return Object.InternalGetPropertyBool(textLabel.SwigCPtr, TextLabel.Property.EnableMarkup); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EnableAutoScrollProperty = null; internal static void SetInternalEnableAutoScrollProperty(BindableObject bindable, object oldValue, object newValue) @@ -390,7 +390,7 @@ internal static object GetInternalEnableAutoScrollProperty(BindableObject bindab return Object.InternalGetPropertyBool(textLabel.SwigCPtr, TextLabel.Property.EnableAutoScroll); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty AutoScrollSpeedProperty = null; internal static void SetInternalAutoScrollSpeedProperty(BindableObject bindable, object oldValue, object newValue) @@ -409,7 +409,7 @@ internal static object GetInternalAutoScrollSpeedProperty(BindableObject bindabl return Object.InternalGetPropertyInt(textLabel.SwigCPtr, TextLabel.Property.AutoScrollSpeed); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty AutoScrollLoopCountProperty = null; internal static void SetInternalAutoScrollLoopCountProperty(BindableObject bindable, object oldValue, object newValue) @@ -428,7 +428,7 @@ internal static object GetInternalAutoScrollLoopCountProperty(BindableObject bin return Object.InternalGetPropertyInt(textLabel.SwigCPtr, TextLabel.Property.AutoScrollLoopCount); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty AutoScrollGapProperty = null; internal static void SetInternalAutoScrollGapProperty(BindableObject bindable, object oldValue, object newValue) @@ -447,7 +447,7 @@ internal static object GetInternalAutoScrollGapProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textLabel.SwigCPtr, TextLabel.Property.AutoScrollGap); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty LineSpacingProperty = null; internal static void SetInternalLineSpacingProperty(BindableObject bindable, object oldValue, object newValue) @@ -485,7 +485,7 @@ internal static object GetInternalRelativeLineHeightProperty(BindableObject bind return Object.InternalGetPropertyFloat(textLabel.SwigCPtr, TextLabel.Property.RelativeLineHeight); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty UnderlineProperty = null; internal static void SetInternalUnderlineProperty(BindableObject bindable, object oldValue, object newValue) @@ -504,7 +504,7 @@ internal static object GetInternalUnderlineProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty ShadowProperty = null; internal static void SetInternalShadowProperty(BindableObject bindable, object oldValue, object newValue) @@ -523,7 +523,7 @@ internal static object GetInternalShadowProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty TextShadowProperty = null; internal static void SetInternalTextShadowProperty(BindableObject bindable, object oldValue, object newValue) @@ -548,7 +548,7 @@ internal static object GetInternalTextShadowProperty(BindableObject bindable) return temp.Empty() ? null : new TextShadow(temp); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EmbossProperty = null; internal static void SetInternalEmbossProperty(BindableObject bindable, object oldValue, object newValue) @@ -567,7 +567,7 @@ internal static object GetInternalEmbossProperty(BindableObject bindable) return Object.InternalGetPropertyString(textLabel.SwigCPtr, TextLabel.Property.EMBOSS); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty OutlineProperty = null; internal static void SetInternalOutlineProperty(BindableObject bindable, object oldValue, object newValue) @@ -586,7 +586,7 @@ internal static object GetInternalOutlineProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty PixelSizeProperty = null; internal static void SetInternalPixelSizeProperty(BindableObject bindable, object oldValue, object newValue) @@ -610,7 +610,7 @@ internal static object GetInternalPixelSizeProperty(BindableObject bindable) return Object.InternalGetPropertyFloat(textLabel.SwigCPtr, TextLabel.Property.PixelSize); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty EllipsisProperty = null; internal static void SetInternalEllipsisProperty(BindableObject bindable, object oldValue, object newValue) @@ -648,7 +648,7 @@ internal static object GetInternalEllipsisPositionProperty(BindableObject bindab return (EllipsisPosition)Object.InternalGetPropertyInt(textLabel.SwigCPtr, TextLabel.Property.EllipsisPosition); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty AutoScrollLoopDelayProperty = null; internal static void SetInternalAutoScrollLoopDelayProperty(BindableObject bindable, object oldValue, object newValue) @@ -667,7 +667,7 @@ internal static object GetInternalAutoScrollLoopDelayProperty(BindableObject bin return Object.InternalGetPropertyFloat(textLabel.SwigCPtr, TextLabel.Property.AutoScrollLoopDelay); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty AutoScrollStopModeProperty = null; internal static void SetInternalAutoScrollStopModeProperty(BindableObject bindable, object oldValue, object newValue) @@ -688,7 +688,7 @@ internal static object GetInternalAutoScrollStopModeProperty(BindableObject bind return temp.GetValueByDescription(); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty LineWrapModeProperty = null; internal static void SetInternalLineWrapModeProperty(BindableObject bindable, object oldValue, object newValue) @@ -707,7 +707,7 @@ internal static object GetInternalLineWrapModeProperty(BindableObject bindable) return (LineWrapMode)Object.InternalGetPropertyInt(textLabel.SwigCPtr, TextLabel.Property.LineWrapMode); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty VerticalLineAlignmentProperty = null; internal static void SetInternalVerticalLineAlignmentProperty(BindableObject bindable, object oldValue, object newValue) @@ -726,7 +726,7 @@ internal static object GetInternalVerticalLineAlignmentProperty(BindableObject b return (VerticalLineAlignment)Object.InternalGetPropertyInt(textLabel.SwigCPtr, TextLabel.Property.VerticalLineAlignment); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty MatchSystemLanguageDirectionProperty = null; internal static void SetInternalMatchSystemLanguageDirectionProperty(BindableObject bindable, object oldValue, object newValue) diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextMapHelper.cs b/src/Tizen.NUI/src/public/BaseComponents/TextMapHelper.cs index cf0454940f1..7683ab462d4 100644 --- a/src/Tizen.NUI/src/public/BaseComponents/TextMapHelper.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextMapHelper.cs @@ -384,6 +384,12 @@ public static PropertyMap GetOutlineMap(Outline outline) if (outline.Width != null) map.Add("width", (float)outline.Width); + if (outline.Offset != null) + map.Add("offset", outline.Offset); + + if (outline.BlurRadius != null) + map.Add("blurRadius", (float)outline.BlurRadius); + return map; } @@ -401,6 +407,8 @@ public static Outline GetOutlineStruct(PropertyMap map) { outline.Color = GetColorFromMap(map, "color"); outline.Width = GetFloatFromMap(map, "width", 0.0f); + outline.Offset = GetVector2FromMap(map, "offset"); + outline.BlurRadius = GetFloatFromMap(map, "blurRadius", 0.0f); } return outline; diff --git a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/ColorStop.cs b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/ColorStop.cs index 7dfb793d867..11d0ff592b5 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/ColorStop.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/ColorStop.cs @@ -29,8 +29,10 @@ public class ColorStop private Color color; //The color value. /// - /// Initialize ColorStop. + /// Initializes a new instance of the ColorStop class with the specified offset and color. /// + /// The offset at which the color stop applies. + /// The color to apply at the specified offset. /// 9 public ColorStop(float offset, Color color) { @@ -39,7 +41,7 @@ public ColorStop(float offset, Color color) } /// - /// The relative position of the color. + /// Gets or sets the relative position of the color stop along the gradient line. /// /// 9 public float Offset @@ -55,7 +57,7 @@ public float Offset } /// - /// The color value. + /// Gets or sets the color value of the gradient stop. /// /// 9 public Color Color diff --git a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/PathCommands.cs b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/PathCommands.cs index 8ac8df3bd60..4e0f98e0d63 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/PathCommands.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/PathCommands.cs @@ -54,6 +54,7 @@ public PathCommands(IEnumerable commands, IEnumerable po /// /// The commands array. + /// This property returns an enumerable collection of PathCommandType representing the path commands. /// /// Thrown when commands is null. /// 9 @@ -75,6 +76,7 @@ public IEnumerable Commands /// /// The points array + /// This returns an enumerable collection of floating-point numbers representing the points. /// /// Thrown when points is null. /// 9 diff --git a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Picture.cs b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Picture.cs index 90735a3a500..09260325371 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Picture.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Picture.cs @@ -29,6 +29,7 @@ public class Picture : Drawable { /// /// Creates an initialized Picture. + /// This constructor initializes a new instance of the Picture class. /// /// 9 public Picture() : this(Interop.Picture.New(), true) diff --git a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Shape.cs b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Shape.cs index 56f9941621a..0a28f205d97 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Shape.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/VectorGraphics/Shape.cs @@ -35,6 +35,7 @@ public class Shape : Drawable /// /// Creates an initialized Shape. + /// This constructor initializes a new instance of the Shape class. /// /// 9 public Shape() : this(Interop.Shape.New(), true) @@ -100,7 +101,8 @@ public Gradient FillGradient } /// - /// The current fill rule of the shape. + /// Gets or sets the fill rule type for the shape. + /// The fill rule type which determines how the interior of a shape is determined. /// /// 9 public FillRuleType FillRule diff --git a/src/Tizen.NUI/src/public/BaseComponents/VideoView.cs b/src/Tizen.NUI/src/public/BaseComponents/VideoView.cs index 3546a45c144..42534a02006 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/VideoView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/VideoView.cs @@ -27,7 +27,7 @@ namespace Tizen.NUI.BaseComponents /// 3 public class VideoView : View { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty VideoProperty = null; internal static void SetInternalVideoProperty(BindableObject bindable, object oldValue, object newValue) @@ -46,7 +46,7 @@ internal static object GetInternalVideoProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty LoopingProperty = null; internal static void SetInternalLoopingProperty(BindableObject bindable, object oldValue, object newValue) @@ -65,7 +65,7 @@ internal static object GetInternalLoopingProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty MutedProperty = null; internal static void SetInternalMutedProperty(BindableObject bindable, object oldValue, object newValue) @@ -84,7 +84,7 @@ internal static object GetInternalMutedProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty VolumeProperty = null; internal static void SetInternalVolumeProperty(BindableObject bindable, object oldValue, object newValue) @@ -103,7 +103,7 @@ internal static object GetInternalVolumeProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty UnderlayProperty = null; internal static void SetInternalUnderlayProperty(BindableObject bindable, object oldValue, object newValue) @@ -122,7 +122,7 @@ internal static object GetInternalUnderlayProperty(BindableObject bindable) return temp; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static BindableProperty ResourceUrlProperty = null; internal static void SetInternalResourceUrlProperty(BindableObject bindable, object oldValue, object newValue) @@ -533,8 +533,12 @@ internal VideoViewSignal FinishedSignal() /// /// Dispose. + /// Releases unmanaged and optionally managed resources. /// - /// DisposeTypes + /// + /// When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources. + /// + /// Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources. /// 3 protected override void Dispose(DisposeTypes type) { diff --git a/src/Tizen.NUI/src/public/BaseComponents/View.cs b/src/Tizen.NUI/src/public/BaseComponents/View.cs index d0fa08a5587..91b7a75cbb7 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/View.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/View.cs @@ -493,6 +493,7 @@ private static IntPtr NewWithAccessibilityMode(ViewAccessibilityMode accessibili /// /// Creates a new instance of a view. + /// The default constructor for the View class. /// /// 3 public View() : this(ViewAccessibilityMode.Default) @@ -505,7 +506,7 @@ public View(ViewAccessibilityMode accessibilityMode) : this(NewWithAccessibility if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public View(ViewStyle viewStyle) : this(Interop.View.New(), true, viewStyle) { @@ -515,7 +516,7 @@ public View(ViewStyle viewStyle) : this(Interop.View.New(), true, viewStyle) /// Create a new instance of a View with setting the status of shown or hidden. /// /// false : Not displayed (hidden), true : displayed (shown) - /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). + /// This will be public opened after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI). [EditorBrowsable(EditorBrowsableState.Never)] public View(bool shown) : this(Interop.View.New(), true) { @@ -571,7 +572,7 @@ internal View(ViewImpl implementation, bool shown = true) : this(Interop.View.Ne /// /// Flag to indicate if layout set explicitly via API call or View was automatically given a Layout. /// - /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool LayoutSet { @@ -586,7 +587,7 @@ public bool LayoutSet /// Once a View has a Layout set then any children added to Views from then on will receive /// automatic Layouts. /// - /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static bool LayoutingDisabled { get; set; } = true; @@ -638,7 +639,7 @@ protected ViewStyle ViewStyle /// please set to true. /// /// Thrown when set null. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public ControlState ControlState { @@ -766,7 +767,7 @@ protected set /// /// Gets / Sets the status of whether the view is excluded from its parent's layouting or not. /// - /// This will be public opened later after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool ExcludeLayouting { @@ -980,7 +981,7 @@ public string BackgroundImage /// /// Get or set the border of background image. /// - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Rectangle BackgroundImageBorder { @@ -1010,7 +1011,8 @@ public Rectangle BackgroundImageBorder } /// - /// The background of view. + /// Gets or sets the background of the view. + /// This property value is the PropertyMap representing the background. /// /// 3 public Tizen.NUI.PropertyMap Background @@ -1398,7 +1400,7 @@ internal float GetInternalBorderlineOffset() } /// - /// The current state of the view. + /// Gets or sets the current state of the view. /// /// 3 public States State @@ -1488,6 +1490,7 @@ internal States GetInternalSubState() /// /// Displays a tooltip + /// This property allows setting the tooltip properties such as text. /// /// 3 public Tizen.NUI.PropertyMap Tooltip @@ -3492,8 +3495,7 @@ public string Name } /// - /// Gets the view's ID. - /// Read-only + /// Gets The unique identifier of the view. (Read-only) /// /// 3 public uint ID @@ -3999,7 +4001,7 @@ internal SizeScalePolicyType GetInternalSizeScalePolicy() } /// - /// Gets or sets the status of whether the width size is dependent on the height size. + /// Gets or sets the status of whether the width size is dependent on the height size. /// /// 3 public bool WidthForHeight @@ -5219,7 +5221,7 @@ public float Weight /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously. /// Note: For Normal Quad images only. /// - /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool BackgroundImageSynchronosLoading { @@ -5274,7 +5276,7 @@ private bool InternalBackgroundImageSynchronosLoading /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously. /// Note: For Normal Quad images only. /// - /// This will be public opened in tizen_7.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool BackgroundImageSynchronousLoading { @@ -5336,7 +5338,7 @@ private bool InternalBackgroundImageSynchronousLoading } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Vector4 UpdateAreaHint { @@ -5638,7 +5640,7 @@ private bool InternalAllowOnlyOwnTouch /// Determines which blend equation will be used to render renderers of this actor. /// /// blend equation enum currently assigned - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BlendEquationType BlendEquation { diff --git a/src/Tizen.NUI/src/public/BaseComponents/ViewPublicMethods.cs b/src/Tizen.NUI/src/public/BaseComponents/ViewPublicMethods.cs index 954bb1a47b7..aa9392309cd 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/ViewPublicMethods.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/ViewPublicMethods.cs @@ -303,6 +303,7 @@ public string GetStyleName() /// /// Clears the background. + /// This method removes any background properties set on the view, such as color or image. /// /// 3 public void ClearBackground() @@ -437,6 +438,7 @@ public void LowerToBottom() /// /// Most resources are only loaded when the control is placed on the stage. /// + /// True if all resources are ready, otherwise false. /// 3 public bool IsResourceReady() { @@ -623,6 +625,11 @@ public void GetPadding(PaddingType paddingOut) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Adds a renderer to the view. + /// + /// The renderer to add. + /// The index of the Renderer that was added to the view. /// 3 public uint AddRenderer(Renderer renderer) { @@ -632,6 +639,14 @@ public uint AddRenderer(Renderer renderer) return ret; } + /// + /// Retrieves the renderer at the specified index. + /// + /// The index of the renderer to retrieve. + /// A Renderer object at the specified index. + /// + /// The index must be between 0 and GetRendererCount()-1 + /// /// 3 public Renderer GetRendererAt(uint index) { @@ -649,6 +664,10 @@ public Renderer GetRendererAt(uint index) return ret; } + /// + /// Removes the specified renderer from the view. + /// + /// The renderer to remove. /// 3 public void RemoveRenderer(Renderer renderer) { @@ -657,6 +676,10 @@ public void RemoveRenderer(Renderer renderer) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + /// + /// Removes a renderer at the specified index from the view. + /// + /// The index of the renderer to remove. /// 3 public void RemoveRenderer(uint index) { @@ -665,7 +688,7 @@ public void RemoveRenderer(uint index) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void RotateBy(Degree angle, Vector3 axis) { @@ -674,7 +697,7 @@ public void RotateBy(Degree angle, Vector3 axis) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void RotateBy(Radian angle, Vector3 axis) { @@ -683,7 +706,7 @@ public void RotateBy(Radian angle, Vector3 axis) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void RotateBy(Rotation relativeRotation) { @@ -692,7 +715,7 @@ public void RotateBy(Rotation relativeRotation) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void ScaleBy(Vector3 relativeScale) { @@ -710,7 +733,7 @@ public void ScaleBy(Vector3 relativeScale) /// The up vector after target look at. If it is null, up vector become +Y axis /// The forward vector of view when it's orientation is not applied. If it is null, localForward vector become +Z axis /// The up vector of view when it's orientation is not applied. If it is null, localUp vector become +Y axis - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void LookAt(Vector3 target, Vector3 up = null, Vector3 localForward = null, Vector3 localUp = null) { @@ -719,7 +742,7 @@ public void LookAt(Vector3 target, Vector3 up = null, Vector3 localForward = nul throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void SetColorMode(ColorMode colorMode) { @@ -728,7 +751,7 @@ public void SetColorMode(ColorMode colorMode) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void ObjectDump() { diff --git a/src/Tizen.NUI/src/public/BaseComponents/VisualView.cs b/src/Tizen.NUI/src/public/BaseComponents/VisualView.cs index 7657a9a0b52..41f6813a5f8 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/VisualView.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/VisualView.cs @@ -49,13 +49,14 @@ public class VisualView : CustomView /// /// Constructor. + /// This constructor initializes the VisualView with default behavior and support for touch events. /// /// 3 public VisualView() : this(CustomViewBehaviour.ViewBehaviourDefault | CustomViewBehaviour.RequiresTouchEventsSupport) { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public VisualView(ViewStyle viewStyle) : this(CustomViewBehaviour.ViewBehaviourDefault | CustomViewBehaviour.RequiresTouchEventsSupport, viewStyle) { @@ -99,6 +100,7 @@ public int NumberOfVisuals /// /// Overrides the parent method. + /// This method is called by the framework when the instance is created. /// /// 3 public override void OnInitialize() @@ -187,7 +189,7 @@ public void RemoveVisual(string visualName) } /// - /// Removes all visuals of the visual view. + /// This method removes all visuals associated with the VisualView instance. /// /// 3 public void RemoveAll() @@ -410,7 +412,7 @@ public Animation AnimateVisualAddFinish() } /// - /// temporary fix to pass TCT. + /// Applies an animation to the specified visual map properties. /// /// Thrown when visualMap is null. /// 3 diff --git a/src/Tizen.NUI/src/public/Clipboard/Clipboard.cs b/src/Tizen.NUI/src/public/Clipboard/Clipboard.cs index 913c3db4dfe..ddb1b7e38d0 100755 --- a/src/Tizen.NUI/src/public/Clipboard/Clipboard.cs +++ b/src/Tizen.NUI/src/public/Clipboard/Clipboard.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI { /// - /// Clipboard. + /// This class provides methods to interact with the system clipboard, allowing users to get and set clipboard content. /// [EditorBrowsable(EditorBrowsableState.Never)] public partial class Clipboard : BaseHandle @@ -195,7 +195,13 @@ private void OnClipboardDataReceived(object sender, ClipboardEventArgs e) /// /// Dispose. + /// Releases unmanaged and optionally managed resources. /// + /// + /// When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources. + /// + /// Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources. + [EditorBrowsable(EditorBrowsableState.Never)] protected override void Dispose(DisposeTypes type) { if (disposed) diff --git a/src/Tizen.NUI/src/public/Common/BaseHandle.cs b/src/Tizen.NUI/src/public/Common/BaseHandle.cs index 9ffb8568d16..b724019f8bc 100755 --- a/src/Tizen.NUI/src/public/Common/BaseHandle.cs +++ b/src/Tizen.NUI/src/public/Common/BaseHandle.cs @@ -156,7 +156,8 @@ internal BaseHandle(global::System.IntPtr cPtr) } /// - /// Dispose. + /// Finalizes the instance of the BaseHandle class. + /// This method implements the finalization pattern for proper disposal of resources. /// /// 3 // following this guide: https://docs.microsoft.com/ko-kr/dotnet/fundamentals/code-analysis/quality-rules/ca1063?view=vs-2019 (CA1063) @@ -225,6 +226,9 @@ public static explicit operator bool(BaseHandle handle) /// /// Equality operator /// + /// The first BaseHandle instance to compare. + /// The second BaseHandle instance to compare. + /// true if both instances are equal; otherwise false. /// 3 public static bool operator ==(BaseHandle x, BaseHandle y) { @@ -254,8 +258,11 @@ public static explicit operator bool(BaseHandle handle) } /// - /// Inequality operator. Returns Null if either operand is Null + /// Inequality operator. Returns true if the operands are not equal, false otherwise. Returns true if either operand is null. /// + /// The first BaseHandle instance to compare. + /// The second BaseHandle instance to compare. + /// True if the operands are not equal, false otherwise. Returns true if either operand is null. /// 3 public static bool operator !=(BaseHandle x, BaseHandle y) { @@ -263,9 +270,12 @@ public static explicit operator bool(BaseHandle handle) } /// - /// Logical AND operator.
- /// It's possible when doing a operator this function (opBitwiseAnd) is never called due to short circuiting.
+ /// Logical AND operator. + /// It's possible when doing a logical AND operation, this function (opBitwiseAnd) might never be called due to short circuiting. /// + /// The first BaseHandle instance. + /// The second BaseHandle instance. + /// Returns the first BaseHandle instance if both instances are equal; otherwise, returns null. /// 3 public static BaseHandle operator &(BaseHandle x, BaseHandle y) { @@ -277,9 +287,12 @@ public static explicit operator bool(BaseHandle handle) } /// - /// Logical OR operator for ||.
- /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.
+ /// Logical OR operator for ||. + /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting. /// + /// The first BaseHandle to be compared. + /// The second BaseHandle to be compared. + /// A BaseHandle that contains either of the non-null bodies of the two operands. /// 3 public static BaseHandle operator |(BaseHandle x, BaseHandle y) { @@ -299,8 +312,10 @@ public static explicit operator bool(BaseHandle handle) } /// - /// Logical ! operator + /// Logical ! operator for BaseHandle class. /// + /// The BaseHandle instance to check. + /// True if the handle is null or has no body; otherwise, false. /// 3 public static bool operator !(BaseHandle x) { @@ -317,10 +332,10 @@ public static explicit operator bool(BaseHandle handle) } /// - /// Equals + /// Compares the current instance with another object of the same type and returns true if they represent the same handle. /// - /// The object should be compared. - /// True if equal. + /// The object to compare with the current instance. + /// true if the specified object is equal to the current object; otherwise, false. /// 5 public override bool Equals(object o) { @@ -361,12 +376,13 @@ public void Dispose() /// /// Hidden API (Inhouse API). /// Dispose. + /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// /// /// Following the guide of https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose. /// This will replace "protected virtual void Dispose(DisposeTypes type)" which is exactly same in functionality. /// - /// true in order to free managed objects + /// If true, disposes any disposable objects. If false, does not dispose disposable objects. // Protected implementation of Dispose pattern. [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void Dispose(bool disposing) @@ -570,7 +586,12 @@ internal void UnregisterFromRegistry() /// /// Dispose. + /// Releases unmanaged and optionally managed resources. /// + /// + /// When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources. + /// + /// Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources. /// 3 protected virtual void Dispose(DisposeTypes type) { diff --git a/src/Tizen.NUI/src/public/Common/Color.cs b/src/Tizen.NUI/src/public/Common/Color.cs index 8e09d8ca7c7..dc843bb7118 100755 --- a/src/Tizen.NUI/src/public/Common/Color.cs +++ b/src/Tizen.NUI/src/public/Common/Color.cs @@ -24,6 +24,8 @@ namespace Tizen.NUI { /// /// The Color class. + /// This class represents a color using red, green, blue, and alpha components. + /// It provides methods to create and manipulate colors. /// [Tizen.NUI.Binding.TypeConverter(typeof(ColorTypeConverter))] public class Color : Disposable, ICloneable diff --git a/src/Tizen.NUI/src/public/Common/Container.cs b/src/Tizen.NUI/src/public/Common/Container.cs index fa07385377d..1cd6b835206 100755 --- a/src/Tizen.NUI/src/public/Common/Container.cs +++ b/src/Tizen.NUI/src/public/Common/Container.cs @@ -142,7 +142,7 @@ internal MergedStyle MergedStyle } /// - /// List of children of Container. + /// Gets the list of children of Container. /// /// 4 public List Children diff --git a/src/Tizen.NUI/src/public/Common/Degree.cs b/src/Tizen.NUI/src/public/Common/Degree.cs index 85e1c37a408..b91d2558c17 100755 --- a/src/Tizen.NUI/src/public/Common/Degree.cs +++ b/src/Tizen.NUI/src/public/Common/Degree.cs @@ -28,7 +28,7 @@ public class Degree : Disposable { /// - /// The constructor. + /// Default constructor of Degree class. /// /// 3 public Degree() : this(Interop.Degree.NewDegree(), true) @@ -61,7 +61,8 @@ internal Degree(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemor } /// - /// The value of degree. + /// Gets or sets the value of the degree. + /// This property value is the angle in degrees. /// /// 3 public float Value diff --git a/src/Tizen.NUI/src/public/Common/Extents.cs b/src/Tizen.NUI/src/public/Common/Extents.cs index 1c1e9cea4cd..8515e04f6c0 100755 --- a/src/Tizen.NUI/src/public/Common/Extents.cs +++ b/src/Tizen.NUI/src/public/Common/Extents.cs @@ -31,7 +31,7 @@ public class Extents : Disposable, ICloneable /// - /// Constructor. + /// Default constructor of Extents class. /// /// 4 public Extents() : this(Interop.Extents.NewExtents(), true) @@ -62,10 +62,10 @@ public static implicit operator Extents(ushort value) /// /// Constructor. - /// Start extent. - /// End extent. - /// Top extent. - /// Bottom extent. + /// The start extent value horizontally. + /// The end extent value horizontally. + /// The top extent value vertically. + /// The bottom extent value vertically. /// /// 4 public Extents(ushort start, ushort end, ushort top, ushort bottom) : this(Interop.Extents.NewExtents(start, end, top, bottom), true) @@ -81,10 +81,10 @@ internal Extents(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemo /// Constructor /// /// - /// - /// - /// - /// + /// The start extent value horizontally. + /// The end extent value horizontally. + /// The top extent value vertically. + /// The bottom extent value vertically. /// Only used by Tizen.NUI.Components, will not be opened [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] public Extents(ExtentsChangedCallback cb, ushort start, ushort end, ushort top, ushort bottom) : this(Interop.Extents.NewExtents(start, end, top, bottom), true) @@ -115,10 +115,10 @@ public void CopyFrom(Extents that) /// /// Constructor /// - /// - /// - /// - /// + /// The start extent value horizontally. + /// The end extent value horizontally. + /// The top extent value vertically. + /// The bottom extent value vertically. /// Only used by Tizen.NUI.Components, will not be opened [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] public delegate void ExtentsChangedCallback(ushort start, ushort end, ushort top, ushort bottom); diff --git a/src/Tizen.NUI/src/public/Common/FrameUpdateCallbackInterface.cs b/src/Tizen.NUI/src/public/Common/FrameUpdateCallbackInterface.cs index 2a429715376..6f8de7ff9e7 100755 --- a/src/Tizen.NUI/src/public/Common/FrameUpdateCallbackInterface.cs +++ b/src/Tizen.NUI/src/public/Common/FrameUpdateCallbackInterface.cs @@ -21,26 +21,26 @@ namespace Tizen.NUI { - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class FrameUpdateCallbackInterface : Disposable { private uint onUpdateCallbackVersion = 0u; - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] internal FrameUpdateCallbackInterface(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public FrameUpdateCallbackInterface() : this(0u) { } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public FrameUpdateCallbackInterface(uint updateCallbackVersion) : this(Interop.FrameUpdateCallbackInterface.newFrameUpdateCallbackInterface(), true) { @@ -57,7 +57,7 @@ protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef NDalicPINVOKE.ThrowExceptionIfExists(); } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public uint UpdateCallbackVersion => onUpdateCallbackVersion; @@ -90,13 +90,13 @@ private bool DirectorOnUpdate(global::System.IntPtr proxy, float elapsedSeconds) internal delegate bool DelegateFrameUpdateCallbackInterfaceV1(global::System.IntPtr proxy, float elapsedSeconds); private DelegateFrameUpdateCallbackInterfaceV1 Delegate1; - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public virtual void OnUpdate(float elapsedSeconds) { } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public virtual bool OnUpdate(FrameUpdateCallbackInterface obj, float elapsedSeconds) { @@ -105,7 +105,7 @@ public virtual bool OnUpdate(FrameUpdateCallbackInterface obj, float elapsedSeco return false; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetPosition(uint id, Vector3 position) { @@ -118,7 +118,7 @@ protected bool GetPosition(uint id, Vector3 position) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool SetPosition(uint id, Vector3 position) { @@ -131,7 +131,7 @@ protected bool SetPosition(uint id, Vector3 position) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool BakePosition(uint id, Vector3 position) { @@ -144,7 +144,7 @@ protected bool BakePosition(uint id, Vector3 position) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetOrientation(uint id, Rotation rotation) { @@ -157,7 +157,7 @@ protected bool GetOrientation(uint id, Rotation rotation) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool SetOrientation(uint id, Rotation rotation) { @@ -170,7 +170,7 @@ protected bool SetOrientation(uint id, Rotation rotation) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool BakeOrientation(uint id, Rotation rotation) { @@ -183,7 +183,7 @@ protected bool BakeOrientation(uint id, Rotation rotation) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetSize(uint id, Vector3 size) { @@ -196,7 +196,7 @@ protected bool GetSize(uint id, Vector3 size) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool SetSize(uint id, Vector3 size) { @@ -209,7 +209,7 @@ protected bool SetSize(uint id, Vector3 size) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool BakeSize(uint id, Vector3 size) { @@ -222,7 +222,7 @@ protected bool BakeSize(uint id, Vector3 size) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetScale(uint id, Vector3 scale) { @@ -235,7 +235,7 @@ protected bool GetScale(uint id, Vector3 scale) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool SetScale(uint id, Vector3 scale) { @@ -248,7 +248,7 @@ protected bool SetScale(uint id, Vector3 scale) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool BakeScale(uint id, Vector3 scale) { @@ -261,7 +261,7 @@ protected bool BakeScale(uint id, Vector3 scale) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetColor(uint id, Vector4 color) { @@ -274,7 +274,7 @@ protected bool GetColor(uint id, Vector4 color) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool SetColor(uint id, Vector4 color) { @@ -287,7 +287,7 @@ protected bool SetColor(uint id, Vector4 color) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool BakeColor(uint id, Vector4 color) { @@ -300,7 +300,7 @@ protected bool BakeColor(uint id, Vector4 color) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetPositionAndSize(uint id, Vector3 Position, Vector3 Size) { @@ -313,7 +313,7 @@ protected bool GetPositionAndSize(uint id, Vector3 Position, Vector3 Size) return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetWorldPositionScaleAndSize(uint id, Vector3 Position, Vector3 Scale, Vector3 Size) { @@ -326,7 +326,7 @@ protected bool GetWorldPositionScaleAndSize(uint id, Vector3 Position, Vector3 S return ret; } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected bool GetWorldTransformAndSize(uint id, Vector3 Position, Vector3 Scale, Rotation Orientation, Vector3 Size) { diff --git a/src/Tizen.NUI/src/public/Common/Layer.cs b/src/Tizen.NUI/src/public/Common/Layer.cs index 51e1374bfc9..00771c934d0 100755 --- a/src/Tizen.NUI/src/public/Common/Layer.cs +++ b/src/Tizen.NUI/src/public/Common/Layer.cs @@ -43,7 +43,7 @@ public class Layer : Container private delegate void AggregatedVisibilityChangedEventCallbackType(IntPtr data, bool visibility); /// - /// Creates a Layer object. + /// Default constructor of Layer class to create a Layer object. /// /// 3 public Layer() : this(Interop.Layer.New(), true) @@ -58,8 +58,13 @@ internal Layer(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemory } /// - /// Dispose Explicit or Implicit + /// Dispose. + /// Releases unmanaged and optionally managed resources. /// + /// + /// When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources. + /// + /// Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources. [EditorBrowsable(EditorBrowsableState.Never)] protected override void Dispose(DisposeTypes type) { @@ -572,7 +577,7 @@ public void MoveBelow(Layer target) LowerBelow(target); } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void SetAnchorPoint(Vector3 anchorPoint) { @@ -581,7 +586,7 @@ public void SetAnchorPoint(Vector3 anchorPoint) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void SetSize(float width, float height) { @@ -590,7 +595,7 @@ public void SetSize(float width, float height) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void SetParentOrigin(Vector3 parentOrigin) { @@ -599,7 +604,7 @@ public void SetParentOrigin(Vector3 parentOrigin) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void SetResizePolicy(ResizePolicyType policy, DimensionType dimension) { diff --git a/src/Tizen.NUI/src/public/Common/NUIConstants.cs b/src/Tizen.NUI/src/public/Common/NUIConstants.cs index afbae4b2723..c32a9c5dbeb 100755 --- a/src/Tizen.NUI/src/public/Common/NUIConstants.cs +++ b/src/Tizen.NUI/src/public/Common/NUIConstants.cs @@ -2312,5 +2312,11 @@ public enum WindowBlurType /// [EditorBrowsable(EditorBrowsableState.Never)] Background = 1, + /// + /// behind blur for the window. + /// It has a blur effect ot th beind area of except the window background. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + Behind = 2, } } diff --git a/src/Tizen.NUI/src/public/Common/PropertyArray.cs b/src/Tizen.NUI/src/public/Common/PropertyArray.cs index f4d5f35e27b..b499d38e97b 100755 --- a/src/Tizen.NUI/src/public/Common/PropertyArray.cs +++ b/src/Tizen.NUI/src/public/Common/PropertyArray.cs @@ -25,7 +25,7 @@ namespace Tizen.NUI public class PropertyArray : Disposable { /// - /// The constructor. + /// Default constructor of PropertyArray class. /// /// 3 public PropertyArray() : this(Interop.Property.NewPropertyArray(), true) @@ -94,6 +94,7 @@ public bool Empty() /// /// Clears the array. + /// This method removes all elements from the PropertyArray, resulting in an empty array. /// /// 3 public void Clear() diff --git a/src/Tizen.NUI/src/public/Common/PropertyKey.cs b/src/Tizen.NUI/src/public/Common/PropertyKey.cs index 0779b75235e..5e5277cdd5b 100755 --- a/src/Tizen.NUI/src/public/Common/PropertyKey.cs +++ b/src/Tizen.NUI/src/public/Common/PropertyKey.cs @@ -51,7 +51,7 @@ internal PropertyKey(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, c } /// - /// The type of key. + /// Represents the type of key used in property-related operations. /// /// 3 /// Can't fix because it's already used by other GBM. @@ -72,6 +72,7 @@ public enum KeyType /// /// The type of the key. + /// This property returns the type of the key, which can be PropertyMap, PropertyArray, or PropertyValue. /// /// 3 public PropertyKey.KeyType Type @@ -90,7 +91,8 @@ public PropertyKey.KeyType Type } /// - /// The index key. + /// Gets the index key. + /// The integer value representing the index key. /// /// 3 public int IndexKey @@ -109,7 +111,7 @@ public int IndexKey } /// - /// The string key. + /// Returns the string key. /// /// 3 public string StringKey diff --git a/src/Tizen.NUI/src/public/Common/PropertyMap.cs b/src/Tizen.NUI/src/public/Common/PropertyMap.cs index b37e30b483d..bd96e0ddd7f 100755 --- a/src/Tizen.NUI/src/public/Common/PropertyMap.cs +++ b/src/Tizen.NUI/src/public/Common/PropertyMap.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI public class PropertyMap : Disposable { /// - /// The constructor. + /// Default constructor of PropertyMap class. /// /// 3 public PropertyMap() : this(Interop.PropertyMap.NewPropertyMap(), true) @@ -363,6 +363,7 @@ public PropertyValue Find(int indexKey, string stringKey) /// /// Clears the map. + /// This method removes all key-value pairs from the PropertyMap. /// /// 3 public void Clear() diff --git a/src/Tizen.NUI/src/public/Common/PropertyValue.cs b/src/Tizen.NUI/src/public/Common/PropertyValue.cs index 267f86172dc..6f1199322ad 100755 --- a/src/Tizen.NUI/src/public/Common/PropertyValue.cs +++ b/src/Tizen.NUI/src/public/Common/PropertyValue.cs @@ -68,7 +68,7 @@ public PropertyValue(Color vectorValue) : this(Interop.PropertyValue.NewProperty } /// - /// The default constructor. + /// The default constructor of PropertyValue class. /// /// 3 public PropertyValue() : this(Interop.PropertyValue.NewPropertyValue(), true) diff --git a/src/Tizen.NUI/src/public/Common/Radian.cs b/src/Tizen.NUI/src/public/Common/Radian.cs index a4a14b39796..e4e38ca6c4c 100755 --- a/src/Tizen.NUI/src/public/Common/Radian.cs +++ b/src/Tizen.NUI/src/public/Common/Radian.cs @@ -20,7 +20,7 @@ namespace Tizen.NUI { /// - /// An angle in radians. + /// This class represents an angle in radians. /// /// 3 public class Radian : Disposable @@ -61,6 +61,7 @@ internal Radian(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemor /// /// The value in radians. + /// The float value representing the angle in radians. /// /// 3 public float Value diff --git a/src/Tizen.NUI/src/public/Common/Rectangle.cs b/src/Tizen.NUI/src/public/Common/Rectangle.cs index 77caf5a2bd4..ef7ef81b621 100755 --- a/src/Tizen.NUI/src/public/Common/Rectangle.cs +++ b/src/Tizen.NUI/src/public/Common/Rectangle.cs @@ -22,13 +22,15 @@ namespace Tizen.NUI { /// /// The Rectangle class. + /// This class is used to define and manipulate rectangular areas in graphics or UI components. + /// It manages the position (x, y coordinates) and size (width, height) of the rectangle, and provides various methods to set or inspect the properties of the rectangle. /// /// 3 [Binding.TypeConverter(typeof(RectangleTypeConverter))] public class Rectangle : Disposable, ICloneable { /// - /// The constructor. + /// The default constructor of Rectangle class. /// /// 3 public Rectangle() : this(Interop.Rectangle.NewRectangle(), true) diff --git a/src/Tizen.NUI/src/public/Common/RelativeVector2.cs b/src/Tizen.NUI/src/public/Common/RelativeVector2.cs index 84885959c42..f927c550db0 100755 --- a/src/Tizen.NUI/src/public/Common/RelativeVector2.cs +++ b/src/Tizen.NUI/src/public/Common/RelativeVector2.cs @@ -29,7 +29,7 @@ namespace Tizen.NUI public class RelativeVector2 : Disposable { /// - /// The constructor. + /// The Default constructor of RelativeVector2 class. /// /// 3 public RelativeVector2() : this(Interop.Vector2.NewVector2(), true) @@ -213,6 +213,7 @@ public float Y } /// + /// Implicitly converts a RelativeVector2 instance to a Vector2 instance. /// /// 3 public static implicit operator Vector2(RelativeVector2 relativeVector2) @@ -225,6 +226,7 @@ public static implicit operator Vector2(RelativeVector2 relativeVector2) } /// + /// Implicitly converts a Vector2 object to a RelativeVector2 object. /// /// 3 public static implicit operator RelativeVector2(Vector2 vec) @@ -303,6 +305,8 @@ public bool NotEqualTo(RelativeVector2 rhs) } /// + /// Retrieves a RelativeVector2 object from a given pointer. + /// This method creates a new RelativeVector2 instance using the provided pointer. /// internal static RelativeVector2 GetRelativeVector2FromPtr(global::System.IntPtr cPtr) { diff --git a/src/Tizen.NUI/src/public/Common/RelativeVector3.cs b/src/Tizen.NUI/src/public/Common/RelativeVector3.cs index 3e24d233259..d2e5e97a5a9 100755 --- a/src/Tizen.NUI/src/public/Common/RelativeVector3.cs +++ b/src/Tizen.NUI/src/public/Common/RelativeVector3.cs @@ -30,7 +30,7 @@ public class RelativeVector3 : Disposable { /// - /// The constructor. + /// The default constructor of RelativeVector3 class. /// /// 3 public RelativeVector3() : this(Interop.Vector3.NewVector3(), true) @@ -242,6 +242,7 @@ public float Z } /// + /// Implicitly converts a RelativeVector3 instance to a Vector3 instance. /// /// 3 public static implicit operator Vector3(RelativeVector3 relativeVector3) @@ -251,6 +252,7 @@ public static implicit operator Vector3(RelativeVector3 relativeVector3) } /// + /// Implicitly converts a Vector3 instance to a RelativeVector3 instance. /// /// 3 public static implicit operator RelativeVector3(Vector3 vec) @@ -325,8 +327,6 @@ public bool NotEqualTo(RelativeVector3 rhs) return ret; } - /// - /// internal static RelativeVector3 GetRelativeVector3FromPtr(global::System.IntPtr cPtr) { RelativeVector3 ret = new RelativeVector3(cPtr, false); diff --git a/src/Tizen.NUI/src/public/Common/RelativeVector4.cs b/src/Tizen.NUI/src/public/Common/RelativeVector4.cs index 6981ad0404b..ad2e2cb87d6 100755 --- a/src/Tizen.NUI/src/public/Common/RelativeVector4.cs +++ b/src/Tizen.NUI/src/public/Common/RelativeVector4.cs @@ -30,7 +30,7 @@ public class RelativeVector4 : Disposable { /// - /// The constructor. + /// The default constructor of RelativeVector4 class. /// /// 3 public RelativeVector4() : this(Interop.Vector4.NewVector4(), true) @@ -290,6 +290,7 @@ public float W } /// + /// Implicitly converts a RelativeVector4 instance to a Vector4 instance. /// /// 3 public static implicit operator Vector4(RelativeVector4 relativeVector4) @@ -302,6 +303,7 @@ public static implicit operator Vector4(RelativeVector4 relativeVector4) } /// + /// Implicitly converts a Vector4 instance to a RelativeVector4 instance. /// /// 3 public static implicit operator RelativeVector4(Vector4 vec) @@ -379,8 +381,6 @@ public bool NotEqualTo(RelativeVector4 rhs) return ret; } - /// - /// internal static RelativeVector4 GetRelativeVector4FromPtr(global::System.IntPtr cPtr) { RelativeVector4 ret = new RelativeVector4(cPtr, false); diff --git a/src/Tizen.NUI/src/public/Common/Rotation.cs b/src/Tizen.NUI/src/public/Common/Rotation.cs index 3eac9a41ed3..559d3b4fe8c 100755 --- a/src/Tizen.NUI/src/public/Common/Rotation.cs +++ b/src/Tizen.NUI/src/public/Common/Rotation.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI { /// - /// The Rotation class. + /// The Rotation class represents a rotation of a UI Component. /// /// 3 [Binding.TypeConverter(typeof(RotationTypeConverter))] @@ -29,7 +29,7 @@ public class Rotation : Disposable { /// - /// The default constructor. + /// The default constructor of Rotation class. /// /// 3 public Rotation() : this(Interop.Rotation.NewRotation(), true) @@ -85,7 +85,7 @@ public Rotation(Vector4 vector) : this(Interop.Rotation.NewRotation4(Vector4.get } /// - /// (0.0f,0.0f,0.0f,1.0f). + /// The identity rotation, which represents no rotation. Actual value is (0.0f,0.0f,0.0f,1.0f). /// /// 3 public static Rotation IDENTITY @@ -414,6 +414,7 @@ public Rotation Normalized() /// /// Conjugates this rotation. + /// This method computes the conjugate of the current rotation. /// /// 3 public void Conjugate() @@ -424,6 +425,7 @@ public void Conjugate() /// /// Inverts this rotation. + /// This method computes the invert of the current rotation. /// /// 3 public void Invert() diff --git a/src/Tizen.NUI/src/public/Common/TypeInfo.cs b/src/Tizen.NUI/src/public/Common/TypeInfo.cs index 23f50200902..160a53bc553 100755 --- a/src/Tizen.NUI/src/public/Common/TypeInfo.cs +++ b/src/Tizen.NUI/src/public/Common/TypeInfo.cs @@ -27,7 +27,7 @@ public class TypeInfo : BaseHandle { /// - /// Creates TypeInfo object. + /// Default constructor which creates TypeInfo object. /// /// 3 public TypeInfo() : this(Interop.TypeInfo.NewTypeInfo(), true, false) diff --git a/src/Tizen.NUI/src/public/Common/Vector2.cs b/src/Tizen.NUI/src/public/Common/Vector2.cs index 68115d8762f..bb76d1ebd15 100755 --- a/src/Tizen.NUI/src/public/Common/Vector2.cs +++ b/src/Tizen.NUI/src/public/Common/Vector2.cs @@ -107,7 +107,8 @@ internal Vector2(Vector2ChangedCallback cb, Vector2 other) : this(cb, other.X, o private Vector2ChangedCallback callback = null; /// - /// (1.0f,1.0f). + /// Returns a Vector2 instance where both the x and y components are set to 1.0f. + /// Actual value is (1.0f,1.0f). /// /// 3 public static Vector2 One @@ -182,7 +183,8 @@ public static Vector2 NegativeYAxis } /// - /// (0.0f, 0.0f). + /// A Vector2 object representing the zero vector. + /// Actual value is (0.0f, 0.0f). /// /// 3 public static Vector2 Zero diff --git a/src/Tizen.NUI/src/public/Common/Vector3.cs b/src/Tizen.NUI/src/public/Common/Vector3.cs index 5271bf1ce0f..6cf28940be8 100755 --- a/src/Tizen.NUI/src/public/Common/Vector3.cs +++ b/src/Tizen.NUI/src/public/Common/Vector3.cs @@ -29,7 +29,7 @@ namespace Tizen.NUI public class Vector3 : Disposable, ICloneable { /// - /// The constructor. + /// The default constructor of Vector3 class. /// /// 3 public Vector3() : this(Interop.Vector3.NewVector3(), true) @@ -92,7 +92,8 @@ internal Vector3(Vector3ChangedCallback cb, float x, float y, float z) : this(In private Vector3ChangedCallback callback = null; /// - /// (1.0f,1.0f,1.0f). + /// Returns a Vector2 instance where both the x and y components are set to 1.0f. + /// Actual value is (1.0f,1.0f,1.0f). /// /// 3 public static Vector3 One @@ -197,7 +198,8 @@ public static Vector3 NegativeZAxis } /// - /// (0.0f, 0.0f, 0.0f). + /// A Vector2 object representing the zero vector. + /// Actual value is (0.0f, 0.0f, 0.0f). /// /// 3 public static Vector3 Zero diff --git a/src/Tizen.NUI/src/public/Common/Vector4.cs b/src/Tizen.NUI/src/public/Common/Vector4.cs index 7893562b6bc..325a46332e3 100755 --- a/src/Tizen.NUI/src/public/Common/Vector4.cs +++ b/src/Tizen.NUI/src/public/Common/Vector4.cs @@ -94,7 +94,8 @@ internal Vector4(Vector4ChangedCallback cb, float x, float y, float z, float w) private Vector4ChangedCallback callback = null; /// - /// (1.0f,1.0f,1.0f,1.0f). + /// Returns a Vector2 instance where both the x and y components are set to 1.0f. + /// Actual value is (1.0f,1.0f,1.0f,1.0f). /// /// 3 public static Vector4 One @@ -109,7 +110,8 @@ public static Vector4 One } /// - /// (1.0f,0.0f,0.0f,0.0f). + /// The vector representing the x-axis. + /// Actual value is (1.0f,0.0f,0.0f,0.0f). /// /// 3 public static Vector4 XAxis @@ -124,7 +126,8 @@ public static Vector4 XAxis } /// - /// (0.0f,1.0f,0.0f,0.0f). + /// The vector representing the y-axis. + /// Actual value is (0.0f,1.0f,0.0f,0.0f). /// /// 3 public static Vector4 YAxis @@ -139,7 +142,8 @@ public static Vector4 YAxis } /// - /// (0.0f,0.0f,1.0f,0.0f). + /// The vector representing the z-axis. + /// Actual value is (0.0f,0.0f,1.0f,0.0f). /// /// 3 public static Vector4 ZAxis @@ -154,7 +158,8 @@ public static Vector4 ZAxis } /// - /// (0.0f, 0.0f, 0.0f, 0.0f). + /// A Vector2 object representing the zero vector. + /// Actual value is (0.0f, 0.0f, 0.0f, 0.0f). /// /// 3 public static Vector4 Zero diff --git a/src/Tizen.NUI/src/public/Common/WeakEvent.cs b/src/Tizen.NUI/src/public/Common/WeakEvent.cs index c57e7e69124..2ae7ce92af7 100755 --- a/src/Tizen.NUI/src/public/Common/WeakEvent.cs +++ b/src/Tizen.NUI/src/public/Common/WeakEvent.cs @@ -40,7 +40,7 @@ public class WeakEvent where T : Delegate protected int Count => handlers.Count; /// - /// Add an event handler. + /// Adds an event handler to the list of weak references. /// /// 12 public virtual void Add(T handler) @@ -59,6 +59,7 @@ public virtual void Add(T handler) /// /// Remove last stored event handler equal to . /// + /// The event handler to remove. /// 12 public virtual void Remove(T handler) { @@ -80,6 +81,8 @@ public virtual void Remove(T handler) /// /// Invoke event handlers. /// + /// The source of the event. + /// An object that contains event data. /// 12 public void Invoke(object sender, object args) { diff --git a/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs b/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs index 506250057a5..1a40e45cf51 100755 --- a/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs +++ b/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs @@ -97,6 +97,11 @@ public class ScriptableProperty : System.Attribute [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] public readonly ScriptableType type; + + /// + /// Initializes a new instance of the class. + /// + /// The type of the scriptable property. /// 3 public ScriptableProperty(ScriptableType type = ScriptableType.Default) { @@ -114,7 +119,7 @@ public enum ScriptableType /// /// 3 Default, // Read Writable, non-animatable property, event thread only - // Animatable // Animatable property, Currently disabled, UK + // Animatable // Animatable property, Currently disabled, UK } /// @@ -165,22 +170,21 @@ public sealed class CustomViewRegistry /// /// Lookup table to match C# types to DALi types, used for the automatic property registration. /// - private static readonly Dictionary daliPropertyTypeLookup - = new Dictionary + private static readonly Dictionary daliPropertyTypeLookup = new Dictionary { - { "float", PropertyType.Float }, - { "int", PropertyType.Integer }, - { "Int32", PropertyType.Integer }, - { "Boolean", PropertyType.Boolean }, - { "string", PropertyType.String }, - { "Vector2", PropertyType.Vector2 }, - { "Vector3", PropertyType.Vector3 }, - { "Vector4", PropertyType.Vector4 }, - { "Size", PropertyType.Vector2 }, - { "Position",PropertyType.Vector3 }, - { "Color", PropertyType.Vector4 }, - { "PropertyArray", PropertyType.Array }, - { "PropertyMap", PropertyType.Map }, + { "float", PropertyType.Float }, + { "int", PropertyType.Integer }, + { "Int32", PropertyType.Integer }, + { "Boolean", PropertyType.Boolean }, + { "string", PropertyType.String }, + { "Vector2", PropertyType.Vector2 }, + { "Vector3", PropertyType.Vector3 }, + { "Vector4", PropertyType.Vector4 }, + { "Size", PropertyType.Vector2 }, + { "Position",PropertyType.Vector3 }, + { "Color", PropertyType.Vector4 }, + { "PropertyArray", PropertyType.Array }, + { "PropertyMap", PropertyType.Map }, // { "Matrix3", PropertyType.MATRIX3 }, commented out until we need to use Matrices from JSON // { "Matrix", PropertyType.MATRIX }, }; @@ -220,6 +224,9 @@ private CustomViewRegistry() [UnmanagedFunctionPointer(CallingConvention.Cdecl)] private delegate void SetPropertyDelegate(IntPtr controlPtr, IntPtr propertyName, IntPtr propertyValue); + /// + /// Gets the singleton instance of the CustomViewRegistry. + /// /// 3 public static CustomViewRegistry Instance { diff --git a/src/Tizen.NUI/src/public/CustomView/ViewWrapper.cs b/src/Tizen.NUI/src/public/CustomView/ViewWrapper.cs index 5192c670983..0a9651f9117 100755 --- a/src/Tizen.NUI/src/public/CustomView/ViewWrapper.cs +++ b/src/Tizen.NUI/src/public/CustomView/ViewWrapper.cs @@ -20,8 +20,9 @@ namespace Tizen.NUI { /// - /// ViewWrapper. - /// + /// ViewWrapper provides a way to wrap a custom view implementation within the Tizen NUI framework. + /// This class is intended for advanced users who need to extend the functionality of the View class by implementing their own rendering logic. + /// /// 3 public class ViewWrapper : View { diff --git a/src/Tizen.NUI/src/public/DragAndDrop/DragAndDrop.cs b/src/Tizen.NUI/src/public/DragAndDrop/DragAndDrop.cs index c0d9120baaf..fb93dab2145 100755 --- a/src/Tizen.NUI/src/public/DragAndDrop/DragAndDrop.cs +++ b/src/Tizen.NUI/src/public/DragAndDrop/DragAndDrop.cs @@ -31,8 +31,19 @@ namespace Tizen.NUI [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000: Dispose objects before losing scope", Justification = "It does not have ownership.")] public class DragAndDrop : BaseHandle { + /// + /// A delegate representing the method that will handle the drag source event. + /// + /// The type of the drag source event. public delegate void SourceEventHandler(DragSourceEventType sourceEventType); + private delegate void InternalSourceEventHandler(int sourceEventType); + + /// + /// Delegate representing the method that will handle drag and drop events. + /// + /// The view where the drag event occurred. + /// The native drag event containing details about the drag operation. public delegate void DragAndDropEventHandler(View targetView, DragEvent navtiveDragEvent); [EditorBrowsable(EditorBrowsableState.Never)] public delegate void DragAndDropWindowEventHandler(Window targetWindow, DragEvent navtiveDragEvent); diff --git a/src/Tizen.NUI/src/public/DragAndDrop/DragEvent.cs b/src/Tizen.NUI/src/public/DragAndDrop/DragEvent.cs index da4cc9ae183..dd2f80cca2f 100755 --- a/src/Tizen.NUI/src/public/DragAndDrop/DragEvent.cs +++ b/src/Tizen.NUI/src/public/DragAndDrop/DragEvent.cs @@ -22,25 +22,25 @@ namespace Tizen.NUI { /// - /// Drag source event type. + /// Enumeration for the drag source event types. /// /// 10 public enum DragSourceEventType { /// - /// Drag and drop is started. + /// Indicates that the drag and drop operation has started. /// Start, /// - /// Drag and drop is cancelled. + /// Indicates that the drag and drop operation has been cancelled. /// Cancel, /// - /// Drag and drop is accepted. + /// Indicates that the drag and drop operation has been accepted by the target. /// Accept, /// - /// Drag and drop is finished. + /// Indicates that the drag and drop operation has finished. /// Finish } @@ -70,7 +70,7 @@ public struct DragData } /// - /// Drag event type. + /// This enumeration defines the different types of drag events that can occur when a drag-and-drop operation is performed on a target view. /// /// 10 public enum DragType diff --git a/src/Tizen.NUI/src/public/Events/Gesture.cs b/src/Tizen.NUI/src/public/Events/Gesture.cs index 7488c899206..0cdff93d8df 100755 --- a/src/Tizen.NUI/src/public/Events/Gesture.cs +++ b/src/Tizen.NUI/src/public/Events/Gesture.cs @@ -163,7 +163,7 @@ public enum SourceDataType } /// - /// The gesture type. + /// Gets the type of gesture. /// /// 3 public Gesture.GestureType Type @@ -175,7 +175,7 @@ public Gesture.GestureType Type } /// - /// The gesture state. + /// Gets the state of gesture. /// /// 3 public Gesture.StateType State @@ -187,7 +187,7 @@ public Gesture.StateType State } /// - /// The time the gesture took place. + /// Get the time when the gesture took place. /// /// 3 public uint Time diff --git a/src/Tizen.NUI/src/public/Events/Hover.cs b/src/Tizen.NUI/src/public/Events/Hover.cs index b202e84b9ca..cbbbff86d13 100755 --- a/src/Tizen.NUI/src/public/Events/Hover.cs +++ b/src/Tizen.NUI/src/public/Events/Hover.cs @@ -30,7 +30,7 @@ public class Hover : BaseHandle { /// - /// The default constructor. + /// The default constructor of Hover class. /// /// 3 public Hover() : this(Interop.Hover.New(0u), true) diff --git a/src/Tizen.NUI/src/public/Events/PanGesture.cs b/src/Tizen.NUI/src/public/Events/PanGesture.cs index 8587a69af1b..88c6875933f 100755 --- a/src/Tizen.NUI/src/public/Events/PanGesture.cs +++ b/src/Tizen.NUI/src/public/Events/PanGesture.cs @@ -32,7 +32,7 @@ public class PanGesture : Gesture { /// - /// The default constructor. + /// The default constructor of PanGesture class. /// /// 3 public PanGesture() : this(Interop.PanGestureDetector.PanGestureNew(0), true) diff --git a/src/Tizen.NUI/src/public/Events/TapGesture.cs b/src/Tizen.NUI/src/public/Events/TapGesture.cs index f9fe9818147..8818627ebde 100755 --- a/src/Tizen.NUI/src/public/Events/TapGesture.cs +++ b/src/Tizen.NUI/src/public/Events/TapGesture.cs @@ -28,7 +28,7 @@ public class TapGesture : Gesture { /// - /// Creates a TapGesture. + /// Default constructor to creates a TapGesture. /// /// 3 public TapGesture() : this(Interop.TapGesture.New(0), true) diff --git a/src/Tizen.NUI/src/public/Events/Touch.cs b/src/Tizen.NUI/src/public/Events/Touch.cs index 69168ff356d..535d7a06931 100755 --- a/src/Tizen.NUI/src/public/Events/Touch.cs +++ b/src/Tizen.NUI/src/public/Events/Touch.cs @@ -253,7 +253,7 @@ internal static Touch GetTouchFromPtr(global::System.IntPtr cPtr) return ret; } - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Degree GetAngle(uint point) { diff --git a/src/Tizen.NUI/src/public/Events/Wheel.cs b/src/Tizen.NUI/src/public/Events/Wheel.cs index ab2d3be73d4..a07b7b67220 100755 --- a/src/Tizen.NUI/src/public/Events/Wheel.cs +++ b/src/Tizen.NUI/src/public/Events/Wheel.cs @@ -30,7 +30,7 @@ public class Wheel : BaseHandle { /// - /// The default constructor. + /// The default constructor of Wheel class. /// /// 3 public Wheel() : this(Interop.Wheel.New(0, 0, 0u, Vector2.getCPtr(new Vector2(0.0f, 0.0f)), 0, 0u), true) diff --git a/src/Tizen.NUI/src/public/Input/FocusManagerArgs.cs b/src/Tizen.NUI/src/public/Input/FocusManagerArgs.cs index 8bf48609b70..ea2cc977f70 100755 --- a/src/Tizen.NUI/src/public/Input/FocusManagerArgs.cs +++ b/src/Tizen.NUI/src/public/Input/FocusManagerArgs.cs @@ -31,7 +31,7 @@ public class FocusChangingEventArgs : EventArgs private View.FocusDirection direction; /// - /// The view which is currently focused. + /// Gets or sets the view which is currently focused. /// /// 10 public View Current @@ -47,7 +47,7 @@ public View Current } /// - /// The proposed view. + /// Gets or sets the proposed view for focus change. /// /// 10 public View Proposed @@ -63,7 +63,7 @@ public View Proposed } /// - /// The focus move direction. + /// Gets or sets the focus move direction. /// /// 10 public View.FocusDirection Direction diff --git a/src/Tizen.NUI/src/public/Input/InputMethod.cs b/src/Tizen.NUI/src/public/Input/InputMethod.cs index bfe555d75b4..eaf00a6f2cf 100755 --- a/src/Tizen.NUI/src/public/Input/InputMethod.cs +++ b/src/Tizen.NUI/src/public/Input/InputMethod.cs @@ -28,7 +28,7 @@ public class InputMethod private int? variation = null; /// - /// The default constructor. + /// The default constructor of InputMethod. /// /// 3 public InputMethod() diff --git a/src/Tizen.NUI/src/public/Input/InputMethodContext.cs b/src/Tizen.NUI/src/public/Input/InputMethodContext.cs index c188e3006e5..faffaacac80 100755 --- a/src/Tizen.NUI/src/public/Input/InputMethodContext.cs +++ b/src/Tizen.NUI/src/public/Input/InputMethodContext.cs @@ -68,7 +68,7 @@ internal InputMethodContext(IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOw private event EventHandler contentReceivedEventHandler; /// - /// InputMethodContext activated. + /// Event handler for the activation of the InputMethodContext. /// /// 5 public event EventHandler Activated @@ -95,7 +95,7 @@ public event EventHandler Activated } /// - /// InputMethodContext event received. + /// This event handler is used to receive events related to the InputMethodContext. /// /// 5 public event EventHandlerWithReturnType EventReceived @@ -122,7 +122,7 @@ public event EventHandlerWithReturnType - /// InputMethodContext status changed. + /// The StatusChanged event is triggered when the input method context status changes. /// /// 5 public event EventHandler StatusChanged @@ -149,7 +149,7 @@ public event EventHandler StatusChanged } /// - /// InputMethodContext resized. + /// Event handler for the InputMethodContext resized event. /// /// 5 public event EventHandler Resized @@ -176,7 +176,7 @@ public event EventHandler Resized } /// - /// InputMethodContext language changed. + /// This event is triggered when the language of the InputMethodContext changes. /// /// 5 public event EventHandler LanguageChanged @@ -203,7 +203,7 @@ public event EventHandler LanguageChanged } /// - /// InputMethodContext keyboard type changed. + /// Event handler for InputMethodContext keyboard type changed. /// /// 5 public event EventHandler KeyboardTypeChanged @@ -232,7 +232,7 @@ public event EventHandler KeyboardTypeChanged /// /// InputMethodContext content received. /// - /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandler ContentReceived { @@ -258,7 +258,7 @@ public event EventHandler ContentReceived } /// - /// The direction of the text. + /// Enumeration for the direction of the text. /// /// 5 public enum TextDirection @@ -274,7 +274,7 @@ public enum TextDirection } /// - /// Events that are generated by the IMF. + /// Enumeration for the events that are generated by the IMF. /// /// 5 public enum EventType @@ -667,6 +667,7 @@ public void ShowInputPanel() /// /// Hides the input panel. + /// This method hides the on-screen keyboard or input panel associated with the current InputMethodContext instance. /// /// 5 public void HideInputPanel() @@ -1013,7 +1014,7 @@ public class EventData : Disposable private global::System.Runtime.InteropServices.HandleRef swigCPtr; /// - /// The default constructor. + /// The default constructor of EventData class. /// /// 5 public EventData() : this(Interop.InputMethodContext.NewInputMethodContextEventData(), true) @@ -1173,7 +1174,7 @@ public class CallbackData : Disposable private global::System.Runtime.InteropServices.HandleRef swigCPtr; /// - /// The default constructor. + /// The default constructor of CallbackData class. /// /// 5 public CallbackData() : this(Interop.InputMethodContext.NewInputMethodContextCallbackData(), true) diff --git a/src/Tizen.NUI/src/public/Input/Key.cs b/src/Tizen.NUI/src/public/Input/Key.cs index ab703231200..c473935a3ab 100755 --- a/src/Tizen.NUI/src/public/Input/Key.cs +++ b/src/Tizen.NUI/src/public/Input/Key.cs @@ -27,7 +27,7 @@ namespace Tizen.NUI public class Key : BaseHandle { /// - /// The default constructor. + /// The default constructor of Key class. /// /// 3 public Key() : this(Interop.Key.New("","",0,0,0u,0), true) @@ -81,7 +81,7 @@ public enum StateType } /// - /// Device name + /// Gets the device name /// /// 3 public string DeviceName @@ -95,7 +95,7 @@ public string DeviceName } /// - /// Name given to the key pressed. + /// Gets or sets the name given to the key pressed. /// /// 3 public string KeyPressedName @@ -223,7 +223,7 @@ public uint Time } /// - /// State of the key event. + /// Gests or sets the state of the key event. /// /// 3 public Key.StateType State diff --git a/src/Tizen.NUI/src/public/Input/KeyValue.cs b/src/Tizen.NUI/src/public/Input/KeyValue.cs index 24cf408ea4d..28821455284 100755 --- a/src/Tizen.NUI/src/public/Input/KeyValue.cs +++ b/src/Tizen.NUI/src/public/Input/KeyValue.cs @@ -23,7 +23,7 @@ namespace Tizen.NUI { /// - /// KeyValue class. + /// The KeyValue class provides functionality for managing key-value pairs. /// public class KeyValue : IDisposable { @@ -57,13 +57,13 @@ public class KeyValue : IDisposable private object originalKey = null; /// - /// Default Constructor. + /// The default Constructor of KeyValue class. /// public KeyValue() { } /// - /// Key property. + /// Gets or sets the key value. /// public string Key { @@ -79,7 +79,7 @@ public string Key } /// - /// OriginalKey property. + /// Gets or sets the original key associated with the KeyValue object. /// /// Thrown when value is null. public object OriginalKey @@ -116,7 +116,7 @@ public object OriginalKey } /// - /// Value property. + /// Gets or sets the value associated with the key. /// public object Value { @@ -181,7 +181,7 @@ public PropertyValue PropertyValue } /// - /// IntergerValue property. + /// Gets or sets the integer value associated with the key. /// public int IntergerValue { @@ -201,7 +201,7 @@ public int IntergerValue } /// - /// BooleanValue property. + /// Gets or sets the boolean value associated with the key. /// public bool BooleanValue { @@ -221,7 +221,7 @@ public bool BooleanValue } /// - /// SingleValue property. + /// Gets or sets the Single(float) value associated with the key. /// public float SingleValue { @@ -241,7 +241,7 @@ public float SingleValue } /// - /// StringValue property. + /// Gets or sets the string value associated with the key. /// public string StringValue { @@ -261,7 +261,7 @@ public string StringValue } /// - /// Vector2Value property. + /// Gets or sets the value associated with the key. /// public Vector2 Vector2Value { @@ -282,7 +282,7 @@ public Vector2 Vector2Value } /// - /// Vector3Value property. + /// Gets or sets the value associated with the key. /// public Vector3 Vector3Value { @@ -303,7 +303,7 @@ public Vector3 Vector3Value } /// - /// Vector4Value property. + /// Gets or sets the value associated with the key. /// public Vector4 Vector4Value { @@ -324,7 +324,7 @@ public Vector4 Vector4Value } /// - /// PositionValue property. + /// Gets or sets the value associated with the key. /// public Position PositionValue { @@ -345,7 +345,7 @@ public Position PositionValue } /// - /// Position2DValue property. + /// Gets or sets the value associated with the key. /// public Position2D Position2DValue { @@ -366,7 +366,7 @@ public Position2D Position2DValue } /// - /// SizeValue property. + /// Gets or sets the value associated with the key. /// public Size SizeValue { @@ -387,7 +387,7 @@ public Size SizeValue } /// - /// Size2DValue property. + /// Gets or sets the value associated with the key. /// public Size2D Size2DValue { @@ -408,7 +408,7 @@ public Size2D Size2DValue } /// - /// ColorValue property. + /// Gets or sets the value associated with the key. /// public Color ColorValue { @@ -429,7 +429,7 @@ public Color ColorValue } /// - /// RectangleValue property. + /// Gets or sets the value associated with the key. /// public Rectangle RectangleValue { @@ -450,7 +450,7 @@ public Rectangle RectangleValue } /// - /// RotationValue property. + /// Gets or sets the value associated with the key. /// public Rotation RotationValue { @@ -471,7 +471,7 @@ public Rotation RotationValue } /// - /// RelativeVector2Value property. + /// Gets or sets the value associated with the key. /// public RelativeVector2 RelativeVector2Value { @@ -492,7 +492,7 @@ public RelativeVector2 RelativeVector2Value } /// - /// RelativeVector3Value property. + /// Gets or sets the value associated with the key. /// public RelativeVector3 RelativeVector3Value { @@ -513,7 +513,7 @@ public RelativeVector3 RelativeVector3Value } /// - /// RelativeVector4Value property. + /// Gets or sets the value associated with the key. /// public RelativeVector4 RelativeVector4Value { @@ -534,7 +534,7 @@ public RelativeVector4 RelativeVector4Value } /// - /// ExtentsValue property. + /// Gets or sets the value associated with the key. /// public Extents ExtentsValue { @@ -555,7 +555,7 @@ public Extents ExtentsValue } /// - /// PropertyArrayValue property. + /// Gets or sets the value associated with the key. /// public PropertyArray PropertyArrayValue { @@ -576,7 +576,7 @@ public PropertyArray PropertyArrayValue } /// - /// PropertyMapValue property. + /// Gets or sets the value associated with the key. /// public PropertyMap PropertyMapValue { diff --git a/src/Tizen.NUI/src/public/Layouting/AbsoluteLayout.cs b/src/Tizen.NUI/src/public/Layouting/AbsoluteLayout.cs index d6675dfd65c..2ab9b409683 100755 --- a/src/Tizen.NUI/src/public/Layouting/AbsoluteLayout.cs +++ b/src/Tizen.NUI/src/public/Layouting/AbsoluteLayout.cs @@ -17,13 +17,13 @@ namespace Tizen.NUI { /// - /// [Draft] This class implements a absolute layout, allowing explicit positioning of children. - /// Positions are from the top left of the layout and can be set using the View.Position and alike. + /// This class implements a absolute layout, allowing explicit positioning of children. + /// Positions are from the top left of the layout and can be set using the View.Position and alike. /// public class AbsoluteLayout : LayoutGroup { /// - /// [Draft] Constructor + /// The default constructor of AbsoluteLayout class /// /// 6 public AbsoluteLayout() diff --git a/src/Tizen.NUI/src/public/Layouting/ILayoutParent.cs b/src/Tizen.NUI/src/public/Layouting/ILayoutParent.cs index 34108235c95..e3f21dfe19e 100755 --- a/src/Tizen.NUI/src/public/Layouting/ILayoutParent.cs +++ b/src/Tizen.NUI/src/public/Layouting/ILayoutParent.cs @@ -18,7 +18,6 @@ namespace Tizen.NUI { /// - /// [Draft] /// Interface that defines a layout Parent. Enables a layout child to access methods on its parent, e.g. Remove (during unparenting) /// public interface ILayoutParent diff --git a/src/Tizen.NUI/src/public/Layouting/LayoutGroup.cs b/src/Tizen.NUI/src/public/Layouting/LayoutGroup.cs index ee259b1adaf..754ed1e8f00 100755 --- a/src/Tizen.NUI/src/public/Layouting/LayoutGroup.cs +++ b/src/Tizen.NUI/src/public/Layouting/LayoutGroup.cs @@ -26,18 +26,18 @@ namespace Tizen.NUI { /// - /// [Draft] LayoutGroup class providing container functionality. + /// LayoutGroup class providing container functionality. /// public class LayoutGroup : LayoutItem, ILayoutParent { /// - /// [Draft] List of child layouts in this container. + /// List of child layouts in this container. /// /// 6 protected List LayoutChildren { get; } // Children of this LayoutGroup /// - /// [Draft] Constructor + /// Default constructor of LayoutGroup class. /// /// 6 public LayoutGroup() diff --git a/src/Tizen.NUI/src/public/Layouting/LayoutItem.cs b/src/Tizen.NUI/src/public/Layouting/LayoutItem.cs index 7f9e69a9fea..b512e849d71 100755 --- a/src/Tizen.NUI/src/public/Layouting/LayoutItem.cs +++ b/src/Tizen.NUI/src/public/Layouting/LayoutItem.cs @@ -34,7 +34,7 @@ enum LayoutFlags : short }; /// - /// [Draft] Base class for layouts. It is used to layout a View + /// Base class for layouts. It is used to layout a View /// It can be laid out by a LayoutGroup. /// public class LayoutItem : IDisposable @@ -56,18 +56,18 @@ public class LayoutItem : IDisposable private bool setPositionByLayout = true; /// - /// [Draft] Condition event that is causing this Layout to transition. + /// Condition event that is causing this Layout to transition. /// internal TransitionCondition ConditionForAnimation { get; set; } /// - /// [Draft] The View that this Layout has been assigned to. + /// The View that this Layout has been assigned to. /// /// 6 public View Owner { get; set; } // Should not keep a View alive. /// - /// [Draft] Use transition for layouting child + /// Use transition for layouting child /// /// 6 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -75,7 +75,7 @@ public class LayoutItem : IDisposable public bool LayoutWithTransition { get; set; } /// - /// [Draft] Set position by layouting result + /// Set position by layouting result /// [EditorBrowsable(EditorBrowsableState.Never)] public bool SetPositionByLayout @@ -95,7 +95,7 @@ public bool SetPositionByLayout } /// - /// [Draft] Margin for this LayoutItem + /// Margin for this LayoutItem /// /// 6 public Extents Margin @@ -112,7 +112,7 @@ public Extents Margin } /// - /// [Draft] Padding for this LayoutItem + /// Padding for this LayoutItem /// /// 6 public Extents Padding @@ -129,7 +129,7 @@ public Extents Padding } /// - /// [Draft] Constructor + /// Default constructor of LayoutItem class. /// /// 6 public LayoutItem() @@ -138,7 +138,7 @@ public LayoutItem() } /// - /// [Draft] Set parent to this layout. + /// Set parent to this layout. /// /// Parent to set on this Layout. internal void SetParent(ILayoutParent parent) @@ -370,7 +370,6 @@ public void RequestLayout() /// /// Predicate to determine if this layout has been requested to re-layout.
/// - internal bool LayoutRequested { get diff --git a/src/Tizen.NUI/src/public/Layouting/LayoutLength.cs b/src/Tizen.NUI/src/public/Layouting/LayoutLength.cs index a412195f1ac..9ec4290c6d5 100755 --- a/src/Tizen.NUI/src/public/Layouting/LayoutLength.cs +++ b/src/Tizen.NUI/src/public/Layouting/LayoutLength.cs @@ -20,14 +20,14 @@ namespace Tizen.NUI { /// - /// [Draft] A type that represents a layout length. Currently, this implies pixels, but could be extended to handle device dependant sizes, etc. + /// A type that represents a layout length. Currently, this implies pixels, but could be extended to handle device dependant sizes, etc. /// public struct LayoutLength : IEquatable { private float value; /// - /// [Draft] Constructor from an int + /// Constructor from an int /// /// Int to initialize with. /// 6 @@ -37,7 +37,7 @@ public LayoutLength(int value) } /// - /// [Draft] Constructor from a float + /// Constructor from a float /// /// Float to initialize with. /// 6 @@ -47,7 +47,7 @@ public LayoutLength(float value) } /// - /// [Draft] Constructor from a LayoutLength + /// Constructor from a LayoutLength /// /// LayoutLength object to initialize with. /// 6 @@ -57,7 +57,7 @@ public LayoutLength(LayoutLength layoutLength) } /// - /// [Draft] Return value as rounded value (whole number), best used as final output + /// Return value as rounded value (whole number), best used as final output /// /// The layout length value as a rounded whole number. /// 6 @@ -67,7 +67,7 @@ public float AsRoundedValue() } /// - /// [Draft] Return value as the raw decimal value, best used for calculations + /// Return value as the raw decimal value, best used for calculations /// /// The layout length value as the raw decimal value. /// 6 @@ -77,7 +77,7 @@ public float AsDecimal() } /// - /// [Draft] The == operator. + /// The == operator. /// /// The first value. /// The second value @@ -89,7 +89,7 @@ public float AsDecimal() } /// - /// [Draft] The != operator. + /// The != operator. /// /// The first value. /// The second value diff --git a/src/Tizen.NUI/src/public/Layouting/LinearLayout.cs b/src/Tizen.NUI/src/public/Layouting/LinearLayout.cs index 3450182e90d..5a5db22d201 100755 --- a/src/Tizen.NUI/src/public/Layouting/LinearLayout.cs +++ b/src/Tizen.NUI/src/public/Layouting/LinearLayout.cs @@ -23,14 +23,14 @@ namespace Tizen.NUI { /// - /// [Draft] This class implements a linear box layout, automatically handling right to left or left to right direction change. + /// This class implements a linear box layout, automatically handling right to left or left to right direction change. /// public class LinearLayout : LayoutGroup { private Alignment linearAlignment = Alignment.Top; /// - /// [Draft] Enumeration for the direction in which the content is laid out + /// Enumeration for the direction in which the content is laid out /// /// 6 public enum Orientation @@ -46,7 +46,7 @@ public enum Orientation } /// - /// [Draft] Enumeration for the alignment of the linear layout items + /// Enumeration for the alignment of the linear layout items /// /// 6 [Obsolete("This has been deprecated in API9 and will be removed in API11. Use HorizontalAlignment and VerticalAlignment instead.")] @@ -95,7 +95,7 @@ public HeightAndWidthState(MeasuredSize.StateType width, MeasuredSize.StateType } /// - /// [Draft] Get/Set the orientation in the layout + /// Get/Set the orientation in the layout /// /// 6 public LinearLayout.Orientation LinearOrientation @@ -112,7 +112,7 @@ public LinearLayout.Orientation LinearOrientation } /// - /// [Draft] Get/Set the padding between cells in the layout + /// Get/Set the padding between cells in the layout /// /// 6 public Size2D CellPadding @@ -135,7 +135,7 @@ public Size2D CellPadding /// - /// [Draft] Get/Set the alignment in the layout + /// Get/Set the alignment in the layout /// /// 6 [Obsolete("This has been deprecated in API9 and will be removed in API11. Use HorizontalAlignment and VerticalAlignment properties instead.")] @@ -202,7 +202,7 @@ public LinearLayout.Alignment LinearAlignment private Orientation linearOrientation = Orientation.Horizontal; /// - /// [Draft] Constructor + /// Default constructor of LinearLayout class. /// /// 6 public LinearLayout() diff --git a/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs b/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs index f58f4f77c8d..50cf621e176 100755 --- a/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs +++ b/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs @@ -22,7 +22,7 @@ namespace Tizen.NUI { /// - /// [Draft] A MeasureSpecification is used during the Measure pass by a LayoutGroup to inform it's children how to be measured. + /// A MeasureSpecification is used during the Measure pass by a LayoutGroup to inform it's children how to be measured. /// For instance, it may measure a child with an exact width and an unspecified height in order to determine height for width. /// public struct MeasureSpecification diff --git a/src/Tizen.NUI/src/public/Layouting/MeasuredSize.cs b/src/Tizen.NUI/src/public/Layouting/MeasuredSize.cs index ca464a1b6c1..381dd35fe58 100755 --- a/src/Tizen.NUI/src/public/Layouting/MeasuredSize.cs +++ b/src/Tizen.NUI/src/public/Layouting/MeasuredSize.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI { /// - /// [Draft] Class that encodes a measurement and a measure state, which is set if the measured size is too small. + /// Class that encodes a measurement and a measure state, which is set if the measured size is too small. /// public struct MeasuredSize { diff --git a/src/Tizen.NUI/src/public/Layouting/PaddingType.cs b/src/Tizen.NUI/src/public/Layouting/PaddingType.cs index 6cdc71df37c..e324d375b9d 100755 --- a/src/Tizen.NUI/src/public/Layouting/PaddingType.cs +++ b/src/Tizen.NUI/src/public/Layouting/PaddingType.cs @@ -20,7 +20,7 @@ namespace Tizen.NUI using System.ComponentModel; /// - /// The gesture state. + /// The PaddingType class represents padding properties used in layouting. /// /// 3 public class PaddingType : Disposable @@ -53,7 +53,7 @@ internal PaddingType(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, c } /// - /// The Start value. + /// The Start value horizontally. /// /// 4 public float Start @@ -69,7 +69,7 @@ public float Start } /// - /// The End value. + /// The End value horizontally. /// /// 4 public float End @@ -85,7 +85,7 @@ public float End } /// - /// The Top value. + /// The Top value vertically. /// /// 3 public float Top @@ -101,7 +101,7 @@ public float Top } /// - /// The Bottom value. + /// The Bottom value vertically. /// /// 3 public float Bottom diff --git a/src/Tizen.NUI/src/public/Rendering/FilterModeType.cs b/src/Tizen.NUI/src/public/Rendering/FilterModeType.cs index 945a4bd6e29..e645b259f30 100755 --- a/src/Tizen.NUI/src/public/Rendering/FilterModeType.cs +++ b/src/Tizen.NUI/src/public/Rendering/FilterModeType.cs @@ -18,7 +18,7 @@ namespace Tizen.NUI { /// - /// The filter mode type. + /// Enumeration of the type of possible filter modes. /// /// 3 public enum FilterModeType diff --git a/src/Tizen.NUI/src/public/Rendering/Renderer.cs b/src/Tizen.NUI/src/public/Rendering/Renderer.cs index fbc4b3f26bf..f6a6441e808 100755 --- a/src/Tizen.NUI/src/public/Rendering/Renderer.cs +++ b/src/Tizen.NUI/src/public/Rendering/Renderer.cs @@ -812,33 +812,27 @@ protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef Interop.Renderer.DeleteRenderer(swigCPtr); } - /// 6.0 - /// This will be changed internal API after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be opened API after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public sealed class Ranges { - /// 6.0 - /// This will be changed internal API after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be opened API after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly int BackgroundEffect = Interop.Renderer.RangesBackgroundEffectGet(); - /// 6.0 - /// This will be changed internal API after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be opened API after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly int BACKGROUND = Interop.Renderer.RangesBackgroundGet(); - /// 6.0 - /// This will be changed internal API after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be opened API after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly int CONTENT = Interop.Renderer.RangesContentGet(); - /// 6.0 - /// This will be changed internal API after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be opened API after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly int DECORATION = Interop.Renderer.RangesDecorationGet(); - /// 6.0 - /// This will be changed internal API after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be opened API after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly int ForegroundEffect = Interop.Renderer.RangesForegroundEffectGet(); diff --git a/src/Tizen.NUI/src/public/Rendering/Shader.cs b/src/Tizen.NUI/src/public/Rendering/Shader.cs index ccbb4d95e5b..b3e090a920a 100755 --- a/src/Tizen.NUI/src/public/Rendering/Shader.cs +++ b/src/Tizen.NUI/src/public/Rendering/Shader.cs @@ -20,7 +20,7 @@ namespace Tizen.NUI { /// - /// Shader. + /// Shader allows custom vertex and color transformations in the GPU. /// /// 3 public class Shader : Animatable @@ -83,7 +83,7 @@ protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef } /// - /// Hint. + /// The Hint class is used to provide additional information to the shader. /// /// 3 public sealed class Hint diff --git a/src/Tizen.NUI/src/public/Rendering/TextureType.cs b/src/Tizen.NUI/src/public/Rendering/TextureType.cs index 3982e9b190c..8ad423d1b10 100755 --- a/src/Tizen.NUI/src/public/Rendering/TextureType.cs +++ b/src/Tizen.NUI/src/public/Rendering/TextureType.cs @@ -18,7 +18,7 @@ namespace Tizen.NUI { /// - /// The texture type. + /// The TextureType enumeration defines the types of textures. /// /// 3 public enum TextureType diff --git a/src/Tizen.NUI/src/public/Rendering/VertexBuffer.cs b/src/Tizen.NUI/src/public/Rendering/VertexBuffer.cs index 3e8542a3142..ed16450f2d7 100755 --- a/src/Tizen.NUI/src/public/Rendering/VertexBuffer.cs +++ b/src/Tizen.NUI/src/public/Rendering/VertexBuffer.cs @@ -30,7 +30,7 @@ public class VertexBuffer : BaseHandle { /// - /// Creates a VertexBuffer. + /// The constructor to creates a VertexBuffer. /// /// The map of names and types that describes the components of the buffer. /// 8 diff --git a/src/Tizen.NUI/src/public/Template/DataTemplate.cs b/src/Tizen.NUI/src/public/Template/DataTemplate.cs index 54664da18f6..bed1d05af5c 100755 --- a/src/Tizen.NUI/src/public/Template/DataTemplate.cs +++ b/src/Tizen.NUI/src/public/Template/DataTemplate.cs @@ -28,7 +28,7 @@ namespace Tizen.NUI.Binding public class DataTemplate : ElementTemplate { /// - /// Base constructor. + /// The default constructor of DataTemplate class. /// /// 9 public DataTemplate() diff --git a/src/Tizen.NUI/src/public/Theme/Theme.cs b/src/Tizen.NUI/src/public/Theme/Theme.cs index b4379bc5074..48852b62437 100755 --- a/src/Tizen.NUI/src/public/Theme/Theme.cs +++ b/src/Tizen.NUI/src/public/Theme/Theme.cs @@ -46,7 +46,7 @@ public class Theme : BindableObject, IResourcesProvider ResourceDictionary resources; /// - /// Create an empty theme. + /// The default constructor to create an empty theme. /// /// 9 public Theme() diff --git a/src/Tizen.NUI/src/public/Theme/ThemeChangedEventArgs.cs b/src/Tizen.NUI/src/public/Theme/ThemeChangedEventArgs.cs index 368c22dc0d8..d5db7f7b6c0 100755 --- a/src/Tizen.NUI/src/public/Theme/ThemeChangedEventArgs.cs +++ b/src/Tizen.NUI/src/public/Theme/ThemeChangedEventArgs.cs @@ -36,19 +36,20 @@ public ThemeChangedEventArgs(string themeId, string platformThemeId, bool isPlat } /// - /// The new theme's Id. + /// Gets the new theme's Id. /// /// 9 public string ThemeId { get; } /// - /// The platform theme's Id. + /// Gets the platform theme's Id. /// [EditorBrowsable(EditorBrowsableState.Never)] public string PlatformThemeId { get; } /// - /// Whether this event is trigger by platform theme change. + /// Returns whether the event was triggered by a platform theme change. + /// The value is true if the event is triggered by a platform theme change, otherwise false. /// /// [EditorBrowsable(EditorBrowsableState.Never)] diff --git a/src/Tizen.NUI/src/public/Transition/Transition.cs b/src/Tizen.NUI/src/public/Transition/Transition.cs index 37a78cf7736..77bacaa5d68 100644 --- a/src/Tizen.NUI/src/public/Transition/Transition.cs +++ b/src/Tizen.NUI/src/public/Transition/Transition.cs @@ -28,7 +28,7 @@ namespace Tizen.NUI public class Transition : TransitionBase { /// - /// Create a Transition for the View pair. + /// Default constructor to create a Transition for the View pair. /// /// 9 public Transition() diff --git a/src/Tizen.NUI/src/public/Transition/TransitionBase.cs b/src/Tizen.NUI/src/public/Transition/TransitionBase.cs index de7c251e597..3ed937787a3 100644 --- a/src/Tizen.NUI/src/public/Transition/TransitionBase.cs +++ b/src/Tizen.NUI/src/public/Transition/TransitionBase.cs @@ -35,7 +35,7 @@ public class TransitionBase : Disposable private TimePeriod timePeriod = null; /// - /// Create a TransitionBase + /// Default constructor to create a TransitionBase /// /// 9 public TransitionBase() diff --git a/src/Tizen.NUI/src/public/Utility/DirectionBias.cs b/src/Tizen.NUI/src/public/Utility/DirectionBias.cs index 13a591589c2..6e1ec4ccf57 100755 --- a/src/Tizen.NUI/src/public/Utility/DirectionBias.cs +++ b/src/Tizen.NUI/src/public/Utility/DirectionBias.cs @@ -19,6 +19,7 @@ namespace Tizen.NUI { /// /// The Direction Bias type. + /// This enum is used to specify the direction bias for scroll snapping. /// /// 3 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1712: Do not prefix enum values with type name")] diff --git a/src/Tizen.NUI/src/public/Utility/TTSPlayer.cs b/src/Tizen.NUI/src/public/Utility/TTSPlayer.cs index 5d8bec1f382..967090f0d48 100755 --- a/src/Tizen.NUI/src/public/Utility/TTSPlayer.cs +++ b/src/Tizen.NUI/src/public/Utility/TTSPlayer.cs @@ -53,7 +53,7 @@ internal TTSPlayer(TTSPlayer handle) : this(Interop.TtsPlayer.NewTtsPlayer(TTSPl private event EventHandler stateChangedEventHandler; /// - /// State changed event. + /// The StateChanged event is triggered when the state of the TTS player changes. /// /// 3 public event EventHandler StateChanged @@ -288,13 +288,13 @@ private void OnStateChanged(TTSState prevState, TTSState nextState) } /// - /// State changed argument. + /// This class represents the event arguments used when the state of the TTS player changes. /// /// 3 public class StateChangedEventArgs : EventArgs { /// - /// PrevState. + /// The previous state of the TTS player before the change. /// /// 3 public TTSState PrevState @@ -304,7 +304,7 @@ public TTSState PrevState } /// - /// NextState. + /// The new state of the TTS player after the change. /// /// 3 public TTSState NextState diff --git a/src/Tizen.NUI/src/public/Utility/Timer.cs b/src/Tizen.NUI/src/public/Utility/Timer.cs index e796e3847e0..9c2ea2ae1ff 100755 --- a/src/Tizen.NUI/src/public/Utility/Timer.cs +++ b/src/Tizen.NUI/src/public/Utility/Timer.cs @@ -259,7 +259,12 @@ internal TimerSignalType TickSignal() /// /// Dispose. + /// Releases unmanaged and optionally managed resources. /// + /// + /// When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources. + /// + /// Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources. /// 3 protected override void Dispose(DisposeTypes type) { diff --git a/src/Tizen.NUI/src/public/ViewProperty/ShadowBase.cs b/src/Tizen.NUI/src/public/ViewProperty/ShadowBase.cs index deec0e1c2d8..2390192ca56 100755 --- a/src/Tizen.NUI/src/public/ViewProperty/ShadowBase.cs +++ b/src/Tizen.NUI/src/public/ViewProperty/ShadowBase.cs @@ -32,7 +32,7 @@ public abstract class ShadowBase private static readonly Vector2 noExtents = new Vector2(0, 0); /// - /// Constructor + /// The default constructor of ShadowBase class. /// [EditorBrowsable(EditorBrowsableState.Never)] protected ShadowBase() : this(noOffset, noExtents) diff --git a/src/Tizen.NUI/src/public/Visuals/AnimatedImageVisual.cs b/src/Tizen.NUI/src/public/Visuals/AnimatedImageVisual.cs index 9e2edbf8cd8..32dcf8bcc5a 100755 --- a/src/Tizen.NUI/src/public/Visuals/AnimatedImageVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/AnimatedImageVisual.cs @@ -31,7 +31,7 @@ public class AnimatedImageVisual : VisualMap private float? loopCount = null; /// - /// Constructor. + /// Default constructor of AnimatedImageVisual class. /// /// 3 public AnimatedImageVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/BorderVisual.cs b/src/Tizen.NUI/src/public/Visuals/BorderVisual.cs index 25eef6b7887..c458a053cd8 100755 --- a/src/Tizen.NUI/src/public/Visuals/BorderVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/BorderVisual.cs @@ -28,7 +28,7 @@ public class BorderVisual : VisualMap private bool? antiAliasing = null; /// - /// Constructor. + /// Default constructor of BorderVisual class. /// /// 3 public BorderVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/ColorVisual.cs b/src/Tizen.NUI/src/public/Visuals/ColorVisual.cs index d2b58836db6..1607bd188a5 100755 --- a/src/Tizen.NUI/src/public/Visuals/ColorVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/ColorVisual.cs @@ -27,7 +27,7 @@ public class ColorVisual : VisualMap private bool? renderIfTransparent = false; /// - /// Constructor. + /// Default constructor of ColorVisual class. /// /// 3 public ColorVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/GradientVisual.cs b/src/Tizen.NUI/src/public/Visuals/GradientVisual.cs index 097052959e1..cd2738872d6 100755 --- a/src/Tizen.NUI/src/public/Visuals/GradientVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/GradientVisual.cs @@ -33,7 +33,7 @@ public class GradientVisual : VisualMap private GradientVisualSpreadMethodType? _spreadMethod = null; /// - /// Constructor. + /// Default constructor of GradientVisual. /// /// 3 public GradientVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/ImageVisual.cs b/src/Tizen.NUI/src/public/Visuals/ImageVisual.cs index be1e741c2c8..db7ea5fedf2 100755 --- a/src/Tizen.NUI/src/public/Visuals/ImageVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/ImageVisual.cs @@ -44,7 +44,7 @@ public class ImageVisual : VisualMap private bool? atlasing = false; /// - /// Constructor. + /// Default constructor of ImageVisual class. /// /// 3 public ImageVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/MeshVisual.cs b/src/Tizen.NUI/src/public/Visuals/MeshVisual.cs index d85f815630d..ca515f4005a 100755 --- a/src/Tizen.NUI/src/public/Visuals/MeshVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/MeshVisual.cs @@ -34,7 +34,7 @@ public class MeshVisual : VisualMap private Vector3 lightPosition = null; /// - /// Constructor. + /// Default constructor of MeshVisual class. /// /// 3 public MeshVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/NPatchVisual.cs b/src/Tizen.NUI/src/public/Visuals/NPatchVisual.cs index b06f9cf0972..473c36a57ad 100755 --- a/src/Tizen.NUI/src/public/Visuals/NPatchVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/NPatchVisual.cs @@ -28,7 +28,7 @@ public class NPatchVisual : VisualMap private Rectangle border = null; /// - /// Constructor. + /// Default constructor of NPatchVisual class. /// /// 3 public NPatchVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/PrimitiveVisual.cs b/src/Tizen.NUI/src/public/Visuals/PrimitiveVisual.cs index 7f881adb546..e099479e4a4 100755 --- a/src/Tizen.NUI/src/public/Visuals/PrimitiveVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/PrimitiveVisual.cs @@ -37,7 +37,7 @@ public class PrimitiveVisual : VisualMap private Vector3 _lightPosition = null; /// - /// Constructor. + /// Default constructor of PrimitiveVisual class. /// /// 3 public PrimitiveVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/SVGVisual.cs b/src/Tizen.NUI/src/public/Visuals/SVGVisual.cs index c951cadf415..3e17c88041f 100755 --- a/src/Tizen.NUI/src/public/Visuals/SVGVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/SVGVisual.cs @@ -26,7 +26,7 @@ public class SVGVisual : VisualMap private string url = null; /// - /// Constructor. + /// Default constructor of SVGVisual class. /// /// 3 public SVGVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/TextVisual.cs b/src/Tizen.NUI/src/public/Visuals/TextVisual.cs index b224299d2db..801a9b3a2b7 100755 --- a/src/Tizen.NUI/src/public/Visuals/TextVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/TextVisual.cs @@ -39,7 +39,7 @@ public class TextVisual : VisualMap private PropertyMap background = null; /// - /// Constructor. + /// Default constructor of TextVisual class. /// /// 3 public TextVisual() : base() diff --git a/src/Tizen.NUI/src/public/Visuals/VisualConstants.cs b/src/Tizen.NUI/src/public/Visuals/VisualConstants.cs index ae43965d2e0..16ce53074b1 100755 --- a/src/Tizen.NUI/src/public/Visuals/VisualConstants.cs +++ b/src/Tizen.NUI/src/public/Visuals/VisualConstants.cs @@ -199,7 +199,17 @@ public enum SamplingModeType /// /// For caching algorithms where a client strongly prefers a cache-hit to reuse a cached image. /// - DontCare + DontCare, + /// + /// Use Lanczos resample algorithm. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + Lanczos, + /// + /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8 etc width and height and approximately the desired size, then apply Lanczos resample algorithm. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + BoxThenLanczos, } /// diff --git a/src/Tizen.NUI/src/public/Visuals/VisualFactory.cs b/src/Tizen.NUI/src/public/Visuals/VisualFactory.cs index 7fb9c8d043c..0ca06449da4 100755 --- a/src/Tizen.NUI/src/public/Visuals/VisualFactory.cs +++ b/src/Tizen.NUI/src/public/Visuals/VisualFactory.cs @@ -136,5 +136,45 @@ public void UsePreCompiledShader() Interop.VisualFactory.UsePreCompiledShader(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } + + /// + /// Adds a list of pre-compiled shaders to the visual factory. + /// + /// + /// This API allows you to add the desired precompile shader to the list. + /// you can set it through PropertyMap. + /// you need to know the values for setting well to use them, so please refer to the explanation below. + /// + /// The property map consists of string keys. + /// + /// - shaderType: Set the desired shader type. we provides these type: "image","text","color","3d" and "custom" + /// - shaderOption(propertyMap): Set the desired shader option. we provides these flag: we provides a lot of shader options, so user need to check proper shader option. + /// - vertexShader: Set the vertext shader that user want. this is for custom shader. + /// - fragmentShader: Set the fragment shader that user want. this is for custom shader. + /// - shaderName: if user want to set shader name, use this. this is for custom shader.(optional) + /// + /// (example) + /// PropertyMap imageShader = new PropertyMap(); + /// imageShader.Add("shaderType", new PropertyValue("image")); + /// imageShader.Add("shaderOption", new PropertyValue(new PropertyMap().Add("ROUNDED_CORNER", new PropertyValue(true)) + /// .Add("MASKING", new PropertyValue(true)))); + /// + /// PropertyMap textShader = new PropertyMap(); + /// textShader.Add("shaderType", new PropertyValue("text")); + /// + /// VisualFactory.Instance.AddPrecompileShader(imageShader); + /// VisualFactory.Instance.AddPrecompileShader(textShader); + /// VisualFactory.Instance.UsePreCompiledShader(); + /// + /// The map contains the shader option for precompiling. + /// True if the pre-compiled shader is added, otherwise false. + [EditorBrowsable(EditorBrowsableState.Never)] + public bool AddPrecompileShader(PropertyMap option) + { + bool result = false; + result = Interop.VisualFactory.AddPrecompileShader(SwigCPtr, PropertyMap.getCPtr(option)); + if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); + return result; + } } } diff --git a/src/Tizen.NUI/src/public/Visuals/VisualObject/ImageVisual.cs b/src/Tizen.NUI/src/public/Visuals/VisualObject/ImageVisual.cs index c1f60836f13..2b1c51168e8 100644 --- a/src/Tizen.NUI/src/public/Visuals/VisualObject/ImageVisual.cs +++ b/src/Tizen.NUI/src/public/Visuals/VisualObject/ImageVisual.cs @@ -331,6 +331,28 @@ public ReleasePolicyType ReleasePolicy } } + /// + /// Gets or sets filtering options used when resizing images to the sample original pixels.
+ /// If not supplied, the default is SamplingModeType.BoxThenLinear.
+ /// For normal quad images only.
+ /// Optional. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public SamplingModeType SamplingMode + { + set + { + UpdateVisualProperty((int)Tizen.NUI.ImageVisualProperty.SamplingMode, new PropertyValue((int)value)); + } + get + { + int ret = (int)SamplingModeType.BoxThenLinear; + var propertyValue = GetCachedVisualProperty((int)Tizen.NUI.ImageVisualProperty.SamplingMode); + propertyValue?.Get(out ret); + return (SamplingModeType)ret; + } + } + /// /// Gets or sets the desired image width.
/// If not specified, the actual image width is used.
diff --git a/src/Tizen.NUI/src/public/WebView/WebView.cs b/src/Tizen.NUI/src/public/WebView/WebView.cs index bcbe42dbf9b..afa2f3751cf 100755 --- a/src/Tizen.NUI/src/public/WebView/WebView.cs +++ b/src/Tizen.NUI/src/public/WebView/WebView.cs @@ -164,7 +164,7 @@ static WebView() /// - /// Creates a WebView. + /// Default constructor to create a WebView. /// /// 9 public WebView() : this(Interop.WebView.New(), true) diff --git a/src/Tizen.NUI/src/public/Widget/Widget.cs b/src/Tizen.NUI/src/public/Widget/Widget.cs index ce65cb5cf79..fb2bace9bff 100755 --- a/src/Tizen.NUI/src/public/Widget/Widget.cs +++ b/src/Tizen.NUI/src/public/Widget/Widget.cs @@ -29,7 +29,7 @@ public class Widget : BaseHandle internal WidgetImpl widgetImpl; /// - /// Creates a Widget handle. + /// Default constructor to create a Widget handle. /// /// 4 public Widget() : this(new WidgetImpl(), true) diff --git a/src/Tizen.NUI/src/public/Window/Window.cs b/src/Tizen.NUI/src/public/Window/Window.cs index d00d5ccd577..cf165fce230 100755 --- a/src/Tizen.NUI/src/public/Window/Window.cs +++ b/src/Tizen.NUI/src/public/Window/Window.cs @@ -2582,8 +2582,9 @@ public bool IsModal /// - /// Gets or sets a value indicating whether the window is alwats on top of other windows or not. - /// Its behavior is effective among windows with the same notification level. + /// Gets or sets a value indicating whether the window is always on top of other windows or not. + /// This is valid between windows that have no notification level or a notification level of 'none'. + /// If it has a notification level, this will not do anything. /// [EditorBrowsable(EditorBrowsableState.Never)] public bool IsAlwaysOnTop @@ -2601,6 +2602,27 @@ public bool IsAlwaysOnTop } } + /// + /// Gets or sets a value indicating whether the window is the bottom of other windows or not. + /// If the enable flag is true, this window will be placed below other windows. + /// Otherwise, if it's called with a false value, it will be located above other windows.. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public bool IsBottom + { + get + { + bool ret = Interop.Window.IsBottom(SwigCPtr); + if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); + return ret; + } + set + { + Interop.Window.SetBottom(SwigCPtr, value); + if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); + } + } + /// /// Requests relative motion grab /// diff --git a/src/Tizen.NUI/src/public/Window/WindowEvent.cs b/src/Tizen.NUI/src/public/Window/WindowEvent.cs index 36e7b8427f0..5cb61ef37e4 100755 --- a/src/Tizen.NUI/src/public/Window/WindowEvent.cs +++ b/src/Tizen.NUI/src/public/Window/WindowEvent.cs @@ -97,7 +97,7 @@ public partial class Window /// - /// FocusChanged event. + /// This event is triggered when the focus changes on the window. /// /// 3 public event EventHandler FocusChanged @@ -1402,7 +1402,7 @@ public Touch Touch } /// - /// Wheel event arguments. + /// The Wheel event arguments. /// /// 3 public class WheelEventArgs : EventArgs @@ -1427,7 +1427,7 @@ public Wheel Wheel } /// - /// Key event arguments. + /// The Key event arguments. /// /// 3 public class KeyEventArgs : EventArgs @@ -1478,7 +1478,7 @@ public Size2D WindowSize } /// - /// MouseInOut evnet arguments. + /// The MouseInOut evnet arguments. /// [EditorBrowsable(EditorBrowsableState.Never)] public class MouseInOutEventArgs : EventArgs @@ -1503,7 +1503,7 @@ public MouseInOut MouseInOut } /// - /// MouseRelative evnet arguments. + /// The MouseRelative evnet arguments. /// [EditorBrowsable(EditorBrowsableState.Never)] public class MouseRelativeEventArgs : EventArgs @@ -1529,7 +1529,7 @@ public MouseRelative MouseRelative /// - /// PointerConstraints evnet arguments. + /// The PointerConstraints evnet arguments. /// [EditorBrowsable(EditorBrowsableState.Never)] public class PointerConstraintsEventArgs : EventArgs diff --git a/src/Tizen.NUI/src/public/Xaml/IMarkupExtension.cs b/src/Tizen.NUI/src/public/Xaml/IMarkupExtension.cs index e9709900b9b..7c4e0777fba 100755 --- a/src/Tizen.NUI/src/public/Xaml/IMarkupExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/IMarkupExtension.cs @@ -20,25 +20,25 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IMarkupExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] new T ProvideValue(IServiceProvider serviceProvider); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] object ProvideValue(IServiceProvider serviceProvider); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [AttributeUsage(AttributeTargets.Class, Inherited = false)] [EditorBrowsable(EditorBrowsableState.Never)] public sealed class AcceptEmptyServiceProviderAttribute : Attribute diff --git a/src/Tizen.NUI/src/public/Xaml/IProvideValueTarget.cs b/src/Tizen.NUI/src/public/Xaml/IProvideValueTarget.cs index d2b98879f6c..18864349960 100755 --- a/src/Tizen.NUI/src/public/Xaml/IProvideValueTarget.cs +++ b/src/Tizen.NUI/src/public/Xaml/IProvideValueTarget.cs @@ -19,15 +19,15 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IProvideValueTarget { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] object TargetObject { get; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] object TargetProperty { get; } } diff --git a/src/Tizen.NUI/src/public/Xaml/IReferenceProvider.cs b/src/Tizen.NUI/src/public/Xaml/IReferenceProvider.cs index 08ade5dd2eb..a4f56d46e61 100755 --- a/src/Tizen.NUI/src/public/Xaml/IReferenceProvider.cs +++ b/src/Tizen.NUI/src/public/Xaml/IReferenceProvider.cs @@ -19,11 +19,11 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IReferenceProvider { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] object FindByName(string name); } diff --git a/src/Tizen.NUI/src/public/Xaml/IRootObjectProvider.cs b/src/Tizen.NUI/src/public/Xaml/IRootObjectProvider.cs index f2fb8129996..0746d6b00a3 100755 --- a/src/Tizen.NUI/src/public/Xaml/IRootObjectProvider.cs +++ b/src/Tizen.NUI/src/public/Xaml/IRootObjectProvider.cs @@ -19,11 +19,11 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] internal interface IRootObjectProvider { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] object RootObject { get; } } diff --git a/src/Tizen.NUI/src/public/Xaml/IValueProvider.cs b/src/Tizen.NUI/src/public/Xaml/IValueProvider.cs index d641cf8a1d6..b2f1f2c9386 100755 --- a/src/Tizen.NUI/src/public/Xaml/IValueProvider.cs +++ b/src/Tizen.NUI/src/public/Xaml/IValueProvider.cs @@ -20,11 +20,11 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IValueProvider { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] object ProvideValue(IServiceProvider serviceProvider); } diff --git a/src/Tizen.NUI/src/public/Xaml/IXamlTypeResolver.cs b/src/Tizen.NUI/src/public/Xaml/IXamlTypeResolver.cs index 2d404a36a8e..976468df26f 100755 --- a/src/Tizen.NUI/src/public/Xaml/IXamlTypeResolver.cs +++ b/src/Tizen.NUI/src/public/Xaml/IXamlTypeResolver.cs @@ -20,15 +20,15 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IXamlTypeResolver { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] Type Resolve(string qualifiedTypeName, IServiceProvider serviceProvider = null); - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] bool TryResolve(string qualifiedTypeName, out Type type); } diff --git a/src/Tizen.NUI/src/public/Xaml/IXmlLineInfoProvider.cs b/src/Tizen.NUI/src/public/Xaml/IXmlLineInfoProvider.cs index bf2ff6e7422..60827b0f50b 100755 --- a/src/Tizen.NUI/src/public/Xaml/IXmlLineInfoProvider.cs +++ b/src/Tizen.NUI/src/public/Xaml/IXmlLineInfoProvider.cs @@ -20,11 +20,11 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IXmlLineInfoProvider { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] IXmlLineInfo XmlLineInfo { get; } } diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ApplicationResourcePathExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ApplicationResourcePathExtension.cs index 41349d1e8a0..bc601d22afa 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ApplicationResourcePathExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ApplicationResourcePathExtension.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty(nameof(FilePath))] [AcceptEmptyServiceProvider] diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ArrayExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ArrayExtension.cs index 0300ba64004..62f0a105767 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ArrayExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ArrayExtension.cs @@ -23,28 +23,28 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Items")] [AcceptEmptyServiceProvider] public class ArrayExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public ArrayExtension() { Items = new List(); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IList Items { get; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Type Type { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Array ProvideValue(IServiceProvider serviceProvider) { diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/BindingExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/BindingExtension.cs index efb246c4eea..16f06cd8a7e 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/BindingExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/BindingExtension.cs @@ -22,49 +22,49 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Path")] [AcceptEmptyServiceProvider] public sealed class BindingExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Path { get; set; } = Binding.Binding.SelfPath; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BindingMode Mode { get; set; } = BindingMode.Default; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IValueConverter Converter { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ConverterParameter { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string StringFormat { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object Source { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string UpdateSourceEventName { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object TargetNullValue { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object FallbackValue { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public TypedBindingBase TypedBinding { get; set; } diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/DynamicResourceExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/DynamicResourceExtension.cs index b7482522e9d..7098c1a5a4b 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/DynamicResourceExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/DynamicResourceExtension.cs @@ -22,16 +22,16 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Key")] public sealed class DynamicResourceExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Key { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ProvideValue(IServiceProvider serviceProvider) { diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NUIResourcePathExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NUIResourcePathExtension.cs index 3633f5039cd..9a2e6159116 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NUIResourcePathExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NUIResourcePathExtension.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty(nameof(FilePath))] [AcceptEmptyServiceProvider] diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NullExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NullExtension.cs index d6622d4fedc..f73b019434a 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NullExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/NullExtension.cs @@ -20,13 +20,13 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiled("Tizen.NUI.Xaml.Build.Tasks.NullExtension")] [AcceptEmptyServiceProvider] public class NullExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ProvideValue(IServiceProvider serviceProvider) { diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ReferenceExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ReferenceExtension.cs index f2111e66570..f28357e886a 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ReferenceExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ReferenceExtension.cs @@ -23,16 +23,16 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Name")] public class ReferenceExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Name { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ProvideValue(IServiceProvider serviceProvider) { diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ResourcePathExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ResourcePathExtension.cs index 7c91e61a4e4..a31acf4e5db 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ResourcePathExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/ResourcePathExtension.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty(nameof(FilePath))] [AcceptEmptyServiceProvider] diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/StaticExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/StaticExtension.cs index 09e1cd01317..3ba2f992cdb 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/StaticExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/StaticExtension.cs @@ -24,17 +24,17 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty(nameof(Member))] [ProvideCompiled("Tizen.NUI.Xaml.Build.Tasks.StaticExtension")] public class StaticExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Member { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ProvideValue(IServiceProvider serviceProvider) { diff --git a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/TemplateBindingExtension.cs b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/TemplateBindingExtension.cs index 5dad6fb615e..90250704d34 100755 --- a/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/TemplateBindingExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/MarkupExtensions/TemplateBindingExtension.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Path")] [AcceptEmptyServiceProvider] @@ -33,23 +33,23 @@ internal TemplateBindingExtension() Path = Tizen.NUI.Binding.Binding.SelfPath; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Path { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BindingMode Mode { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IValueConverter Converter { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ConverterParameter { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string StringFormat { get; set; } diff --git a/src/Tizen.NUI/src/public/Xaml/StaticResourceExtension.cs b/src/Tizen.NUI/src/public/Xaml/StaticResourceExtension.cs index 12ee8ed1c69..1beac968047 100755 --- a/src/Tizen.NUI/src/public/Xaml/StaticResourceExtension.cs +++ b/src/Tizen.NUI/src/public/Xaml/StaticResourceExtension.cs @@ -24,16 +24,16 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Key")] public sealed class StaticResourceExtension : IMarkupExtension { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Key { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ProvideValue(IServiceProvider serviceProvider) { diff --git a/src/Tizen.NUI/src/public/Xaml/TypeConversionAttribute.cs b/src/Tizen.NUI/src/public/Xaml/TypeConversionAttribute.cs index 1460e446ca2..36017f3f062 100755 --- a/src/Tizen.NUI/src/public/Xaml/TypeConversionAttribute.cs +++ b/src/Tizen.NUI/src/public/Xaml/TypeConversionAttribute.cs @@ -20,16 +20,16 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [System.AttributeUsage(AttributeTargets.Class, Inherited = true, AllowMultiple = false)] public sealed class TypeConversionAttribute : Attribute { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Type TargetType { get; private set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public TypeConversionAttribute(Type targetType) { diff --git a/src/Tizen.NUI/src/public/Xaml/XamlFilePathAttribute.cs b/src/Tizen.NUI/src/public/Xaml/XamlFilePathAttribute.cs index dcbe7c83023..ca0ff47fde9 100755 --- a/src/Tizen.NUI/src/public/Xaml/XamlFilePathAttribute.cs +++ b/src/Tizen.NUI/src/public/Xaml/XamlFilePathAttribute.cs @@ -23,12 +23,12 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)] public sealed class XamlFilePathAttribute : Attribute { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XamlFilePathAttribute([CallerFilePath] string filePath = "") => FilePath = filePath; diff --git a/src/Tizen.NUI/src/public/Xaml/XamlParseException.cs b/src/Tizen.NUI/src/public/Xaml/XamlParseException.cs index 168bbba6ea6..b3c3624e0d1 100755 --- a/src/Tizen.NUI/src/public/Xaml/XamlParseException.cs +++ b/src/Tizen.NUI/src/public/Xaml/XamlParseException.cs @@ -23,7 +23,7 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class XamlParseException : Exception { @@ -64,7 +64,7 @@ public XamlParseException(string message, Exception innerException = null) : bas unformattedMessage = message; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XamlParseException(string message, IXmlLineInfo xmlInfo, Exception innerException = null) : base(FormatMessage(message + GetStackInfo(), xmlInfo), innerException) { @@ -77,7 +77,7 @@ internal XamlParseException(string message, IServiceProvider serviceProvider, Ex { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IXmlLineInfo XmlInfo { get; private set; } diff --git a/src/Tizen.NUI/src/public/Xaml/XamlResourceIdAttribute.cs b/src/Tizen.NUI/src/public/Xaml/XamlResourceIdAttribute.cs index 15c20fb4480..a50a6baed99 100755 --- a/src/Tizen.NUI/src/public/Xaml/XamlResourceIdAttribute.cs +++ b/src/Tizen.NUI/src/public/Xaml/XamlResourceIdAttribute.cs @@ -21,24 +21,24 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [AttributeUsage(AttributeTargets.Assembly, Inherited = false, AllowMultiple = true)] public sealed class XamlResourceIdAttribute : Attribute { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string ResourceId { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Path { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Type Type { get; set; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XamlResourceIdAttribute(string resourceId, string path, Type type) { diff --git a/src/Tizen.NUI/src/public/Xaml/XamlServiceProvider.cs b/src/Tizen.NUI/src/public/Xaml/XamlServiceProvider.cs index 6c66ccd8643..f0326f1cd09 100755 --- a/src/Tizen.NUI/src/public/Xaml/XamlServiceProvider.cs +++ b/src/Tizen.NUI/src/public/Xaml/XamlServiceProvider.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class XamlServiceProvider : IServiceProvider { @@ -54,7 +54,7 @@ internal XamlServiceProvider(INode node, HydrationContext context) IValueConverterProvider = new ValueConverterProvider(); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XamlServiceProvider() { @@ -97,7 +97,7 @@ internal IValueConverterProvider IValueConverterProvider set { services[typeof(IValueConverterProvider)] = value; } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object GetService(Type serviceType) { @@ -105,7 +105,7 @@ public object GetService(Type serviceType) return services.TryGetValue(serviceType, out service) ? service : null; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void Add(Type type, object service) { @@ -156,21 +156,21 @@ IEnumerable IProvideParentValues.ParentObjects } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class SimpleValueTargetProvider : IProvideParentValues, IProvideValueTarget, IReferenceProvider { readonly object[] objectAndParents; readonly object targetProperty; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [Obsolete("SimpleValueTargetProvider(object[] objectAndParents) is obsolete as of version 2.3.4. Use SimpleValueTargetProvider(object[] objectAndParents, object targetProperty) instead.")] public SimpleValueTargetProvider(object[] objectAndParents) : this(objectAndParents, null) { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public SimpleValueTargetProvider(object[] objectAndParents, object targetProperty) { @@ -192,7 +192,7 @@ object IProvideValueTarget.TargetObject object IProvideValueTarget.TargetProperty => targetProperty; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object FindByName(string name) { @@ -210,7 +210,7 @@ public object FindByName(string name) } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class XamlTypeResolver : IXamlTypeResolver { @@ -218,7 +218,7 @@ public class XamlTypeResolver : IXamlTypeResolver readonly GetTypeFromXmlName getTypeFromXmlName; readonly IXmlNamespaceResolver namespaceResolver; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XamlTypeResolver(IXmlNamespaceResolver namespaceResolver, Assembly currentAssembly) : this(namespaceResolver, XamlParser.GetElementType, currentAssembly) @@ -305,18 +305,18 @@ public XamlRootObjectProvider(object rootObject) public object RootObject { get; } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class XmlLineInfoProvider : IXmlLineInfoProvider { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XmlLineInfoProvider(IXmlLineInfo xmlLineInfo) { XmlLineInfo = xmlLineInfo; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IXmlLineInfo XmlLineInfo { get; } } @@ -341,30 +341,30 @@ public object FindByName(string name) } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ObsoleteAttribute(" ", false)] public class NameScopeProvider : INameScopeProvider { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public INameScope NameScope { get; set; } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class XmlNamespaceResolver : IXmlNamespaceResolver { readonly Dictionary namespaces = new Dictionary(); - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IDictionary GetNamespacesInScope(XmlNamespaceScope scope) { throw new NotImplementedException(); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string LookupNamespace(string prefix) { @@ -374,14 +374,14 @@ public string LookupNamespace(string prefix) return null; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string LookupPrefix(string namespaceName) { throw new NotImplementedException(); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void Add(string prefix, string ns) { diff --git a/src/Tizen.NUI/src/public/Xaml/XmlLineInfo.cs b/src/Tizen.NUI/src/public/Xaml/XmlLineInfo.cs index e7af646fcee..451c4c8b017 100755 --- a/src/Tizen.NUI/src/public/Xaml/XmlLineInfo.cs +++ b/src/Tizen.NUI/src/public/Xaml/XmlLineInfo.cs @@ -20,19 +20,19 @@ namespace Tizen.NUI.Xaml { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class XmlLineInfo : IXmlLineInfo { readonly bool hasLineInfo; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XmlLineInfo() { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XmlLineInfo(int linenumber, int lineposition) { @@ -41,18 +41,18 @@ public XmlLineInfo(int linenumber, int lineposition) LinePosition = lineposition; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool HasLineInfo() { return hasLineInfo; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public int LineNumber { get; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public int LinePosition { get; } } diff --git a/src/Tizen.NUI/src/public/XamlBinding/BindableObjectExtensions.cs b/src/Tizen.NUI/src/public/XamlBinding/BindableObjectExtensions.cs index f011036e33f..89cd54489c6 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/BindableObjectExtensions.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/BindableObjectExtensions.cs @@ -21,11 +21,11 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static class BindableObjectExtensions { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static void SetBinding(this BindableObject self, BindableProperty targetProperty, string path, BindingMode mode = BindingMode.Default, IValueConverter converter = null, string stringFormat = null) diff --git a/src/Tizen.NUI/src/public/XamlBinding/BindablePropertyConverter.cs b/src/Tizen.NUI/src/public/XamlBinding/BindablePropertyConverter.cs index 98a4d4cd1c9..ae38975207d 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/BindablePropertyConverter.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/BindablePropertyConverter.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiled("Tizen.NUI.Xaml.Core.XamlC.BindablePropertyConverter")] [TypeConversion(typeof(BindableProperty))] @@ -92,7 +92,7 @@ object IExtendedTypeConverter.ConvertFromInvariantString(string value, IServiceP throw new XamlParseException($"Can't resolve {value}. Syntax is [[prefix:]Type.]PropertyName.", lineinfo); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override object ConvertFromInvariantString(string value) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Binding.cs b/src/Tizen.NUI/src/public/XamlBinding/Binding.cs index 2e13748227b..098e494d1e9 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Binding.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Binding.cs @@ -27,7 +27,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [SuppressMessage("Microsoft.Design", "CA1724: Type names should not match namespaces")] [EditorBrowsable(EditorBrowsableState.Never)] public sealed class Binding : BindingBase @@ -41,13 +41,13 @@ public sealed class Binding : BindingBase object source; string updateSourceEventName; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Binding() { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Binding(string path, BindingMode mode = BindingMode.Default, IValueConverter converter = null, object converterParameter = null, string stringFormat = null, object source = null) { @@ -64,7 +64,7 @@ public Binding(string path, BindingMode mode = BindingMode.Default, IValueConver Source = source; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IValueConverter Converter { @@ -77,7 +77,7 @@ public IValueConverter Converter } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object ConverterParameter { @@ -90,7 +90,7 @@ public object ConverterParameter } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Path { @@ -104,7 +104,7 @@ public string Path } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object Source { @@ -121,7 +121,7 @@ public object Source } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string UpdateSourceEventName { diff --git a/src/Tizen.NUI/src/public/XamlBinding/BindingBase.cs b/src/Tizen.NUI/src/public/XamlBinding/BindingBase.cs index 49f468b4436..d6ae7b1d617 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/BindingBase.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/BindingBase.cs @@ -42,7 +42,7 @@ internal BindingBase() /// /// Gets or sets the mode for this binding. /// - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BindingMode Mode { @@ -65,7 +65,7 @@ public BindingMode Mode /// /// Gets or sets the string format for this binding. /// - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string StringFormat { @@ -78,7 +78,7 @@ public string StringFormat } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object TargetNullValue { @@ -90,7 +90,7 @@ public object TargetNullValue } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object FallbackValue { @@ -112,7 +112,7 @@ public object FallbackValue /// Stops synchronization on the collection. /// /// The collection on which to stop synchronization. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static void DisableCollectionSynchronization(IEnumerable collection) { @@ -122,7 +122,7 @@ public static void DisableCollectionSynchronization(IEnumerable collection) SynchronizedCollections.Remove(collection); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static void EnableCollectionSynchronization(IEnumerable collection, object context, CollectionSynchronizationCallback callback) { @@ -137,7 +137,7 @@ public static void EnableCollectionSynchronization(IEnumerable collection, objec /// /// Throws an InvalidOperationException if the binding has been applied. /// - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected void ThrowIfApplied() { diff --git a/src/Tizen.NUI/src/public/XamlBinding/BindingTypeConverter.cs b/src/Tizen.NUI/src/public/XamlBinding/BindingTypeConverter.cs index 2c74460a9fc..db86252534a 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/BindingTypeConverter.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/BindingTypeConverter.cs @@ -20,13 +20,13 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiled("Tizen.NUI.Xaml.Core.XamlC.BindingTypeConverter")] [TypeConversion(typeof(Binding))] public sealed class BindingTypeConverter : TypeConverter { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override object ConvertFromInvariantString(string value) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/CollectionSynchronizationCallback.cs b/src/Tizen.NUI/src/public/XamlBinding/CollectionSynchronizationCallback.cs index fa9c27f245d..4c9685a77f9 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/CollectionSynchronizationCallback.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/CollectionSynchronizationCallback.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public delegate void CollectionSynchronizationCallback(IEnumerable collection, object context, Action accessMethod, bool writeAccess); } diff --git a/src/Tizen.NUI/src/public/XamlBinding/ColorTypeConverter.cs b/src/Tizen.NUI/src/public/XamlBinding/ColorTypeConverter.cs index 6b59a3bb076..f45ce4e8a37 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/ColorTypeConverter.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/ColorTypeConverter.cs @@ -22,7 +22,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiled("Tizen.NUI.Xaml.Core.XamlC.ColorTypeConverter")] [TypeConversion(typeof(Color))] @@ -32,7 +32,7 @@ public class ColorTypeConverter : TypeConverter // HEX #rgb, #argb, #rrggbb, #aarrggbb // float array 0.5,0.5,0.5,0.5 // Predefined color case insensitive - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override object ConvertFromInvariantString(string value) { @@ -95,7 +95,7 @@ static uint ToHexD(char c) return (j << 4) | j; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static Color FromRgba(int r, int g, int b, int a) { @@ -106,7 +106,7 @@ public static Color FromRgba(int r, int g, int b, int a) return new Color(red, green, blue, alpha); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static Color FromRgb(int r, int g, int b) { @@ -152,7 +152,7 @@ static Color FromHex(string hex) } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override string ConvertToString(object value) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Command.cs b/src/Tizen.NUI/src/public/XamlBinding/Command.cs index ecc7368902e..5c6fd816965 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Command.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Command.cs @@ -22,11 +22,11 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public sealed class Command : Command { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Command(Action execute) : base(o => @@ -43,7 +43,7 @@ public Command(Action execute) } } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Command(Action execute, Func canExecute) : base(o => @@ -94,7 +94,7 @@ public class Command : ICommand /// Initializes a new instance of the Command class. /// /// An instance to execute when the Command is executed. - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Command(Action execute) { @@ -108,7 +108,7 @@ public Command(Action execute) /// Initializes a new instance of the Command class. /// /// An Action to execute when the Command is executed. - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Command(Action execute) : this(o => execute()) { @@ -121,7 +121,7 @@ public Command(Action execute) : this(o => execute()) /// /// An Action to execute when the Command is executed. /// A instance indicating if the Command can be executed. - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Command(Action execute, Func canExecute) : this(execute) { @@ -136,7 +136,7 @@ public Command(Action execute, Func canExecute) : this(exe /// /// An Action to execute when the Command is executed. /// A instance indicating if the Command can be executed. - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Command(Action execute, Func canExecute) : this(o => execute(), o => canExecute()) { @@ -151,7 +151,7 @@ public Command(Action execute, Func canExecute) : this(o => execute(), o = /// /// An Object used as parameter to determine if the Command can be executed. /// true if the Command can be executed, false otherwise. - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public bool CanExecute(object parameter) { @@ -164,7 +164,7 @@ public bool CanExecute(object parameter) /// /// Occurs when the target of the Command should reevaluate whether or not the Command can be executed. /// - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandler CanExecuteChanged; @@ -172,7 +172,7 @@ public bool CanExecute(object parameter) /// Invokes the execute Action. /// /// An Object used as parameter for the execute Action. - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void Execute(object parameter) { @@ -182,7 +182,7 @@ public void Execute(object parameter) /// /// Send a CanExecuteChanged. /// - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void ChangeCanExecute() { diff --git a/src/Tizen.NUI/src/public/XamlBinding/ElementEventArgs.cs b/src/Tizen.NUI/src/public/XamlBinding/ElementEventArgs.cs index c968b60f9f0..36eef26ebd5 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/ElementEventArgs.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/ElementEventArgs.cs @@ -20,11 +20,11 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class ElementEventArgs : EventArgs { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public ElementEventArgs(Element element) { @@ -34,7 +34,7 @@ public ElementEventArgs(Element element) Element = element; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Element Element { get; private set; } } diff --git a/src/Tizen.NUI/src/public/XamlBinding/FloatGraphicsTypeConverter.cs b/src/Tizen.NUI/src/public/XamlBinding/FloatGraphicsTypeConverter.cs index 1b4dbdecef0..b25c9c278e4 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/FloatGraphicsTypeConverter.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/FloatGraphicsTypeConverter.cs @@ -31,13 +31,13 @@ namespace Tizen.NUI.Binding /// dp, sp suffix is converted to pixel value with Dpi and ScalingFactors by GraphicsTypeManager. /// /// - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiledAttribute("Tizen.NUI.Xaml.Core.XamlC.FloatGraphicsTypeConverter")] public class FloatGraphicsTypeConverter : TypeConverter { /// - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override object ConvertFromInvariantString(string value) { @@ -50,7 +50,7 @@ public override object ConvertFromInvariantString(string value) } /// - /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override string ConvertToString(object value) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/IResourcesProvider.cs b/src/Tizen.NUI/src/public/XamlBinding/IResourcesProvider.cs index c2d473fa7a8..c47edd7bfae 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/IResourcesProvider.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/IResourcesProvider.cs @@ -19,7 +19,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IResourcesProvider { diff --git a/src/Tizen.NUI/src/public/XamlBinding/IValueConverter.cs b/src/Tizen.NUI/src/public/XamlBinding/IValueConverter.cs index 937ff820ab9..907219b6d0f 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/IValueConverter.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/IValueConverter.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IValueConverter { diff --git a/src/Tizen.NUI/src/public/XamlBinding/IntGraphicsTypeConverter.cs b/src/Tizen.NUI/src/public/XamlBinding/IntGraphicsTypeConverter.cs index 4484b008e2f..7e58cdc0a93 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/IntGraphicsTypeConverter.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/IntGraphicsTypeConverter.cs @@ -26,12 +26,12 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiledAttribute("Tizen.NUI.Xaml.Core.XamlC.IntGraphicsTypeConverter")] public class IntGraphicsTypeConverter : TypeConverter { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override object ConvertFromInvariantString(string value) { @@ -43,7 +43,7 @@ public override object ConvertFromInvariantString(string value) throw new InvalidOperationException($"Cannot convert \"{value}\" into {typeof(int)}"); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override string ConvertToString(object value) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Behavior.cs b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Behavior.cs index 2ce1f16b790..28b9f48dde6 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Behavior.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Behavior.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public abstract class Behavior : BindableObject, IAttachedObject { @@ -32,7 +32,7 @@ internal Behavior(Type associatedType) AssociatedType = associatedType; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected Type AssociatedType { get; } @@ -50,30 +50,30 @@ void IAttachedObject.DetachFrom(BindableObject bindable) OnDetachingFrom(bindable); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnAttachedTo(BindableObject bindable) { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnDetachingFrom(BindableObject bindable) { } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public abstract class Behavior : Behavior where T : BindableObject { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected Behavior() : base(typeof(T)) { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected override void OnAttachedTo(BindableObject bindable) { @@ -81,13 +81,13 @@ protected override void OnAttachedTo(BindableObject bindable) OnAttachedTo((T)bindable); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnAttachedTo(T bindable) { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected override void OnDetachingFrom(BindableObject bindable) { @@ -95,7 +95,7 @@ protected override void OnDetachingFrom(BindableObject bindable) base.OnDetachingFrom(bindable); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnDetachingFrom(T bindable) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/BindingCondition.cs b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/BindingCondition.cs index 23c6692e533..77c72edfa46 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/BindingCondition.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/BindingCondition.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiled("Tizen.NUI.Xaml.Core.XamlC.PassthroughValueProvider")] [AcceptEmptyServiceProvider] @@ -32,14 +32,14 @@ public sealed class BindingCondition : Condition, IValueProvider BindingBase binding; object triggerValue; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BindingCondition() { boundProperty = BindableProperty.CreateAttached("Bound", typeof(object), typeof(BindingCondition), null, propertyChanged: OnBoundPropertyChanged); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BindingBase Binding { @@ -54,7 +54,7 @@ public BindingBase Binding } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object Value { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Condition.cs b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Condition.cs index dd1c2a37cb3..53f2bd7d11e 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Condition.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/Condition.cs @@ -20,7 +20,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public abstract class Condition { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/DataTrigger.cs b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/DataTrigger.cs index c8ab3ece116..9363c843408 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/DataTrigger.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/DataTrigger.cs @@ -22,20 +22,20 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Setters")] [ProvideCompiled("Tizen.NUI.Xaml.Core.XamlC.PassthroughValueProvider")] [AcceptEmptyServiceProvider] public sealed class DataTrigger : TriggerBase, IValueProvider { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public DataTrigger([TypeConverter(typeof(TypeTypeConverter))][Parameter("TargetType")] Type targetType) : base(new BindingCondition(), targetType) { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BindingBase Binding { @@ -52,14 +52,14 @@ public BindingBase Binding } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public new IList Setters { get { return base.Setters; } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [Obsolete("This has been deprecated in API9 and will be removed in API11. Use GetValue() instead.")] public object Value diff --git a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/EventTrigger.cs b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/EventTrigger.cs index 983f073faca..9aaa9cbf9a7 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/EventTrigger.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/EventTrigger.cs @@ -23,7 +23,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Actions")] public sealed class EventTrigger : TriggerBase @@ -36,18 +36,18 @@ public sealed class EventTrigger : TriggerBase string eventname; Delegate handlerdelegate; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public EventTrigger() : base(typeof(BindableObject)) { Actions = new SealedList(); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IList Actions { get; } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Event { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/MultiTrigger.cs b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/MultiTrigger.cs index 58fbe534ff7..a3d3f299320 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/MultiTrigger.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/MultiTrigger.cs @@ -21,25 +21,25 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ContentProperty("Setters")] public sealed class MultiTrigger : TriggerBase { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public MultiTrigger([TypeConverter(typeof(TypeTypeConverter))][Parameter("TargetType")] Type targetType) : base(new MultiCondition(), targetType) { } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public IList Conditions { get { return ((MultiCondition)Condition).Conditions; } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public new IList Setters { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/XamlPropertyCondition.cs b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/XamlPropertyCondition.cs index 8389ca2b3a1..b2a3b2e14ee 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Interactivity/XamlPropertyCondition.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Interactivity/XamlPropertyCondition.cs @@ -22,7 +22,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ProvideCompiled("Tizen.NUI.Core.XamlC.PassthroughValueProvider")] [AcceptEmptyServiceProvider] @@ -33,14 +33,14 @@ public sealed class XamlPropertyCondition : Condition, IValueProvider BindableProperty property; object triggerValue; - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public XamlPropertyCondition() { stateProperty = BindableProperty.CreateAttached("State", typeof(bool), typeof(XamlPropertyCondition), false, propertyChanged: OnStatePropertyChanged); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public BindableProperty Property { @@ -62,7 +62,7 @@ public BindableProperty Property } } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public object Value { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Internals/DynamicResource.cs b/src/Tizen.NUI/src/public/XamlBinding/Internals/DynamicResource.cs index 328476f7520..b1707e1107b 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Internals/DynamicResource.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Internals/DynamicResource.cs @@ -19,18 +19,18 @@ namespace Tizen.NUI.Binding.Internals { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class DynamicResource { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public DynamicResource(string key) { Key = key; } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public string Key { get; private set; } } diff --git a/src/Tizen.NUI/src/public/XamlBinding/Internals/IDynamicResourceHandler.cs b/src/Tizen.NUI/src/public/XamlBinding/Internals/IDynamicResourceHandler.cs index aaa96de5d11..e44de49018f 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Internals/IDynamicResourceHandler.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Internals/IDynamicResourceHandler.cs @@ -20,11 +20,11 @@ namespace Tizen.NUI.Binding.Internals { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface IDynamicResourceHandler { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] void SetDynamicResource(BindableProperty targetProperty, string key); } diff --git a/src/Tizen.NUI/src/public/XamlBinding/Internals/INameScope.cs b/src/Tizen.NUI/src/public/XamlBinding/Internals/INameScope.cs index 31175cb903c..2616768dbb1 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Internals/INameScope.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Internals/INameScope.cs @@ -21,23 +21,23 @@ namespace Tizen.NUI.Binding.Internals { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public interface INameScope { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] object FindByName(string name); - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] void RegisterName(string name, object scopedElement); - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] void UnregisterName(string name); - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] [ObsoleteAttribute(" ", false)] void RegisterName(string name, object scopedElement, IXmlLineInfo xmlLineInfo); diff --git a/src/Tizen.NUI/src/public/XamlBinding/Internals/NameScope.cs b/src/Tizen.NUI/src/public/XamlBinding/Internals/NameScope.cs index 69f9683242d..13e9ca75f3a 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Internals/NameScope.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Internals/NameScope.cs @@ -24,11 +24,11 @@ namespace Tizen.NUI.Binding.Internals { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class NameScope : INameScope { - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindableProperty NameScopeProperty = BindableProperty.CreateAttached("NameScope", typeof(INameScope), typeof(NameScope), default(INameScope)); @@ -97,7 +97,7 @@ void INameScope.UnregisterName(string name) names.Remove(name); } - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static INameScope GetNameScope(BindableObject bindable) { @@ -105,7 +105,7 @@ public static INameScope GetNameScope(BindableObject bindable) } /// Thrown when bindable is null. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static void SetNameScope(BindableObject bindable, INameScope value) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/NameScopeExtensions.cs b/src/Tizen.NUI/src/public/XamlBinding/NameScopeExtensions.cs index a83d1265cff..4a10f440d90 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/NameScopeExtensions.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/NameScopeExtensions.cs @@ -21,11 +21,11 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static class NameScopeExtensions { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static T FindByName(this Element element, string name) { @@ -52,7 +52,7 @@ internal static void PopElement() /// /// Used to find the object defined in Xaml file. /// - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static T FindByNameInCurrentNameScope(string name) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/PointSizeTypeConverter.cs b/src/Tizen.NUI/src/public/XamlBinding/PointSizeTypeConverter.cs index 8e6a8707159..44852b61618 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/PointSizeTypeConverter.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/PointSizeTypeConverter.cs @@ -31,7 +31,7 @@ namespace Tizen.NUI.Binding [ProvideCompiledAttribute("Tizen.NUI.Xaml.Core.XamlC.PointSizeTypeConverter")] public class PointSizeTypeConverter : TypeConverter { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override object ConvertFromInvariantString(string value) { @@ -43,7 +43,7 @@ public override object ConvertFromInvariantString(string value) throw new InvalidOperationException($"Cannot convert \"{value}\" into {typeof(float)}"); } - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public override string ConvertToString(object value) { diff --git a/src/Tizen.NUI/src/public/XamlBinding/Registrar.cs b/src/Tizen.NUI/src/public/XamlBinding/Registrar.cs index 8bc42b0e86c..bf5e11fbaa7 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/Registrar.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/Registrar.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI.Binding.Internals /// For internal use. /// /// - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class Registrar where TRegistrable : class { @@ -37,7 +37,7 @@ public class Registrar where TRegistrable : class /// /// The type of the view /// The type of the render. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void Register(Type tview, Type trender) { @@ -78,7 +78,7 @@ internal TRegistrable GetHandler(Type type, params object[] args) /// The type of the handler /// The type. /// The handler instance. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public TOut GetHandler(Type type) where TOut : TRegistrable { @@ -92,7 +92,7 @@ public TOut GetHandler(Type type) where TOut : TRegistrable /// The type. /// The args of the type /// The handler instance. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public TOut GetHandler(Type type, params object[] args) where TOut : TRegistrable { @@ -105,7 +105,7 @@ public TOut GetHandler(Type type, params object[] args) where TOut : TRegi /// The type /// The object instance. /// The handle of the obj. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public TOut GetHandlerForObject(object obj) where TOut : TRegistrable { @@ -125,7 +125,7 @@ public TOut GetHandlerForObject(object obj) where TOut : TRegistrable /// The object instance /// The args of the type /// The handler of the object. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public TOut GetHandlerForObject(object obj, params object[] args) where TOut : TRegistrable { @@ -143,7 +143,7 @@ public TOut GetHandlerForObject(object obj, params object[] args) where TO /// /// The view type. /// The type of the handle. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Type GetHandlerType(Type viewType) { @@ -185,7 +185,7 @@ public Type GetHandlerType(Type viewType) /// /// The object instance. /// The type of the handler. - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Type GetHandlerTypeForObject(object obj) { @@ -221,7 +221,7 @@ bool LookupHandlerType(Type viewType, out Type handlerType) /// /// For internal use /// - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static class Registrar { @@ -231,7 +231,7 @@ static Registrar() internal static Dictionary Effects { get; } = new Dictionary(); - /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public static IEnumerable ExtraAssemblies { get; set; } } diff --git a/src/Tizen.NUI/src/public/XamlBinding/ResourceDictionary.cs b/src/Tizen.NUI/src/public/XamlBinding/ResourceDictionary.cs index 10510906cc9..0e7c088662f 100755 --- a/src/Tizen.NUI/src/public/XamlBinding/ResourceDictionary.cs +++ b/src/Tizen.NUI/src/public/XamlBinding/ResourceDictionary.cs @@ -29,7 +29,7 @@ namespace Tizen.NUI.Binding { - /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. + /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public class ResourceDictionary : IResourceDictionary, IDictionary { @@ -39,7 +39,7 @@ public class ResourceDictionary : IResourceDictionary, IDictionary