Release 4.0.0-preview1-00184
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Applications.WidgetApplication.xml
1 <?xml version="1.0"?>
2 <doc>
3     <assembly>
4         <name>Tizen.Applications.WidgetApplication</name>
5     </assembly>
6     <members>
7         <member name="T:Tizen.Applications.WidgetApplication">
8             <summary>
9             Represents a widget application.
10             </summary>
11         </member>
12         <member name="M:Tizen.Applications.WidgetApplication.#ctor(System.Collections.Generic.IDictionary{System.Type,System.String})">
13             <summary>
14             Initializes the WidgetApplication class with the type and application ID.
15             </summary>
16             <param name="typeInfo">Map structure for the derived class type and widget ID.</param>
17         </member>
18         <member name="M:Tizen.Applications.WidgetApplication.#ctor(System.Type)">
19             <summary>
20             Initializes the WidgetApplication class with the type.
21             </summary>
22             <remarks>Widget ID will be replaced as the application ID.</remarks>
23             <param name="type">Derived class type.</param>
24         </member>
25         <member name="M:Tizen.Applications.WidgetApplication.GetInstances(System.Type)">
26             <summary>
27             Gets all instances of the widget associated with the type.
28             </summary>
29             <param name="type">Class type for the widget.</param>
30         </member>
31         <member name="M:Tizen.Applications.WidgetApplication.Run(System.String[])">
32             <summary>
33             Runs the widget application's main loop.
34             </summary>
35             <param name="args">Arguments from the commandline.</param>
36         </member>
37         <member name="T:Tizen.Applications.WidgetBase">
38             <summary>
39             The abstract class for widget instances.
40             </summary>
41         </member>
42         <member name="F:Tizen.Applications.WidgetBase.Window">
43             <summary>
44             Window object for this widget instance.
45             It will be created after OnCreate method is invoked.
46             </summary>
47         </member>
48         <member name="T:Tizen.Applications.WidgetBase.WidgetDestroyType">
49             <summary>
50             Delete type.
51             </summary>
52         </member>
53         <member name="F:Tizen.Applications.WidgetBase.WidgetDestroyType.Permanent">
54             <summary>
55             User deleted this widget from the viewer.
56             </summary>
57         </member>
58         <member name="F:Tizen.Applications.WidgetBase.WidgetDestroyType.Temporary">
59             <summary>
60             Widget is deleted because of other reasons. (For example, widget process is terminated temporarily by the system)
61             </summary>
62         </member>
63         <member name="M:Tizen.Applications.WidgetBase.#ctor">
64             <summary>
65             Constructor.
66             </summary>
67         </member>
68         <member name="M:Tizen.Applications.WidgetBase.SetContent(Tizen.Applications.Bundle)">
69             <summary>
70             Sets the content information to the widget.
71             </summary>
72             <param name="info">The data set to save.</param>
73             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
74             <exception cref="T:System.NotSupportedException">Thrown when the API is not supported in this device.</exception>
75             <exception cref="T:System.InvalidOperationException">Thrown in case of an unrecoverable error.</exception>
76         </member>
77         <member name="M:Tizen.Applications.WidgetBase.SetTitle(System.String)">
78             <summary>
79             Sends the title to the widget.
80             </summary>
81             <param name="title">When an accessibility mode is turned on, this string will be read.</param>
82             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
83             <exception cref="T:System.NotSupportedException">Thrown when the API is not supported in this device.</exception>
84             <exception cref="T:System.InvalidOperationException">Thrown in case of an unrecoverable error.</exception>
85         </member>
86         <member name="M:Tizen.Applications.WidgetBase.Exit">
87             <summary>
88             Finishes the context for the widget instance.
89             </summary>
90             <exception cref="T:System.NotSupportedException">Thrown when the API is not supported in this device.</exception>
91             <exception cref="T:System.InvalidOperationException">Thrown in case of an unrecoverable error.</exception>
92         </member>
93         <member name="M:Tizen.Applications.WidgetBase.OnCreate(Tizen.Applications.Bundle,System.Int32,System.Int32)">
94             <summary>
95             Overrides this method if want to handle the behavior when the widget instance is started.
96             </summary>
97             <param name="content">The data set for the previous status.</param>
98             <param name="w">The pixel value for the widget width.</param>
99             <param name="h">The pixel value for the widget height.</param>
100         </member>
101         <member name="M:Tizen.Applications.WidgetBase.OnDestroy(Tizen.Applications.WidgetBase.WidgetDestroyType,Tizen.Applications.Bundle)">
102             <summary>
103             Overrides this method if want to handle the behavior when the widget instance is destroyed.
104             </summary>
105             <param name="reason">The reason for destruction.</param>
106             <param name="content">The data set to save.</param>
107         </member>
108         <member name="M:Tizen.Applications.WidgetBase.OnPause">
109             <summary>
110             Overrides this method if want to handle the behavior when the widget instance is paused.
111             </summary>
112         </member>
113         <member name="M:Tizen.Applications.WidgetBase.OnResume">
114             <summary>
115             Overrides this method if want to handle the behavior when the widget instance is resumed.
116             </summary>
117         </member>
118         <member name="M:Tizen.Applications.WidgetBase.OnResize(System.Int32,System.Int32)">
119             <summary>
120             Overrides this method if want to handle the behavior when the widget instance is resized.
121             </summary>
122             <param name="w">Widget width.</param>
123             <param name="h">Widget height.</param>
124         </member>
125         <member name="M:Tizen.Applications.WidgetBase.OnUpdate(Tizen.Applications.Bundle,System.Boolean)">
126             <summary>
127             Overrides this method if want to handle the behavior when the widget instance is updated.
128             </summary>
129             <param name="content">The data set for updating this widget will be provided by the requester.</param>
130             <param name="isForce">Although the widget is paused, if it is true, the widget can be updated.</param>
131         </member>
132     </members>
133 </doc>