Skip to content
This repository was archived by the owner on Jan 16, 2024. It is now read-only.

Commit 99bfbb1

Browse files
committed
feat(docs): add initial documentation for keyClicks
1 parent 5c0d588 commit 99bfbb1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

index.d.ts

+12
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ export declare class NgTest {
55
* Create a new simulation wrapper for widget
66
*/
77
constructor(widget: NodeWidget): NgTest;
8+
89
/**
910
* Simulates clicking of key with an optional modifier
1011
*
@@ -13,6 +14,7 @@ export declare class NgTest {
1314
* @example {@link https://github.com/ng-qt/ng-test/blob/master/src/ng-test.spec.ts#25}
1415
*/
1516
keyClick(key: string, modifier?: KeyboardModifier): void;
17+
1618
/**
1719
* Simulates clicking of key with an optional modifier
1820
*
@@ -21,6 +23,7 @@ export declare class NgTest {
2123
* @example {@link https://github.com/ng-qt/ng-test/blob/master/src/ng-test.spec.ts#34}
2224
*/
2325
keyClick(key: Key, modifier?: KeyboardModifier): void;
26+
2427
/**
2528
* Simulates pressing a key with an optional modifier
2629
*
@@ -29,6 +32,7 @@ export declare class NgTest {
2932
* @example {@link https://github.com/ng-qt/ng-test/blob/master/src/ng-test.spec.ts#45}
3033
*/
3134
keyPress(key: string, modifier?: KeyboardModifier): void;
35+
3236
/**
3337
* Simulates pressing a key with an optional modifier
3438
*
@@ -37,4 +41,12 @@ export declare class NgTest {
3741
* @example {@link https://github.com/ng-qt/ng-test/blob/master/src/ng-test.spec.ts#54}
3842
*/
3943
keyPress(key: Key, modifier?: KeyboardModifier): void;
44+
45+
/**
46+
* Simulates clicking a sequence of keys on a widget.
47+
* Optionally, a keyboard modifier can be specified as well as a delay (in milliseconds) of the test before each key click.
48+
*
49+
* @see {@https://doc.qt.io/qt-5/qtest.html#keyClicks}
50+
*/
51+
keyClicks(sequence: string, modifier?: KeyboardModifier, delay?: number): void;
4052
}

0 commit comments

Comments
 (0)