projects / platform / core / csapi / tizenfx.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: c98a4c5)
[NUI] Make APIs of WebView editor-browsable
authorhuayong.xu <huayong.xu@samsung.com>
Wed, 8 Sep 2021 05:46:45 +0000 (13:46 +0800)
committerSeoyeon2Kim <34738918+Seoyeon2Kim@users.noreply.github.com>
Mon, 13 Sep 2021 07:33:23 +0000 (16:33 +0900)
src/Tizen.NUI/src/public/WebView/WebPageLoadError.cs [moved from src/Tizen.NUI/src/internal/WebView/WebPageLoadError.cs with 75% similarity] patch | blob | history
src/Tizen.NUI/src/public/WebView/WebView.cs [moved from src/Tizen.NUI/src/internal/WebView/WebView.cs with 98% similarity] patch | blob | history
src/Tizen.NUI/src/public/WebView/WebViewPageLoadErrorEventArgs.cs [moved from src/Tizen.NUI/src/internal/WebView/WebViewPageLoadErrorEventArgs.cs with 91% similarity] patch | blob | history
src/Tizen.NUI/src/public/WebView/WebViewPageLoadEventArgs.cs [moved from src/Tizen.NUI/src/internal/WebView/WebViewPageLoadEventArgs.cs with 91% similarity] patch | blob | history

