namespace Tizen.Applications
{
/// <summary>
- /// Represents proxy class for widget application.
+ /// Represents the proxy class for the widget application.
/// </summary>
public class RemoteView
{
/// <summary>
- /// Event types to send.
+ /// The event types to send.
/// </summary>
public enum Event
{
FeedMouseUp,
/// <summary>
- /// Type for cancelling click event procedure.
+ /// Type for canceling the click event procedure.
/// </summary>
CancelClick
}
/// <summary>
- /// Layout object including preview image, overlay text, loading text and remote screen image.
+ /// Layout object including preview image, overlay text, loading text, and remote screen image.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
public Layout Layout { get; internal set; }
/// <summary>
- /// Widget ID.
+ /// The widget ID.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
public string Id
}
/// <summary>
- /// Update period.
+ /// The update period.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
public double Period
}
/// <summary>
- /// Contents of widget.
+ /// Contents of the widget.
/// </summary>
/// <remarks>
- /// This string can be used for creating contents of widget again after rebooting a device or it can be recovered from crash(abnormal status).
+ /// This string can be used for creating contents of the widget again after rebooting a device or it can be recovered from a crash (abnormal status).
/// </remarks>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
public string Content
}
/// <summary>
- /// Pauses all connected widget applications.
+ /// Pauses all the connected widget applications.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
public static void PauseAll()
{
CheckException(Interop.WidgetViewerEvas.NotifyPausedStatusOfViewer());
}
/// <summary>
- /// Resumes all connected widget applications.
+ /// Resumes all the connected widget applications.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device<./exception>
public static void ResumeAll()
{
CheckException(Interop.WidgetViewerEvas.NotifyResumedStatusOfViewer());
/// Pauses the widget application which is connected on this proxy.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
public void Pause()
{
CheckException(Interop.WidgetViewerEvas.PauseWidget(Layout));
/// Resumes the widget application which is connected on this proxy.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
public void Resume()
{
CheckException(Interop.WidgetViewerEvas.ResumeWidget(Layout));
}
/// <summary>
- /// Sends event to the widget application which is connected on this proxy.
+ /// Sends the event to the widget application which is connected on this proxy.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
public void SendEvent(Event ev)
{
switch (ev)
namespace Tizen.Applications
{
/// <summary>
- /// Represents a factory class for making RemoveView objects.
+ /// Represents a factory class for making the RemoteView objects.
/// </summary>
public static class RemoteViewFactory
{
/// All the remote views will be located in the specified window object.
/// </param>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
public static void Init(EvasObject win)
{
if (_ready)
}
/// <summary>
- /// Creates RemoteView object.
+ /// Creates a RemoteView object.
/// </summary>
- /// <param name="parent">Parent object</param>
- /// <param name="widgetId">Widget ID</param>
- /// <param name="content">Contents that will be given to the widget instance</param>
- /// <param name="period">Update period</param>
- /// <param name="previewImage">True if you want to show preview image</param>
- /// <param name="overlayText">True if you want to show overlay text</param>
- /// <param name="loadingMessage">True if you want to show loading message</param>
+ /// <param name="parent">Parent object.</param>
+ /// <param name="widgetId">Widget ID.</param>
+ /// <param name="content">Contents that will be given to the widget instance.</param>
+ /// <param name="period">Update period.</param>
+ /// <param name="previewImage">True if you want to show the preview image.</param>
+ /// <param name="overlayText">True if you want to show the overlay text.</param>
+ /// <param name="loadingMessage">True if you want to show the loading message.</param>
/// <returns>RemoteView object.</returns>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
public static RemoteView Create(EvasObject parent, string widgetId, string content, double period,
bool previewImage = true, bool overlayText = true, bool loadingMessage = true)
{
}
/// <summary>
- /// Finalizes RemoteViewFactory.
+ /// Finalizes the RemoteViewFactory.
/// </summary>
/// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
- /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
- /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+ /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
public static void Shutdown()
{
if (!_ready)