Repository navigation
Expand file tree
/
Copy pathcef_values.h
More file actions
471 lines (406 loc) · 14.1 KB
/
Copy pathcef_values.h
File metadata and controls
471 lines (406 loc) · 14.1 KB
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
// Copyright (c) 2012 Marshall A. Greenblatt. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the name Chromium Embedded
// Framework nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// ---------------------------------------------------------------------------
//
// The contents of this file must follow a specific format in order to
// support the CEF translator tool. See the translator.README.txt file in the
// tools directory for more information.
//
#ifndef CEF_INCLUDE_CEF_VALUES_H_
#define CEF_INCLUDE_CEF_VALUES_H_
#pragma once
#include <vector>
#include "include/cef_base.h"
class CefDictionaryValue;
class CefListValue;
typedef cef_value_type_t CefValueType;
///
// Class representing a binary value. Can be used on any process and thread.
///
/*--cef(source=library)--*/
class CefBinaryValue : public virtual CefBase {
public:
///
// Creates a new object that is not owned by any other object. The specified
// |data| will be copied.
///
/*--cef()--*/
static CefRefPtr<CefBinaryValue> Create(const void* data,
size_t data_size);
///
// Returns true if this object is valid. Do not call any other methods if this
// method returns false.
///
/*--cef()--*/
virtual bool IsValid() =0;
///
// Returns true if this object is currently owned by another object.
///
/*--cef()--*/
virtual bool IsOwned() =0;
///
// Returns a copy of this object. The data in this object will also be copied.
///
/*--cef()--*/
virtual CefRefPtr<CefBinaryValue> Copy() =0;
///
// Returns the data size.
///
/*--cef()--*/
virtual size_t GetSize() =0;
///
// Read up to |buffer_size| number of bytes into |buffer|. Reading begins at
// the specified byte |data_offset|. Returns the number of bytes read.
///
/*--cef()--*/
virtual size_t GetData(void* buffer,
size_t buffer_size,
size_t data_offset) =0;
};
///
// Class representing a dictionary value. Can be used on any process and thread.
///
/*--cef(source=library)--*/
class CefDictionaryValue : public virtual CefBase {
public:
typedef std::vector<CefString> KeyList;
///
// Creates a new object that is not owned by any other object.
///
/*--cef()--*/
static CefRefPtr<CefDictionaryValue> Create();
///
// Returns true if this object is valid. Do not call any other methods if this
// method returns false.
///
/*--cef()--*/
virtual bool IsValid() =0;
///
// Returns true if this object is currently owned by another object.
///
/*--cef()--*/
virtual bool IsOwned() =0;
///
// Returns true if the values of this object are read-only. Some APIs may
// expose read-only objects.
///
/*--cef()--*/
virtual bool IsReadOnly() =0;
///
// Returns a writable copy of this object. If |exclude_empty_children| is true
// any empty dictionaries or lists will be excluded from the copy.
///
/*--cef()--*/
virtual CefRefPtr<CefDictionaryValue> Copy(bool exclude_empty_children) =0;
///
// Returns the number of values.
///
/*--cef()--*/
virtual size_t GetSize() =0;
///
// Removes all values. Returns true on success.
///
/*--cef()--*/
virtual bool Clear() =0;
///
// Returns true if the current dictionary has a value for the given key.
///
/*--cef()--*/
virtual bool HasKey(const CefString& key) =0;
///
// Reads all keys for this dictionary into the specified vector.
///
/*--cef()--*/
virtual bool GetKeys(KeyList& keys) =0;
///
// Removes the value at the specified key. Returns true is the value was
// removed successfully.
///
/*--cef()--*/
virtual bool Remove(const CefString& key) =0;
///
// Returns the value type for the specified key.
///
/*--cef(default_retval=VTYPE_INVALID)--*/
virtual CefValueType GetType(const CefString& key) =0;
///
// Returns the value at the specified key as type bool.
///
/*--cef()--*/
virtual bool GetBool(const CefString& key) =0;
///
// Returns the value at the specified key as type int.
///
/*--cef()--*/
virtual int GetInt(const CefString& key) =0;
///
// Returns the value at the specified key as type double.
///
/*--cef()--*/
virtual double GetDouble(const CefString& key) =0;
///
// Returns the value at the specified key as type string.
///
/*--cef()--*/
virtual CefString GetString(const CefString& key) =0;
///
// Returns the value at the specified key as type binary.
///
/*--cef()--*/
virtual CefRefPtr<CefBinaryValue> GetBinary(const CefString& key) =0;
///
// Returns the value at the specified key as type dictionary.
///
/*--cef()--*/
virtual CefRefPtr<CefDictionaryValue> GetDictionary(const CefString& key) =0;
///
// Returns the value at the specified key as type list.
///
/*--cef()--*/
virtual CefRefPtr<CefListValue> GetList(const CefString& key) =0;
///
// Sets the value at the specified key as type null. Returns true if the
// value was set successfully.
///
/*--cef()--*/
virtual bool SetNull(const CefString& key) =0;
///
// Sets the value at the specified key as type bool. Returns true if the
// value was set successfully.
///
/*--cef()--*/
virtual bool SetBool(const CefString& key, bool value) =0;
///
// Sets the value at the specified key as type int. Returns true if the
// value was set successfully.
///
/*--cef()--*/
virtual bool SetInt(const CefString& key, int value) =0;
///
// Sets the value at the specified key as type double. Returns true if the
// value was set successfully.
///
/*--cef()--*/
virtual bool SetDouble(const CefString& key, double value) =0;
///
// Sets the value at the specified key as type string. Returns true if the
// value was set successfully.
///
/*--cef(optional_param=value)--*/
virtual bool SetString(const CefString& key, const CefString& value) =0;
///
// Sets the value at the specified key as type binary. Returns true if the
// value was set successfully. If |value| is currently owned by another object
// then the value will be copied and the |value| reference will not change.
// Otherwise, ownership will be transferred to this object and the |value|
// reference will be invalidated.
///
/*--cef()--*/
virtual bool SetBinary(const CefString& key,
CefRefPtr<CefBinaryValue> value) =0;
///
// Sets the value at the specified key as type dict. Returns true if the
// value was set successfully. After calling this method the |value| object
// will no longer be valid. If |value| is currently owned by another object
// then the value will be copied and the |value| reference will not change.
// Otherwise, ownership will be transferred to this object and the |value|
// reference will be invalidated.
///
/*--cef()--*/
virtual bool SetDictionary(const CefString& key,
CefRefPtr<CefDictionaryValue> value) =0;
///
// Sets the value at the specified key as type list. Returns true if the
// value was set successfully. After calling this method the |value| object
// will no longer be valid. If |value| is currently owned by another object
// then the value will be copied and the |value| reference will not change.
// Otherwise, ownership will be transferred to this object and the |value|
// reference will be invalidated.
///
/*--cef()--*/
virtual bool SetList(const CefString& key,
CefRefPtr<CefListValue> value) =0;
};
///
// Class representing a list value. Can be used on any process and thread.
///
/*--cef(source=library)--*/
class CefListValue : public virtual CefBase {
public:
///
// Creates a new object that is not owned by any other object.
///
/*--cef()--*/
static CefRefPtr<CefListValue> Create();
///
// Returns true if this object is valid. Do not call any other methods if this
// method returns false.
///
/*--cef()--*/
virtual bool IsValid() =0;
///
// Returns true if this object is currently owned by another object.
///
/*--cef()--*/
virtual bool IsOwned() =0;
///
// Returns true if the values of this object are read-only. Some APIs may
// expose read-only objects.
///
/*--cef()--*/
virtual bool IsReadOnly() =0;
///
// Returns a writable copy of this object.
///
/*--cef()--*/
virtual CefRefPtr<CefListValue> Copy() =0;
///
// Sets the number of values. If the number of values is expanded all
// new value slots will default to type null. Returns true on success.
///
/*--cef()--*/
virtual bool SetSize(size_t size) =0;
///
// Returns the number of values.
///
/*--cef()--*/
virtual size_t GetSize() =0;
///
// Removes all values. Returns true on success.
///
/*--cef()--*/
virtual bool Clear() =0;
///
// Removes the value at the specified index.
///
/*--cef(index_param=index)--*/
virtual bool Remove(int index) =0;
///
// Returns the value type at the specified index.
///
/*--cef(default_retval=VTYPE_INVALID,index_param=index)--*/
virtual CefValueType GetType(int index) =0;
///
// Returns the value at the specified index as type bool.
///
/*--cef(index_param=index)--*/
virtual bool GetBool(int index) =0;
///
// Returns the value at the specified index as type int.
///
/*--cef(index_param=index)--*/
virtual int GetInt(int index) =0;
///
// Returns the value at the specified index as type double.
///
/*--cef(index_param=index)--*/
virtual double GetDouble(int index) =0;
///
// Returns the value at the specified index as type string.
///
/*--cef(index_param=index)--*/
virtual CefString GetString(int index) =0;
///
// Returns the value at the specified index as type binary.
///
/*--cef(index_param=index)--*/
virtual CefRefPtr<CefBinaryValue> GetBinary(int index) =0;
///
// Returns the value at the specified index as type dictionary.
///
/*--cef(index_param=index)--*/
virtual CefRefPtr<CefDictionaryValue> GetDictionary(int index) =0;
///
// Returns the value at the specified index as type list.
///
/*--cef(index_param=index)--*/
virtual CefRefPtr<CefListValue> GetList(int index) =0;
///
// Sets the value at the specified index as type null. Returns true if the
// value was set successfully.
///
/*--cef(index_param=index)--*/
virtual bool SetNull(int index) =0;
///
// Sets the value at the specified index as type bool. Returns true if the
// value was set successfully.
///
/*--cef(index_param=index)--*/
virtual bool SetBool(int index, bool value) =0;
///
// Sets the value at the specified index as type int. Returns true if the
// value was set successfully.
///
/*--cef(index_param=index)--*/
virtual bool SetInt(int index, int value) =0;
///
// Sets the value at the specified index as type double. Returns true if the
// value was set successfully.
///
/*--cef(index_param=index)--*/
virtual bool SetDouble(int index, double value) =0;
///
// Sets the value at the specified index as type string. Returns true if the
// value was set successfully.
///
/*--cef(optional_param=value,index_param=index)--*/
virtual bool SetString(int index, const CefString& value) =0;
///
// Sets the value at the specified index as type binary. Returns true if the
// value was set successfully. After calling this method the |value| object
// will no longer be valid. If |value| is currently owned by another object
// then the value will be copied and the |value| reference will not change.
// Otherwise, ownership will be transferred to this object and the |value|
// reference will be invalidated.
///
/*--cef(index_param=index)--*/
virtual bool SetBinary(int index, CefRefPtr<CefBinaryValue> value) =0;
///
// Sets the value at the specified index as type dict. Returns true if the
// value was set successfully. After calling this method the |value| object
// will no longer be valid. If |value| is currently owned by another object
// then the value will be copied and the |value| reference will not change.
// Otherwise, ownership will be transferred to this object and the |value|
// reference will be invalidated.
///
/*--cef(index_param=index)--*/
virtual bool SetDictionary(int index, CefRefPtr<CefDictionaryValue> value) =0;
///
// Sets the value at the specified index as type list. Returns true if the
// value was set successfully. After calling this method the |value| object
// will no longer be valid. If |value| is currently owned by another object
// then the value will be copied and the |value| reference will not change.
// Otherwise, ownership will be transferred to this object and the |value|
// reference will be invalidated.
///
/*--cef(index_param=index)--*/
virtual bool SetList(int index, CefRefPtr<CefListValue> value) =0;
};
#endif // CEF_INCLUDE_CEF_VALUES_H_