• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2023 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 ArkUI
19 */
20
21/*** if arkts 1.2 */
22import { CommonConfiguration, CommonMethod, ShadowOptions, ContentModifier, Optional, DateTimeOptions } from './common'
23import { ResourceColor, Length, ResourceStr } from './units'
24import { FontStyle, FontWeight } from './enums'
25/*** endif */
26
27/**
28 * Provides a way to control the textclock status.
29 *
30 * @syscap SystemCapability.ArkUI.ArkUI.Full
31 * @since 8
32 */
33/**
34 * Provides a way to control the textclock status.
35 *
36 * @syscap SystemCapability.ArkUI.ArkUI.Full
37 * @crossplatform
38 * @since 10
39 */
40/**
41 * Provides a way to control the textclock status.
42 *
43 * @syscap SystemCapability.ArkUI.ArkUI.Full
44 * @crossplatform
45 * @form
46 * @atomicservice
47 * @since arkts {'1.1':'11','1.2':'20'}
48 * @arkts 1.1&1.2
49 */
50declare class TextClockController {
51  /**
52   * constructor.
53   *
54   * @syscap SystemCapability.ArkUI.ArkUI.Full
55   * @since 8
56   */
57  /**
58   * constructor.
59   *
60   * @syscap SystemCapability.ArkUI.ArkUI.Full
61   * @crossplatform
62   * @since 10
63   */
64  /**
65   * constructor.
66   *
67   * @syscap SystemCapability.ArkUI.ArkUI.Full
68   * @crossplatform
69   * @form
70   * @atomicservice
71   * @since arkts {'1.1':'11','1.2':'20'}
72   * @arkts 1.1&1.2
73   */
74  constructor();
75  /**
76   * Provides a start event for textclock.
77   *
78   * @syscap SystemCapability.ArkUI.ArkUI.Full
79   * @since 8
80   */
81  /**
82   * Provides a start event for textclock.
83   *
84   * @syscap SystemCapability.ArkUI.ArkUI.Full
85   * @crossplatform
86   * @since 10
87   */
88  /**
89   * Provides a start event for textclock.
90   *
91   * @syscap SystemCapability.ArkUI.ArkUI.Full
92   * @crossplatform
93   * @form
94   * @atomicservice
95   * @since 11
96   */
97  start();
98  /**
99   * Provides a start event for textclock.
100   *
101   * @syscap SystemCapability.ArkUI.ArkUI.Full
102   * @crossplatform
103   * @form
104   * @atomicservice
105   * @since 20
106   * @arkts 1.2
107   */
108  start(): void;
109  /**
110   * Provides a stop event for textclock.
111   *
112   * @syscap SystemCapability.ArkUI.ArkUI.Full
113   * @since 8
114   */
115  /**
116   * Provides a stop event for textclock.
117   *
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @crossplatform
120   * @since 10
121   */
122  /**
123   * Provides a stop event for textclock.
124   *
125   * @syscap SystemCapability.ArkUI.ArkUI.Full
126   * @crossplatform
127   * @form
128   * @atomicservice
129   * @since 11
130   */
131  stop();
132  /**
133   * Provides a stop event for textclock.
134   *
135   * @syscap SystemCapability.ArkUI.ArkUI.Full
136   * @crossplatform
137   * @form
138   * @atomicservice
139   * @since 20
140   * @arkts 1.2
141   */
142  stop(): void;
143}
144
145/**
146 * TextClockConfiguration used by text clock content modifier
147 *
148 * @extends CommonConfiguration<TextClockConfiguration>
149 * @interface TextClockConfiguration
150 * @syscap SystemCapability.ArkUI.ArkUI.Full
151 * @crossplatform
152 * @atomicservice
153 * @since arkts {'1.1':'12','1.2':'20'}
154 * @arkts 1.1&1.2
155 */
156declare interface TextClockConfiguration extends CommonConfiguration<TextClockConfiguration> {
157  /**
158   * Specifies the current time zone.
159   * The valid value is an integer ranging from - 14 to 12,
160   * Where a negative value indicates the eastern time zone, for example, -8.
161   *
162   * @type { number }
163   * @syscap SystemCapability.ArkUI.ArkUI.Full
164   * @crossplatform
165   * @atomicservice
166   * @since arkts {'1.1':'12','1.2':'20'}
167   * @arkts 1.1&1.2
168   */
169  timeZoneOffset: number;
170
171  /**
172   * TextClock is started or not.
173   *
174   * @type { boolean }
175   * @syscap SystemCapability.ArkUI.ArkUI.Full
176   * @crossplatform
177   * @atomicservice
178   * @since arkts {'1.1':'12','1.2':'20'}
179   * @arkts 1.1&1.2
180   */
181  started: boolean;
182
183  /**
184   * The time of the TextClock.
185   *
186   * @type { number }
187   * @syscap SystemCapability.ArkUI.ArkUI.Full
188   * @crossplatform
189   * @atomicservice
190   * @since arkts {'1.1':'12','1.2':'20'}
191   * @arkts 1.1&1.2
192   */
193  timeValue: number;
194}
195
196/**
197 * Options to construct TextClock component.
198 *
199 * @interface TextClockOptions
200 * @syscap SystemCapability.ArkUI.ArkUI.Full
201 * @crossplatform
202 * @form
203 * @atomicservice
204 * @since arkts {'1.1':'18','1.2':'20'}
205 * @arkts 1.1&1.2
206 */
207declare interface TextClockOptions {
208  /**
209   * Time zone offset.
210   *
211   * @type { ?number }
212   * @syscap SystemCapability.ArkUI.ArkUI.Full
213   * @since 8
214   */
215  /**
216   * Time zone offset.
217   *
218   * @type { ?number }
219   * @syscap SystemCapability.ArkUI.ArkUI.Full
220   * @crossplatform
221   * @since 10
222   */
223  /**
224   * Time zone offset.
225   *
226   * @type { ?number }
227   * @syscap SystemCapability.ArkUI.ArkUI.Full
228   * @crossplatform
229   * @form
230   * @atomicservice
231   * @since 11
232   */
233  /**
234   * Time zone offset.
235   * Anonymous Object Rectification.
236   *
237   * @type { ?number }
238   * @syscap SystemCapability.ArkUI.ArkUI.Full
239   * @crossplatform
240   * @form
241   * @atomicservice
242   * @since arkts {'1.1':'18','1.2':'20'}
243   * @arkts 1.1&1.2
244   */
245  timeZoneOffset?: number;
246
247  /**
248   * TextClock controller.
249   *
250   * @type { ?TextClockController }
251   * @syscap SystemCapability.ArkUI.ArkUI.Full
252   * @since 8
253   */
254  /**
255   * TextClock controller.
256   *
257   * @type { ?TextClockController }
258   * @syscap SystemCapability.ArkUI.ArkUI.Full
259   * @crossplatform
260   * @since 10
261   */
262  /**
263   * TextClock controller.
264   *
265   * @type { ?TextClockController }
266   * @syscap SystemCapability.ArkUI.ArkUI.Full
267   * @crossplatform
268   * @form
269   * @atomicservice
270   * @since 11
271   */
272  /**
273   * TextClock controller.
274   * Anonymous Object Rectification.
275   *
276   * @type { ?TextClockController }
277   * @syscap SystemCapability.ArkUI.ArkUI.Full
278   * @crossplatform
279   * @form
280   * @atomicservice
281   * @since arkts {'1.1':'18','1.2':'20'}
282   * @arkts 1.1&1.2
283   */
284  controller?: TextClockController
285}
286
287/**
288 * TextClock component, which provides the text clock capability.
289 *
290 * @interface TextClockInterface
291 * @syscap SystemCapability.ArkUI.ArkUI.Full
292 * @since 8
293 */
294/**
295 * TextClock component, which provides the text clock capability.
296 *
297 * @interface TextClockInterface
298 * @syscap SystemCapability.ArkUI.ArkUI.Full
299 * @crossplatform
300 * @since 10
301 */
302/**
303 * TextClock component, which provides the text clock capability.
304 *
305 * @interface TextClockInterface
306 * @syscap SystemCapability.ArkUI.ArkUI.Full
307 * @crossplatform
308 * @form
309 * @atomicservice
310 * @since arkts {'1.1':'11','1.2':'20'}
311 * @arkts 1.1&1.2
312 */
313interface TextClockInterface {
314  /**
315   * Construct the text clock component.
316   * Specifies the current time zone.
317   * The valid value is an integer ranging from - 14 to 12,
318   * Where a negative value indicates the eastern time zone, for example, -8.
319   *
320   * @param { object } options
321   * @returns { TextClockAttribute }
322   * @syscap SystemCapability.ArkUI.ArkUI.Full
323   * @since 8
324   */
325  /**
326   * Construct the text clock component.
327   * Specifies the current time zone.
328   * The valid value is an integer ranging from - 14 to 12,
329   * Where a negative value indicates the eastern time zone, for example, -8.
330   *
331   * @param { object } options
332   * @returns { TextClockAttribute }
333   * @syscap SystemCapability.ArkUI.ArkUI.Full
334   * @crossplatform
335   * @since 10
336   */
337  /**
338   * Construct the text clock component.
339   * Specifies the current time zone.
340   * The valid value is an integer ranging from - 14 to 12,
341   * Where a negative value indicates the eastern time zone, for example, -8.
342   *
343   * @param { object } options
344   * @returns { TextClockAttribute }
345   * @syscap SystemCapability.ArkUI.ArkUI.Full
346   * @crossplatform
347   * @form
348   * @atomicservice
349   * @since 11
350   */
351  /**
352   * Construct the text clock component.
353   * Specifies the current time zone.
354   * The valid value is an integer ranging from - 14 to 12,
355   * Where a negative value indicates the eastern time zone, for example, -8.
356   * Anonymous Object Rectification.
357   *
358   * @param { TextClockOptions } [options] - TextClock options.
359   * @returns { TextClockAttribute }
360   * @syscap SystemCapability.ArkUI.ArkUI.Full
361   * @crossplatform
362   * @form
363   * @atomicservice
364   * @since arkts {'1.1':'18','1.2':'20'}
365   * @arkts 1.1&1.2
366   */
367  (options?: TextClockOptions): TextClockAttribute;
368}
369
370/**
371 * Provides attribute for TextClock.
372 *
373 * @extends CommonMethod<TextClockAttribute>
374 * @syscap SystemCapability.ArkUI.ArkUI.Full
375 * @since 8
376 */
377/**
378 * Provides attribute for TextClock.
379 *
380 * @extends CommonMethod<TextClockAttribute>
381 * @syscap SystemCapability.ArkUI.ArkUI.Full
382 * @crossplatform
383 * @since 10
384 */
385/**
386 * Provides attribute for TextClock.
387 *
388 * @extends CommonMethod<TextClockAttribute>
389 * @syscap SystemCapability.ArkUI.ArkUI.Full
390 * @crossplatform
391 * @form
392 * @atomicservice
393 * @since arkts {'1.1':'11','1.2':'20'}
394 * @arkts 1.1&1.2
395 */
396declare class TextClockAttribute extends CommonMethod<TextClockAttribute> {
397  /**
398   * set display time format,such as "yyyy/mm/dd","yyyy-mm-dd".
399   * support time format:yyyy,mm,mmm(English month abbreviation),mmmm(Full name of the month in English),
400   * dd,ddd(English Week abbreviation),dddd(Full name of the week in English),
401   * HH/hh(24-hour clock/12-hour clock),MM/mm(minute),SS/ss(second).
402   *
403   * @param { string } value
404   * @returns { TextClockAttribute }
405   * @syscap SystemCapability.ArkUI.ArkUI.Full
406   * @since 8
407   */
408  /**
409   * set display time format,such as "yyyy/mm/dd","yyyy-mm-dd".
410   * support time format:yyyy,mm,mmm(English month abbreviation),mmmm(Full name of the month in English),
411   * dd,ddd(English Week abbreviation),dddd(Full name of the week in English),
412   * HH/hh(24-hour clock/12-hour clock),MM/mm(minute),SS/ss(second).
413   *
414   * @param { string } value
415   * @returns { TextClockAttribute }
416   * @syscap SystemCapability.ArkUI.ArkUI.Full
417   * @crossplatform
418   * @since 10
419   */
420  /**
421   * set display time format,such as "yyyy/mm/dd","yyyy-mm-dd".
422   * support time format:yyyy,mm,mmm(English month abbreviation),mmmm(Full name of the month in English),
423   * dd,ddd(English Week abbreviation),dddd(Full name of the week in English),
424   * HH/hh(24-hour clock/12-hour clock),MM/mm(minute),SS/ss(second).
425   * The default value is "hh:mm:ss" when TextClock is not in a form.
426   * The default value is "hh:mm" when TextClock is in a form.
427   * If the value has second or millisecond, the value will be set to the default value.
428   *
429   * @param { string } value
430   * @returns { TextClockAttribute }
431   * @syscap SystemCapability.ArkUI.ArkUI.Full
432   * @crossplatform
433   * @form
434   * @atomicservice
435   * @since 11
436   */
437  /**
438   * set display time format,such as "yyyy/mm/dd","yyyy-mm-dd".
439   * support time format:yyyy,mm,mmm(English month abbreviation),mmmm(Full name of the month in English),
440   * dd,ddd(English Week abbreviation),dddd(Full name of the week in English),
441   * HH/hh(24-hour clock/12-hour clock),MM/mm(minute),SS/ss(second).
442   * The default value is "hh:mm:ss" when TextClock is not in a form.
443   * The default value is "hh:mm" when TextClock is in a form.
444   * If the value has second or millisecond, the value will be set to the default value.
445   *
446   * @param { ResourceStr } value
447   * @returns { TextClockAttribute }
448   * @syscap SystemCapability.ArkUI.ArkUI.Full
449   * @crossplatform
450   * @form
451   * @atomicservice
452   * @since 20
453   */
454  format(value: ResourceStr): TextClockAttribute;
455
456  /**
457   * set display time format,such as "yyyy/mm/dd","yyyy-mm-dd".
458   * support time format:yyyy,mm,mmm(English month abbreviation),mmmm(Full name of the month in English),
459   * dd,ddd(English Week abbreviation),dddd(Full name of the week in English),
460   * HH/hh(24-hour clock/12-hour clock),MM/mm(minute),SS/ss(second).
461   * The default value is "hh:mm:ss" when TextClock is not in a form.
462   * The default value is "hh:mm" when TextClock is in a form.
463   * If the value has second or millisecond, the value will be set to the default value.
464   *
465   * @param { string } value
466   * @returns { TextClockAttribute }
467   * @syscap SystemCapability.ArkUI.ArkUI.Full
468   * @crossplatform
469   * @form
470   * @atomicservice
471   * @since 20
472   * @arkts 1.2
473   */
474  format(value: string): TextClockAttribute;
475
476  /**
477   * Provides a date change callback.
478   * The callback parameter is Unix Time Stamp,
479   * The number of milliseconds that have elapsed since January 1, 1970 (UTC).
480   * The minimum callback interval for this event is seconds.
481   * You can listen to this callback,
482   * Use the format attribute method to customize data display in the callback.
483   *
484   * @param { function } event - Listening date event callback.
485   * @returns { TextClockAttribute }
486   * @syscap SystemCapability.ArkUI.ArkUI.Full
487   * @since 8
488   */
489  /**
490   * Provides a date change callback.
491   * The callback parameter is Unix Time Stamp,
492   * The number of milliseconds that have elapsed since January 1, 1970 (UTC).
493   * The minimum callback interval for this event is seconds.
494   * You can listen to this callback,
495   * Use the format attribute method to customize data display in the callback.
496   *
497   * @param { function } event - Listening date event callback.
498   * @returns { TextClockAttribute }
499   * @syscap SystemCapability.ArkUI.ArkUI.Full
500   * @crossplatform
501   * @since 10
502   */
503  /**
504   * Provides a date change callback.
505   * The callback parameter is Unix Time Stamp,
506   * The number of milliseconds that have elapsed since January 1, 1970 (UTC).
507   * The minimum callback interval for this event default is seconds when TextClock is not in a form.
508   * The minimum callback interval for this event is minutes when TextClock is in a form.
509   * If visibility is Hidden the callback be disabled when TextClock is in a form.
510   * You can listen to this callback,
511   * Use the format attribute method to customize data display in the callback.
512   *
513   * @param { function } event - Listening date event callback.
514   * @returns { TextClockAttribute }
515   * @syscap SystemCapability.ArkUI.ArkUI.Full
516   * @crossplatform
517   * @form
518   * @atomicservice
519   * @since arkts {'1.1':'11','1.2':'20'}
520   * @arkts 1.1&1.2
521   */
522  onDateChange(event: (value: number) => void): TextClockAttribute;
523
524  /**
525   * Called when the value of TextClock fontColor is set
526   *
527   * @param { ResourceColor } value
528   * @returns { TextClockAttribute }
529   * @syscap SystemCapability.ArkUI.ArkUI.Full
530   * @since 8
531   */
532  /**
533   * Called when the value of TextClock fontColor is set
534   *
535   * @param { ResourceColor } value
536   * @returns { TextClockAttribute }
537   * @syscap SystemCapability.ArkUI.ArkUI.Full
538   * @crossplatform
539   * @since 10
540   */
541  /**
542   * Called when the value of TextClock fontColor is set
543   *
544   * @param { ResourceColor } value
545   * @returns { TextClockAttribute }
546   * @syscap SystemCapability.ArkUI.ArkUI.Full
547   * @crossplatform
548   * @form
549   * @atomicservice
550   * @since arkts {'1.1':'11','1.2':'20'}
551   * @arkts 1.1&1.2
552   */
553  fontColor(value: ResourceColor): TextClockAttribute;
554
555  /**
556   * Called when the value of TextClock fontSize is set
557   *
558   * @param { Length } value
559   * @returns { TextClockAttribute }
560   * @syscap SystemCapability.ArkUI.ArkUI.Full
561   * @since 8
562   */
563  /**
564   * Called when the value of TextClock fontSize is set
565   *
566   * @param { Length } value
567   * @returns { TextClockAttribute }
568   * @syscap SystemCapability.ArkUI.ArkUI.Full
569   * @crossplatform
570   * @since 10
571   */
572  /**
573   * Called when the value of TextClock fontSize is set
574   *
575   * @param { Length } value
576   * @returns { TextClockAttribute }
577   * @syscap SystemCapability.ArkUI.ArkUI.Full
578   * @crossplatform
579   * @form
580   * @atomicservice
581   * @since arkts {'1.1':'11','1.2':'20'}
582   * @arkts 1.1&1.2
583   */
584  fontSize(value: Length): TextClockAttribute;
585
586  /**
587   * Called when the value of TextClock fontStyle is set
588   *
589   * @param { FontStyle } value
590   * @returns { TextClockAttribute }
591   * @syscap SystemCapability.ArkUI.ArkUI.Full
592   * @since 8
593   */
594  /**
595   * Called when the value of TextClock fontStyle is set
596   *
597   * @param { FontStyle } value
598   * @returns { TextClockAttribute }
599   * @syscap SystemCapability.ArkUI.ArkUI.Full
600   * @crossplatform
601   * @since 10
602   */
603  /**
604   * Called when the value of TextClock fontStyle is set
605   *
606   * @param { FontStyle } value
607   * @returns { TextClockAttribute }
608   * @syscap SystemCapability.ArkUI.ArkUI.Full
609   * @crossplatform
610   * @form
611   * @atomicservice
612   * @since arkts {'1.1':'11','1.2':'20'}
613   * @arkts 1.1&1.2
614   */
615  fontStyle(value: FontStyle): TextClockAttribute;
616
617  /**
618   * Called when the value of TextClock fontWeight is set
619   *
620   * @param { number | FontWeight | string } value
621   * @returns { TextClockAttribute }
622   * @syscap SystemCapability.ArkUI.ArkUI.Full
623   * @since 8
624   */
625  /**
626   * Called when the value of TextClock fontWeight is set
627   *
628   * @param { number | FontWeight | string } value
629   * @returns { TextClockAttribute }
630   * @syscap SystemCapability.ArkUI.ArkUI.Full
631   * @crossplatform
632   * @since 10
633   */
634  /**
635   * Called when the value of TextClock fontWeight is set
636   *
637   * @param { number | FontWeight | string } value
638   * @returns { TextClockAttribute }
639   * @syscap SystemCapability.ArkUI.ArkUI.Full
640   * @crossplatform
641   * @form
642   * @atomicservice
643   * @since arkts {'1.1':'11','1.2':'20'}
644   * @arkts 1.1&1.2
645   */
646  fontWeight(value: number | FontWeight | string): TextClockAttribute;
647
648  /**
649   * Called when the value of TextClock fontFamily is set
650   *
651   * @param { ResourceStr } value
652   * @returns { TextClockAttribute }
653   * @syscap SystemCapability.ArkUI.ArkUI.Full
654   * @since 8
655   */
656  /**
657   * Called when the value of TextClock fontFamily is set
658   *
659   * @param { ResourceStr } value
660   * @returns { TextClockAttribute }
661   * @syscap SystemCapability.ArkUI.ArkUI.Full
662   * @crossplatform
663   * @since 10
664   */
665  /**
666   * Called when the value of TextClock fontFamily is set
667   *
668   * @param { ResourceStr } value
669   * @returns { TextClockAttribute }
670   * @syscap SystemCapability.ArkUI.ArkUI.Full
671   * @crossplatform
672   * @form
673   * @atomicservice
674   * @since arkts {'1.1':'11','1.2':'20'}
675   * @arkts 1.1&1.2
676   */
677  fontFamily(value: ResourceStr): TextClockAttribute;
678
679  /**
680   * Called when the text shadow is set.
681   *
682   * @param { ShadowOptions | Array<ShadowOptions> } value - The shadow options.
683   * @returns { TextClockAttribute }
684   * @syscap SystemCapability.ArkUI.ArkUI.Full
685   * @crossplatform
686   * @form
687   * @since 11
688   */
689  /**
690   * Called when the text shadow is set.
691   *
692   * @param { ShadowOptions | Array<ShadowOptions> } value - The shadow options.
693   * @returns { TextClockAttribute }
694   * @syscap SystemCapability.ArkUI.ArkUI.Full
695   * @crossplatform
696   * @form
697   * @atomicservice
698   * @since arkts {'1.1':'12','1.2':'20'}
699   * @arkts 1.1&1.2
700   */
701  textShadow(value: ShadowOptions | Array<ShadowOptions>): TextClockAttribute;
702
703  /**
704   * Called when the text fontFeature is set.
705   *
706   * @param { string } value - The fontFeature.
707   * normal | <feature-tag-value>,
708   * where <feature-tag-value> = <string> [ <integer> | on | off ], like: "ss01" 0
709   * number of <feature-tag-value> can be single or multiple, and separated by comma ','.
710   * @returns { TextClockAttribute }
711   * @syscap SystemCapability.ArkUI.ArkUI.Full
712   * @crossplatform
713   * @form
714   * @since 11
715   */
716  /**
717   * Called when the text fontFeature is set.
718   *
719   * @param { string } value - The fontFeature.
720   * normal | <feature-tag-value>,
721   * where <feature-tag-value> = <string> [ <integer> | on | off ], like: "ss01" 0
722   * number of <feature-tag-value> can be single or multiple, and separated by comma ','.
723   * @returns { TextClockAttribute }
724   * @syscap SystemCapability.ArkUI.ArkUI.Full
725   * @crossplatform
726   * @form
727   * @atomicservice
728   * @since arkts {'1.1':'12','1.2':'20'}
729   * @arkts 1.1&1.2
730   */
731  fontFeature(value: string): TextClockAttribute;
732
733  /**
734   * Set the content modifier of textclock.
735   *
736   * @param { ContentModifier<TextClockConfiguration> } modifier - The content modifier of textclock.
737   * @returns { TextClockAttribute }
738   * @syscap SystemCapability.ArkUI.ArkUI.Full
739   * @crossplatform
740   * @atomicservice
741   * @since arkts {'1.1':'12','1.2':'20'}
742   * @arkts 1.1&1.2
743   */
744  contentModifier(modifier: ContentModifier<TextClockConfiguration>): TextClockAttribute;
745
746  /**
747   * Set hour format
748   *
749   * @param { Optional<DateTimeOptions> } dateTimeOptions - Indicates whether a leading 0 is required for the hour.
750   * @returns { TextClockAttribute } the attribute of the text clock
751   * @syscap SystemCapability.ArkUI.ArkUI.Full
752   * @crossplatform
753   * @form
754   * @atomicservice
755   * @since arkts {'1.1':'12','1.2':'20'}
756   * @arkts 1.1&1.2
757   */
758  dateTimeOptions(dateTimeOptions: Optional<DateTimeOptions>): TextClockAttribute;
759}
760
761/**
762 * Defines TextClock Component.
763 *
764 * @syscap SystemCapability.ArkUI.ArkUI.Full
765 * @since 8
766 */
767/**
768 * Defines TextClock Component.
769 *
770 * @syscap SystemCapability.ArkUI.ArkUI.Full
771 * @crossplatform
772 * @since 10
773 */
774/**
775 * Defines TextClock Component.
776 *
777 * @syscap SystemCapability.ArkUI.ArkUI.Full
778 * @crossplatform
779 * @form
780 * @atomicservice
781 * @since 11
782 */
783declare const TextClock: TextClockInterface;
784
785/**
786 * Defines TextClock Component instance.
787 *
788 * @syscap SystemCapability.ArkUI.ArkUI.Full
789 * @since 8
790 */
791/**
792 * Defines TextClock Component instance.
793 *
794 * @syscap SystemCapability.ArkUI.ArkUI.Full
795 * @crossplatform
796 * @since 10
797 */
798/**
799 * Defines TextClock Component instance.
800 *
801 * @syscap SystemCapability.ArkUI.ArkUI.Full
802 * @crossplatform
803 * @form
804 * @atomicservice
805 * @since 11
806 */
807declare const TextClockInstance: TextClockAttribute;
808