46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.multimodalInput.pointer.d.ts 74.20 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749
/*
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit InputKit
*/
/*** if arkts 1.1 */
import type { AsyncCallback } from './@ohos.base';
import type image from './@ohos.multimedia.image';
/*** endif */
/*** if arkts 1.2 */
import { AsyncCallback } from './@ohos.base';
import image from './@ohos.multimedia.image';
/*** endif */
/**
* The pointer module provides APIs related to pointer attribute management, such as querying and setting pointer attributes.
*
* @namespace pointer
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
/**
* The pointer module provides APIs related to pointer attribute management, such as querying and setting pointer attributes.
*
* @namespace pointer
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace pointer {
/**
* Enumerates mouse pointer styles.
*
* @enum { number }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
/**
* Enumerates mouse pointer styles.
*
* @enum { number }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
enum PointerStyle {
/**
* Default
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
DEFAULT,
/**
* East arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
EAST,
/**
* West arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
WEST,
/**
* South arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
SOUTH,
/**
* North arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
NORTH,
/**
* East-west arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
WEST_EAST,
/**
* North-south arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
NORTH_SOUTH,
/**
* North-east arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
NORTH_EAST,
/**
* North-west arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
NORTH_WEST,
/**
* South-east arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
SOUTH_EAST,
/**
* South-west arrow
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
SOUTH_WEST,
/**
* Northeast and southwest adjustment
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
NORTH_EAST_SOUTH_WEST,
/**
* Northwest and southeast adjustment
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
NORTH_WEST_SOUTH_EAST,
/**
* Cross (accurate selection)
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
CROSS,
/**
* Copy
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
CURSOR_COPY,
/**
* Forbid
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
CURSOR_FORBID,
/**
* Sucker
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
COLOR_SUCKER,
/**
* Grabbing hand
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
HAND_GRABBING,
/**
* Opening hand
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
HAND_OPEN,
/**
* Hand-shaped pointer
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
HAND_POINTING,
/**
* Help
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
HELP,
/**
* Move
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MOVE,
/**
* Left and right resizing
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
RESIZE_LEFT_RIGHT,
/**
* Up and down resizing
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
RESIZE_UP_DOWN,
/**
* Screenshot crosshair
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
SCREENSHOT_CHOOSE,
/**
* Screenshot
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
SCREENSHOT_CURSOR,
/**
* Text selection
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TEXT_CURSOR,
/**
* Zoom in
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
ZOOM_IN,
/**
* Zoom out
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
ZOOM_OUT,
/**
* Scrolling east
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_EAST,
/**
* Scrolling west
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_WEST,
/**
* Scrolling south
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_SOUTH,
/**
* Scrolling north
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_NORTH,
/**
* Scrolling north and south
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_NORTH_SOUTH,
/**
* Scrolling northeast
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_NORTH_EAST,
/**
* Scrolling northwest
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_NORTH_WEST,
/**
* Scrolling southeast
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_SOUTH_EAST,
/**
* Scrolling southwest
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_SOUTH_WEST,
/**
* Moving as a cone in four directions
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_NORTH_SOUTH_WEST_EAST,
/**
* Horizontal text selection
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
HORIZONTAL_TEXT_CURSOR,
/**
* Precise selection
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
CURSOR_CROSS,
/**
* Cursor with circle style
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
CURSOR_CIRCLE,
/**
* Loading state with dynamic cursor
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
/**
* Loading state with dynamic cursor
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @atomicservice
* @since arkts{ '1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOADING,
/**
* Running state with dynamic cursor
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
/**
* Running state with dynamic cursor
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @atomicservice
* @since arkts{ '1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
RUNNING,
/**
* Scrolling east and west
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
MIDDLE_BTN_EAST_WEST,
/**
* Screen recorder cursor
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 20
* @arkts 1.1&1.2
*/
SCREENRECORDER_CURSOR = 48
}
/**
* Mouse button.
*
* @enum { number }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
enum PrimaryButton {
/**
* Left mouse button
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
LEFT = 0,
/**
* Right mouse button
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
RIGHT = 1
}
/**
* Enumerates shortcut menu triggering modes.
*
* @enum { number }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
enum RightClickType {
/**
* Tapping the right-button area of the touchpad.
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
TOUCHPAD_RIGHT_BUTTON = 1,
/**
* Tapping the left-button area of the touchpad.
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
TOUCHPAD_LEFT_BUTTON = 2,
/**
* Tapping or pressing the touchpad with two fingers.
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
TOUCHPAD_TWO_FINGER_TAP = 3,
/**
* Touchpad two fingers tap or right button.
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 20
*/
TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON = 4,
/**
* Touchpad two fingers tap or left button.
*
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 20
*/
TOUCHPAD_TWO_FINGER_TAP_OR_LEFT_BUTTON = 5,
}
/**
* Pixel map resource.
*
* @interface CustomCursor
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 15
*/
interface CustomCursor {
/**
* Defines a custom cursor. The minimum size is subject to the minimum limit of the image. The maximum size is 256 x 256 px.
*
* @type { image.PixelMap }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 15
*/
pixelMap: image.PixelMap;
/**
* Horizontal coordinate of the cursor focus. The coordinates are restricted by the size of the custom cursor.
* The minimum value is 0, and the maximum value is the maximum width of the image. The default value is 0 if the parameter is left empty.
*
* @type { number }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 15
*/
focusX?: number;
/**
* Vertical coordinate of the cursor focus. The coordinates are restricted by the size of the custom cursor.
* The minimum value is 0, and the maximum value is the maximum height of the image. The default value is 0 if the parameter is left empty.
*
* @type { number }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 15
*/
focusY?: number;
}
/**
* Defines the custom cursor configuration.
*
* @interface CursorConfig
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 15
*/
interface CursorConfig {
/**
* Whether to adjust the cursor size based on system settings.
* The value true means to adjust the cursor size based on system settings, and the value false means to use the custom cursor size.
* The adjustment range is [size of the cursor image, 256 x 256].
*
* @type { boolean }
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 15
*/
followSystem : boolean;
}
/**
* Sets the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.
*
* @param { number } speed - Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 9
*/
/**
* Sets the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.
*
* @param { number } speed - Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 12
*/
function setPointerSpeed(speed: number, callback: AsyncCallback<void>): void;
/**
* Sets the moving speed of the mouse pointer. This API uses a promise to return the result.
*
* @param { number } speed - Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 9
*/
/**
* Sets the moving speed of the mouse pointer. This API uses a promise to return the result.
*
* @param { number } speed - Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 12
*/
function setPointerSpeed(speed: number): Promise<void>;
/**
* Sets the moving speed of the mouse pointer. This API returns the result synchronously.
*
* @param { number } speed - Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 10
*/
function setPointerSpeedSync(speed: number): void;
/**
* Obtains the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<number> } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 9
*/
/**
* Obtains the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<number> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 12
*/
function getPointerSpeed(callback: AsyncCallback<number>): void;
/**
* Obtains the moving speed of the mouse pointer. This API uses a promise to return the result.
*
* @returns { Promise<number> } Promise used to return the result.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 9
*/
/**
* Obtains the moving speed of the mouse pointer. This API uses a promise to return the result.
*
* @returns { Promise<number> } Promise used to return the result.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 12
*/
function getPointerSpeed(): Promise<number>;
/**
* Obtains the moving speed of the mouse pointer. This API returns the result synchronously.
*
* @returns { number } Returns the pointer speed through sync mode.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use
* @since 10
*/
function getPointerSpeedSync(): number;
/**
* Sets the mouse pointer style. This API uses an asynchronous callback to return the result.
*
* @param { number } windowId - Window ID.
* @param { PointerStyle } pointerStyle - Pointer style.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback<void>): void;
/**
* Sets the mouse pointer style. This API uses a promise to return the result.
*
* @param { number } windowId - Window ID.
* @param { PointerStyle } pointerStyle - Pointer style.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise<void>;
/**
* Sets the mouse pointer style. This API returns the result synchronously.
*
* @param { number } windowId - Window ID.
* @param { PointerStyle } pointerStyle - Pointer style.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
function setPointerStyleSync(windowId: number, pointerStyle: PointerStyle): void;
/**
* Obtains the mouse pointer style. This API uses an asynchronous callback to return the result.
*
* @param { number } windowId - Window ID.
* @param { AsyncCallback<PointerStyle> } callback - Callback used to return the mouse pointer style.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
function getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>): void;
/**
* Obtains the mouse pointer style. This API uses a promise to return the result.
*
* @param { number } windowId - Window ID. The value is an integer greater than or equal to -1.
* The value -1 indicates the global window.
* @returns { Promise<PointerStyle> } Promise used to return the mouse pointer style.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
function getPointerStyle(windowId: number): Promise<PointerStyle>;
/**
* Obtains the mouse pointer style, such as the east arrow, west arrow, south arrow, and north arrow.
* This API returns the result synchronously.
*
* @param { number } windowId - Window ID. The default value is -1, indicating the global mouse pointer style.
* @returns { PointerStyle } Returns the pointerStyle.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
function getPointerStyleSync(windowId: number): PointerStyle;
/**
* Sets the visible status of the mouse pointer. This API uses an asynchronous callback to return the result.
*
* @param { boolean } visible Whether the mouse pointer is visible. The value true indicates that the pointer
* icon is visible, and the value false indicates the opposite.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
/**
* Sets the visible status of the mouse pointer. This API uses an asynchronous callback to return the result.
*
* @param { boolean } visible Whether the mouse pointer is visible. The value true indicates that the pointer
* icon is visible, and the value false indicates the opposite.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported;
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 18
*/
function setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the visible status of the mouse pointer. This API uses a promise to return the result.
*
* @param { boolean } visible Whether the mouse pointer is visible. The value true indicates that the pointer
* icon is visible, and the value false indicates the opposite.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
/**
* Sets the visible status of the mouse pointer. This API uses a promise to return the result.
*
* @param { boolean } visible Whether the mouse pointer is visible. The value true indicates that the pointer
* icon is visible, and the value false indicates the opposite.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported;
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 18
*/
function setPointerVisible(visible: boolean): Promise<void>;
/**
* Sets the visible status of the mouse pointer. This API returns the result synchronously.
*
* @param { boolean } visible Whether the mouse pointer is visible. The value true indicates that the pointer
* icon is visible, and the value false indicates the opposite.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
function setPointerVisibleSync(visible: boolean): void;
/**
* Checks the visible status of the mouse pointer. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result.
* The value true indicates that the mouse pointer is visible, and the value false indicates the opposite.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
function isPointerVisible(callback: AsyncCallback<boolean>): void;
/**
* Obtains the visible status of the mouse pointer. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the visible status of the mouse pointer.
* The value true indicates that the mouse pointer is visible, and the value false indicates the opposite.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 9
*/
function isPointerVisible(): Promise<boolean>;
/**
* Obtains the visible status of the mouse pointer. This API returns the result synchronously.
*
* @returns { boolean } Visible status of the mouse pointer.
* The value true indicates that the mouse pointer is visible, and the value false indicates the opposite.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 10
*/
function isPointerVisibleSync(): boolean;
/**
* Sets the pointer color. This API uses an asynchronous callback to return the result.
*
* @param { number } color - Pointer color. The default value is black (0x000000).
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, err is undefined. Otherwise, err is an error object.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setPointerColor(color: number, callback: AsyncCallback<void>): void;
/**
* Sets the pointer color. This API uses a promise to return the result.
*
* @param { number } color - Pointer color. The default value is black (0x000000).
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setPointerColor(color: number): Promise<void>;
/**
* Sets the pointer color. This API returns the result synchronously.
*
* @param { number } color - Pointer color. The default value is black (0x000000).
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setPointerColorSync(color: number): void;
/**
* Obtains the pointer color. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<number> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getPointerColor(callback: AsyncCallback<number>): void;
/**
* Obtains the pointer color. This API uses a promise to return the result.
*
* @returns { Promise<number> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getPointerColor(): Promise<number>;
/**
* Obtains the pointer color. This API returns the result synchronously.
*
* @returns { number } Pointer color.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getPointerColorSync(): number;
/**
* Sets the pointer size. This API uses an asynchronous callback to return the result.
*
* @param { number } size - Pointer size. The value ranges from 1 to 7. The default value is 1.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* If the operation is successful, err is undefined. Otherwise, err is an error object.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setPointerSize(size: number, callback: AsyncCallback<void>): void;
/**
* Sets the pointer size. This API uses a promise to return the result.
*
* @param { number } size - Pointer size. The value ranges from 1 to 7. The default value is 1.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setPointerSize(size: number): Promise<void>;
/**
* Sets the pointer size. This API returns the result synchronously.
*
* @param { number } size - Pointer size. The value ranges from 1 to 7. The default value is 1.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setPointerSizeSync(size: number): void;
/**
* Obtains the pointer size. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<number> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getPointerSize(callback: AsyncCallback<number>): void;
/**
* Obtains the pointer size. This API uses a promise to return the result.
*
* @returns { Promise<number> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getPointerSize(): Promise<number>;
/**
* Obtains the pointer size. This API returns the result synchronously.
*
* @returns { number } Pointer size.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getPointerSizeSync(): number;
/**
* Sets the primary button of the mouse. This API uses an asynchronous callback to return the result.
*
* @param { PrimaryButton } primary - ID of the primary mouse button.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setMousePrimaryButton(primary: PrimaryButton, callback: AsyncCallback<void>): void;
/**
* Sets the primary button of the mouse. This API uses a promise to return the result.
*
* @param { PrimaryButton } primary - ID of the primary mouse button.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setMousePrimaryButton(primary: PrimaryButton): Promise<void>;
/**
* Obtains the primary button of the mouse. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<PrimaryButton> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getMousePrimaryButton(callback: AsyncCallback<PrimaryButton>): void;
/**
* Obtains the primary button of the mouse. This API uses a promise to return the result.
*
* @returns { Promise<PrimaryButton> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getMousePrimaryButton(): Promise<PrimaryButton>;
/**
* Sets the status of the mouse hover scroll switch. This API uses an asynchronous callback to return the result.
*
* @param { boolean } state - Status of the mouse hover scroll switch.
* The value true indicates that the switch is enabled, and the value false indicates the opposite.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setHoverScrollState(state: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the status of the mouse hover scroll switch. This API uses a promise to return the result.
*
* @param { boolean } state - Status of the mouse hover scroll switch.
* The value true indicates that the switch is enabled, and the value false indicates the opposite.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setHoverScrollState(state: boolean): Promise<void>;
/**
* Obtains the status of the mouse hover scroll switch. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Obtains the status of the mouse hover scroll switch.
* This API uses an asynchronous callback to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getHoverScrollState(callback: AsyncCallback<boolean>): void;
/**
* Obtains the status of the mouse hover scroll switch. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getHoverScrollState(): Promise<boolean>;
/**
* Sets the number of mouse scroll rows. This API uses an asynchronous callback to return the result.
*
* @param { number } rows - Number of mouse scroll rows. The value ranges from 1 to 100. The default value is 3.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setMouseScrollRows(rows: number, callback: AsyncCallback<void>): void;
/**
* Sets the number of mouse scroll rows. This API uses a promise to return the result.
*
* @param { number } rows - Number of mouse scroll rows. The value ranges from 1 to 100. The default value is 3.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setMouseScrollRows(rows: number): Promise<void>;
/**
* Obtains the number of mouse scroll rows. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<number> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getMouseScrollRows(callback: AsyncCallback<number>): void;
/**
* Obtains the moving speed of the mouse pointer. This API uses a promise to return the result.
*
* @returns { Promise<number> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getMouseScrollRows(): Promise<number>;
/**
* Sets the scroll switch of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { boolean } state - Scroll switch status. The value true indicates that the switch is enabled,
* and the value false indicates the opposite. The default value is true.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadScrollSwitch(state: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the scroll switch of the touchpad. This API uses a promise to return the result.
*
* @param { boolean } state - Scroll switch status. The value true indicates that the switch is enabled,
* and the value false indicates the opposite. The default value is true.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadScrollSwitch(state: boolean): Promise<void>;
/**
* Obtains the scroll switch status of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadScrollSwitch(callback: AsyncCallback<boolean>): void;
/**
* Obtains the scroll switch status of the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadScrollSwitch(): Promise<boolean>;
/**
* Sets the scroll direction of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { boolean } state - Scroll direction of the touchpad.
* The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite.
* The default value is true.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadScrollDirection(state: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the scroll direction of the touchpad. This API uses a promise to return the result.
*
* @param { boolean } state - Scroll direction of the touchpad.
* The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite.
* The default value is true.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadScrollDirection(state: boolean): Promise<void>;
/**
* Obtains the scroll direction of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result.
* The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite.
* The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadScrollDirection(callback: AsyncCallback<boolean>): void;
/**
* Obtains the scroll direction of the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result.
* The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite.
* The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadScrollDirection(): Promise<boolean>;
/**
* Sets the tap switch of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { boolean } state - Tap switch status of the touchpad The value true indicates that the switch is enabled,
* and the value false indicates the opposite. The default value is true.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadTapSwitch(state: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the tap switch of the touchpad. This API uses a promise to return the result.
*
* @param { boolean } state - Tap switch status of the touchpad. The value true indicates that the switch is enabled,
* and the value false indicates the opposite. The default value is true.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadTapSwitch(state: boolean): Promise<void>;
/**
* Obtains the tap switch status of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadTapSwitch(callback: AsyncCallback<boolean>): void;
/**
* Obtains the tap switch status of the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadTapSwitch(): Promise<boolean>;
/**
* Sets the mouse pointer moving speed of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { number } speed - Mouse pointer moving speed of the touchpad. The value range is [1,11]. The default value is 6.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadPointerSpeed(speed: number, callback: AsyncCallback<void>): void;
/**
* Sets the mouse pointer moving speed of the touchpad. This API uses a promise to return the result.
*
* @param { number } speed - Mouse pointer moving speed of the touchpad. The value range is [1,11]. The default value is 6.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadPointerSpeed(speed: number): Promise<void>;
/**
* Obtains the mouse pointer moving speed of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<number> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadPointerSpeed(callback: AsyncCallback<number>): void;
/**
* Obtains the mouse pointer moving speed of the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<number> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadPointerSpeed(): Promise<number>;
/**
* Sets the pinch switch of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { boolean } state - Pinch switch status of the touchpad.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadPinchSwitch(state: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the pinch switch of the touchpad. This API uses a promise to return the result.
*
* @param { boolean } state - Pinch switch status of the touchpad.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadPinchSwitch(state: boolean): Promise<void>;
/**
* Obtains the pinch switch status of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadPinchSwitch(callback: AsyncCallback<boolean>): void;
/**
* Obtains the pinch switch status of the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadPinchSwitch(): Promise<boolean>;
/**
* Sets the multi-finger swipe switch of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { boolean } state - Swipe switch status of the touchpad.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadSwipeSwitch(state: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the swipe switch of the touchpad. This API uses a promise to return the result.
*
* @param { boolean } state - Swipe switch status of the touchpad.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadSwipeSwitch(state: boolean): Promise<void>;
/**
* Obtains the multi-finger swipe switch status of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadSwipeSwitch(callback: AsyncCallback<boolean>): void;
/**
* Obtains the multi-finger swipe switch status of the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result.
* The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadSwipeSwitch(): Promise<boolean>;
/**
* Sets the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { RightClickType } type - Shortcut menu type of the touchpad.
- TOUCHPAD_RIGHT_BUTTON: Tapping the right-button area of the touchpad.
- TOUCHPAD_LEFT_BUTTON: Tapping the left-button area of the touchpad.
- TOUCHPAD_TWO_FINGER_TAP: Tapping or pressing the touchpad with two fingers.
- TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON: Tapping or pressing the touchpad with two fingers, or tapping the right-button area of the touchpad.
- TOUCHPAD_TWO_FINGER_TAP_OR_LEFT_BUTTON: Tapping or pressing the touchpad with two fingers, or tapping the left-button area of the touchpad.
* The default value is TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadRightClickType(type: RightClickType, callback: AsyncCallback<void>): void;
/**
* Sets the shortcut menu type of the touchpad. This API uses a promise to return the result.
*
* @param { RightClickType } type - Shortcut menu type of the touchpad.
- TOUCHPAD_RIGHT_BUTTON: Tapping the right-button area of the touchpad.
- TOUCHPAD_LEFT_BUTTON: Tapping the left-button area of the touchpad.
- TOUCHPAD_TWO_FINGER_TAP: Tapping or pressing the touchpad with two fingers.
- TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON: Tapping or pressing the touchpad with two fingers, or tapping the right-button area of the touchpad.
- TOUCHPAD_TWO_FINGER_TAP_OR_LEFT_BUTTON: Tapping or pressing the touchpad with two fingers, or tapping the left-button area of the touchpad.
* The default value is TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function setTouchpadRightClickType(type: RightClickType): Promise<void>;
/**
* Obtains the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<RightClickType> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadRightClickType(callback: AsyncCallback<RightClickType>): void;
/**
* Obtains the shortcut menu type of the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<RightClickType> } Promise used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 10
*/
function getTouchpadRightClickType(): Promise<RightClickType>;
/**
* Sets the custom cursor style. This API uses a promise to return the result.
*
* @param { number } windowId - Window ID.
* @param { image.PixelMap } pixelMap - Pixel map resource.
* @param { number } focusX - Focus x of the custom cursor. The value is greater than or equal to 0. The default value is 0.
* @param { number } focusY - Focus y of the custom cursor. The value is greater than or equal to 0. The default value is 0.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 11
*/
function setCustomCursor(windowId: number, pixelMap: image.PixelMap, focusX?: number, focusY?: number): Promise<void>;
/**
* Sets a custom cursor. This API returns the result synchronously.
*
* @param { number } windowId - Window ID. The value must be an integer greater than 0.
* @param { image.PixelMap } pixelMap - Pixel map resource.
* @param { number } focusX - Focus x of the custom cursor. The value is greater than or equal to 0. The default value is 0.
* @param { number } focusY - Focus y of the custom cursor. The value is greater than or equal to 0. The default value is 0.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 11
*/
function setCustomCursorSync(windowId: number, pixelMap: image.PixelMap, focusX?: number, focusY?: number): void;
/**
* Sets the custom cursor style. This API uses a promise to return the result.
* The cursor may be switched back to the system style in the following cases: application window layout change, hot zone switching,
* page redirection, moving of the cursor out of the window and then back to the window, or moving of the cursor in different areas of the window.
* In this case, you need to reset the cursor style.
*
* @param { number } windowId - Window ID.
* @param { CustomCursor } cursor - Pixel map resource.
* @param { CursorConfig } config - Custom cursor configuration, which specifies whether to adjust the cursor size based on system settings.
* If followSystem in CursorConfig is set to true, the supported adjustment range is [size of the cursor image, 256 x 256].
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Abnormal windowId parameter passed in;
* <br>2. Abnormal pixelMap parameter passed in; 3. Abnormal focusX parameter passed in;
* <br>4. Abnormal focusY parameter passed in.
* @throws { BusinessError } 26500001 - Invalid windowId. Possible causes: The window id does not belong to the current process.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @since 15
*/
function setCustomCursor(windowId: number, cursor: CustomCursor, config: CursorConfig): Promise<void>;
/**
* Sets the double-tap and drag switch for the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { boolean } isOpen - Status of the double-tap and drag switch.
* The value true indicates that the switch is enabled, and the value false indicates the opposite.
* @param { AsyncCallback<void> } callback - Callback used to return the result.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 14
*/
function setTouchpadDoubleTapAndDragState(isOpen: boolean, callback: AsyncCallback<void>): void;
/**
* Sets the double-tap and drag switch for the touchpad. This API uses a promise to return the result.
*
* @param { boolean } isOpen - Status of the double-tap and drag switch.
* The value true indicates that the switch is enabled, and the value false indicates the opposite.
* @returns { Promise<void> } Returns the result through a promise.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 14
*/
function setTouchpadDoubleTapAndDragState(isOpen: boolean): Promise<void>;
/**
* Obtains the status of the double-tap and drag switch for the touchpad. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the status of the double-tap drag switch.
* The value true indicates that the switch is enabled, and the value false indicates the opposite.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 14
*/
function getTouchpadDoubleTapAndDragState(callback: AsyncCallback<boolean>): void;
/**
* Obtains the status of the double-tap and drag switch for the touchpad. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the status of the touchpad double-tap drag switch.
* The value true indicates that the switch is enabled, and the value false indicates the opposite.
* @throws { BusinessError } 202 - SystemAPI permission error.
* @syscap SystemCapability.MultimodalInput.Input.Pointer
* @systemapi hide for inner use.
* @since 14
*/
function getTouchpadDoubleTapAndDragState(): Promise<boolean>;
}
export default pointer;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助