• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2022-2025 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License"),
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit AbilityKit
19 */
20
21/**
22 * The definition of ConfigurationConstant.
23 *
24 * @namespace ConfigurationConstant
25 * @syscap SystemCapability.Ability.AbilityBase
26 * @since 9
27 */
28/**
29 * The definition of ConfigurationConstant.
30 *
31 * @namespace ConfigurationConstant
32 * @syscap SystemCapability.Ability.AbilityBase
33 * @atomicservice
34 * @since 11
35 */
36/**
37 * The definition of ConfigurationConstant.
38 *
39 * @namespace ConfigurationConstant
40 * @syscap SystemCapability.Ability.AbilityBase
41 * @crossplatform
42 * @atomicservice
43 * @since arkts {'1.1':'12', '1.2':'20'}
44 * @arkts 1.1&1.2
45 */
46declare namespace ConfigurationConstant {
47  /**
48   * Color mode
49   *
50   * @enum { number }
51   * @syscap SystemCapability.Ability.AbilityBase
52   * @since 9
53   */
54  /**
55   * Color mode
56   *
57   * @enum { number }
58   * @syscap SystemCapability.Ability.AbilityBase
59   * @crossplatform
60   * @since 10
61   */
62  /**
63   * Color mode
64   *
65   * @enum { number }
66   * @syscap SystemCapability.Ability.AbilityBase
67   * @crossplatform
68   * @atomicservice
69   * @since arkts {'1.1':'11', '1.2':'20'}
70   * @arkts 1.1&1.2
71   */
72  export enum ColorMode {
73    /**
74     * The color mode is not set.
75     *
76     * @syscap SystemCapability.Ability.AbilityBase
77     * @since 9
78     */
79    /**
80     * The color mode is not set.
81     *
82     * @syscap SystemCapability.Ability.AbilityBase
83     * @crossplatform
84     * @since 10
85     */
86    /**
87     * The color mode is not set.
88     *
89     * @syscap SystemCapability.Ability.AbilityBase
90     * @crossplatform
91     * @atomicservice
92     * @since arkts {'1.1':'11', '1.2':'20'}
93     * @arkts 1.1&1.2
94     */
95    COLOR_MODE_NOT_SET = -1,
96
97    /**
98     * Dark mode.
99     *
100     * @syscap SystemCapability.Ability.AbilityBase
101     * @since 9
102     */
103    /**
104     * Dark mode.
105     *
106     * @syscap SystemCapability.Ability.AbilityBase
107     * @crossplatform
108     * @since 10
109     */
110    /**
111     * Dark mode.
112     *
113     * @syscap SystemCapability.Ability.AbilityBase
114     * @crossplatform
115     * @atomicservice
116     * @since arkts {'1.1':'11', '1.2':'20'}
117     * @arkts 1.1&1.2
118     */
119    COLOR_MODE_DARK = 0,
120
121    /**
122     * Light mode.
123     *
124     * @syscap SystemCapability.Ability.AbilityBase
125     * @since 9
126     */
127    /**
128     * Light mode.
129     *
130     * @syscap SystemCapability.Ability.AbilityBase
131     * @crossplatform
132     * @since 10
133     */
134    /**
135     * Light mode.
136     *
137     * @syscap SystemCapability.Ability.AbilityBase
138     * @crossplatform
139     * @atomicservice
140     * @since arkts {'1.1':'11', '1.2':'20'}
141     * @arkts 1.1&1.2
142     */
143    COLOR_MODE_LIGHT = 1
144  }
145
146  /**
147   * Screen direction.
148   *
149   * @enum { number }
150   * @syscap SystemCapability.Ability.AbilityBase
151   * @since 9
152   */
153  /**
154   * Screen direction.
155   *
156   * @enum { number }
157   * @syscap SystemCapability.Ability.AbilityBase
158   * @crossplatform
159   * @since 10
160   */
161  /**
162   * Screen direction.
163   *
164   * @enum { number }
165   * @syscap SystemCapability.Ability.AbilityBase
166   * @crossplatform
167   * @atomicservice
168   * @since arkts {'1.1':'11', '1.2':'20'}
169   * @arkts 1.1&1.2
170   */
171  export enum Direction {
172    /**
173     * The direction is not set.
174     *
175     * @syscap SystemCapability.Ability.AbilityBase
176     * @since 9
177     */
178    /**
179     * The direction is not set.
180     *
181     * @syscap SystemCapability.Ability.AbilityBase
182     * @crossplatform
183     * @since 10
184     */
185    /**
186     * The direction is not set.
187     *
188     * @syscap SystemCapability.Ability.AbilityBase
189     * @crossplatform
190     * @atomicservice
191     * @since arkts {'1.1':'11', '1.2':'20'}
192     * @arkts 1.1&1.2
193     */
194    DIRECTION_NOT_SET = -1,
195
196    /**
197     * Vertical direction.
198     *
199     * @syscap SystemCapability.Ability.AbilityBase
200     * @since 9
201     */
202    /**
203     * Vertical direction.
204     *
205     * @syscap SystemCapability.Ability.AbilityBase
206     * @crossplatform
207     * @since 10
208     */
209    /**
210     * Vertical direction.
211     *
212     * @syscap SystemCapability.Ability.AbilityBase
213     * @crossplatform
214     * @atomicservice
215     * @since arkts {'1.1':'11', '1.2':'20'}
216     * @arkts 1.1&1.2
217     */
218    DIRECTION_VERTICAL = 0,
219
220    /**
221     * Horizontal direction.
222     *
223     * @syscap SystemCapability.Ability.AbilityBase
224     * @since 9
225     */
226    /**
227     * Horizontal direction.
228     *
229     * @syscap SystemCapability.Ability.AbilityBase
230     * @crossplatform
231     * @since 10
232     */
233    /**
234     * Horizontal direction.
235     *
236     * @syscap SystemCapability.Ability.AbilityBase
237     * @crossplatform
238     * @atomicservice
239     * @since arkts {'1.1':'11', '1.2':'20'}
240     * @arkts 1.1&1.2
241     */
242    DIRECTION_HORIZONTAL = 1
243  }
244
245  /**
246   * Screen density
247   *
248   * @enum { number }
249   * @syscap SystemCapability.Ability.AbilityBase
250   * @since 9
251   */
252  /**
253   * Screen density
254   *
255   * @enum { number }
256   * @syscap SystemCapability.Ability.AbilityBase
257   * @atomicservice
258   * @since 11
259   */
260  /**
261   * Screen density
262   *
263   * @enum { number }
264   * @syscap SystemCapability.Ability.AbilityBase
265   * @crossplatform
266   * @atomicservice
267   * @since arkts {'1.1':'18', '1.2':'20'}
268   * @arkts 1.1&1.2
269   */
270  export enum ScreenDensity {
271    /**
272     * The screen pixel density is not set.
273     *
274     * @syscap SystemCapability.Ability.AbilityBase
275     * @since 9
276     */
277    /**
278     * The screen pixel density is not set.
279     *
280     * @syscap SystemCapability.Ability.AbilityBase
281     * @atomicservice
282     * @since 11
283     */
284    /**
285     * The screen pixel density is not set.
286     *
287     * @syscap SystemCapability.Ability.AbilityBase
288     * @crossplatform
289     * @atomicservice
290     * @since arkts {'1.1':'18', '1.2':'20'}
291     * @arkts 1.1&1.2
292     */
293    SCREEN_DENSITY_NOT_SET = 0,
294
295    /**
296     * Screen pixel density is 'SDPI'
297     *
298     * @syscap SystemCapability.Ability.AbilityBase
299     * @since 9
300     */
301    /**
302     * Screen pixel density is 'SDPI'
303     *
304     * @syscap SystemCapability.Ability.AbilityBase
305     * @atomicservice
306     * @since 11
307     */
308    /**
309     * Screen pixel density is 'SDPI'
310     *
311     * @syscap SystemCapability.Ability.AbilityBase
312     * @crossplatform
313     * @atomicservice
314     * @since arkts {'1.1':'18', '1.2':'20'}
315     * @arkts 1.1&1.2
316     */
317    SCREEN_DENSITY_SDPI = 120,
318
319    /**
320     * Screen pixel density is 'MDPI'
321     *
322     * @syscap SystemCapability.Ability.AbilityBase
323     * @since 9
324     */
325    /**
326     * Screen pixel density is 'MDPI'
327     *
328     * @syscap SystemCapability.Ability.AbilityBase
329     * @atomicservice
330     * @since 11
331     */
332    /**
333     * Screen pixel density is 'MDPI'
334     *
335     * @syscap SystemCapability.Ability.AbilityBase
336     * @crossplatform
337     * @atomicservice
338     * @since arkts {'1.1':'18', '1.2':'20'}
339     * @arkts 1.1&1.2
340     */
341    SCREEN_DENSITY_MDPI = 160,
342
343    /**
344     * Screen pixel density is 'LDPI'
345     *
346     * @syscap SystemCapability.Ability.AbilityBase
347     * @since 9
348     */
349    /**
350     * Screen pixel density is 'LDPI'
351     *
352     * @syscap SystemCapability.Ability.AbilityBase
353     * @atomicservice
354     * @since 11
355     */
356    /**
357     * Screen pixel density is 'LDPI'
358     *
359     * @syscap SystemCapability.Ability.AbilityBase
360     * @crossplatform
361     * @atomicservice
362     * @since arkts {'1.1':'18', '1.2':'20'}
363     * @arkts 1.1&1.2
364     */
365    SCREEN_DENSITY_LDPI = 240,
366
367    /**
368     * Screen pixel density is 'XLDPI'
369     *
370     * @syscap SystemCapability.Ability.AbilityBase
371     * @since 9
372     */
373    /**
374     * Screen pixel density is 'XLDPI'
375     *
376     * @syscap SystemCapability.Ability.AbilityBase
377     * @atomicservice
378     * @since 11
379     */
380    /**
381     * Screen pixel density is 'XLDPI'
382     *
383     * @syscap SystemCapability.Ability.AbilityBase
384     * @crossplatform
385     * @atomicservice
386     * @since arkts {'1.1':'18', '1.2':'20'}
387     * @arkts 1.1&1.2
388     */
389    SCREEN_DENSITY_XLDPI = 320,
390
391    /**
392     * Screen pixel density is 'XXLDPI'
393     *
394     * @syscap SystemCapability.Ability.AbilityBase
395     * @since 9
396     */
397    /**
398     * Screen pixel density is 'XXLDPI'
399     *
400     * @syscap SystemCapability.Ability.AbilityBase
401     * @atomicservice
402     * @since 11
403     */
404    /**
405     * Screen pixel density is 'XXLDPI'
406     *
407     * @syscap SystemCapability.Ability.AbilityBase
408     * @crossplatform
409     * @atomicservice
410     * @since arkts {'1.1':'18', '1.2':'20'}
411     * @arkts 1.1&1.2
412     */
413    SCREEN_DENSITY_XXLDPI = 480,
414
415    /**
416     * Screen pixel density is 'XXXLDPI'
417     *
418     * @syscap SystemCapability.Ability.AbilityBase
419     * @since 9
420     */
421    /**
422     * Screen pixel density is 'XXXLDPI'
423     *
424     * @syscap SystemCapability.Ability.AbilityBase
425     * @atomicservice
426     * @since 11
427     */
428    /**
429     * Screen pixel density is 'XXXLDPI'
430     *
431     * @syscap SystemCapability.Ability.AbilityBase
432     * @crossplatform
433     * @atomicservice
434     * @since arkts {'1.1':'18', '1.2':'20'}
435     * @arkts 1.1&1.2
436     */
437    SCREEN_DENSITY_XXXLDPI = 640
438  }
439}
440
441export default ConfigurationConstant;
442