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