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/** 22 * Defines the struct of TimePickerResult. 23 * 24 * @interface TimePickerResult 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 8 27 */ 28/** 29 * Defines the struct of TimePickerResult. 30 * 31 * @interface TimePickerResult 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @crossplatform 34 * @since 10 35 */ 36/** 37 * Defines the struct of TimePickerResult. 38 * 39 * @interface TimePickerResult 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @atomicservice 43 * @since 11 44 */ 45declare interface TimePickerResult { 46 /** 47 * Application hour 48 * 49 * @type { ?number } 50 * @syscap SystemCapability.ArkUI.ArkUI.Full 51 * @since 8 52 */ 53 /** 54 * Application hour 55 * 56 * @type { ?number } 57 * @syscap SystemCapability.ArkUI.ArkUI.Full 58 * @crossplatform 59 * @since 10 60 */ 61 /** 62 * Hour portion of the selected time. 63 * 64 * @type { number } 65 * @syscap SystemCapability.ArkUI.ArkUI.Full 66 * @crossplatform 67 * @atomicservice 68 * @since 11 69 */ 70 hour: number; 71 72 /** 73 * Application minute 74 * 75 * @type { ?number } 76 * @syscap SystemCapability.ArkUI.ArkUI.Full 77 * @since 8 78 */ 79 /** 80 * Application minute 81 * 82 * @type { ?number } 83 * @syscap SystemCapability.ArkUI.ArkUI.Full 84 * @crossplatform 85 * @since 10 86 */ 87 /** 88 * Minute portion of the selected time. 89 * 90 * @type { number } 91 * @syscap SystemCapability.ArkUI.ArkUI.Full 92 * @crossplatform 93 * @atomicservice 94 * @since 11 95 */ 96 minute: number; 97 98 /** 99 * Second portion of the selected time. 100 * 101 * @type { number } 102 * @syscap SystemCapability.ArkUI.ArkUI.Full 103 * @crossplatform 104 * @atomicservice 105 * @since 11 106 */ 107 second: number; 108} 109 110/** 111 * Type of the TimePicker that need to be displayed. 112 * @enum {number} 113 * @syscap SystemCapability.ArkUI.ArkUI.Full 114 * @crossplatform 115 * @since 11 116 */ 117/** 118 * Type of the TimePicker that need to be displayed. 119 * @enum {number} 120 * @syscap SystemCapability.ArkUI.ArkUI.Full 121 * @crossplatform 122 * @atomicservice 123 * @since 12 124 */ 125declare enum TimePickerFormat { 126 /** 127 * Hour and minute. 128 * @syscap SystemCapability.ArkUI.ArkUI.Full 129 * @crossplatform 130 * @since 11 131 */ 132 /** 133 * Hour and minute. 134 * @syscap SystemCapability.ArkUI.ArkUI.Full 135 * @crossplatform 136 * @atomicservice 137 * @since 12 138 */ 139 HOUR_MINUTE, 140 141 /** 142 * Hour and minute and second 143 * @syscap SystemCapability.ArkUI.ArkUI.Full 144 * @crossplatform 145 * @since 11 146 */ 147 /** 148 * Hour and minute and second 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @crossplatform 151 * @atomicservice 152 * @since 12 153 */ 154 HOUR_MINUTE_SECOND, 155} 156 157/** 158 * Defines the options of TimePicker. 159 * 160 * @interface TimePickerOptions 161 * @syscap SystemCapability.ArkUI.ArkUI.Full 162 * @since 8 163 */ 164/** 165 * Defines the options of TimePicker. 166 * 167 * @interface TimePickerOptions 168 * @syscap SystemCapability.ArkUI.ArkUI.Full 169 * @crossplatform 170 * @since 10 171 */ 172/** 173 * Defines the options of TimePicker. 174 * 175 * @interface TimePickerOptions 176 * @syscap SystemCapability.ArkUI.ArkUI.Full 177 * @crossplatform 178 * @atomicservice 179 * @since 11 180 */ 181declare interface TimePickerOptions { 182 /** 183 * Specifies the time selector check time. 184 * 185 * @type { ?Date } 186 * @syscap SystemCapability.ArkUI.ArkUI.Full 187 * @since 8 188 */ 189 /** 190 * Specifies the time selector check time. 191 * 192 * @type { ?Date } 193 * @syscap SystemCapability.ArkUI.ArkUI.Full 194 * @crossplatform 195 * @since 10 196 */ 197 /** 198 * Specifies the time selector check time. 199 * 200 * @type { ?Date } 201 * @syscap SystemCapability.ArkUI.ArkUI.Full 202 * @crossplatform 203 * @atomicservice 204 * @since 11 205 */ 206 selected?: Date; 207 208 /** 209 * Specifies the format of the TimePicker that need to be displayed. 210 * 211 * @type { ?TimePickerFormat } 212 * @default HOUR_MINUTE 213 * @syscap SystemCapability.ArkUI.ArkUI.Full 214 * @crossplatform 215 * @since 11 216 */ 217 /** 218 * Specifies the format of the TimePicker that need to be displayed. 219 * 220 * @type { ?TimePickerFormat } 221 * @default HOUR_MINUTE 222 * @syscap SystemCapability.ArkUI.ArkUI.Full 223 * @crossplatform 224 * @atomicservice 225 * @since 12 226 */ 227 format?: TimePickerFormat; 228 229 /** 230 * Defines the start time of the time picker. 231 * 232 * @type { ?Date } 233 * @syscap SystemCapability.ArkUI.ArkUI.Full 234 * @crossplatform 235 * @atomicservice 236 * @since 18 237 */ 238 start?: Date; 239 240 /** 241 * Defines the end time of the time picker. 242 * 243 * @type { ?Date } 244 * @syscap SystemCapability.ArkUI.ArkUI.Full 245 * @crossplatform 246 * @atomicservice 247 * @since 18 248 */ 249 end?: Date; 250} 251 252/** 253 * Defines the TimePicker Component. 254 * 255 * @interface TimePickerInterface 256 * @syscap SystemCapability.ArkUI.ArkUI.Full 257 * @since 8 258 */ 259/** 260 * Defines the TimePicker Component. 261 * 262 * @interface TimePickerInterface 263 * @syscap SystemCapability.ArkUI.ArkUI.Full 264 * @crossplatform 265 * @since 10 266 */ 267/** 268 * Defines the TimePicker Component. 269 * 270 * @interface TimePickerInterface 271 * @syscap SystemCapability.ArkUI.ArkUI.Full 272 * @crossplatform 273 * @atomicservice 274 * @since 11 275 */ 276interface TimePickerInterface { 277 /** 278 * Defines the TimePicker constructor. 279 * 280 * @param { TimePickerOptions } options 281 * @returns { TimePickerAttribute } 282 * @syscap SystemCapability.ArkUI.ArkUI.Full 283 * @since 8 284 */ 285 /** 286 * Defines the TimePicker constructor. 287 * 288 * @param { TimePickerOptions } options 289 * @returns { TimePickerAttribute } 290 * @syscap SystemCapability.ArkUI.ArkUI.Full 291 * @crossplatform 292 * @since 10 293 */ 294 /** 295 * Defines the TimePicker constructor. 296 * 297 * @param { TimePickerOptions } options 298 * @returns { TimePickerAttribute } 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @crossplatform 301 * @atomicservice 302 * @since 11 303 */ 304 (options?: TimePickerOptions): TimePickerAttribute; 305} 306/** 307 * Define the internationalization parameter format. 308 * 309 * @typedef { import('../api/@ohos.intl').default.DateTimeOptions } DateTimeOptions 310 * @syscap SystemCapability.ArkUI.ArkUI.Full 311 * @crossplatform 312 * @atomicservice 313 * @since 12 314 */ 315declare type DateTimeOptions = import('../api/@ohos.intl').default.DateTimeOptions 316 317/** 318 * Callback of the timePicker time is selected event. 319 * 320 * @typedef {function} OnTimePickerChangeCallback 321 * @syscap SystemCapability.ArkUI.ArkUI.Full 322 * @crossplatform 323 * @atomicservice 324 * @since 18 325 */ 326declare type OnTimePickerChangeCallback = (result: TimePickerResult) => void; 327 328/** 329 * Defines the TimePicker attribute functions. 330 * 331 * @extends CommonMethod<TimePickerAttribute> 332 * @syscap SystemCapability.ArkUI.ArkUI.Full 333 * @since 8 334 */ 335/** 336 * Defines the TimePicker attribute functions. 337 * 338 * @extends CommonMethod<TimePickerAttribute> 339 * @syscap SystemCapability.ArkUI.ArkUI.Full 340 * @crossplatform 341 * @since 10 342 */ 343/** 344 * Defines the TimePicker attribute functions. 345 * 346 * @extends CommonMethod<TimePickerAttribute> 347 * @syscap SystemCapability.ArkUI.ArkUI.Full 348 * @crossplatform 349 * @atomicservice 350 * @since 11 351 */ 352declare class TimePickerAttribute extends CommonMethod<TimePickerAttribute> { 353 /** 354 * Time Selector: indicates whether to display the 24-hour clock. 355 * 356 * @param { boolean } value 357 * @returns { TimePickerAttribute } 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @since 8 360 */ 361 /** 362 * Time Selector: indicates whether to display the 24-hour clock. 363 * 364 * @param { boolean } value 365 * @returns { TimePickerAttribute } 366 * @syscap SystemCapability.ArkUI.ArkUI.Full 367 * @crossplatform 368 * @since 10 369 */ 370 /** 371 * Time Selector: indicates whether to display the 24-hour clock. 372 * 373 * @param { boolean } value 374 * @returns { TimePickerAttribute } 375 * @syscap SystemCapability.ArkUI.ArkUI.Full 376 * @crossplatform 377 * @atomicservice 378 * @since 11 379 */ 380 useMilitaryTime(value: boolean): TimePickerAttribute; 381 382 /** 383 * Time Selector: indicates whether to display the 24-hour clock. 384 * 385 * @param { Optional<boolean> } isMilitaryTime 386 * @returns { TimePickerAttribute } 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @crossplatform 389 * @atomicservice 390 * @since 18 391 */ 392 useMilitaryTime(isMilitaryTime: Optional<boolean>): TimePickerAttribute; 393 394 /** 395 * Sets whether to enable the wheel mode. 396 * @param { boolean } value - indicates whether to enable the wheel mode. 397 * @returns { TimePickerAttribute } the attribute of the time picker 398 * @syscap SystemCapability.ArkUI.ArkUI.Full 399 * @crossplatform 400 * @since 11 401 */ 402 /** 403 * Sets whether to enable the wheel mode. 404 * @param { boolean } value - indicates whether to enable the wheel mode. 405 * @returns { TimePickerAttribute } the attribute of the time picker 406 * @syscap SystemCapability.ArkUI.ArkUI.Full 407 * @crossplatform 408 * @atomicservice 409 * @since 12 410 */ 411 loop(value: boolean): TimePickerAttribute; 412 413 /** 414 * Sets whether to enable the wheel mode. 415 * @param { Optional<boolean> } isLoop - indicates whether to enable the wheel mode. 416 * @returns { TimePickerAttribute } the attribute of the time picker 417 * @syscap SystemCapability.ArkUI.ArkUI.Full 418 * @crossplatform 419 * @atomicservice 420 * @since 18 421 */ 422 loop(isLoop: Optional<boolean>): TimePickerAttribute; 423 424 /** 425 * Sets the text style of disappearing items 426 * 427 * @param { PickerTextStyle } value - indicates the text style of disappearing items. 428 * @returns { TimePickerAttribute } 429 * @syscap SystemCapability.ArkUI.ArkUI.Full 430 * @crossplatform 431 * @since 10 432 */ 433 /** 434 * Sets the text style of disappearing items 435 * 436 * @param { PickerTextStyle } value - indicates the text style of disappearing items. 437 * @returns { TimePickerAttribute } 438 * @syscap SystemCapability.ArkUI.ArkUI.Full 439 * @crossplatform 440 * @atomicservice 441 * @since 11 442 */ 443 disappearTextStyle(value: PickerTextStyle): TimePickerAttribute; 444 445 /** 446 * Sets the text style of disappearing items 447 * 448 * @param { Optional<PickerTextStyle> } style - indicates the text style of disappearing items. 449 * @returns { TimePickerAttribute } 450 * @syscap SystemCapability.ArkUI.ArkUI.Full 451 * @crossplatform 452 * @atomicservice 453 * @since 18 454 */ 455 disappearTextStyle(style: Optional<PickerTextStyle>): TimePickerAttribute; 456 457 /** 458 * Sets the text style of normal items 459 * 460 * @param { PickerTextStyle } value - indicates the text style of normal items. 461 * @returns { TimePickerAttribute } 462 * @syscap SystemCapability.ArkUI.ArkUI.Full 463 * @crossplatform 464 * @since 10 465 */ 466 /** 467 * Sets the text style of normal items 468 * 469 * @param { PickerTextStyle } value - indicates the text style of normal items. 470 * @returns { TimePickerAttribute } 471 * @syscap SystemCapability.ArkUI.ArkUI.Full 472 * @crossplatform 473 * @atomicservice 474 * @since 11 475 */ 476 textStyle(value: PickerTextStyle): TimePickerAttribute; 477 478 /** 479 * Sets the text style of normal items 480 * 481 * @param { Optional<PickerTextStyle> } style - indicates the text style of normal items. 482 * @returns { TimePickerAttribute } 483 * @syscap SystemCapability.ArkUI.ArkUI.Full 484 * @crossplatform 485 * @atomicservice 486 * @since 18 487 */ 488 textStyle(style: Optional<PickerTextStyle>): TimePickerAttribute; 489 490 /** 491 * Sets the text style of selected items 492 * 493 * @param { PickerTextStyle } value - indicates the text style of selected items. 494 * @returns { TimePickerAttribute } 495 * @syscap SystemCapability.ArkUI.ArkUI.Full 496 * @crossplatform 497 * @since 10 498 */ 499 /** 500 * Sets the text style of selected items 501 * 502 * @param { PickerTextStyle } value - indicates the text style of selected items. 503 * @returns { TimePickerAttribute } 504 * @syscap SystemCapability.ArkUI.ArkUI.Full 505 * @crossplatform 506 * @atomicservice 507 * @since 11 508 */ 509 selectedTextStyle(value: PickerTextStyle): TimePickerAttribute; 510 511 /** 512 * Sets the text style of selected items 513 * 514 * @param { Optional<PickerTextStyle> } style - indicates the text style of selected items. 515 * @returns { TimePickerAttribute } 516 * @syscap SystemCapability.ArkUI.ArkUI.Full 517 * @crossplatform 518 * @atomicservice 519 * @since 18 520 */ 521 selectedTextStyle(style: Optional<PickerTextStyle>): TimePickerAttribute; 522 523 /** 524 * Set time format 525 * 526 * @param { DateTimeOptions } value - indicates the format of the time display. 527 * @returns { TimePickerAttribute } the attribute of the time picker 528 * @syscap SystemCapability.ArkUI.ArkUI.Full 529 * @crossplatform 530 * @atomicservice 531 * @since 12 532 */ 533 dateTimeOptions(value: DateTimeOptions): TimePickerAttribute; 534 535 /** 536 * Set time format 537 * 538 * @param { Optional<DateTimeOptions> } timeFormat - indicates the format of the time display. 539 * @returns { TimePickerAttribute } the attribute of the time picker 540 * @syscap SystemCapability.ArkUI.ArkUI.Full 541 * @crossplatform 542 * @atomicservice 543 * @since 18 544 */ 545 dateTimeOptions(timeFormat: Optional<DateTimeOptions>): TimePickerAttribute; 546 547 /** 548 * This event is triggered when a TimePicker time is selected. 549 * 550 * @param { function } callback 551 * @returns { TimePickerAttribute } 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @since 8 554 */ 555 /** 556 * This event is triggered when a TimePicker time is selected. 557 * 558 * @param { function } callback 559 * @returns { TimePickerAttribute } 560 * @syscap SystemCapability.ArkUI.ArkUI.Full 561 * @crossplatform 562 * @since 10 563 */ 564 /** 565 * This event is triggered when a TimePicker time is selected. 566 * 567 * @param { function } callback 568 * @returns { TimePickerAttribute } 569 * @syscap SystemCapability.ArkUI.ArkUI.Full 570 * @crossplatform 571 * @atomicservice 572 * @since 11 573 */ 574 onChange(callback: (value: TimePickerResult) => void): TimePickerAttribute; 575 576 /** 577 * This event is triggered when a TimePicker time is selected. 578 * 579 * @param { Optional<OnTimePickerChangeCallback> } callback 580 * @returns { TimePickerAttribute } 581 * @syscap SystemCapability.ArkUI.ArkUI.Full 582 * @crossplatform 583 * @atomicservice 584 * @since 18 585 */ 586 onChange(callback: Optional<OnTimePickerChangeCallback>): TimePickerAttribute; 587 588 /** 589 * This event is triggered when an item enters the selected area. 590 * 591 * @param { Callback<TimePickerResult> } callback 592 * @returns { TimePickerAttribute } 593 * @syscap SystemCapability.ArkUI.ArkUI.Full 594 * @crossplatform 595 * @atomicservice 596 * @since 18 597 */ 598 onEnterSelectedArea(callback: Callback<TimePickerResult>): TimePickerAttribute; 599 600 /** 601 * Enable or disable haptic feedback. 602 * 603 * @param { boolean } enable - Default value is true, set false to disable haptic feedback. 604 * @returns { TimePickerAttribute } 605 * @syscap SystemCapability.ArkUI.ArkUI.Full 606 * @atomicservice 607 * @since 12 608 */ 609 enableHapticFeedback(enable: boolean): TimePickerAttribute; 610 611 /** 612 * Enable or disable haptic feedback. 613 * 614 * @param { Optional<boolean> } enable - Default value is true, set false to disable haptic feedback. 615 * @returns { TimePickerAttribute } 616 * @syscap SystemCapability.ArkUI.ArkUI.Full 617 * @atomicservice 618 * @since 18 619 */ 620 enableHapticFeedback(enable: Optional<boolean>): TimePickerAttribute; 621 622 /** 623 * If the attribute is set, the crown rotation sensitivity can be changed. 624 * 625 * @param { Optional<CrownSensitivity> } sensitivity 626 * @returns { TimePickerAttribute } 627 * @syscap SystemCapability.ArkUI.ArkUI.Full 628 * @crossplatform 629 * @atomicservice 630 * @since 18 631 */ 632 digitalCrownSensitivity(sensitivity: Optional<CrownSensitivity>): TimePickerAttribute; 633 634 /** 635 * Defines whether the AM/PM option is cascaded with the time in 12-hour mode. 636 * 637 * @param { boolean } enabled - Default value is false, set true to enable. 638 * @returns { TimePickerAttribute } 639 * @syscap SystemCapability.ArkUI.ArkUI.Full 640 * @crossplatform 641 * @atomicservice 642 * @since 18 643 */ 644 enableCascade(enabled: boolean): TimePickerAttribute; 645} 646 647/** 648 * Defines the TimePickerDialogOptions for Data Picker Dialog. 649 * 650 * @extends TimePickerOptions 651 * @interface TimePickerDialogOptions 652 * @syscap SystemCapability.ArkUI.ArkUI.Full 653 * @since 8 654 */ 655/** 656 * Defines the TimePickerDialogOptions for Data Picker Dialog. 657 * 658 * @extends TimePickerOptions 659 * @interface TimePickerDialogOptions 660 * @syscap SystemCapability.ArkUI.ArkUI.Full 661 * @crossplatform 662 * @since 10 663 */ 664/** 665 * Defines the TimePickerDialogOptions for Data Picker Dialog. 666 * 667 * @extends TimePickerOptions 668 * @interface TimePickerDialogOptions 669 * @syscap SystemCapability.ArkUI.ArkUI.Full 670 * @crossplatform 671 * @atomicservice 672 * @since 11 673 */ 674declare interface TimePickerDialogOptions extends TimePickerOptions { 675 /** 676 * Time Selector: indicates whether to display the 24-hour clock. 677 * 678 * @type { ?boolean } 679 * @syscap SystemCapability.ArkUI.ArkUI.Full 680 * @since 8 681 */ 682 /** 683 * Time Selector: indicates whether to display the 24-hour clock. 684 * 685 * @type { ?boolean } 686 * @syscap SystemCapability.ArkUI.ArkUI.Full 687 * @crossplatform 688 * @since 10 689 */ 690 /** 691 * Time Selector: indicates whether to display the 24-hour clock. 692 * 693 * @type { ?boolean } 694 * @syscap SystemCapability.ArkUI.ArkUI.Full 695 * @crossplatform 696 * @atomicservice 697 * @since 11 698 */ 699 useMilitaryTime?: boolean; 700 701 /** 702 * Text style of disappearing items 703 * 704 * @type { ?PickerTextStyle } 705 * @syscap SystemCapability.ArkUI.ArkUI.Full 706 * @crossplatform 707 * @since 10 708 */ 709 /** 710 * Text style of disappearing items 711 * 712 * @type { ?PickerTextStyle } 713 * @syscap SystemCapability.ArkUI.ArkUI.Full 714 * @crossplatform 715 * @atomicservice 716 * @since 11 717 */ 718 disappearTextStyle?: PickerTextStyle; 719 720 /** 721 * Text style of normal items 722 * 723 * @type { ?PickerTextStyle } 724 * @syscap SystemCapability.ArkUI.ArkUI.Full 725 * @crossplatform 726 * @since 10 727 */ 728 /** 729 * Text style of normal items 730 * 731 * @type { ?PickerTextStyle } 732 * @syscap SystemCapability.ArkUI.ArkUI.Full 733 * @crossplatform 734 * @atomicservice 735 * @since 11 736 */ 737 textStyle?: PickerTextStyle; 738 739 /** 740 * Style of accept button. 741 * 742 * @type { ?PickerDialogButtonStyle } 743 * @syscap SystemCapability.ArkUI.ArkUI.Full 744 * @crossplatform 745 * @atomicservice 746 * @since 12 747 */ 748 acceptButtonStyle?: PickerDialogButtonStyle; 749 750 /** 751 * Style of cancel button. 752 * 753 * @type { ?PickerDialogButtonStyle } 754 * @syscap SystemCapability.ArkUI.ArkUI.Full 755 * @crossplatform 756 * @atomicservice 757 * @since 12 758 */ 759 cancelButtonStyle?: PickerDialogButtonStyle; 760 761 /** 762 * Text style of selected items 763 * 764 * @type { ?PickerTextStyle } 765 * @syscap SystemCapability.ArkUI.ArkUI.Full 766 * @crossplatform 767 * @since 10 768 */ 769 /** 770 * Text style of selected items 771 * 772 * @type { ?PickerTextStyle } 773 * @syscap SystemCapability.ArkUI.ArkUI.Full 774 * @crossplatform 775 * @atomicservice 776 * @since 11 777 */ 778 selectedTextStyle?: PickerTextStyle; 779 780 /** 781 * Mask Region of dialog. The size cannot exceed the main window. 782 * 783 * @type { ?Rectangle } 784 * @syscap SystemCapability.ArkUI.ArkUI.Full 785 * @crossplatform 786 * @since 10 787 */ 788 /** 789 * Mask Region of dialog. The size cannot exceed the main window. 790 * 791 * @type { ?Rectangle } 792 * @syscap SystemCapability.ArkUI.ArkUI.Full 793 * @crossplatform 794 * @atomicservice 795 * @since 11 796 */ 797 maskRect?: Rectangle; 798 799 /** 800 * Defines the dialog alignment of the screen. 801 * 802 * @type { ?DialogAlignment } 803 * @syscap SystemCapability.ArkUI.ArkUI.Full 804 * @crossplatform 805 * @since 10 806 */ 807 /** 808 * Defines the dialog alignment of the screen. 809 * 810 * @type { ?DialogAlignment } 811 * @syscap SystemCapability.ArkUI.ArkUI.Full 812 * @crossplatform 813 * @atomicservice 814 * @since 11 815 */ 816 alignment?: DialogAlignment; 817 818 /** 819 * Defines the dialog offset. 820 * 821 * @type { ?Offset } 822 * @syscap SystemCapability.ArkUI.ArkUI.Full 823 * @crossplatform 824 * @since 10 825 */ 826 /** 827 * Defines the dialog offset. 828 * 829 * @type { ?Offset } 830 * @syscap SystemCapability.ArkUI.ArkUI.Full 831 * @crossplatform 832 * @atomicservice 833 * @since 11 834 */ 835 offset?: Offset; 836 837 /** 838 * Called when the OK button in the dialog is clicked. 839 * 840 * @type { ?function } 841 * @syscap SystemCapability.ArkUI.ArkUI.Full 842 * @since 8 843 */ 844 /** 845 * Called when the OK button in the dialog is clicked. 846 * 847 * @type { ?function } 848 * @syscap SystemCapability.ArkUI.ArkUI.Full 849 * @crossplatform 850 * @since 10 851 */ 852 /** 853 * Called when the OK button in the dialog is clicked. 854 * 855 * @type { ?function } 856 * @syscap SystemCapability.ArkUI.ArkUI.Full 857 * @crossplatform 858 * @atomicservice 859 * @since 11 860 */ 861 onAccept?: (value: TimePickerResult) => void; 862 863 /** 864 * Called when the Cancel button in the dialog is clicked. 865 * 866 * @type { ?function } 867 * @syscap SystemCapability.ArkUI.ArkUI.Full 868 * @since 8 869 */ 870 /** 871 * Called when the Cancel button in the dialog is clicked. 872 * 873 * @type { ?function } 874 * @syscap SystemCapability.ArkUI.ArkUI.Full 875 * @crossplatform 876 * @since 10 877 */ 878 /** 879 * Called when the Cancel button in the dialog is clicked. 880 * 881 * @type { ?function } 882 * @syscap SystemCapability.ArkUI.ArkUI.Full 883 * @crossplatform 884 * @atomicservice 885 * @since 11 886 */ 887 onCancel?: () => void; 888 889 /** 890 * This event is triggered when a TimePicker Time or time is selected in dialog. 891 * 892 * @type { ?function } 893 * @syscap SystemCapability.ArkUI.ArkUI.Full 894 * @since 8 895 */ 896 /** 897 * This event is triggered when a TimePicker Time or time is selected in dialog. 898 * 899 * @type { ?function } 900 * @syscap SystemCapability.ArkUI.ArkUI.Full 901 * @crossplatform 902 * @since 10 903 */ 904 /** 905 * This event is triggered when a TimePicker Time or time is selected in dialog. 906 * 907 * @type { ?function } 908 * @syscap SystemCapability.ArkUI.ArkUI.Full 909 * @crossplatform 910 * @atomicservice 911 * @since 11 912 */ 913 onChange?: (value: TimePickerResult) => void; 914 915 /** 916 * This event is triggered when an item enters the selected area in dialog. 917 * 918 * @type { ?Callback<TimePickerResult> } 919 * @syscap SystemCapability.ArkUI.ArkUI.Full 920 * @crossplatform 921 * @atomicservice 922 * @since 18 923 */ 924 onEnterSelectedArea?: Callback<TimePickerResult>; 925 926 /** 927 * Defines the timePickerDialog's background color 928 * 929 * @type { ?ResourceColor } 930 * @default Color.Transparent 931 * @syscap SystemCapability.ArkUI.ArkUI.Full 932 * @crossplatform 933 * @since 11 934 */ 935 /** 936 * Defines the timePickerDialog's background color 937 * 938 * @type { ?ResourceColor } 939 * @default Color.Transparent 940 * @syscap SystemCapability.ArkUI.ArkUI.Full 941 * @crossplatform 942 * @atomicservice 943 * @since 12 944 */ 945 backgroundColor?: ResourceColor; 946 947 /** 948 * Defines the timePickerDialog's background blur Style 949 * 950 * @type { ?BlurStyle } 951 * @default BlurStyle.COMPONENT_ULTRA_THICK 952 * @syscap SystemCapability.ArkUI.ArkUI.Full 953 * @crossplatform 954 * @since 11 955 */ 956 /** 957 * Defines the timePickerDialog's background blur Style 958 * 959 * @type { ?BlurStyle } 960 * @default BlurStyle.COMPONENT_ULTRA_THICK 961 * @syscap SystemCapability.ArkUI.ArkUI.Full 962 * @crossplatform 963 * @atomicservice 964 * @since 12 965 */ 966 backgroundBlurStyle?: BlurStyle; 967 968 /** 969 * Defines whether the AM/PM option is cascaded with the time in 12-hour mode. 970 * 971 * @type { ?boolean } 972 * @default false 973 * @syscap SystemCapability.ArkUI.ArkUI.Full 974 * @crossplatform 975 * @atomicservice 976 * @since 18 977 */ 978 enableCascade?: boolean; 979 980 /** 981 * Callback function when the dialog appears. 982 * 983 * @type { ?function } 984 * @syscap SystemCapability.ArkUI.ArkUI.Full 985 * @crossplatform 986 * @atomicservice 987 * @since 12 988 */ 989 onDidAppear?: () => void; 990 991 /** 992 * Callback function when the dialog disappears. 993 * 994 * @type { ?function } 995 * @syscap SystemCapability.ArkUI.ArkUI.Full 996 * @crossplatform 997 * @atomicservice 998 * @since 12 999 */ 1000 onDidDisappear?: () => void; 1001 1002 /** 1003 * Callback function before the dialog openAnimation starts. 1004 * 1005 * @type { ?function } 1006 * @syscap SystemCapability.ArkUI.ArkUI.Full 1007 * @crossplatform 1008 * @atomicservice 1009 * @since 12 1010 */ 1011 onWillAppear?: () => void; 1012 1013 /** 1014 * Callback function before the dialog closeAnimation starts. 1015 * 1016 * @type { ?function } 1017 * @syscap SystemCapability.ArkUI.ArkUI.Full 1018 * @crossplatform 1019 * @atomicservice 1020 * @since 12 1021 */ 1022 onWillDisappear?: () => void; 1023 1024 /** 1025 * Defines the dialog's shadow. 1026 * 1027 * @type { ?(ShadowOptions | ShadowStyle) } 1028 * @syscap SystemCapability.ArkUI.ArkUI.Full 1029 * @crossplatform 1030 * @atomicservice 1031 * @since 12 1032 */ 1033 shadow?: ShadowOptions | ShadowStyle; 1034 1035 /** 1036 * Set time format 1037 * 1038 * @type { ?DateTimeOptions } 1039 * @syscap SystemCapability.ArkUI.ArkUI.Full 1040 * @crossplatform 1041 * @atomicservice 1042 * @since 12 1043 */ 1044 dateTimeOptions?: DateTimeOptions; 1045 1046 /** 1047 * Defines whether to respond to the hover mode. 1048 * 1049 * @type { ?boolean } 1050 * @default false 1051 * @syscap SystemCapability.ArkUI.ArkUI.Full 1052 * @crossplatform 1053 * @atomicservice 1054 * @since 14 1055 */ 1056 enableHoverMode?: boolean; 1057 1058 /** 1059 * Defines the dialog's display area in hover mode. 1060 * 1061 * @type { ?HoverModeAreaType } 1062 * @default HoverModeAreaType.BOTTOM_SCREEN 1063 * @syscap SystemCapability.ArkUI.ArkUI.Full 1064 * @crossplatform 1065 * @atomicservice 1066 * @since 14 1067 */ 1068 hoverModeArea?: HoverModeAreaType; 1069 1070 /** 1071 * Enable or disable haptic feedback. 1072 * 1073 * @type { ?boolean } 1074 * @default true 1075 * @syscap SystemCapability.ArkUI.ArkUI.Full 1076 * @atomicservice 1077 * @since 18 1078 */ 1079 enableHapticFeedback?: boolean; 1080} 1081 1082/** 1083 * Defines TimePickerDialog which uses show method to show TimePicker dialog. 1084 * 1085 * @syscap SystemCapability.ArkUI.ArkUI.Full 1086 * @since 8 1087 */ 1088/** 1089 * Defines TimePickerDialog which uses show method to show TimePicker dialog. 1090 * 1091 * @syscap SystemCapability.ArkUI.ArkUI.Full 1092 * @crossplatform 1093 * @since 10 1094 */ 1095/** 1096 * Defines TimePickerDialog which uses show method to show TimePicker dialog. 1097 * 1098 * @syscap SystemCapability.ArkUI.ArkUI.Full 1099 * @crossplatform 1100 * @atomicservice 1101 * @since 11 1102 */ 1103declare class TimePickerDialog { 1104 /** 1105 * Invoking method display. 1106 * 1107 * @param { TimePickerDialogOptions } options 1108 * @syscap SystemCapability.ArkUI.ArkUI.Full 1109 * @since 8 1110 */ 1111 /** 1112 * Invoking method display. 1113 * 1114 * @param { TimePickerDialogOptions } options 1115 * @syscap SystemCapability.ArkUI.ArkUI.Full 1116 * @crossplatform 1117 * @since 10 1118 */ 1119 /** 1120 * Invoking method display. 1121 * 1122 * @param { TimePickerDialogOptions } options 1123 * @syscap SystemCapability.ArkUI.ArkUI.Full 1124 * @crossplatform 1125 * @atomicservice 1126 * @since 11 1127 * @deprecated since 18 1128 * @useinstead ohos.arkui.UIContext.UIContext#showTimePickerDialog 1129 */ 1130 static show(options?: TimePickerDialogOptions); 1131} 1132 1133/** 1134 * Defines TimePicker Component. 1135 * 1136 * @syscap SystemCapability.ArkUI.ArkUI.Full 1137 * @since 8 1138 */ 1139/** 1140 * Defines TimePicker Component. 1141 * 1142 * @syscap SystemCapability.ArkUI.ArkUI.Full 1143 * @crossplatform 1144 * @since 10 1145 */ 1146/** 1147 * Defines TimePicker Component. 1148 * 1149 * @syscap SystemCapability.ArkUI.ArkUI.Full 1150 * @crossplatform 1151 * @atomicservice 1152 * @since 11 1153 */ 1154declare const TimePicker: TimePickerInterface; 1155 1156/** 1157 * Defines TimePicker Component instance. 1158 * 1159 * @syscap SystemCapability.ArkUI.ArkUI.Full 1160 * @since 8 1161 */ 1162/** 1163 * Defines TimePicker Component instance. 1164 * 1165 * @syscap SystemCapability.ArkUI.ArkUI.Full 1166 * @crossplatform 1167 * @since 10 1168 */ 1169/** 1170 * Defines TimePicker Component instance. 1171 * 1172 * @syscap SystemCapability.ArkUI.ArkUI.Full 1173 * @crossplatform 1174 * @atomicservice 1175 * @since 11 1176 */ 1177declare const TimePickerInstance: TimePickerAttribute; 1178