namespace Tizen.WebView
{
/// <summary>
- /// This class provides methods to initialize and shutdown Chromium-efl.
+ /// This class provides the methods to initialize and shutdown the Chromium-efl.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Chromium
{
/// <summary>
- /// Initializes Chromium's instance.
+ /// Initializes the Chromium's instance.
/// </summary>
- /// <returns>A reference count of Chromium's instance</returns>
+ /// <returns>A reference count of the Chromium's instance.</returns>
/// <since_tizen> 4 </since_tizen>
public static int Initialize()
{
}
/// <summary>
- /// Decreases a reference count of WebKit's instance, possibly destroying it.
+ /// Decreases a reference count of the WebKit's instance, possibly destroying it.
/// </summary>
- /// <returns>A reference count of Chromium's instance</returns>
+ /// <returns>A reference count of the Chromium's instance.</returns>
/// <since_tizen> 4 </since_tizen>
public static int Shutdown()
{
namespace Tizen.WebView
{
/// <summary>
- /// Enumeration that contains option for cache model.
+ /// Enumeration for cache model options.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CacheModel
/// </summary>
DocumentViewer,
/// <summary>
- /// Use bigger cache capacity than DocumentBrowser.
+ /// Use the bigger cache capacity than DocumentBrowser.
/// </summary>
DocumentBrowser,
/// <summary>
}
/// <summary>
- /// This class encapsulates all pages related to the specific use of Chromium-efl.
+ /// This class encapsulates all the pages related to the specific use of the Chromium-efl.
/// </summary>
/// <remarks>
/// Applications have the option of creating a context different from the default one and using it for a group of pages.
/// <summary>
/// Gets the CookieManager object for this context.
/// </summary>
- /// <returns>The CookieManager object</returns>
+ /// <returns>The CookieManager object.</returns>
/// <since_tizen> 4 </since_tizen>
public CookieManager GetCookieManager()
{
namespace Tizen.WebView
{
/// <summary>
- /// Enumeration that contains accept policies for the cookies.
+ /// Enumeration for the cookies accept policies.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CookieAcceptPolicy
/// </summary>
Always,
/// <summary>
- /// Rejects all cookies.
+ /// Rejects all the cookies.
/// </summary>
Never,
/// <summary>
- /// Accepts only cookies set by the main document loaded.
+ /// Accepts only cookies set by the main document that is loaded.
/// </summary>
NoThirdParty
}
/// <summary>
- /// Enumeration that creates a type name for the storage of persistent cookies.
+ /// Enumeration for creating a type name for the storage of persistent cookies.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CookiePersistentStorage
/// Sets the cookie acceptance policy.
/// </summary>
/// <remarks>
- /// By default, only cookies set by the main document loaded are accepted.
+ /// By default, only cookies set by the main document that is loaded, are accepted.
/// </remarks>
- /// <param name="policy">The cookie acceptance policy</param>
+ /// <param name="policy">The cookie acceptance policy.</param>
/// <since_tizen> 4 </since_tizen>
public void SetCookieAcceptPolicy(CookieAcceptPolicy policy)
{
}
/// <summary>
- /// Sets the storage where non-session cookies are stored persistently to read/write the cookies.
+ /// Sets the storage where the non-session cookies are stored persistently, to read/write the cookies.
/// </summary>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
- /// <param name="path">The path where to read/write Cookies</param>
- /// <param name="storage">The type of storage</param>
+ /// <param name="path">The path where to read/write cookies.</param>
+ /// <param name="storage">The type of storage.</param>
/// <since_tizen> 4 </since_tizen>
public void SetPersistentStorage(string path, CookiePersistentStorage storage)
{
/// <summary>
/// The callback function that is invoked when the message is received from the script.
/// </summary>
- /// <param name="message">The JavaScriptMessage returned by the script</param>
+ /// <param name="message">The JavaScriptMessage returned by the script.</param>
/// <since_tizen> 4 </since_tizen>
public delegate void JavaScriptMessageHandler(JavaScriptMessage message);
/// <summary>
- /// A Script message contains information that sent from JavaScript runtime.
+ /// A script message contains information that is sent from the JavaScript runtime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class JavaScriptMessage
}
/// <summary>
- /// Obect name in JavaScript.
+ /// The object name in JavaScript.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string Name
}
/// <summary>
- /// Gets the value of body as integer type.
+ /// Gets the value of the body as an integer type.
/// </summary>
- /// <returns>The value of body as integer type</returns>
+ /// <returns>The value of the body as an integer type.</returns>
/// <since_tizen> 4 </since_tizen>
public int GetBodyAsInteger()
{
}
/// <summary>
- /// Gets the value of body as double type.
+ /// Gets the value of the body as a double type.
/// </summary>
- /// <returns>The value of body as double type</returns>
+ /// <returns>The value of the body as a double type.</returns>
/// <since_tizen> 4 </since_tizen>
public double GetBodyAsDouble()
{
}
/// <summary>
- /// Gets the value of body as boolean type.
+ /// Gets the value of the body as a boolean type.
/// </summary>
- /// <returns>The value of body as boolean type</returns>
+ /// <returns>The value of the body as boolean type.</returns>
/// <since_tizen> 4 </since_tizen>
public bool GetBodyAsBoolean()
{
}
/// <summary>
- /// Gets the value of body as string type.
+ /// Gets the value of the body as a string type.
/// </summary>
- /// <returns>The value of body as string type</returns>
+ /// <returns>The value of the body as a string type.</returns>
/// <since_tizen> 4 </since_tizen>
public string GetBodyAsString()
{
namespace Tizen.WebView
{
/// <summary>
- /// This class provides properties for setting the preference of a specific WebView.
+ /// This class provides the properties for setting the preference of a specific WebView.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class Settings
}
/// <summary>
- /// Whether JavaScript can be executable.
+ /// Whether the JavaScript can be executed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool JavaScriptEnabled
}
/// <summary>
- /// Whether images can be loaded automatically.
+ /// Whether the images can be loaded automatically.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool LoadImageAutomatically
namespace Tizen.WebView
{
/// <summary>
- /// Argument from the SmartCallback.
+ /// The argument from the SmartCallback.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SmartCallbackArgs : EventArgs
}
/// <summary>
- /// Gets argument as integer type.
+ /// Gets the argument as an integer type.
/// </summary>
- /// <returns>Argument as integer type</returns>
+ /// <returns>Argument as an integer type.</returns>
/// <since_tizen> 4 </since_tizen>
public int GetAsInteger()
{
}
/// <summary>
- /// Gets argument as double type.
+ /// Gets the argument as a double type.
/// </summary>
- /// <returns>Argument as double type</returns>
+ /// <returns>Argument as a double type.</returns>
/// <since_tizen> 4 </since_tizen>
public double GetAsDouble()
{
}
/// <summary>
- /// Gets argument as boolean type.
+ /// Gets the argument as a boolean type.
/// </summary>
- /// <returns>Argument as boolean type</returns>
+ /// <returns>Argument as a boolean type.</returns>
/// <since_tizen> 4 </since_tizen>
public bool GetAsBoolean()
{
}
/// <summary>
- /// Gets argument as string type.
+ /// Gets the argument as a string type.
/// </summary>
- /// <returns>Argument as string type</returns>
+ /// <returns>Argument as a string type.</returns>
/// <since_tizen> 4 </since_tizen>
public string GetAsString()
{
namespace Tizen.WebView
{
/// <summary>
- /// Enumeration that provides an option to error codes.
+ /// Enumeration for providing an option to the error codes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum LoadErrorCode
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown = 0,
/// <summary>
- /// User canceled
+ /// User canceled.
/// </summary>
Canceled,
/// <summary>
- /// Can't show page for this MIME Type.
+ /// Can't show the page for this MIME type.
/// </summary>
CantSupportMimetype,
/// <summary>
- /// File IO error
+ /// File IO error.
/// </summary>
FailedFileIo,
/// <summary>
- /// Cannot connect to network.
+ /// Cannot connect to the network.
/// </summary>
CantConnect,
/// <summary>
- /// Fail to look up host from DNS.
+ /// Fail to look up host from the DNS.
/// </summary>
CantLookupHost,
/// <summary>
/// </summary>
InvalidCertificate,
/// <summary>
- /// Connection timeout
+ /// Connection timeout.
/// </summary>
RequestTimeout,
/// <summary>
- /// Too many redirects
+ /// Too many redirects.
/// </summary>
TooManyRedirects,
/// <summary>
- /// Too many requests during this load
+ /// Too many requests during this load.
/// </summary>
TooManyRequests,
/// <summary>
- /// Malformed url
+ /// Malformed URL.
/// </summary>
BadUrl,
/// <summary>
- /// Unsupported scheme
+ /// Unsupported scheme.
/// </summary>
UnsupportedScheme,
/// <summary>
- /// User authentication failed on server
+ /// User authentication failed on the server.
/// </summary>
Authentication,
/// <summary>
- /// Web server has internal server error.
+ /// Web server has an internal server error.
/// </summary>
InternalServer,
}
/// <summary>
- /// Argument from the LoadError SmartCallback.
+ /// Arguments from the LoadError SmartCallback.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class SmartCallbackLoadErrorArgs : EventArgs
namespace Tizen.WebView
{
/// <summary>
- /// A view used to render web contents.
+ /// A view used to render the web contents.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class WebView: EvasObject
/// <summary>
- /// Event that occurs when load started.
+ /// Event that occurs when the load is started.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler LoadStarted;
/// <summary>
- /// Event that occurs when load finished.
+ /// Event that occurs when the load is finished.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler LoadFinished;
/// <summary>
- /// Event that occurs when load error.
+ /// Event that occurs when the load throws an error.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<SmartCallbackLoadErrorArgs> LoadError;
/// <summary>
- /// Event that occurs when title of main frame was changed.
+ /// Event that occurs when the title of the main frame is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<SmartCallbackArgs> TitleChanged;
/// <summary>
- /// Event that occurs when URL of main frame was changed.
+ /// Event that occurs when the URL of the main frame is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<SmartCallbackArgs> UrlChanged;
}
/// <summary>
- /// Create a WebView object.
+ /// Creates a WebView object.
/// </summary>
- /// <param name="parent">Parent object of WebView</param>
+ /// <param name="parent">Parent object of the WebView.</param>
/// <since_tizen> 4 </since_tizen>
public WebView(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Gets the Context object of this view.
+ /// Gets the context object of this view.
/// </summary>
- /// <returns>The Context object of this view</returns>
+ /// <returns>The context object of this view.</returns>
/// <since_tizen> 4 </since_tizen>
public Context GetContext()
{
}
/// <summary>
- /// Gets the Settings object of this view.
+ /// Gets the settings object of this view.
/// </summary>
- /// <returns>The Settings object of this view</returns>
+ /// <returns>The settings object of this view.</returns>
/// <since_tizen> 4 </since_tizen>
public Settings GetSettings()
{
/// Asks the object to load the given URL.
/// </summary>
/// <remarks>
- /// You can only be sure that url changed after UrlChanged event.
+ /// You can only be sure that the URL changes after UrlChanged event.
/// </remarks>
- /// <param name="url">The uniform resource identifier to load</param>
+ /// <param name="url">The uniform resource identifier to load.</param>
/// <since_tizen> 4 </since_tizen>
public void LoadUrl(string url)
{
}
/// <summary>
- /// Loads the specified html string as the content of the view.
+ /// Loads the specified HTML string as the content of the view.
/// </summary>
- /// <param name="html">HTML data to load</param>
- /// <param name="baseUrl">Base URL used for relative paths to external objects</param>
+ /// <param name="html">HTML data to load.</param>
+ /// <param name="baseUrl">Base URL used for relative paths to external objects.</param>
/// <since_tizen> 4 </since_tizen>
public void LoadHtml(string html, string baseUrl)
{
}
/// <summary>
- /// Checks whether it is possible to navigate backwards one item in history.
+ /// Checks whether it is possible to navigate backward one item in history.
/// </summary>
- /// <returns>Whether it is possible to navigate backwards one item in history</returns>
+ /// <returns>Whether it is possible to navigate backward one item in history.</returns>
/// <since_tizen> 4 </since_tizen>
public bool CanGoBack()
{
}
/// <summary>
- /// Checks whether it is possible to navigate forwards one item in history.
+ /// Checks whether it is possible to navigate forward one item in history.
/// </summary>
- /// <returns>Whether it is possible to navigate forwards one item in history</returns>
+ /// <returns>Whether it is possible to navigate forward one item in history.</returns>
/// <since_tizen> 4 </since_tizen>
public bool CanGoForward()
{
/// <summary>
/// Injects the supplied javascript message handler into the view.
/// </summary>
- /// <param name="name"> The message callback</param>
- /// <param name="handler">The name used to expose the object in JavaScript</param>
- /// <returns>'true' on success, otherwise 'false'</returns>
+ /// <param name="name"> The message callback.</param>
+ /// <param name="handler">The name used to expose the object in JavaScript.</param>
+ /// <returns>'true' on success, otherwise 'false'.</returns>
/// <since_tizen> 4 </since_tizen>
public bool AddJavaScriptMessageHandler(string name, JavaScriptMessageHandler handler)
{
}
/// <summary>
- /// Requests the execution of given name and result to the JavaScript runtime.
+ /// Requests the execution of a given name and the result to the JavaScript runtime.
/// </summary>
- /// <param name="name">The name used to expose the object in JavaScript</param>
- /// <param name="result">The result to the JavaScript runtime</param>
+ /// <param name="name">The name used to expose the object in JavaScript.</param>
+ /// <param name="result">The result to the JavaScript runtime.</param>
/// <since_tizen> 4 </since_tizen>
public void EvalWithResult(string name, string result)
{
/// <summary>
/// Requests the execution of the given script.
/// </summary>
- /// <param name="script">The JavaScript code string to execute</param>
+ /// <param name="script">The JavaScript code string to execute.</param>
/// <since_tizen> 4 </since_tizen>
public void Eval(string script)
{
/// <summary>
/// Requests to set or unset a view as the currently focused one.
/// </summary>
- /// <param name="focused">'true' to set the focus on the view, 'false' to remove the focus from the view</param>
+ /// <param name="focused">'true' to set the focus on the view, 'false' to remove the focus from the view.</param>
/// <since_tizen> 4 </since_tizen>
public void SetFocus(bool focused)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>IntPtr of the widget handle</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>IntPtr of the widget handle.</returns>
/// <since_tizen> 4 </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
projects / platform / core / csapi / tizenfx.git / commitdiff