diff --git a/src/Tizen.NUI/src/internal/WebView/WebPageLoadError.cs b/src/Tizen.NUI/src/public/WebView/WebPageLoadError.cs
similarity index 75%
rename from src/Tizen.NUI/src/internal/WebView/WebPageLoadError.cs
rename to src/Tizen.NUI/src/public/WebView/WebPageLoadError.cs
index 6d46c1c..3be4091 100755 (executable)
--- a/src/Tizen.NUI/src/internal/WebView/WebPageLoadError.cs
+++ b/src/Tizen.NUI/src/public/WebView/WebPageLoadError.cs
@@ -23,7 +23,7 @@ namespace Tizen.NUI
     /// <summary>
     /// It is a class for load error of page of web view.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public class WebPageLoadError : Disposable
     {
         internal WebPageLoadError(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
@@ -41,159 +41,136 @@ namespace Tizen.NUI
         /// <summary>
         /// Enumeration for the load error type
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public enum ErrorType
         {
             /// <summary>
             /// None.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             None,
 
             /// <summary>
             /// Internal error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Internal,
 
             /// <summary>
             /// Network error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Network,
 
             /// <summary>
             /// Policy error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Policy,
 
             /// <summary>
             /// Plugin error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Plugin,
 
             /// <summary>
             /// Download error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Download,
 
             /// <summary>
             /// Print error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Print,
         }
 
         /// <summary>
         /// Enumeration for the load error code
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public enum ErrorCode
         {
             /// <summary>
             /// Unknown.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Unknown,
 
             /// <summary>
             /// User canceled.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Canceled,
 
             /// <summary>
             /// Can't show the page for this MIME type.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             CantSupportMimetype,
 
             /// <summary>
             /// File IO error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             FailedFileIo,
 
             /// <summary>
             /// Cannot connect to the network.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             CannotConnect,
 
             /// <summary>
             /// Fail to look up host from the DNS.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             CannotLookupHost,
 
             /// <summary>
             /// Fail to SSL/TLS handshake.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             FailedTlsHandshake,
 
             /// <summary>
             /// Received certificate is invalid.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             InvalidCertificate,
 
             /// <summary>
             /// Connection timeout.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             RequestTimeout,
 
             /// <summary>
             /// Too many redirects.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             TooManyRedirects,
 
             /// <summary>
             /// Too many requests during this load.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             TooManyRequests,
 
             /// <summary>
             /// Malformed URL.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             BadUrl,
 
             /// <summary>
             /// Unsupported scheme.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             UnsupportedScheme,
 
             /// <summary>
             /// User authentication failed on the server.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Authentication,
 
             /// <summary>
             /// Web server has an internal server error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             InternalServer,
 
             /// <summary>
             /// Other error.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             Other,
         }
 
         /// <summary>
         /// Queries failing URL for this error.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public string Url
         {
             get
@@ -205,7 +182,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Queries code for this error.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public ErrorCode Code
         {
             get
@@ -217,7 +194,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Queries description for this error.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public string Description
         {
             get
@@ -229,7 +206,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Queries type for this error.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public ErrorType Type
         {
             get
diff --git a/src/Tizen.NUI/src/internal/WebView/WebView.cs b/src/Tizen.NUI/src/public/WebView/WebView.cs
similarity index 98%
rename from src/Tizen.NUI/src/internal/WebView/WebView.cs
rename to src/Tizen.NUI/src/public/WebView/WebView.cs
index e96f3d0..3662aed 100755 (executable)
--- a/src/Tizen.NUI/src/internal/WebView/WebView.cs
+++ b/src/Tizen.NUI/src/public/WebView/WebView.cs
@@ -24,9 +24,9 @@ using Tizen.NUI.Binding;
 namespace Tizen.NUI.BaseComponents
 {
     /// <summary>
-    /// WebView
+    /// WebView allows presenting content with embedded web browser, both local files and remote websites.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public class WebView : View
     {
         private Color contentBackgroundColor;
@@ -90,17 +90,17 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// Creates a WebView.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public WebView() : this(Interop.WebView.New(), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }
 
         /// <summary>
-        /// Creates a WebView with local language and time zone.
-        /// <param name="locale">The locale language of Web</param>
-        /// <param name="timezoneId">The time zone Id of Web</param>
+        /// Creates a WebView with locale and time-zone.
         /// </summary>
+        /// <param name="locale">The specified locale</param>
+        /// <param name="timezoneId">The specified time-zone ID</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public WebView(string locale, string timezoneId) : this(Interop.WebView.New2(locale, timezoneId), true)
         {
@@ -109,9 +109,9 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// Creates a WebView with an args list.
-        /// <param name="args">args array. The first value of array must be program's name.</param>
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <param name="args">Arguments passed into web engine. The first value of array must be program's name.</param>
+        /// <since_tizen> 9 </since_tizen>
         public WebView(string[] args) : this(Interop.WebView.New3(args?.Length ?? 0, args), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -119,9 +119,9 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// Copy constructor.
-        /// <param name="webView">WebView to copy. The copied WebView will point at the same implementation</param>
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <param name="webView">WebView to copy. The copied WebView will point at the same implementation</param>
+        /// <since_tizen> 9 </since_tizen>
         public WebView(WebView webView) : this(Interop.WebView.NewWebView(WebView.getCPtr(webView)), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -280,7 +280,7 @@ namespace Tizen.NUI.BaseComponents
         /// Event for the PageLoadStarted signal which can be used to subscribe or unsubscribe the event handler.<br />
         /// This signal is emitted when page loading has started.<br />
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public event EventHandler<WebViewPageLoadEventArgs> PageLoadStarted
         {
             add
@@ -303,7 +303,7 @@ namespace Tizen.NUI.BaseComponents
         /// Event for the PageLoading signal which can be used to subscribe or unsubscribe the event handler.<br />
         /// This signal is emitted when page loading is in progress.<br />
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public event EventHandler<WebViewPageLoadEventArgs> PageLoading
         {
             add
@@ -326,7 +326,7 @@ namespace Tizen.NUI.BaseComponents
         /// Event for the PageLoadFinished signal which can be used to subscribe or unsubscribe the event handler.<br />
         /// This signal is emitted when page loading has finished.<br />
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public event EventHandler<WebViewPageLoadEventArgs> PageLoadFinished
         {
             add
@@ -349,7 +349,7 @@ namespace Tizen.NUI.BaseComponents
         /// Event for the PageLoadError signal which can be used to subscribe or unsubscribe the event handler.<br />
         /// This signal is emitted when there's an error in page loading.<br />
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public event EventHandler<WebViewPageLoadErrorEventArgs> PageLoadError
         {
             add
@@ -738,9 +738,9 @@ namespace Tizen.NUI.BaseComponents
         public WebSettings Settings { get; }
 
         /// <summary>
-        /// The url to load.
+        /// The URL to load.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public string Url
         {
             get
@@ -789,7 +789,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The user agent string.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public string UserAgent
         {
             get
@@ -1051,7 +1051,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// Gets title of web page.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public string Title
         {
             get
@@ -1063,7 +1063,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// Gets favicon of web page.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public ImageView Favicon
         {
             get
@@ -1112,7 +1112,7 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// Gets percentage of loading progress.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public float LoadProgressPercentage
         {
             get
@@ -1375,9 +1375,15 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// Loads a html.
-        /// <param name="url">The path of Web</param>
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <param name="url">The path of Web</param>
+        /// <remarks>
+        /// The following privileges are required:
+        /// http://tizen.org/privilege/internet for remote web pages of websites.
+        /// http://tizen.org/privilege/mediastorage for local files in media storage.
+        /// http://tizen.org/privilege/externalstorage for local files in external storage.
+        /// </remarks>
+        /// <since_tizen> 9 </since_tizen>
         public void LoadUrl(string url)
         {
             Interop.WebView.LoadUrl(SwigCPtr, url);
@@ -1397,9 +1403,9 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// Loads a html by string.
-        /// <param name="data">The data of Web</param>
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <param name="data">The data of Web</param>
+        /// <since_tizen> 9 </since_tizen>
         public void LoadHtmlString(string data)
         {
             Interop.WebView.LoadHtmlString(SwigCPtr, data);
diff --git a/src/Tizen.NUI/src/internal/WebView/WebViewPageLoadErrorEventArgs.cs b/src/Tizen.NUI/src/public/WebView/WebViewPageLoadErrorEventArgs.cs
similarity index 91%
rename from src/Tizen.NUI/src/internal/WebView/WebViewPageLoadErrorEventArgs.cs
rename to src/Tizen.NUI/src/public/WebView/WebViewPageLoadErrorEventArgs.cs
index 54ed03f..11c32a0 100755 (executable)
--- a/src/Tizen.NUI/src/internal/WebView/WebViewPageLoadErrorEventArgs.cs
+++ b/src/Tizen.NUI/src/public/WebView/WebViewPageLoadErrorEventArgs.cs
@@ -23,7 +23,7 @@ namespace Tizen.NUI
     /// <summary>
     /// Event arguments that passed via the WebView.PageLoadError.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public class WebViewPageLoadErrorEventArgs : EventArgs
     {
         internal WebViewPageLoadErrorEventArgs(WebPageLoadError error)
@@ -34,7 +34,7 @@ namespace Tizen.NUI
         /// <summary>
         /// The load error of current web page.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public WebPageLoadError PageLoadError { get; }
     }
 }
diff --git a/src/Tizen.NUI/src/internal/WebView/WebViewPageLoadEventArgs.cs b/src/Tizen.NUI/src/public/WebView/WebViewPageLoadEventArgs.cs
similarity index 91%
rename from src/Tizen.NUI/src/internal/WebView/WebViewPageLoadEventArgs.cs
rename to src/Tizen.NUI/src/public/WebView/WebViewPageLoadEventArgs.cs
index 7707981..e9bc917 100755 (executable)
--- a/src/Tizen.NUI/src/internal/WebView/WebViewPageLoadEventArgs.cs
+++ b/src/Tizen.NUI/src/public/WebView/WebViewPageLoadEventArgs.cs
@@ -24,14 +24,14 @@ namespace Tizen.NUI
     /// <summary>
     /// Event arguments that passed via the WebView.PageLoadStarted or WebView.PageLoadFinished.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public class WebViewPageLoadEventArgs : EventArgs
     {
         private WebView _webView;
         private string _pageUrl;
 
         /// <summary>
-        /// The view for displaying webpages.
+        /// Deprecated. The view for displaying webpages.
         /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public WebView WebView
@@ -47,7 +47,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// The url string of current webpage.
+        /// Deprecated. The URL of current web page.
         /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public string PageUrl
Domain: Dotnet / Frameworks;