Class WidgetBase
Definition
- Namespace:
- Tizen.Applications
- Assembly:
- Tizen.Applications.WidgetApplication.dll
The abstract class for widget instances.
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public abstract class WidgetBase
- Inheritance
-
objectWidgetBase
Constructors
View SourceWidgetBase()
Constructor.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public WidgetBase()
Fields
View SourceWindow
Window object for this widget instance. It will be created after OnCreate method is invoked.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
protected Window Window
Field Value
Type | Description |
---|---|
Window |
Properties
View SourceId
ID for this widget instance. It will be created after OnCreate method is invoked.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public string Id { get; }
Property Value
Type | Description |
---|---|
string |
Methods
View SourceExit()
Finishes the context for the widget instance.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public void Exit()
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the API is not supported in this device. |
System.InvalidOperationException | Thrown in case of an unrecoverable error. |
OnCreate(Bundle, int, int)
Overrides this method if want to handle the behavior when the widget instance is started.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public virtual void OnCreate(Bundle content, int w, int h)
Parameters
Type | Name | Description |
---|---|---|
Bundle | content | The data set for the previous status. |
int | w | The pixel value for the widget width. |
int | h | The pixel value for the widget height. |
OnDestroy(WidgetDestroyType, Bundle)
Overrides this method if want to handle the behavior when the widget instance is destroyed.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public virtual void OnDestroy(WidgetBase.WidgetDestroyType reason, Bundle content)
Parameters
Type | Name | Description |
---|---|---|
WidgetBase.WidgetDestroyType | reason | The reason for destruction. |
Bundle | content | The data set to save. |
OnPause()
Overrides this method if want to handle the behavior when the widget instance is paused.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public virtual void OnPause()
OnResize(int, int)
Overrides this method if want to handle the behavior when the widget instance is resized.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public virtual void OnResize(int w, int h)
Parameters
Type | Name | Description |
---|---|---|
int | w | Widget width. |
int | h | Widget height. |
OnResume()
Overrides this method if want to handle the behavior when the widget instance is resumed.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public virtual void OnResume()
OnUpdate(Bundle, bool)
Overrides this method if want to handle the behavior when the widget instance is updated.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public virtual void OnUpdate(Bundle content, bool isForce)
Parameters
Type | Name | Description |
---|---|---|
Bundle | content | The data set for updating this widget will be provided by the requester. |
bool | isForce | Although the widget is paused, if it is true, the widget can be updated. |
SetContent(Bundle)
Sets the content information to the widget.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public void SetContent(Bundle info)
Parameters
Type | Name | Description |
---|---|---|
Bundle | info | The data set to save. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when failed because of an invalid argument. |
System.NotSupportedException | Thrown when the API is not supported in this device. |
System.InvalidOperationException | Thrown in case of an unrecoverable error. |
SetTitle(string)
Sends the title to the widget.
Declaration
[Obsolete("Deprecated since API10. Will be removed in API12.")]
public void SetTitle(string title)
Parameters
Type | Name | Description |
---|---|---|
string | title | When an accessibility mode is turned on, this string will be read. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when failed because of an invalid argument. |
System.NotSupportedException | Thrown when the API is not supported in this device. |
System.InvalidOperationException | Thrown in case of an unrecoverable error. |