[ElmSharp] Fix XML documentation warnings.
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / AccessibleRelation.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17
18 namespace ElmSharp.Accessible
19 {
20     /// <summary>
21     /// IAccessibleRelation is a interface which defines the relationship between two accessible objects.
22     /// </summary>
23     public interface IAccessibleRelation
24     {
25
26         /// <summary>
27         /// Gets or sets the target object.
28         /// </summary>
29         AccessibleObject Target { get; set; }
30
31         /// <summary>
32         /// Gets the type.
33         /// </summary>
34         int Type { get; }
35     }
36
37     /// <summary>
38     /// To define label info for accessible object.
39     /// </summary>
40     public class LabelledBy : IAccessibleRelation
41     {
42         /// <summary>
43         /// Gets or sets the target object which is LabelledBy.
44         /// </summary>
45         public AccessibleObject Target { get; set; }
46
47         /// <summary>
48         /// Gets the LabelledBy type.
49         /// </summary>
50         public int Type
51         {
52             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_LABELLED_BY; }
53         }
54     }
55
56     /// <summary>
57     /// To define label info for accessible object.
58     /// </summary>
59     public class LabelFor : IAccessibleRelation
60     {
61         /// <summary>
62         /// Gets or sets the target object which is LabelFor.
63         /// </summary>
64         public AccessibleObject Target { get; set; }
65
66         /// <summary>
67         /// Gets the LabelFor type.
68         /// </summary>
69         public int Type
70         {
71             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_LABEL_FOR; }
72         }
73     }
74
75     /// <summary>
76     /// To define control relationship for accessible object.
77     /// </summary>
78     public class ControllerFor : IAccessibleRelation
79     {
80         /// <summary>
81         /// Gets or sets the target object which is ControllerFor.
82         /// </summary>
83         public AccessibleObject Target { get; set; }
84
85         /// <summary>
86         /// Gets the ControllerFor type.
87         /// </summary>
88         public int Type
89         {
90             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_CONTROLLER_FOR; }
91         }
92     }
93
94     /// <summary>
95     /// To define control relationship for accessible object.
96     /// </summary>
97     public class ControlledBy : IAccessibleRelation
98     {
99         /// <summary>
100         /// Gets or sets the target object which is ControlledBy.
101         /// </summary>
102         public AccessibleObject Target { get; set; }
103
104         /// <summary>
105         /// Gets the ControlledBy type.
106         /// </summary>
107         public int Type
108         {
109             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_CONTROLLED_BY; }
110         }
111     }
112
113     /// <summary>
114     /// To define member relationship for accessible object.
115     /// </summary>
116     public class MemberOf : IAccessibleRelation
117     {
118         /// <summary>
119         /// Gets or sets the target object which is MemberOf.
120         /// </summary>
121         public AccessibleObject Target { get; set; }
122
123         /// <summary>
124         /// Gets the MemberOf type.
125         /// </summary>
126         public int Type
127         {
128             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_MEMBER_OF; }
129         }
130     }
131
132     /// <summary>
133     /// To define tooltip for accessible object.
134     /// </summary>
135     public class TooltipFor : IAccessibleRelation
136     {
137         /// <summary>
138         /// Gets or sets the target object which is TooltipFor.
139         /// </summary>
140         public AccessibleObject Target { get; set; }
141
142         /// <summary>
143         /// Gets the TooltipFor type.
144         /// </summary>
145         public int Type
146         {
147             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_TOOLTIP_FOR; }
148         }
149     }
150
151     /// <summary>
152     /// To define child for accessible object.
153     /// </summary>
154     public class ChildOf : IAccessibleRelation
155     {
156         /// <summary>
157         /// Gets or sets the target object which is ChildOf.
158         /// </summary>
159         public AccessibleObject Target { get; set; }
160
161         /// <summary>
162         /// Gets the ChildOf type.
163         /// </summary>
164         public int Type
165         {
166             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_NODE_CHILD_OF; }
167         }
168     }
169
170     /// <summary>
171     /// To define parent for accessible object.
172     /// </summary>
173     public class ParentOf : IAccessibleRelation
174     {
175         /// <summary>
176         /// Gets or sets the target object which is ParentOf.
177         /// </summary>
178         public AccessibleObject Target { get; set; }
179
180         /// <summary>
181         /// Gets the ParentOf type.
182         /// </summary>
183         public int Type
184         {
185             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_NODE_PARENT_OF; }
186         }
187     }
188
189     /// <summary>
190     /// To define extend for accessible object.
191     /// </summary>
192     public class Extended : IAccessibleRelation
193     {
194         /// <summary>
195         /// Gets or sets the target object which is Extended.
196         /// </summary>
197         public AccessibleObject Target { get; set; }
198
199         /// <summary>
200         /// Gets the Extended type.
201         /// </summary>
202         public int Type
203         {
204             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_EXTENDED; }
205         }
206     }
207
208     /// <summary>
209     /// To define the custom reading order.
210     /// </summary>
211     public class FlowsTo : IAccessibleRelation
212     {
213         /// <summary>
214         /// Gets or sets the target object which is FlowsTo.
215         /// </summary>
216         public AccessibleObject Target { get; set; }
217
218         /// <summary>
219         /// Gets the FlowsTo type.
220         /// </summary>
221         public int Type
222         {
223             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_FLOWS_TO; }
224         }
225     }
226
227     /// <summary>
228     /// To define the custom reading order.
229     /// </summary>
230     public class FlowsFrom : IAccessibleRelation
231     {
232         /// <summary>
233         /// Gets or sets the target object which is FlowsFrom.
234         /// </summary>
235         public AccessibleObject Target { get; set; }
236
237         /// <summary>
238         /// Gets the FlowsFrom type.
239         /// </summary>
240         public int Type
241         {
242             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_FLOWS_FROM; }
243         }
244     }
245
246     /// <summary>
247     /// To define subwindow for accessible object.
248     /// </summary>
249     public class SubwindowOf : IAccessibleRelation
250     {
251         /// <summary>
252         /// Gets or sets the target object which is SubwindowOf.
253         /// </summary>
254         public AccessibleObject Target { get; set; }
255
256         /// <summary>
257         /// Gets the SubwindowOf type.
258         /// </summary>
259         public int Type
260         {
261             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_SUBWINDOW_OF; }
262         }
263     }
264
265     /// <summary>
266     /// To define embed for accessible object.
267     /// </summary>
268     public class Embeds : IAccessibleRelation
269     {
270         /// <summary>
271         /// Gets or sets the target object which is Embeds.
272         /// </summary>
273         public AccessibleObject Target { get; set; }
274
275         /// <summary>
276         /// Gets the Embeds type.
277         /// </summary>
278         public int Type
279         {
280             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_EMBEDS; }
281         }
282     }
283
284     /// <summary>
285     /// To define embed for accessible object.
286     /// </summary>
287     public class EmbeddedBy : IAccessibleRelation
288     {
289         /// <summary>
290         /// Gets or sets the target object which is EmbeddedBy.
291         /// </summary>
292         public AccessibleObject Target { get; set; }
293
294         /// <summary>
295         /// Gets the EmbeddedBy type.
296         /// </summary>
297         public int Type
298         {
299             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_EMBEDDED_BY; }
300         }
301     }
302
303     /// <summary>
304     /// To define popup for accessible object.
305     /// </summary>
306     public class PopupFor : IAccessibleRelation
307     {
308         /// <summary>
309         /// Gets or sets the target object which is PopupFor.
310         /// </summary>
311         public AccessibleObject Target { get; set; }
312
313         /// <summary>
314         /// Gets the PopupFor type.
315         /// </summary>
316         public int Type
317         {
318             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_POPUP_FOR; }
319         }
320     }
321
322     /// <summary>
323     /// To define parent window for accessible object.
324     /// </summary>
325     public class ParentWindowOf : IAccessibleRelation
326     {
327         /// <summary>
328         /// Gets or sets the target object which is ParentWindowOf.
329         /// </summary>
330         public AccessibleObject Target { get; set; }
331
332         /// <summary>
333         /// Gets the ParentWindowOf type.
334         /// </summary>
335         public int Type
336         {
337             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_PARENT_WINDOW_OF; }
338         }
339     }
340
341     /// <summary>
342     /// To define description for accessible object.
343     /// </summary>
344     public class DescriptionFor : IAccessibleRelation
345     {
346         /// <summary>
347         /// Gets or sets the target object which is DescriptionFor.
348         /// </summary>
349         public AccessibleObject Target { get; set; }
350
351         /// <summary>
352         /// Gets the DescriptionFor type.
353         /// </summary>
354         public int Type
355         {
356             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_DESCRIPTION_FOR; }
357         }
358     }
359
360     /// <summary>
361     /// To define description for accessible object.
362     /// </summary>
363     public class DescribedBy : IAccessibleRelation
364     {
365         /// <summary>
366         /// Gets or sets the target object which is DescribedBy.
367         /// </summary>
368         public AccessibleObject Target { get; set; }
369
370         /// <summary>
371         /// Gets the DescribedBy type.
372         /// </summary>
373         public int Type
374         {
375             get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_DESCRIBED_BY; }
376         }
377     }
378 }