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