-
Notifications
You must be signed in to change notification settings - Fork 241
/
EditablesContainer.cs
350 lines (316 loc) · 13.8 KB
/
EditablesContainer.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/*
* Copyright (c) 2018 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Collections.Generic;
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
/// Represents the editables container for a watch application.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public abstract class EditablesContainer : IDisposable
{
internal IList<DesignElement> _deList = new List<DesignElement>();
internal IList<Complication> _compList = new List<Complication>();
internal IntPtr _container = IntPtr.Zero;
private Interop.WatchfaceComplication.EditableUpdateRequestedCallback _editableUpdatedCallback;
private readonly Interop.WatchfaceComplication.EditReadyCallback _editReadyCallback;
private bool _disposed = false;
private static string _logTag = "WatchfaceComplication";
/// <summary>
/// Initializes the EditablesContainer class.
/// </summary>
/// <exception cref="ArgumentException">Thrown when some parameter are invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
/// <since_tizen> 6 </since_tizen>
protected EditablesContainer()
{
_editReadyCallback = new Interop.WatchfaceComplication.EditReadyCallback(EditReady);
ComplicationError err = Interop.WatchfaceComplication.AddEditReadyCallback(_editReadyCallback, IntPtr.Zero);
if (err != ComplicationError.None)
ErrorFactory.ThrowException(err, "Fail to add edit ready callback");
Log.Debug(_logTag, "Edit container ready");
}
/// <summary>
/// Destructor of the EditablesContainer class.
/// </summary>
~EditablesContainer()
{
Dispose(false);
}
/// <summary>
/// Adds the DesignElement to edit list.
/// </summary>
/// <param name="de">The DesignElement object.</param>
/// <param name="editableId">The editable id.</param>
/// <exception cref="ArgumentException">Thrown when the invalid parameter is passed.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <since_tizen> 6 </since_tizen>
public void Add(DesignElement de, int editableId)
{
if (de == null)
ErrorFactory.ThrowException(ComplicationError.InvalidParam);
if (IsExist(editableId))
ErrorFactory.ThrowException(ComplicationError.ExistID);
IEditable e = de;
e.EditableId = editableId;
_deList.Add(de);
}
/// <summary>
/// Adds the Complication to edit list.
/// </summary>
/// <param name="comp">The Complication object.</param>
/// <param name="editableId">The editable id.</param>
/// <exception cref="ArgumentException">Thrown when the invalid parameter is passed.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <since_tizen> 6 </since_tizen>
public void Add(Complication comp, int editableId)
{
if (comp == null)
ErrorFactory.ThrowException(ComplicationError.InvalidParam);
if (IsExist(editableId))
ErrorFactory.ThrowException(ComplicationError.ExistID);
IEditable e = comp;
e.EditableId = editableId;
_compList.Add(comp);
}
/// <summary>
/// Removes the editable from edit list.
/// </summary>
/// <param name="editableId">The editable id.</param>
/// <exception cref="ArgumentException">Thrown when the invalid parameter is passed.</exception>
/// <example>
/// <code>
/// if (myContainer.IsExist(_colorEditId)
/// myContainer.Remove(_colorEditId);
/// </code>
/// </example>
/// <since_tizen> 6 </since_tizen>
public void Remove(int editableId)
{
foreach (DesignElement de in _deList)
{
if (((IEditable)de).EditableId == editableId)
{
_deList.Remove(de);
return;
}
}
foreach (Complication comp in _compList)
{
if (((IEditable)comp).EditableId == editableId)
{
_compList.Remove(comp);
return;
}
}
ErrorFactory.ThrowException(ComplicationError.InvalidParam, "invalid editable ID");
}
internal IEditable GetEditable(int editableId)
{
foreach (IEditable ed in _deList)
{
if (ed.EditableId == editableId)
return ed;
}
foreach (IEditable ed in _compList)
{
if (ed.EditableId == editableId)
return ed;
}
return null;
}
internal DesignElement GetDesignElement(int editableId)
{
foreach (DesignElement de in _deList)
{
IEditable ed = de;
if (ed.EditableId == editableId)
return de;
}
return null;
}
/// <summary>
/// Checks whether editableId already exists in edit list.
/// </summary>
/// <param name="editableId">The target editable Id.</param>
/// <returns>true if the editable already exists in edit list, otherwise false</returns>
/// <since_tizen> 6 </since_tizen>
public bool IsExist(int editableId)
{
return (GetEditable(editableId) != null);
}
private void EditReady(IntPtr container, string editorAppid, IntPtr userData)
{
OnEditReady(editorAppid);
}
private void EditableUpdatedCallback(IntPtr handle, int selectedIdx,
int state, IntPtr userData)
{
int editableId;
ComplicationError err = Interop.WatchfaceComplication.GetEditableId(handle, out editableId);
if (err != ComplicationError.None)
ErrorFactory.ThrowException(err, "fail to get current index");
int currentIdx;
err = Interop.WatchfaceComplication.GetCurrentIdx(handle, out currentIdx);
if (err != ComplicationError.None)
ErrorFactory.ThrowException(err, "fail to get current index");
DesignElement de = GetDesignElement(editableId);
if (de != null)
{
de.SetCurrentDataIndex(currentIdx);
de.NotifyUpdate(currentIdx, (State)state);
}
}
/// <summary>
/// Requests edit to editor application.
/// </summary>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when the application does not have privilege to access this method.</exception>
/// <example>
/// <code>
/// public class MyContainer : EditablesContainer {
/// public MyContainer() : base()
/// {
/// }
/// protected override void OnEditReady(string editorId)
/// {
/// this.RequestEdit();
/// }
/// }
/// </code>
/// </example>
/// <since_tizen> 6 </since_tizen>
public void RequestEdit()
{
Log.Debug(_logTag, "request edit");
ComplicationError ret;
Interop.WatchfaceComplication.GetEditableContainer(out _container);
if (_container == IntPtr.Zero)
{
ErrorFactory.ThrowException(ComplicationError.EditNotReady, "Editor not ready");
}
if (_editableUpdatedCallback == null)
_editableUpdatedCallback = new Interop.WatchfaceComplication.EditableUpdateRequestedCallback(EditableUpdatedCallback);
foreach (Complication comp in _compList)
{
IEditable e = comp;
IntPtr hi = IntPtr.Zero;
if (e.Highlight != null && e.Highlight.Raw != IntPtr.Zero)
hi = e.Highlight.Raw;
Interop.WatchfaceComplication.AddComplication(_container, e.EditableId, comp._handle, hi);
}
foreach (DesignElement de in _deList)
{
IEditable e = de;
IntPtr candidates;
Interop.WatchfaceComplication.CreateCandidatesList(out candidates);
foreach (Bundle b in de.Candidates)
{
Interop.WatchfaceComplication.AddCandidatesListItem(candidates, b.SafeBundleHandle);
}
IntPtr hi = IntPtr.Zero;
if (e.Highlight != null && e.Highlight.Raw != IntPtr.Zero)
hi = e.Highlight.Raw;
Interop.WatchfaceComplication.AddDesignElement(_container, e.EditableId, e.GetCurrentDataIndex(), candidates, hi, e.Name);
Log.Debug(_logTag, "Add design element done :" + e.Name);
}
ret = Interop.WatchfaceComplication.RequestEdit(_container, _editableUpdatedCallback, IntPtr.Zero);
if (ret != ComplicationError.None)
{
ErrorFactory.ThrowException(ret, "Request edit fail");
}
}
/// <summary>
/// Overrides this method if you want to handle the behavior when the editor is ready to edit.
/// </summary>
/// <param name="editorId">The appid of ready to edit editor.</param>
/// <since_tizen> 6 </since_tizen>
protected abstract void OnEditReady(string editorId);
/// <summary>
/// Loads the editable's current data.
/// </summary>
/// <returns>The editable's latest data that selected by editor.</returns>
/// <exception cref="ArgumentException">Thrown when some parameter are invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
/// <remarks>
/// This method loads the last editable data which is updated by editor application.
/// </remarks>
/// <param name="editableId">The id of the editable.</param>
/// <example>
/// <code>
/// internal void InitEditables()
/// {
/// _container = new MyContainer();
/// Bundle curData = EditablesContainer.LoadCurrentData(_colorEditId);
/// List<Bundle> candidatesList = new List<Bundle>();
/// int curIdx = 0;
/// int i = 0;
/// foreach (string str in _colorArr)
/// {
/// Bundle data = new Bundle();
/// data.AddItem(_colorKey, str);
/// candidatesList.Add(data);
/// if (curData != null && curData.GetItem(_colorKey) != null
/// && curData.GetItem(_colorKey).Equals(str))
/// {
/// curIdx = i;
/// }
/// i++;
/// }
/// ColorDesign colorEdit = new ColorDesign(candidatesList, curIdx, "COLOR", _complicationBtn);
/// colorEdit.Highlight = new Highlight(ShapeType.Circle, 0, 40, 10, 10);
/// _container.Add(colorEdit, _colorEditId);
/// }
/// </code>
/// </example>
/// <since_tizen> 6 </since_tizen>
public static Bundle LoadCurrentData(int editableId)
{
SafeBundleHandle handle;
ComplicationError err = Interop.WatchfaceComplication.LoadCurrentData(editableId, out handle);
if (err == ComplicationError.None)
return new Bundle(handle);
return null;
}
/// <summary>
/// Releases the unmanaged resources used by the EditablesContainer class specifying whether or not to perform a normal dispose operation.
/// </summary>
/// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
/// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (!_disposed)
{
Interop.WatchfaceComplication.RemoveEditReadyCallback(_editReadyCallback);
_disposed = true;
}
}
/// <summary>
/// Releases all resources used by the EditablesContainer instance.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
};
}